diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 531def83..739fe386 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -76,4 +76,6 @@ jobs: - name: Cargo test run: cargo test --workspace --all-features env: + # To avoid stack overflows + RUST_MIN_STACK: 100000000 MONERO_ADDITIONAL_SLEEP_PERIOD: 60000 diff --git a/LICENSE b/LICENSE index 38aebcd0..f288702d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,674 @@ -MIT License + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 -Copyright (c) 2020 COMIT + 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 +. diff --git a/xmr-btc/Cargo.toml b/xmr-btc/Cargo.toml index 0b6cf7e7..6aff2c90 100644 --- a/xmr-btc/Cargo.toml +++ b/xmr-btc/Cargo.toml @@ -7,16 +7,17 @@ edition = "2018" [dependencies] anyhow = "1" async-trait = "0.1" -bitcoin = { version = "0.23", features = ["rand"] } -cross-curve-dleq = { git = "https://github.com/comit-network/cross-curve-dleq", rev = "a3e57a70d332b4ce9600663453b9bd02936d76bf" } +bitcoin = { version = "0.23", features = ["rand", "serde"] } +cross-curve-dleq = { git = "https://github.com/comit-network/cross-curve-dleq", rev = "49171f5e08473d46f951fb1fc338fe437d974d3c" } curve25519-dalek = "2" -ecdsa_fun = { version = "0.3.1", features = ["libsecp_compat"] } -ed25519-dalek = "1.0.0-pre.4" # Cannot be 1 because they depend on curve25519-dalek version 3 +ecdsa_fun = { git = "https://github.com/LLFourn/secp256kfun", rev = "510d48ef6a2b19805f7f5c70c598e5b03f668e7a", features = ["libsecp_compat", "serde", "serialization"] } +ed25519-dalek = { version = "1.0.0-pre.4", features = ["serde"] }# Cannot be 1 because they depend on curve25519-dalek version 3 futures = "0.3" genawaiter = "0.99.1" -miniscript = "1" -monero = "0.9" +miniscript = { version = "1", features = ["serde"] } +monero = { version = "0.9", features = ["serde_support"] } rand = "0.7" +serde = { version = "1", features = ["derive"] } sha2 = "0.9" thiserror = "1" tracing = "0.1" @@ -28,6 +29,8 @@ bitcoin-harness = { git = "https://github.com/coblox/bitcoin-harness-rs", rev = futures = "0.3" monero-harness = { path = "../monero-harness" } reqwest = { version = "0.10", default-features = false } +serde_cbor = "0.11" +sled = "0.34" testcontainers = "0.10" tokio = { version = "0.2", default-features = false, features = ["blocking", "macros", "rt-core", "time", "rt-threaded"] } tracing = "0.1" diff --git a/xmr-btc/src/alice.rs b/xmr-btc/src/alice.rs index 62d6385f..5d486161 100644 --- a/xmr-btc/src/alice.rs +++ b/xmr-btc/src/alice.rs @@ -3,6 +3,7 @@ use crate::{ bitcoin::{BroadcastSignedTransaction, WatchForRawTransaction}, bob, monero, monero::{CreateWalletForOutput, Transfer}, + serde::{bitcoin_amount, cross_curve_dleq_scalar, ecdsa_fun_signature}, transport::{ReceiveMessage, SendMessage}, }; use anyhow::{anyhow, Result}; @@ -11,6 +12,7 @@ use ecdsa_fun::{ nonce::Deterministic, }; use rand::{CryptoRng, RngCore}; +use serde::{Deserialize, Serialize}; use sha2::Sha256; use std::convert::{TryFrom, TryInto}; @@ -129,11 +131,13 @@ impl State { } } -#[derive(Clone, Debug)] +#[derive(Debug, Deserialize, Serialize)] pub struct State0 { a: bitcoin::SecretKey, + #[serde(with = "cross_curve_dleq_scalar")] s_a: cross_curve_dleq::Scalar, v_a: monero::PrivateViewKey, + #[serde(with = "bitcoin_amount")] btc: bitcoin::Amount, xmr: monero::Amount, refund_timelock: u32, @@ -188,7 +192,7 @@ impl State0 { pub fn receive(self, msg: bob::Message0) -> Result { msg.dleq_proof_s_b.verify( - &msg.S_b_bitcoin.clone().into(), + msg.S_b_bitcoin.clone().into(), msg.S_b_monero .point .decompress() @@ -215,14 +219,16 @@ impl State0 { } } -#[derive(Clone, Debug)] +#[derive(Debug, Deserialize, Serialize)] pub struct State1 { a: bitcoin::SecretKey, B: bitcoin::PublicKey, + #[serde(with = "cross_curve_dleq_scalar")] s_a: cross_curve_dleq::Scalar, S_b_monero: monero::PublicKey, S_b_bitcoin: bitcoin::PublicKey, v: monero::PrivateViewKey, + #[serde(with = "bitcoin_amount")] btc: bitcoin::Amount, xmr: monero::Amount, refund_timelock: u32, @@ -253,14 +259,16 @@ impl State1 { } } -#[derive(Debug)] +#[derive(Debug, Deserialize, Serialize)] pub struct State2 { a: bitcoin::SecretKey, B: bitcoin::PublicKey, + #[serde(with = "cross_curve_dleq_scalar")] s_a: cross_curve_dleq::Scalar, S_b_monero: monero::PublicKey, S_b_bitcoin: bitcoin::PublicKey, v: monero::PrivateViewKey, + #[serde(with = "bitcoin_amount")] btc: bitcoin::Amount, xmr: monero::Amount, refund_timelock: u32, @@ -328,14 +336,16 @@ impl State2 { } } -#[derive(Debug)] +#[derive(Debug, Deserialize, Serialize)] pub struct State3 { pub a: bitcoin::SecretKey, pub B: bitcoin::PublicKey, + #[serde(with = "cross_curve_dleq_scalar")] pub s_a: cross_curve_dleq::Scalar, pub S_b_monero: monero::PublicKey, pub S_b_bitcoin: bitcoin::PublicKey, pub v: monero::PrivateViewKey, + #[serde(with = "bitcoin_amount")] btc: bitcoin::Amount, pub xmr: monero::Amount, pub refund_timelock: u32, @@ -344,7 +354,9 @@ pub struct State3 { pub redeem_address: bitcoin::Address, pub punish_address: bitcoin::Address, pub tx_lock: bitcoin::TxLock, + #[serde(with = "ecdsa_fun_signature")] pub tx_punish_sig_bob: bitcoin::Signature, + #[serde(with = "ecdsa_fun_signature")] pub tx_cancel_sig_bob: bitcoin::Signature, } @@ -381,14 +393,16 @@ impl State3 { } } -#[derive(Debug)] +#[derive(Debug, Deserialize, Serialize)] pub struct State4 { a: bitcoin::SecretKey, B: bitcoin::PublicKey, + #[serde(with = "cross_curve_dleq_scalar")] s_a: cross_curve_dleq::Scalar, S_b_monero: monero::PublicKey, S_b_bitcoin: bitcoin::PublicKey, v: monero::PrivateViewKey, + #[serde(with = "bitcoin_amount")] btc: bitcoin::Amount, xmr: monero::Amount, refund_timelock: u32, @@ -397,7 +411,9 @@ pub struct State4 { redeem_address: bitcoin::Address, punish_address: bitcoin::Address, tx_lock: bitcoin::TxLock, + #[serde(with = "ecdsa_fun_signature")] tx_punish_sig_bob: bitcoin::Signature, + #[serde(with = "ecdsa_fun_signature")] tx_cancel_sig_bob: bitcoin::Signature, } @@ -484,14 +500,16 @@ impl State4 { } } -#[derive(Debug)] +#[derive(Debug, Deserialize, Serialize)] pub struct State5 { a: bitcoin::SecretKey, B: bitcoin::PublicKey, + #[serde(with = "cross_curve_dleq_scalar")] s_a: cross_curve_dleq::Scalar, S_b_monero: monero::PublicKey, S_b_bitcoin: bitcoin::PublicKey, v: monero::PrivateViewKey, + #[serde(with = "bitcoin_amount")] btc: bitcoin::Amount, xmr: monero::Amount, refund_timelock: u32, @@ -501,7 +519,9 @@ pub struct State5 { punish_address: bitcoin::Address, tx_lock: bitcoin::TxLock, tx_lock_proof: monero::TransferProof, + #[serde(with = "ecdsa_fun_signature")] tx_punish_sig_bob: bitcoin::Signature, + #[serde(with = "ecdsa_fun_signature")] tx_cancel_sig_bob: bitcoin::Signature, lock_xmr_fee: monero::Amount, } @@ -575,14 +595,16 @@ impl State5 { } } -#[derive(Debug)] +#[derive(Debug, Deserialize, Serialize)] pub struct State6 { a: bitcoin::SecretKey, B: bitcoin::PublicKey, + #[serde(with = "cross_curve_dleq_scalar")] s_a: cross_curve_dleq::Scalar, S_b_monero: monero::PublicKey, S_b_bitcoin: bitcoin::PublicKey, v: monero::PrivateViewKey, + #[serde(with = "bitcoin_amount")] btc: bitcoin::Amount, xmr: monero::Amount, refund_timelock: u32, @@ -591,6 +613,7 @@ pub struct State6 { redeem_address: bitcoin::Address, punish_address: bitcoin::Address, tx_lock: bitcoin::TxLock, + #[serde(with = "ecdsa_fun_signature")] tx_punish_sig_bob: bitcoin::Signature, tx_redeem_encsig: EncryptedSignature, lock_xmr_fee: monero::Amount, diff --git a/xmr-btc/src/bitcoin.rs b/xmr-btc/src/bitcoin.rs index 291c6ce8..d3c96d15 100644 --- a/xmr-btc/src/bitcoin.rs +++ b/xmr-btc/src/bitcoin.rs @@ -19,6 +19,7 @@ use ecdsa_fun::{ }; use miniscript::{Descriptor, Segwitv0}; use rand::{CryptoRng, RngCore}; +use serde::{Deserialize, Serialize}; use sha2::Sha256; use std::str::FromStr; @@ -28,7 +29,7 @@ pub use ecdsa_fun::{adaptor::EncryptedSignature, Signature}; pub const TX_FEE: u64 = 10_000; -#[derive(Debug, Clone)] +#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)] pub struct SecretKey { inner: Scalar, public: Point, @@ -83,7 +84,7 @@ impl SecretKey { } } -#[derive(Debug, Clone)] +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] pub struct PublicKey(Point); impl From for Point { diff --git a/xmr-btc/src/bitcoin/transactions.rs b/xmr-btc/src/bitcoin/transactions.rs index c54448dc..3242f471 100644 --- a/xmr-btc/src/bitcoin/transactions.rs +++ b/xmr-btc/src/bitcoin/transactions.rs @@ -8,9 +8,10 @@ use bitcoin::{ }; use ecdsa_fun::Signature; use miniscript::Descriptor; +use serde::{Deserialize, Serialize}; use std::collections::HashMap; -#[derive(Debug, Clone)] +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] pub struct TxLock { inner: Transaction, output_descriptor: Descriptor<::bitcoin::PublicKey>, diff --git a/xmr-btc/src/bob.rs b/xmr-btc/src/bob.rs index 2087a142..bf8780ea 100644 --- a/xmr-btc/src/bob.rs +++ b/xmr-btc/src/bob.rs @@ -5,7 +5,8 @@ use crate::{ WatchForRawTransaction, }, monero, - monero::{CreateWalletForOutput, WatchForTransfer}, + monero::{CheckTransfer, CreateWalletForOutput, WatchForTransfer}, + serde::{bitcoin_amount, cross_curve_dleq_scalar, monero_private_key}, transport::{ReceiveMessage, SendMessage}, }; use anyhow::{anyhow, Result}; @@ -15,6 +16,7 @@ use ecdsa_fun::{ Signature, }; use rand::{CryptoRng, RngCore}; +use serde::{Deserialize, Serialize}; use sha2::Sha256; use std::convert::{TryFrom, TryInto}; @@ -102,11 +104,13 @@ impl_from_child_enum!(State3, State); impl_from_child_enum!(State4, State); impl_from_child_enum!(State5, State); -#[derive(Clone, Debug)] +#[derive(Debug, Deserialize, Serialize)] pub struct State0 { b: bitcoin::SecretKey, + #[serde(with = "cross_curve_dleq_scalar")] s_b: cross_curve_dleq::Scalar, v_b: monero::PrivateViewKey, + #[serde(with = "bitcoin_amount")] btc: bitcoin::Amount, xmr: monero::Amount, refund_timelock: u32, @@ -160,7 +164,7 @@ impl State0 { W: BuildTxLockPsbt, { msg.dleq_proof_s_a.verify( - &msg.S_a_bitcoin.clone().into(), + msg.S_a_bitcoin.clone().into(), msg.S_a_monero .point .decompress() @@ -190,14 +194,16 @@ impl State0 { } } -#[derive(Clone, Debug)] +#[derive(Debug, Deserialize, Serialize)] pub struct State1 { A: bitcoin::PublicKey, b: bitcoin::SecretKey, + #[serde(with = "cross_curve_dleq_scalar")] s_b: cross_curve_dleq::Scalar, S_a_monero: monero::PublicKey, S_a_bitcoin: bitcoin::PublicKey, v: monero::PrivateViewKey, + #[serde(with = "bitcoin_amount")] btc: bitcoin::Amount, xmr: monero::Amount, refund_timelock: u32, @@ -253,14 +259,16 @@ impl State1 { } } -#[derive(Debug)] +#[derive(Debug, Deserialize, Serialize)] pub struct State2 { pub A: bitcoin::PublicKey, pub b: bitcoin::SecretKey, + #[serde(with = "cross_curve_dleq_scalar")] pub s_b: cross_curve_dleq::Scalar, pub S_a_monero: monero::PublicKey, pub S_a_bitcoin: bitcoin::PublicKey, pub v: monero::PrivateViewKey, + #[serde(with = "bitcoin_amount")] btc: bitcoin::Amount, pub xmr: monero::Amount, pub refund_timelock: u32, @@ -324,14 +332,16 @@ impl State2 { } } -#[derive(Debug)] +#[derive(Debug, Serialize, Deserialize)] pub struct State3 { A: bitcoin::PublicKey, b: bitcoin::SecretKey, + #[serde(with = "cross_curve_dleq_scalar")] s_b: cross_curve_dleq::Scalar, S_a_monero: monero::PublicKey, S_a_bitcoin: bitcoin::PublicKey, v: monero::PrivateViewKey, + #[serde(with = "bitcoin_amount")] btc: bitcoin::Amount, xmr: monero::Amount, refund_timelock: u32, @@ -435,14 +445,16 @@ impl State3 { } } -#[derive(Debug)] +#[derive(Debug, Deserialize, Serialize)] pub struct State4 { A: bitcoin::PublicKey, b: bitcoin::SecretKey, + #[serde(with = "cross_curve_dleq_scalar")] s_b: cross_curve_dleq::Scalar, S_a_monero: monero::PublicKey, S_a_bitcoin: bitcoin::PublicKey, v: monero::PrivateViewKey, + #[serde(with = "bitcoin_amount")] btc: bitcoin::Amount, xmr: monero::Amount, refund_timelock: u32, @@ -502,15 +514,18 @@ impl State4 { } } -#[derive(Debug)] +#[derive(Debug, Clone, Deserialize, Serialize)] pub struct State5 { A: bitcoin::PublicKey, b: bitcoin::SecretKey, + #[serde(with = "monero_private_key")] s_a: monero::PrivateKey, + #[serde(with = "cross_curve_dleq_scalar")] s_b: cross_curve_dleq::Scalar, S_a_monero: monero::PublicKey, S_a_bitcoin: bitcoin::PublicKey, v: monero::PrivateViewKey, + #[serde(with = "bitcoin_amount")] btc: bitcoin::Amount, xmr: monero::Amount, refund_timelock: u32, diff --git a/xmr-btc/src/lib.rs b/xmr-btc/src/lib.rs index 1b2b6e24..b84bef51 100644 --- a/xmr-btc/src/lib.rs +++ b/xmr-btc/src/lib.rs @@ -49,6 +49,7 @@ pub mod alice; pub mod bitcoin; pub mod bob; pub mod monero; +pub mod serde; pub mod transport; use async_trait::async_trait; diff --git a/xmr-btc/src/monero.rs b/xmr-btc/src/monero.rs index 241666c7..24bf747d 100644 --- a/xmr-btc/src/monero.rs +++ b/xmr-btc/src/monero.rs @@ -1,7 +1,10 @@ +use crate::serde::monero_private_key; +use anyhow::Result; use async_trait::async_trait; pub use curve25519_dalek::scalar::Scalar; pub use monero::{Address, PrivateKey, PublicKey}; use rand::{CryptoRng, RngCore}; +use serde::{Deserialize, Serialize}; use std::ops::Add; pub const MIN_CONFIRMATIONS: u32 = 10; @@ -12,8 +15,8 @@ pub fn random_private_key(rng: &mut R) -> PrivateKey { PrivateKey::from_scalar(scalar) } -#[derive(Clone, Copy, Debug)] -pub struct PrivateViewKey(PrivateKey); +#[derive(Clone, Copy, Debug, Serialize, Deserialize, PartialEq)] +pub struct PrivateViewKey(#[serde(with = "monero_private_key")] PrivateKey); impl PrivateViewKey { pub fn new_random(rng: &mut R) -> Self { @@ -51,7 +54,7 @@ impl From for PublicKey { #[derive(Clone, Copy, Debug)] pub struct PublicViewKey(PublicKey); -#[derive(Debug, Copy, Clone)] +#[derive(Debug, Copy, Clone, Deserialize, Serialize, PartialEq)] pub struct Amount(u64); impl Amount { @@ -73,9 +76,10 @@ impl From for u64 { } } -#[derive(Clone, Debug)] +#[derive(Clone, Debug, Serialize, Deserialize)] pub struct TransferProof { tx_hash: TxHash, + #[serde(with = "monero_private_key")] tx_key: PrivateKey, } @@ -92,7 +96,7 @@ impl TransferProof { } // TODO: add constructor/ change String to fixed length byte array -#[derive(Clone, Debug)] +#[derive(Clone, Debug, Serialize, Deserialize)] pub struct TxHash(pub String); impl From for String { diff --git a/xmr-btc/src/serde.rs b/xmr-btc/src/serde.rs new file mode 100644 index 00000000..e64cfd10 --- /dev/null +++ b/xmr-btc/src/serde.rs @@ -0,0 +1,210 @@ +pub mod ecdsa_fun_signature { + use serde::{de, de::Visitor, Deserializer, Serializer}; + use std::{convert::TryFrom, fmt}; + + struct Bytes64Visitor; + + impl<'de> Visitor<'de> for Bytes64Visitor { + type Value = ecdsa_fun::Signature; + + fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(formatter, "a string containing 64 bytes") + } + + fn visit_bytes(self, s: &[u8]) -> Result + where + E: de::Error, + { + if let Ok(value) = <[u8; 64]>::try_from(s) { + let sig = ecdsa_fun::Signature::from_bytes(value) + .expect("bytes represent an integer greater than or equal to the curve order"); + Ok(sig) + } else { + Err(de::Error::invalid_length(s.len(), &self)) + } + } + } + + pub fn serialize(x: &ecdsa_fun::Signature, s: S) -> Result + where + S: Serializer, + { + s.serialize_bytes(&x.to_bytes()) + } + + pub fn deserialize<'de, D>( + deserializer: D, + ) -> Result>::Error> + where + D: Deserializer<'de>, + { + let sig = deserializer.deserialize_bytes(Bytes64Visitor)?; + Ok(sig) + } +} + +pub mod cross_curve_dleq_scalar { + use serde::{de, de::Visitor, Deserializer, Serializer}; + use std::{convert::TryFrom, fmt}; + + struct Bytes32Visitor; + + impl<'de> Visitor<'de> for Bytes32Visitor { + type Value = cross_curve_dleq::Scalar; + + fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(formatter, "a string containing 32 bytes") + } + + fn visit_bytes(self, s: &[u8]) -> Result + where + E: de::Error, + { + if let Ok(value) = <[u8; 32]>::try_from(s) { + Ok(cross_curve_dleq::Scalar::from(value)) + } else { + Err(de::Error::invalid_length(s.len(), &self)) + } + } + } + + pub fn serialize(x: &cross_curve_dleq::Scalar, s: S) -> Result + where + S: Serializer, + { + // Serialise as ed25519 because the inner bytes are private + // TODO: Open PR in cross_curve_dleq to allow accessing the inner bytes + s.serialize_bytes(&x.into_ed25519().to_bytes()) + } + + pub fn deserialize<'de, D>( + deserializer: D, + ) -> Result>::Error> + where + D: Deserializer<'de>, + { + let dleq = deserializer.deserialize_bytes(Bytes32Visitor)?; + Ok(dleq) + } +} + +pub mod monero_private_key { + use serde::{de, de::Visitor, Deserializer, Serializer}; + use std::fmt; + + struct BytesVisitor; + + impl<'de> Visitor<'de> for BytesVisitor { + type Value = monero::PrivateKey; + + fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(formatter, "a string containing 32 bytes") + } + + fn visit_bytes(self, s: &[u8]) -> Result + where + E: de::Error, + { + if let Ok(key) = monero::PrivateKey::from_slice(s) { + Ok(key) + } else { + Err(de::Error::invalid_length(s.len(), &self)) + } + } + } + + pub fn serialize(x: &monero::PrivateKey, s: S) -> Result + where + S: Serializer, + { + s.serialize_bytes(x.as_bytes()) + } + + pub fn deserialize<'de, D>( + deserializer: D, + ) -> Result>::Error> + where + D: Deserializer<'de>, + { + let key = deserializer.deserialize_bytes(BytesVisitor)?; + Ok(key) + } +} + +pub mod bitcoin_amount { + use serde::{Deserialize, Deserializer, Serializer}; + + pub fn serialize(value: &bitcoin::Amount, serializer: S) -> Result + where + S: Serializer, + { + serializer.serialize_u64(value.as_sat()) + } + + pub fn deserialize<'de, D>( + deserializer: D, + ) -> Result>::Error> + where + D: Deserializer<'de>, + { + let value = u64::deserialize(deserializer)?; + let amount = bitcoin::Amount::from_sat(value); + + Ok(amount) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use ::bitcoin::SigHash; + use curve25519_dalek::scalar::Scalar; + use rand::rngs::OsRng; + use serde::{Deserialize, Serialize}; + + #[derive(Debug, Serialize, Deserialize, PartialEq)] + pub struct CrossCurveDleqScalar( + #[serde(with = "cross_curve_dleq_scalar")] cross_curve_dleq::Scalar, + ); + + #[derive(Debug, Serialize, Deserialize, PartialEq)] + pub struct ECDSAFunSignature(#[serde(with = "ecdsa_fun_signature")] ecdsa_fun::Signature); + + #[derive(Debug, Serialize, Deserialize, PartialEq)] + pub struct MoneroPrivateKey(#[serde(with = "monero_private_key")] crate::monero::PrivateKey); + + #[derive(Debug, Serialize, Deserialize, PartialEq)] + pub struct BitcoinAmount(#[serde(with = "bitcoin_amount")] ::bitcoin::Amount); + + #[test] + fn serde_cross_curv_dleq_scalar() { + let scalar = CrossCurveDleqScalar(cross_curve_dleq::Scalar::random(&mut OsRng)); + let encoded = serde_cbor::to_vec(&scalar).unwrap(); + let decoded: CrossCurveDleqScalar = serde_cbor::from_slice(&encoded).unwrap(); + assert_eq!(scalar, decoded); + } + + #[test] + fn serde_ecdsa_fun_sig() { + let secret_key = crate::bitcoin::SecretKey::new_random(&mut OsRng); + let sig = ECDSAFunSignature(secret_key.sign(SigHash::default())); + let encoded = serde_cbor::to_vec(&sig).unwrap(); + let decoded: ECDSAFunSignature = serde_cbor::from_slice(&encoded).unwrap(); + assert_eq!(sig, decoded); + } + + #[test] + fn serde_monero_private_key() { + let key = MoneroPrivateKey(monero::PrivateKey::from_scalar(Scalar::random(&mut OsRng))); + let encoded = serde_cbor::to_vec(&key).unwrap(); + let decoded: MoneroPrivateKey = serde_cbor::from_slice(&encoded).unwrap(); + assert_eq!(key, decoded); + } + #[test] + fn serde_bitcoin_amount() { + let amount = BitcoinAmount(::bitcoin::Amount::from_sat(100)); + let encoded = serde_cbor::to_vec(&amount).unwrap(); + let decoded: BitcoinAmount = serde_cbor::from_slice(&encoded).unwrap(); + assert_eq!(amount, decoded); + } +} diff --git a/xmr-btc/tests/e2e.rs b/xmr-btc/tests/e2e.rs index 2eb3cf70..d2e5f550 100644 --- a/xmr-btc/tests/e2e.rs +++ b/xmr-btc/tests/e2e.rs @@ -18,6 +18,8 @@ use xmr_btc::{alice, bitcoin, bob, monero}; const TEN_XMR: u64 = 10_000_000_000_000; const RELATIVE_REFUND_TIMELOCK: u32 = 1; const RELATIVE_PUNISH_TIMELOCK: u32 = 1; +const ALICE_TEST_DB_FOLDER: &str = "../target/e2e-test-alice-recover"; +const BOB_TEST_DB_FOLDER: &str = "../target/e2e-test-bob-recover"; pub async fn init_bitcoind(tc_client: &Cli) -> Bitcoind<'_> { let bitcoind = Bitcoind::new(tc_client, "0.19.1").expect("failed to create bitcoind"); @@ -59,9 +61,9 @@ pub fn init_alice_and_bob_transports() -> ( (a_transport, b_transport) } -pub async fn init_test( - monero: &Monero, - bitcoind: &Bitcoind<'_>, +pub async fn init_test<'a>( + monero: &'a Monero<'a>, + bitcoind: &Bitcoind<'a>, ) -> ( alice::State0, bob::State0, @@ -142,15 +144,21 @@ pub async fn init_test( } mod tests { + // NOTE: For some reason running these tests overflows the stack. In order to + // mitigate this run them with: + // + // RUST_MIN_STACK=100000000 cargo test + use crate::{ harness, harness::node::{run_alice_until, run_bob_until}, - init_bitcoind, init_test, + init_bitcoind, init_test, ALICE_TEST_DB_FOLDER, BOB_TEST_DB_FOLDER, }; use futures::future; use monero_harness::Monero; use rand::rngs::OsRng; - use std::convert::TryInto; + + use std::{convert::TryInto, path::Path}; use testcontainers::clients::Cli; use tracing_subscriber::util::SubscriberInitExt; use xmr_btc::{ @@ -375,4 +383,126 @@ mod tests { initial_balances.bob_btc - swap_amounts.btc - lock_tx_bitcoin_fee ); } + + #[tokio::test] + async fn recover_protocol_state_from_db() { + let _guard = tracing_subscriber::fmt() + .with_env_filter("info") + .set_default(); + + let cli = Cli::default(); + let monero = Monero::new(&cli); + let bitcoind = init_bitcoind(&cli).await; + let alice_db = harness::storage::Database::open(Path::new(ALICE_TEST_DB_FOLDER)).unwrap(); + let bob_db = harness::storage::Database::open(Path::new(BOB_TEST_DB_FOLDER)).unwrap(); + + let ( + alice_state0, + bob_state0, + mut alice_node, + mut bob_node, + initial_balances, + swap_amounts, + ) = init_test(&monero, &bitcoind).await; + + { + let (alice_state, bob_state) = future::try_join( + run_alice_until( + &mut alice_node, + alice_state0.into(), + harness::alice::is_state5, + &mut OsRng, + ), + run_bob_until( + &mut bob_node, + bob_state0.into(), + harness::bob::is_state3, + &mut OsRng, + ), + ) + .await + .unwrap(); + + let alice_state5: alice::State5 = alice_state.try_into().unwrap(); + let bob_state3: bob::State3 = bob_state.try_into().unwrap(); + + // save state to db + alice_db.insert_latest_state(&alice_state5).await.unwrap(); + bob_db.insert_latest_state(&bob_state3).await.unwrap(); + }; + + let (alice_state6, bob_state5) = { + // recover state from db + let alice_state5: alice::State5 = alice_db.get_latest_state().unwrap(); + let bob_state3: bob::State3 = bob_db.get_latest_state().unwrap(); + + let (alice_state, bob_state) = future::try_join( + run_alice_until( + &mut alice_node, + alice_state5.into(), + harness::alice::is_state6, + &mut OsRng, + ), + run_bob_until( + &mut bob_node, + bob_state3.into(), + harness::bob::is_state5, + &mut OsRng, + ), + ) + .await + .unwrap(); + + let alice_state: alice::State6 = alice_state.try_into().unwrap(); + let bob_state: bob::State5 = bob_state.try_into().unwrap(); + + (alice_state, bob_state) + }; + + let alice_final_btc_balance = alice_node.bitcoin_wallet.balance().await.unwrap(); + let bob_final_btc_balance = bob_node.bitcoin_wallet.balance().await.unwrap(); + + let lock_tx_bitcoin_fee = bob_node + .bitcoin_wallet + .transaction_fee(bob_state5.tx_lock_id()) + .await + .unwrap(); + + let alice_final_xmr_balance = alice_node + .monero_wallet + .0 + .get_balance_alice() + .await + .unwrap(); + + bob_node + .monero_wallet + .0 + .wait_for_bob_wallet_block_height() + .await + .unwrap(); + + let bob_final_xmr_balance = bob_node.monero_wallet.0.get_balance_bob().await.unwrap(); + + assert_eq!( + alice_final_btc_balance, + initial_balances.alice_btc + swap_amounts.btc + - bitcoin::Amount::from_sat(bitcoin::TX_FEE) + ); + assert_eq!( + bob_final_btc_balance, + initial_balances.bob_btc - swap_amounts.btc - lock_tx_bitcoin_fee + ); + + assert_eq!( + alice_final_xmr_balance, + initial_balances.alice_xmr + - u64::from(swap_amounts.xmr) + - u64::from(alice_state6.lock_xmr_fee()) + ); + assert_eq!( + bob_final_xmr_balance, + initial_balances.bob_xmr + u64::from(swap_amounts.xmr) + ); + } } diff --git a/xmr-btc/tests/harness/mod.rs b/xmr-btc/tests/harness/mod.rs index 4f2cba46..d08a7291 100644 --- a/xmr-btc/tests/harness/mod.rs +++ b/xmr-btc/tests/harness/mod.rs @@ -1,4 +1,5 @@ pub mod node; +pub mod storage; pub mod transport; pub mod wallet; diff --git a/xmr-btc/tests/harness/storage.rs b/xmr-btc/tests/harness/storage.rs new file mode 100644 index 00000000..19b1b401 --- /dev/null +++ b/xmr-btc/tests/harness/storage.rs @@ -0,0 +1,159 @@ +use anyhow::{anyhow, Context, Result}; +use serde::{de::DeserializeOwned, Deserialize, Serialize}; +use std::path::Path; + +pub struct Database { + db: sled::Db, +} + +impl Database { + const LAST_STATE_KEY: &'static str = "latest_state"; + + pub fn open(path: &Path) -> Result { + let path = path + .to_str() + .ok_or_else(|| anyhow!("The path is not utf-8 valid: {:?}", path))?; + let db = sled::open(path).with_context(|| format!("Could not open the DB at {}", path))?; + + Ok(Database { db }) + } + + pub async fn insert_latest_state(&self, state: &T) -> Result<()> + where + T: Serialize + DeserializeOwned, + { + let key = serialize(&Self::LAST_STATE_KEY)?; + let new_value = serialize(&state).context("Could not serialize new state value")?; + + let old_value = self.db.get(&key)?; + + self.db + .compare_and_swap(key, old_value, Some(new_value)) + .context("Could not write in the DB")? + .context("Stored swap somehow changed, aborting saving")?; // let _ = + + self.db + .flush_async() + .await + .map(|_| ()) + .context("Could not flush db") + } + + pub fn get_latest_state(&self) -> anyhow::Result + where + T: DeserializeOwned, + { + let key = serialize(&Self::LAST_STATE_KEY)?; + + let encoded = self + .db + .get(&key)? + .ok_or_else(|| anyhow!("State does not exist {:?}", key))?; + + let state = deserialize(&encoded).context("Could not deserialize state")?; + Ok(state) + } +} + +pub fn serialize(t: &T) -> anyhow::Result> +where + T: Serialize, +{ + Ok(serde_cbor::to_vec(t)?) +} + +pub fn deserialize(v: &[u8]) -> anyhow::Result +where + T: DeserializeOwned, +{ + Ok(serde_cbor::from_slice(&v)?) +} + +#[cfg(test)] +mod tests { + #![allow(non_snake_case)] + use super::*; + use bitcoin::SigHash; + use curve25519_dalek::scalar::Scalar; + use ecdsa_fun::fun::rand_core::OsRng; + use std::str::FromStr; + use xmr_btc::serde::{ + bitcoin_amount, cross_curve_dleq_scalar, ecdsa_fun_signature, monero_private_key, + }; + + #[derive(Debug, Serialize, Deserialize, PartialEq)] + pub struct TestState { + A: xmr_btc::bitcoin::PublicKey, + a: xmr_btc::bitcoin::SecretKey, + #[serde(with = "cross_curve_dleq_scalar")] + s_a: ::cross_curve_dleq::Scalar, + #[serde(with = "monero_private_key")] + s_b: monero::PrivateKey, + S_a_monero: ::monero::PublicKey, + S_a_bitcoin: xmr_btc::bitcoin::PublicKey, + v: xmr_btc::monero::PrivateViewKey, + #[serde(with = "bitcoin_amount")] + btc: ::bitcoin::Amount, + xmr: xmr_btc::monero::Amount, + refund_timelock: u32, + refund_address: ::bitcoin::Address, + transaction: ::bitcoin::Transaction, + #[serde(with = "ecdsa_fun_signature")] + tx_punish_sig: xmr_btc::bitcoin::Signature, + } + + #[tokio::test] + async fn recover_state_from_db() { + let db = Database::open(Path::new("../target/test_recover.db")).unwrap(); + + let a = crate::bitcoin::SecretKey::new_random(&mut OsRng); + let s_a = cross_curve_dleq::Scalar::random(&mut OsRng); + let s_b = monero::PrivateKey::from_scalar(Scalar::random(&mut OsRng)); + let v_a = xmr_btc::monero::PrivateViewKey::new_random(&mut OsRng); + let S_a_monero = monero::PublicKey::from_private_key(&monero::PrivateKey { + scalar: s_a.into_ed25519(), + }); + let S_a_bitcoin = s_a.into_secp256k1().into(); + let tx_punish_sig = a.sign(SigHash::default()); + + let state = TestState { + A: a.public(), + a, + s_b, + s_a, + S_a_monero, + S_a_bitcoin, + v: v_a, + btc: ::bitcoin::Amount::from_sat(100), + xmr: crate::monero::Amount::from_piconero(1000), + refund_timelock: 0, + refund_address: ::bitcoin::Address::from_str("1L5wSMgerhHg8GZGcsNmAx5EXMRXSKR3He") + .unwrap(), + transaction: ::bitcoin::Transaction { + version: 0, + lock_time: 0, + input: vec![::bitcoin::TxIn::default()], + output: vec![::bitcoin::TxOut::default()], + }, + tx_punish_sig, + }; + + db.insert_latest_state(&state) + .await + .expect("Failed to save state the first time"); + let recovered: TestState = db + .get_latest_state() + .expect("Failed to recover state the first time"); + + // We insert and recover twice to ensure database implementation allows the + // caller to write to an existing key + db.insert_latest_state(&recovered) + .await + .expect("Failed to save state the second time"); + let recovered: TestState = db + .get_latest_state() + .expect("Failed to recover state the second time"); + + assert_eq!(state, recovered); + } +}