From 5fc61b72db69ca9a10805e75d4c74db1598a60bc Mon Sep 17 00:00:00 2001 From: wileyj <2847772+wileyj@users.noreply.github.com> Date: Mon, 22 Sep 2025 10:59:54 -0700 Subject: [PATCH 1/9] Create LICENSE --- LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 674 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. From 6a4c2a6cfeed9999322007f82f473d88333e1456 Mon Sep 17 00:00:00 2001 From: wileyj <2847772+wileyj@users.noreply.github.com> Date: Mon, 22 Sep 2025 13:43:06 -0700 Subject: [PATCH 2/9] cleanup - added comments - removed service monitor --- Makefile | 4 +- README.md | 1 - docker/docker-compose.yml | 62 +++++++++--------------------- docker/stacker/stacking/monitor.ts | 4 +- 4 files changed, 22 insertions(+), 49 deletions(-) diff --git a/Makefile b/Makefile index 191ba63..f22aa82 100644 --- a/Makefile +++ b/Makefile @@ -54,9 +54,9 @@ up: check-not-running | build $(CHAINSTATE_DIR) # Run the network from genesis genesis: check-not-running | build $(CHAINSTATE_DIR) /usr/bin/sudo @echo "Starting $(PROJECT) network from genesis" - @if [ -d "$(CHAINSTATE_DIR)/logs" ]; then \ + @if [ -d "$(CHAINSTATE_DIR)" ]; then \ echo " Removing existing genesis chainstate dir: $(CHAINSTATE_DIR)"; \ - rm -rf $(CHAINSTATE_DIR)/logs; \ + sudo rm -rf $(CHAINSTATE_DIR); \ fi @echo " Chainstate Dir: $(CHAINSTATE_DIR)" mkdir -p "$(CHAINSTATE_DIR)" diff --git a/README.md b/README.md index 872a417..4dbaba8 100644 --- a/README.md +++ b/README.md @@ -159,7 +159,6 @@ make clean - **postgres**: postgres DB used by stacks-api - **stacker**: stack for `stacks-signer-1`, `stacks-signer-2` and `stacks-signer-3` - **tx-broadcaster**: submits token transfer txs to ensure stacks block production during a sortition -- **monitor**: monitors block details and tracks stacking calls ## Stacks Miner Accounts diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml index cce3601..be42afa 100644 --- a/docker/docker-compose.yml +++ b/docker/docker-compose.yml @@ -39,7 +39,8 @@ x-common-vars: - &STACKS_MINER_3_BTC_WALLET stacks-miner-3 - &STACKS_MINER_3_BLOCK_PUSH_FAIL_PROBABILITY 0 - # Container IP assignments + # Container Static IP assignments + # *Note*: The stacks miner ip's are used for the bootstrap config later in this file - &DOCKER_NETWORK_CIDR 10.0.0.0/24 - &DOCKER_NETWORK_GATEWAY 10.0.0.1 - &STACKS_MINER_1_IP 10.0.0.101 @@ -84,9 +85,6 @@ x-common-vars: - &REWARD_RECIPIENT_1 ${REWARD_RECIPIENT_1:-ST1XVSVQN0KP5SDYFNT8E5TXWVW0XZVQEDBMCJ3XM} # priv: a6143d20cd73d0dce2179e2af7771372a95b9d6795924492bd4d15d17709531e01 - &REWARD_RECIPIENT_2 ${REWARD_RECIPIENT_2:-ST2FW15NGB4H76FMVXKHYYSM865YVS6V3SA1GNABC} # priv: fe3087801196d8027008146b13e6d365920c2e4b7bc9969729ec2f0f22ef74fc01 - &REWARD_RECIPIENT_3 ${REWARD_RECIPIENT_3:-ST2MES40ZEXTX9M4YXW9QSWHRVC9HYT419S198VPM} # priv: ed7eb063c61b8e892987228f1fcfb74eab5009568861613dc4b074b708a7893701 - - &REWARD_RECIPIENT_4 ${REWARD_RECIPIENT_4:-ST1235HCHDHFRSVX3EM4DFRTGJ0MK8FBYXNYXRE96} # priv: 452b2a668a05ba3330c4d31ed8a8839302bf03fb869e4ca13a0f5e84875cfc1201 - - &REWARD_RECIPIENT_5 ${REWARD_RECIPIENT_5:-ST2RT3Z1ETNWMTV7CSCC3WAT6QM560N9E8V87ANJQ} # priv: 9ffcae72c15c361f05f7ccd09e03d212bef00bf57706ee90f209cf8b51b429df01 - - &EXIT_FROM_MONITOR 1 # set to "1" to automatically shut down via monitor.ts - &STACKS_CORE_BASE_BRANCH ${STACKS_CORE_BASE_BRANCH:-3.2.0.0.1} - &PAUSE_HEIGHT ${PAUSE_HEIGHT:-999999999999} - &PAUSE_TIMER 86400000 @@ -95,21 +93,19 @@ x-common-vars: # ------------------------------------------------------------------------------ x-stacks-blockchain-node: - # image: stacks-core:local &stacks-blockchain-node build: args: STACKS_CORE_BASE_BRANCH: *STACKS_CORE_BASE_BRANCH - dockerfile: ${PWD}/docker/stacks/Dockerfile + dockerfile: ./stacks/Dockerfile target: stacks-node x-stacks-blockchain-signer: - # image: stacks-signer:local &stacks-blockchain-signer build: args: STACKS_CORE_BASE_BRANCH: *STACKS_CORE_BASE_BRANCH - dockerfile: ${PWD}/docker/stacks/Dockerfile + dockerfile: ./stacks/Dockerfile target: stacks-signer x-stacks-node: &stacks-node @@ -137,10 +133,11 @@ x-stacks-node: &stacks-node STACKS_LOG_JSON: *STACKS_LOG_JSON STACKS_LOG_DEBUG: *STACKS_LOG_DEBUG STACKS_LOG_FORMAT_TIME: *STACKS_LOG_FORMAT_TIME - # Use static IP's defined above for the bootstrap nodes in case one or more miners are stopped/crashed and docker removes the DNS entry + # Use static IP's defined in x-common-vars for the bootstrap nodes in case one or more miners are stopped/crashed and docker removes the DNS entry BOOTSTRAP_NODE: "0383bca67d28fce336ea7c2fc1120ecc63fbe55e89251e20587c2eb877f971e56b@10.0.0.101:20444,037f705fffab4de974d10563828ee3bf0c3e2e4f318f9ae670b8374a7b890195a2@10.0.0.102:20444,03180a98f60f943f1594adec7cd39d639a0cc5109a33219c268c796d55096fe66b@10.0.0.103:20444" networks: - default + # Config files are templated, need to first replace variables in the config with defined values from `environment` entrypoint: - /bin/bash - -c @@ -158,6 +155,7 @@ x-stacks-signer: &stacks-signer STACKS_LOG_FORMAT_TIME: *STACKS_LOG_FORMAT_TIME networks: - default + # Config files are templated, need to first replace variables in the config with defined values from `environment` entrypoint: - /bin/bash - -c @@ -227,7 +225,7 @@ services: STACKS_25_HEIGHT: *STACKS_25_HEIGHT PAUSE_HEIGHT: *PAUSE_HEIGHT PAUSE_TIMER: *PAUSE_TIMER - STACKS_2_05_HEIGHT: *STACKS_2_05_HEIGHT # this is used in the miner.sh script and for the below health check so we don't start stacks-miner services too quickly. + STACKS_2_05_HEIGHT: *STACKS_2_05_HEIGHT # This is used in the miner.sh script and for the below health check so we don't start stacks-miner services too quickly. networks: default: ipv4_address: *BITCOIN_MINER_IP @@ -236,8 +234,8 @@ services: - -c - /miner.sh healthcheck: - # since we're mining btc blocks to the (STACKS_2_05_HEIGHT -1), add healthcheck so stacks-miners do not try and create a descriptor wallet - # removing this healthcheck can create a race condition where the wallet may not be created, and the stacks-node will create it on startup (this will break the setup) + # Since we're mining btc blocks to the ((STACKS_2_05_HEIGHT-1)), add a healthcheck so stacks-miners do not try and create a descriptor wallet on startup + # **Note**: Removing this healthcheck can create a race condition where the wallet may not be created, and the stacks miner will create it on startup (this will break the setup) test: [ "CMD-SHELL", "bitcoin-cli -rpcwait -rpcconnect=bitcoin getblockhash $$((STACKS_2_05_HEIGHT - 1))" ] interval: 5s timeout: 1s @@ -278,7 +276,7 @@ services: <<: *stacks-node profiles: - default - stop_grace_period: 15s + stop_grace_period: 5s stop_signal: SIGTERM stacks-miner-2: @@ -309,7 +307,7 @@ services: <<: *stacks-node profiles: - default - stop_grace_period: 15s + stop_grace_period: 5s stop_signal: SIGTERM stacks-miner-3: @@ -340,7 +338,7 @@ services: <<: *stacks-node profiles: - default - stop_grace_period: 15s + stop_grace_period: 5s stop_signal: SIGTERM stacks-signer-1: @@ -405,8 +403,8 @@ services: retries: 3 profiles: - default - stop_grace_period: 5s + stop_signal: SIGTERM stacks-api: image: *IMAGE_STACKS_API @@ -438,6 +436,7 @@ services: profiles: - default stop_grace_period: 5s + stop_signal: SIGTERM # Stacker # ------------------ @@ -452,13 +451,13 @@ services: STACKING_CYCLES: *STACKING_CYCLES STACKING_KEYS: 41634762d89dfa09133a4a8e9c1378d0161d29cd0a9433b51f1e3d32947a73dc01,9bfecf16c9c12792589dd2b843f850d5b89b81a04f8ab91c083bdf6709fbefee01,3ec0ca5770a356d6cd1a9bfcbf6cd151eb1bd85c388cc00648ec4ef5853fdb7401 # STACKING_SLOT_DISTRO: 1,4,5 - STACKING_SLOT_DISTRO: 2,2,2 + STACKING_SLOT_DISTRO: 2,2,2 # Sets the stacking weight for the 3 stacking addresses. Default is evenly distributed across all 3 stackers STACKS_25_HEIGHT: *STACKS_25_HEIGHT STACKS_30_HEIGHT: *STACKS_30_HEIGHT POX_PREPARE_LENGTH: *POX_PREPARE_LENGTH POX_REWARD_LENGTH: *POX_REWARD_LENGTH - STACKING_INTERVAL: 2 # interval (seconds) for checking if stacking transactions are needed - POST_TX_WAIT: 10 # seconds to wait after a stacking transaction broadcast before continuing the loop + STACKING_INTERVAL: 2 # Interval (seconds) for checking if stacking transactions are needed + POST_TX_WAIT: 10 # Seconds to wait after a stacking transaction is broadcast before continuing the loop SERVICE_NAME: stacker profiles: - default @@ -488,31 +487,6 @@ services: profiles: - default - monitor: - build: stacker - container_name: monitor - depends_on: - - stacks-api - environment: - STACKS_CORE_RPC_HOST: stacks-api - STACKS_CORE_RPC_PORT: 3999 - STACKING_CYCLES: *STACKING_CYCLES - STACKING_KEYS: 41634762d89dfa09133a4a8e9c1378d0161d29cd0a9433b51f1e3d32947a73dc01,9bfecf16c9c12792589dd2b843f850d5b89b81a04f8ab91c083bdf6709fbefee01,3ec0ca5770a356d6cd1a9bfcbf6cd151eb1bd85c388cc00648ec4ef5853fdb7401 - STACKS_25_HEIGHT: *STACKS_25_HEIGHT - STACKS_30_HEIGHT: *STACKS_30_HEIGHT - POX_PREPARE_LENGTH: *POX_PREPARE_LENGTH - POX_REWARD_LENGTH: *POX_REWARD_LENGTH - EXIT_FROM_MONITOR: *EXIT_FROM_MONITOR - SERVICE_NAME: monitor - entrypoint: - - /bin/bash - - -c - - | - set -e - exec npx tsx /root/monitor.ts - profiles: - - default - networks: default: name: *DOCKER_NETWORK diff --git a/docker/stacker/stacking/monitor.ts b/docker/stacker/stacking/monitor.ts index 467aa37..43020ab 100644 --- a/docker/stacker/stacking/monitor.ts +++ b/docker/stacker/stacking/monitor.ts @@ -1,5 +1,5 @@ import { - accounts, + accountsApi, nodeUrl, waitForSetup, EPOCH_30_START, @@ -36,7 +36,7 @@ async function getTransactions(): Promise { } async function getInfo() { - let { client } = accounts[0]; + let { client } = accountsApi[0]; const [poxInfo, blockInfo, txs] = await Promise.all([ client.getPoxInfo(), blocksApi.getBlock({ From 1efa987cef7c1baf12d770e11efd83f0363be92e Mon Sep 17 00:00:00 2001 From: wileyj <2847772+wileyj@users.noreply.github.com> Date: Mon, 22 Sep 2025 14:14:27 -0700 Subject: [PATCH 3/9] Cleanup and logically order Makefile targets --- Makefile | 132 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 75 insertions(+), 57 deletions(-) diff --git a/Makefile b/Makefile index f22aa82..c3d28cd 100644 --- a/Makefile +++ b/Makefile @@ -1,9 +1,10 @@ +# List of binaries devent needs to function properly COMMANDS := sudo tar zstd getent stress $(foreach bin,$(COMMANDS),\ $(if $(shell command -v $(bin) 2> /dev/null),$(info),$(error Missing required dependency: `$(bin)`))) - TARGET := $(firstword $(MAKECMDGOALS)) PARAMS := $(filter-out $(TARGET),$(MAKECMDGOALS)) +# Hardcode the chainstate dir if we're booting from genesis ifeq ($(TARGET),up-genesis) export CHAINSTATE_DIR := $(PWD)/docker/chainstate/genesis endif @@ -11,8 +12,7 @@ ifeq ($(TARGET),genesis) export CHAINSTATE_DIR := $(PWD)/docker/chainstate/genesis endif - -## UID and GID are not currently used, but will be in the near future +# UID and GID are not currently used, but may be later to ensure consistent file permissions export UID := $(shell getent passwd $$(whoami) | cut -d":" -f 3) export GID := $(shell getent passwd $$(whoami) | cut -d":" -f 4) EPOCH := $(shell date +%s) @@ -23,6 +23,7 @@ CHAINSTATE_ARCHIVE ?= $(PWD)/docker/chainstate.tar.zstd export CHAINSTATE_DIR ?= $(PWD)/docker/chainstate/$(EPOCH) export DOCKER_NETWORK ?= stacks SERVICES := $(shell CHAINSTATE_DIR="" docker compose -f docker/docker-compose.yml --profile=default config --services) +# Pauses the bitcoin miner script. Default is set to nearly 1 trillion blocks PAUSE_HEIGHT ?= 999999999999 # Used for the stress testing target. modifies how much cpu to consume for how long STRESS_CORES ?= $(shell cat /proc/cpuinfo | grep processor | wc -l) @@ -43,7 +44,47 @@ $(CHAINSTATE_DIR): /usr/bin/tar /usr/bin/zstd fi fi -# Boot the network from the local chainstate archive + +# Build the images with a cache if present +build: check-not-running + COMPOSE_BAKE=true PWD=$(PWD) docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) build + +# Build the images without a cache (default uses cache) +build-no-cache: check-not-running + COMPOSE_BAKE=true PWD=$(PWD) docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) build --no-cache + +# Set env var of what the statically defined chainstate dir is +current-chainstate-dir: | check-running + $(eval ACTIVE_CHAINSTATE_DIR=$(shell cat .current-chainstate-dir)) + +# If the network is already running, we need to exit (ex: trying to start the network when it's already running) +check-not-running: + @if test `docker compose ls --filter name=$(PROJECT) -q`; then \ + echo ""; \ + echo "WARNING: Network appears to be running or was not properly shut down."; \ + echo "Current chainstate directory: $$(cat .current-chainstate-dir)"; \ + echo ""; \ + echo "To backup logs first: make backup-logs"; \ + echo "To shut down: make down"; \ + echo ""; \ + exit 1; \ + fi + +# If the network is not running, we need to exit (ex: trying to restart a container) +check-running: + @if test ! `docker compose ls --filter name=$(PROJECT) -q`; then \ + echo "Network not running. exiting"; \ + exit 1; \ + fi + +# For targets that need an arg, check that *something* is provided. it not, exit +check-params: | check-running + @if [ ! "$(PARAMS)" ]; then \ + echo "No service defined. Exiting"; \ + exit 1; \ + fi + +# Boot the network from a local chainstate archive up: check-not-running | build $(CHAINSTATE_DIR) @echo "Starting $(PROJECT) network from chainstate archive" @echo " Chainstate Dir: $(CHAINSTATE_DIR)" @@ -51,7 +92,8 @@ up: check-not-running | build $(CHAINSTATE_DIR) echo "$(CHAINSTATE_DIR)" > .current-chainstate-dir docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) up -d -# Run the network from genesis + +# Boot the network from genesis genesis: check-not-running | build $(CHAINSTATE_DIR) /usr/bin/sudo @echo "Starting $(PROJECT) network from genesis" @if [ -d "$(CHAINSTATE_DIR)" ]; then \ @@ -63,10 +105,8 @@ genesis: check-not-running | build $(CHAINSTATE_DIR) /usr/bin/sudo echo "$(CHAINSTATE_DIR)" > .current-chainstate-dir docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) up -d -# secondary name to run genesis network +# Secondary name to boot the genesis network up-genesis: genesis -# secondary name to bring down genesis network -down-genesis: down # Shut down the network (chainstate and logs will be preserved, but not logs) down: backup-logs current-chainstate-dir @@ -76,7 +116,11 @@ down: backup-logs current-chainstate-dir rm -f .current-chainstate-dir fi -# if the network is in a weird state - this target will force kill (bypassing error checks) + +# Secondary name to bring down the genesis network +down-genesis: down + +# If the network is in an unexpected state - this target will force kill (bypassing error checks) down-force: @echo "Force Shutting down $(PROJECT) network" docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) down @@ -84,23 +128,18 @@ down-force: rm -f .current-chainstate-dir fi -# Build the images with a cache if present -build: check-not-running - COMPOSE_BAKE=true PWD=$(PWD) docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) build - -# Build the images without a cache (default uses cache) -build-no-cache: check-not-running - COMPOSE_BAKE=true PWD=$(PWD) docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) build --no-cache # Stream specified service logs to STDOUT. does not validate if PARAMS is supplied log: current-chainstate-dir @echo "Logs for service $(PARAMS)" docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) logs -t --no-log-prefix $(PARAMS) -f + # Stream all services logs to STDOUT log-all: current-chainstate-dir docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) logs -t -f + # Backup all service logs to $ACTIVE_CHAINSTATE_DIR/logs/.log backup-logs: current-chainstate-dir /usr/bin/sudo @if [ -f .current-chainstate-dir ]; then \ @@ -118,11 +157,8 @@ backup-logs: current-chainstate-dir /usr/bin/sudo done; \ fi -# set env var of what the statically defined chainstate dir is -current-chainstate-dir: | check-running - $(eval ACTIVE_CHAINSTATE_DIR=$(shell cat .current-chainstate-dir)) -# replace the existing chainstate archive. will be used with target `up` +# Replace the existing chainstate archive. will be used with target `up` snapshot: current-chainstate-dir down @echo "Creating $(PROJECT) chainstate snapshot from $(ACTIVE_CHAINSTATE_DIR)" @if [ -d "$(ACTIVE_CHAINSTATE_DIR)/logs" ]; then \ @@ -132,17 +168,20 @@ snapshot: current-chainstate-dir down @echo "cd $(ACTIVE_CHAINSTATE_DIR); sudo tar --zstd -cf $(CHAINSTATE_ARCHIVE) *; cd $(PWD)" cd $(ACTIVE_CHAINSTATE_DIR); sudo tar --zstd -cf $(CHAINSTATE_ARCHIVE) *; cd $(PWD) -# pause all services in the network (netork is down, but recoverably with target 'unpause') + +# Pause all services in the network (netork is down, but recoverably with target 'unpause') pause: @echo "Pausing all services" docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) pause $(SERVICES) -# unpause all services in the network (only used after first using target 'pause') + +# Unpause all services in the network (only used after first using target 'pause') unpause: @echo "Unpausing all services" docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) unpause $(SERVICES) -# stop an individual service + +# Stop an individual service stop: check-params current-chainstate-dir | check-running @echo "Killing service $(PARAMS)" @echo " Chainstate Dir: $(ACTIVE_CHAINSTATE_DIR)" @@ -150,7 +189,8 @@ stop: check-params current-chainstate-dir | check-running @echo " Params: $(PARAMS)" CHAINSTATE_DIR=$(ACTIVE_CHAINSTATE_DIR) docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) down $(PARAMS) -# start an individual service + +# Start an individual service start: check-params current-chainstate-dir | check-running @echo "Resuming service $(PARAMS)" @echo " Chainstate Dir: $(ACTIVE_CHAINSTATE_DIR)" @@ -158,59 +198,37 @@ start: check-params current-chainstate-dir | check-running @echo " Params: $(PARAMS)" CHAINSTATE_DIR=$(ACTIVE_CHAINSTATE_DIR) docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) up -d $(PARAMS) -# restart a service with a defined servicename/duration. called script will validate PARAMS -# if no duration is provided, default of 30s shall be used + +# Restart a service with a defined servicename/duration - Script will validate PARAMS +# If no duration is provided, a default of 30s shall be used restart: check-params | check-running @echo "Restarting service" @echo " Params: $(PARAMS)" ./docker/tests/restart-container.sh $(PARAMS) -# use 'stress' binary to consume defined cpu over a specified time + +# Use 'stress' binary to consume defined cpu over a specified time stress: @echo "Stressing system CPU $(PARAMS)" @echo " Cores: $(STRESS_CORES)" @echo " Timeout: $(STRESS_TIMEOUT)" stress --cpu $(STRESS_CORES) --timeout $(STRESS_TIMEOUT) -# run the test script to verify the services are all load and operating as expected + +# Run the liveness script to verify the services are all loaded and operating as expected test: ./docker/tests/devnet-liveness.sh -# run the chain monitor script (loops and curls /v2/info, parsing the output to show current heights of miners) + +# Run the chain monitor script (loops and curls /v2/info, parsing the output to show current heights of miners) monitor: ./docker/tests/chain-monitor.sh -# if the network is already running, we need to exit (ex: trying to start the network when it's already running) -check-not-running: - @if test `docker compose ls --filter name=$(PROJECT) -q`; then \ - echo ""; \ - echo "WARNING: Network appears to be running or was not properly shut down."; \ - echo "Current chainstate directory: $$(cat .current-chainstate-dir)"; \ - echo ""; \ - echo "To backup logs first: make backup-logs"; \ - echo "To shut down: make down"; \ - echo ""; \ - exit 1; \ - fi - -# if the network is not running, we need to exit (ex: trying to restart a container) -check-running: - @if test ! `docker compose ls --filter name=$(PROJECT) -q`; then \ - echo "Network not running. exiting"; \ - exit 1; \ - fi - -# for targets that need an arg, check that *something* is provided. it not, exit -check-params: | check-running - @if [ ! "$(PARAMS)" ]; then \ - echo "No service defined. Exiting"; \ - exit 1; \ - fi -# force stop and remove any existing chainstates (leaving all docker images/layers) +# Force stop and remove any existing chainstates (leaving all docker images/layers) clean: down-force sudo rm -rf ./docker/chainstate/* -.PHONY: up genesis up-genesis down-genesis down down-force build build-no-cache log log-all backup-logs current-chainstate-dir snapshot pause unpause stop start restart stress test monitor check-not-running check-running check-params clean +.PHONY: build build-no-cache current-chainstate-dir check-not-running check-running check-params up genesis up-genesis down down-genesis down-force log log-all backup-logs snapshot pause unpause stop start restart stress test monitor clean .ONESHELL: all-in-one-shell From a2f6848305b0042e8b4f87207f9775f71af27673 Mon Sep 17 00:00:00 2001 From: wileyj <2847772+wileyj@users.noreply.github.com> Date: Mon, 22 Sep 2025 18:16:49 -0700 Subject: [PATCH 4/9] shellcheck for the miner.sh bitcoin mining script --- docker/bitcoin/miner.sh | 146 ++++++++++++++++++++++------------------ 1 file changed, 81 insertions(+), 65 deletions(-) diff --git a/docker/bitcoin/miner.sh b/docker/bitcoin/miner.sh index 200135f..ce2c591 100755 --- a/docker/bitcoin/miner.sh +++ b/docker/bitcoin/miner.sh @@ -1,29 +1,30 @@ +#!/bin/env bash + set -e trap "exit" INT TERM trap "kill 0" EXIT - -DEFAULT_TIMEOUT=$(($(date +%s) + 30)) ## set the default mining timeout to the current epoch +30s -DEFINED_ADDRESSES=$(compgen -A variable | grep "STACKS.*.BTC_ADDR") ## retrieve env vars matching STACKS*BTC_ADDRESS -DEFINED_WALLETS=$(compgen -A variable | grep "STACKS.*.BTC_WALLET") ## retrieve env vars matching STACKS*BTC_WALLET -mapfile -t ADDRESSES < <(printf '%s\n' "$DEFINED_ADDRESSES" | tr ' ' '\n') ## convert the compgen output to an array -mapfile -t WALLETS < <(printf '%s\n' "$DEFINED_WALLETS" | tr ' ' '\n') ## convert the compgen output to an array -NUM_MINERS=${#ADDRESSES[@]} ## use the same value for total miners throughout script -RESERVED_BLOCKS=100 ## during initial block mining, reserve 100 blocks to mine at the end so the earlier blocks have received rewards by the epoch 2.0 block +DEFAULT_TIMEOUT=$(($(date +%s) + 30)) # set the default mining timeout to the current epoch +30s +DEFINED_ADDRESSES=$(compgen -A variable | grep "STACKS.*.BTC_ADDR") # retrieve env vars matching STACKS*BTC_ADDRESS +DEFINED_WALLETS=$(compgen -A variable | grep "STACKS.*.BTC_WALLET") # retrieve env vars matching STACKS*BTC_WALLET +mapfile -t ADDRESSES < <(printf '%s\n' "$DEFINED_ADDRESSES" | tr ' ' '\n') # convert the compgen output to an array +mapfile -t WALLETS < <(printf '%s\n' "$DEFINED_WALLETS" | tr ' ' '\n') # convert the compgen output to an array +NUM_MINERS=${#ADDRESSES[@]} # use the same value for total miners throughout script +RESERVED_BLOCKS=100 # during initial block mining, reserve 100 blocks to mine at the end so the earlier blocks have received rewards by the epoch 2.0 block function get_height(){ - ## return the current block height, or -1 in case of error - echo $(bitcoin-cli -rpcconnect=bitcoin getblockcount 2>/dev/null || echo "-1") + # return the current block height, or -1 in case of error + bitcoin-cli -rpcconnect=bitcoin getblockcount 2>/dev/null || echo "-1" true } function get_mining_info(){ - ## canary check for getmininginfo if `chain` == `regtest`. else return a failure + # canary check for getmininginfo if `chain` == `regtest`. else return a failure local mining_info="" + local chain="" mining_info=$(bitcoin-cli -rpcconnect=bitcoin -rpcwait getmininginfo 2> /dev/null) - local ret="$?" - local chain=$(echo "${mining_info}" | awk '/chain/ { gsub(/[",]/,""); print $2}') + chain=$(echo "${mining_info}" | awk '/chain/ { gsub(/[",]/,""); print $2}') if [ "$chain" == "regtest" ];then return 0 fi @@ -31,16 +32,15 @@ function get_mining_info(){ } function get_wallet_info(){ - ## returns if a wallet exists - ## if wallet db exists, but wallet is not loaded: this will lead to failure of the script since the wallet cannot be created since it is on disk but not loaded in memory - ## note: the health check in the docker compose file should avoid this scenario, since stacks-miner services will wait until the epoch 2.05 block before starting + # returns if a wallet exists + # if wallet db exists, but wallet is not loaded: this will lead to failure of the script since the wallet cannot be created since it is on disk but not loaded in memory + # note: the health check in the docker compose file should avoid this scenario, since stacks-miner services will wait until the epoch 2.05 block before starting echo "[func] Get wallet info" local wallet=${1} echo " - checking for wallet (${wallet})" - local getwallet="" local ret="" - getwallet=$(bitcoin-cli -rpcconnect=bitcoin -rpcwait -rpcwallet=${wallet} getwalletinfo 2>&1 > /dev/null) # || return $? - local ret=$? + bitcoin-cli -rpcconnect=bitcoin -rpcwait -rpcwallet="${wallet}" getwalletinfo > /dev/null 2>&1 + ret="$?" if [ "$ret" -eq "0" ]; then echo " - successfully retrieved named wallet" true @@ -49,13 +49,13 @@ function get_wallet_info(){ } function create_wallet(){ - ## Create a named bitcoin wallet + # Create a named bitcoin wallet echo " [func] Create Wallet" local wallet=${1} local descriptors=${2:-false} local load_on_startup=${3:-true} echo " - Creating named wallet ${wallet} (desciptors: ${descriptors}, load_on_startup=${load_on_startup})" - local createwallet=$(bitcoin-cli -rpcconnect=bitcoin -named createwallet wallet_name=${wallet} descriptors=${descriptors} load_on_startup=${load_on_startup} 2>&1 > /dev/null) + bitcoin-cli -rpcconnect=bitcoin -named createwallet wallet_name="${wallet}" descriptors="${descriptors}" load_on_startup="${load_on_startup}" > /dev/null 2>&1 ret=$? if [ "$ret" -eq "0" ]; then echo " - successfully created named wallet (${wallet})" @@ -64,37 +64,39 @@ function create_wallet(){ } function get_address_info(){ - ## Check if a provided address was imported + # Check if a provided address was imported local wallet=${1} local address=${2} - local getaddressinfo="" + local getaddressinfo + local is_found echo " [func] Get address info" echo " - Checking (${wallet}) for address (${address})" - getaddressinfo=$(bitcoin-cli -rpcconnect=bitcoin -rpcwait -rpcwallet=${wallet} getaddressinfo ${address} 2> /dev/null) + getaddressinfo=$(bitcoin-cli -rpcconnect=bitcoin -rpcwait -rpcwallet="${wallet}" getaddressinfo "${address}" 2> /dev/null) local ret="$?" - local is_found=$(echo "${getaddressinfo}" | awk '/iswatchonly/ { gsub(/[",]/,""); print $2}') ## check if the address iswatchonly: true + is_found=$(echo "${getaddressinfo}" | awk '/iswatchonly/ { gsub(/[",]/,""); print $2}') # check if the address iswatchonly: true if [ "$is_found" == "true" ]; then echo " - Address ${address} already imported ($is_found)" else echo " - Address ${address} is not imported ($is_found)" - ret=1 # force a return since the above command *was* successful, just not the data we want + # force a non-zero return since the above command (is_found) *was* successful, just not the data we want + ret=1 fi return $ret } function mine_blocks(){ - ## Mine regtest blocks to a specified wallet address + # Mine regtest blocks to a specified wallet address echo "[func] Mine blocks" local wallet=${1} local address=${2} local blocks=${3} echo " - Mining ${blocks} blocks to address ${address} in wallet ${wallet}" - bitcoin-cli -rpcwallet=${wallet} -rpcconnect=bitcoin generatetoaddress ${blocks} ${address} 2>&1 > /dev/null || false + bitcoin-cli -rpcwallet="${wallet}" -rpcconnect=bitcoin generatetoaddress "${blocks}" "${address}" > /dev/null 2>&1 || false true } function import_address(){ - ## Import an addresss into a named wallet + # Import an addresss into a named wallet echo " [func] import_address" local wallet=${1} local address=${2} @@ -103,7 +105,7 @@ function import_address(){ echo " - address: $address" echo " - wallet: $wallet" echo " - Importing address ${btc_address} with label ${label} to wallet ${btc_wallet} (rescan: ${rescan})" - bitcoin-cli -rpcwallet=${btc_wallet} -rpcconnect=bitcoin importaddress ${btc_address} ${label} ${rescan} 2>&1 > /dev/null || false + bitcoin-cli -rpcwallet="${btc_wallet}" -rpcconnect=bitcoin importaddress "${btc_address}" "${label}" "${rescan}" > /dev/null 2>&1 || false true } @@ -113,36 +115,37 @@ function mining_loop(){ echo "**** Mining forever ****" echo "******************************************" echo - local mined_block_counter=0 ## set the counter before the loop starts - local block_height=$(get_height) ## get the block height + local mined_block_counter + local block_height + mined_block_counter=0 # set the counter before the loop starts + block_height=$(get_height) # get the block height while true; do echo "******************************************" local conf_counter=0 - local random_wallet="" local confs="" - local random="" ## for tracking which array element we're using + local random="" # for tracking which array element we're using local sleep_duration=${MINE_INTERVAL} - ## loop through addresses and see if there are any mining txs in the list + # loop through addresses and see if there are any mining txs in the list for i in $(seq 0 $((NUM_MINERS - 1)));do local btc_address=${!ADDRESSES[$i]} local btc_wallet=${!WALLETS[$i]} - confs=$(bitcoin-cli -rpcwallet=${btc_wallet} -rpcconnect=bitcoin listtransactions '*' 1 0 true | grep -oP '"confirmations": \K\d+' | awk '{print $1}' 2>/dev/null || echo "") + confs=$(bitcoin-cli -rpcwallet="${btc_wallet}" -rpcconnect=bitcoin listtransactions '*' 1 0 true | grep -oP '"confirmations": \K\d+' | awk '{print $1}' 2>/dev/null || echo "") conf_counter=$(( conf_counter + confs )) echo " - conf_counter: ${conf_counter}" done - if [ "${conf_counter}" = "0" ] || [ $(date +%s) -gt $DEFAULT_TIMEOUT ]; then - if [ $(date +%s) -gt $DEFAULT_TIMEOUT ]; then + if [ "${conf_counter}" = "0" ] || [ "$(date +%s)" -gt "$DEFAULT_TIMEOUT" ]; then + if [ "$(date +%s)" -gt "$DEFAULT_TIMEOUT" ]; then echo "Timed out waiting for a mempool tx, mining a btc block..." else echo "Detected Stacks mining mempool tx, mining btc block..." fi - random=$((0 + $RANDOM % NUM_MINERS )) # random int with a range based on how many miners are defined + random=$((0 + RANDOM % NUM_MINERS )) # random int with a range based on how many miners are defined. start from 0 since we're using an array echo "Mining block to:" echo " - wallet: ${!WALLETS[$random]}" echo " - address: ${!ADDRESSES[$random]}" - echo " - block hash: $(bitcoin-cli -rpcwallet=${!WALLETS[$random]} -rpcconnect=bitcoin generatetoaddress 1 "${!ADDRESSES[$random]}" | awk -F, 'NR==2{ gsub(/[",]/,"");gsub (" ", "", $0);print $1}')" + echo " - block hash: $(bitcoin-cli -rpcwallet="${!WALLETS[$random]}" -rpcconnect=bitcoin generatetoaddress 1 "${!ADDRESSES[$random]}" | awk -F, 'NR==2{ gsub(/[",]/,"");gsub (" ", "", $0);print $1}')" mined_block_counter=$((mined_block_counter + 1 )) # increment the mined block counter (used when restarting from a chainstate snapshot) - block_height=$((block_height + 1)) # increment the already retrieved block_height, incrementing in the loop + block_height=$((block_height + 1)) # increment the already retrieved block_height, incrementing in the loop DEFAULT_TIMEOUT=$(($(date +%s) + 30)) else echo "No Stacks mining tx detected" @@ -150,22 +153,22 @@ function mining_loop(){ if [ "${block_height}" -eq "${PAUSE_HEIGHT}" ]; then echo "At boundary ( ${PAUSE_HEIGHT} ) - sleeping for ${PAUSE_TIMER}" - sleep ${PAUSE_TIMER} + sleep "${PAUSE_TIMER}" # if we use the default snapshot, mine the next blocks quickly based on the counter position elif ! [[ "${CHAINSTATE_DIR}" =~ "genesis" ]] && [[ "${mined_block_counter}" -le "2" ]]; then echo "Network resumed. sleeping for 5s for next 2 mined blocks" sleep_duration=5 - elif [ "${block_height}" -gt $(( ${STACKS_30_HEIGHT} + 1 )) ]; then + elif [ "${block_height}" -gt $(( STACKS_30_HEIGHT + 1 )) ]; then echo "In Epoch3, sleeping for ${MINE_INTERVAL_EPOCH3} ... " sleep_duration=${MINE_INTERVAL_EPOCH3} - elif [ "${block_height}" -gt $(( ${STACKS_25_HEIGHT} + 1 )) ]; then + elif [ "${block_height}" -gt $(( STACKS_25_HEIGHT + 1 )) ]; then echo "In Epoch2.5, sleeping for ${MINE_INTERVAL_EPOCH25} ... " sleep_duration=${MINE_INTERVAL_EPOCH25} fi echo "Current btc height: ${block_height}" echo "total mined blocks: ${mined_block_counter}" echo "sleeping for ${sleep_duration}s" - sleep ${sleep_duration} & + sleep "${sleep_duration}" & wait || exit 0 done true @@ -178,11 +181,9 @@ function init(){ echo "Waiting indefinitely for a return from 'bitcoin-cli getmininginfo'" sleep 1 done - local mineable_blocks=$(( (STACKS_2_05_HEIGHT - 1) - RESERVED_BLOCKS )) # calculate the total number of blocks to allocate to the defined stacks-miner wallets local remainder_blocks=0 # set the initial remainder as zero before calculating if there is a modulus local mined_counter=0 # keep track of initial mined blocks - local address_count=0 # keep track of how many addresses have an initial balance blocks_per_miner=$(( mineable_blocks / NUM_MINERS )) # how many blocks per miner address remainder_blocks=$(( (STACKS_2_05_HEIGHT - 1) - (blocks_per_miner * NUM_MINERS + RESERVED_BLOCKS) )) # if there is a modulus, we need to mine them to the last miner address for i in $(seq 0 $((NUM_MINERS - 1)));do @@ -195,40 +196,54 @@ function init(){ if [ "$i" -eq $((NUM_MINERS - 1)) ];then blocks_per_miner=$((blocks_per_miner + remainder_blocks)) # this is the last miner address. add the modulus to the defined number of blocks for all miner fi - if ! get_wallet_info ${btc_wallet}; then ## Check if a wallet is loaded in memory - if ! create_wallet ${btc_wallet}; then ## Create a wallet if one is not loaded in memory (if not in memory, but on disk...this will break the script) + # Check if a wallet is loaded in memory + if ! get_wallet_info "${btc_wallet}"; then + # Create a wallet if one is not loaded in memory (if not in memory, but on disk...this will break the script) + if ! create_wallet "${btc_wallet}"; then echo "ERROR creating wallet (${btc_wallet})" - exit 1 ## Exit if wallet creation returns a failure + # Exit if wallet creation returns a failure + exit 1 fi fi - if ! get_address_info ${btc_wallet} ${btc_address}; then ## Check if a specified address is loaded in a specific wallet - if ! import_address ${btc_wallet} ${btc_address}; then ## Import an address into a wallet + # Check if a specified address is loaded in a specific wallet + if ! get_address_info "${btc_wallet}" "${btc_address}"; then + # Import an address into a wallet + if ! import_address "${btc_wallet}" "${btc_address}"; then echo "ERROR importing address (${btc_address}) into wallet (${btc_wallet})" - exit 1 ## Exit if address import returns a failure + # Exit if address import returns a failure + exit 1 fi fi - mine_blocks ${btc_wallet} ${btc_address} ${blocks_per_miner} ## mined the initial balance per address (102 blocks / number of miners) per address - mined_counter=$((mined_counter + blocks_per_miner)) ## keep track of how many blocks were mined in this stage + mine_blocks "${btc_wallet}" "${btc_address}" "${blocks_per_miner}" # mined the initial balance per address (102 blocks / number of miners) per address + mined_counter=$((mined_counter + blocks_per_miner)) # keep track of how many blocks were mined in this stage done echo "" echo "******************************************" - local depositor_blocks=$(((STACKS_2_05_HEIGHT - 1) - mined_counter)) ## this should be equal to reserved_blocks (100). this is needed for the stacks-miner wallet address to have mature rewards + local depositor_blocks=$(((STACKS_2_05_HEIGHT - 1) - mined_counter)) # this should be equal to reserved_blocks (100). this is needed for the stacks-miner wallet address to have mature rewards echo "btc_wallet: depositor" echo "btc_address: tbd" - if ! get_wallet_info depositor; then ## Check if depositor wallet is loaded in memory - if ! create_wallet depositor; then ## Create depositor wallet if one is not loaded in memory (if not in memory, but on disk...this will break the script) + local depositor_addr + # Check if depositor wallet is loaded in memory + if ! get_wallet_info depositor; then + # Create depositor wallet if one is not loaded in memory (if not in memory, but on disk...this will break the script) + if ! create_wallet depositor; then echo "Error creating depositor wallet" - exit 1 ## Exit if depositor wallet creation returns a failure + # Exit if depositor wallet creation returns a failure + exit 1 fi - local depositor_addr=$(bitcoin-cli -rpcwallet=depositor -rpcconnect=bitcoin getnewaddress label="" bech32) + depositor_addr=$(bitcoin-cli -rpcwallet=depositor -rpcconnect=bitcoin getnewaddress label="" bech32) fi - if ! get_address_info depositor ${depositor_addr}; then ## Check if depositor address is loaded in a specific wallet - if ! import_address depositor ${depositor_addr}; then ## Import depositor address into the depositor wallet + # Check if depositor address is loaded in a specific wallet + if ! get_address_info depositor "${depositor_addr}"; then + # Import depositor address into the depositor wallet + if ! import_address depositor "${depositor_addr}"; then echo "ERROR importing address (depositor) into wallet (${depositor_addr})" - exit 1 ## Exit if depositor address import returns a failure + # Exit if depositor address import returns a failure + exit 1 fi fi - mine_blocks "depositor" ${depositor_addr} ${depositor_blocks} ## mine blocks to the depositor address (should be 100 blocks so stacks-miner blocks are mature for epoch 2.0) + # mine blocks to the depositor address (should be 100 blocks so stacks-miner blocks are mature for epoch 2.0) + mine_blocks "depositor" "${depositor_addr}" "${depositor_blocks}" echo "" echo "******************************************" echo "Mined ${mined_counter} btc to (${NUM_MINERS}) stacks-miner wallets" @@ -237,7 +252,8 @@ function init(){ true } -if [ $(get_height) -eq "0" ]; then ## if the btc height is > 0, we don't need to create the wallets or import address. assume they already exist. +# if the btc height is > 0, we don't need to create the wallets or import address. assume they already exist. +if [ "$(get_height)" -eq "0" ]; then init else echo "Skipping genesis functions" From f2e1a972f06f199386126ba80d910d0553e94259 Mon Sep 17 00:00:00 2001 From: wileyj <2847772+wileyj@users.noreply.github.com> Date: Tue, 23 Sep 2025 07:28:11 -0700 Subject: [PATCH 5/9] Apply suggestions from code review Co-authored-by: Radu Bahmata <92028479+BowTiedRadone@users.noreply.github.com> --- Makefile | 13 ++++++------- docker/bitcoin/miner.sh | 2 +- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/Makefile b/Makefile index c3d28cd..9a74c9b 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -# List of binaries devent needs to function properly +# List of binaries devnet needs to function properly COMMANDS := sudo tar zstd getent stress $(foreach bin,$(COMMANDS),\ $(if $(shell command -v $(bin) 2> /dev/null),$(info),$(error Missing required dependency: `$(bin)`))) @@ -64,7 +64,6 @@ check-not-running: echo "WARNING: Network appears to be running or was not properly shut down."; \ echo "Current chainstate directory: $$(cat .current-chainstate-dir)"; \ echo ""; \ - echo "To backup logs first: make backup-logs"; \ echo "To shut down: make down"; \ echo ""; \ exit 1; \ @@ -108,7 +107,7 @@ genesis: check-not-running | build $(CHAINSTATE_DIR) /usr/bin/sudo # Secondary name to boot the genesis network up-genesis: genesis -# Shut down the network (chainstate and logs will be preserved, but not logs) +# Shut down the network (chainstate and logs will be preserved) down: backup-logs current-chainstate-dir @echo "Shutting down $(PROJECT) network" docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) down @@ -129,7 +128,7 @@ down-force: fi -# Stream specified service logs to STDOUT. does not validate if PARAMS is supplied +# Stream specified service logs to STDOUT. Does not validate if PARAMS is supplied log: current-chainstate-dir @echo "Logs for service $(PARAMS)" docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) logs -t --no-log-prefix $(PARAMS) -f @@ -158,7 +157,7 @@ backup-logs: current-chainstate-dir /usr/bin/sudo fi -# Replace the existing chainstate archive. will be used with target `up` +# Replace the existing chainstate archive. Will be used with target `up` snapshot: current-chainstate-dir down @echo "Creating $(PROJECT) chainstate snapshot from $(ACTIVE_CHAINSTATE_DIR)" @if [ -d "$(ACTIVE_CHAINSTATE_DIR)/logs" ]; then \ @@ -169,7 +168,7 @@ snapshot: current-chainstate-dir down cd $(ACTIVE_CHAINSTATE_DIR); sudo tar --zstd -cf $(CHAINSTATE_ARCHIVE) *; cd $(PWD) -# Pause all services in the network (netork is down, but recoverably with target 'unpause') +# Pause all services in the network (netork is down, but recoverably with target 'unpause') pause: @echo "Pausing all services" docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) pause $(SERVICES) @@ -199,7 +198,7 @@ start: check-params current-chainstate-dir | check-running CHAINSTATE_DIR=$(ACTIVE_CHAINSTATE_DIR) docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) up -d $(PARAMS) -# Restart a service with a defined servicename/duration - Script will validate PARAMS +# Restart a service with a defined servicename/duration - the script will validate PARAMS # If no duration is provided, a default of 30s shall be used restart: check-params | check-running @echo "Restarting service" diff --git a/docker/bitcoin/miner.sh b/docker/bitcoin/miner.sh index ce2c591..5b41156 100755 --- a/docker/bitcoin/miner.sh +++ b/docker/bitcoin/miner.sh @@ -210,7 +210,7 @@ function init(){ # Import an address into a wallet if ! import_address "${btc_wallet}" "${btc_address}"; then echo "ERROR importing address (${btc_address}) into wallet (${btc_wallet})" - # Exit if address import returns a failure + # Exit if address import returns a failure exit 1 fi fi From fb0f9dd7d3efafc5afebe8e82a81c1aabc823ff9 Mon Sep 17 00:00:00 2001 From: wileyj <2847772+wileyj@users.noreply.github.com> Date: Tue, 23 Sep 2025 08:29:31 -0700 Subject: [PATCH 6/9] remove monitor service --- docker/stacker/Dockerfile | 2 +- docker/stacker/stacking/monitor-ext.sh | 11 -- docker/stacker/stacking/monitor.ts | 236 ------------------------- 3 files changed, 1 insertion(+), 248 deletions(-) delete mode 100644 docker/stacker/stacking/monitor-ext.sh delete mode 100644 docker/stacker/stacking/monitor.ts diff --git a/docker/stacker/Dockerfile b/docker/stacker/Dockerfile index 7ea877e..49a7edd 100644 --- a/docker/stacker/Dockerfile +++ b/docker/stacker/Dockerfile @@ -6,6 +6,6 @@ WORKDIR /root COPY ./stacking/package.json /root/ RUN npm i -COPY ./stacking/stacking.ts ./stacking/common.ts ./stacking/monitor.ts ./stacking/tx-broadcaster.ts /root/ +COPY ./stacking/stacking.ts ./stacking/common.ts ./stacking/tx-broadcaster.ts /root/ CMD ["npx", "tsx", "/root/stacking.ts"] diff --git a/docker/stacker/stacking/monitor-ext.sh b/docker/stacker/stacking/monitor-ext.sh deleted file mode 100644 index e5d1cf0..0000000 --- a/docker/stacker/stacking/monitor-ext.sh +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env bash - -export STACKS_CORE_RPC_HOST=$1 -export STACKS_CORE_RPC_PORT=20443 -export STACKS_30_HEIGHT=232 -export STACKS_25_HEIGHT=209 -export STACKING_KEYS="41634762d89dfa09133a4a8e9c1378d0161d29cd0a9433b51f1e3d32947a73dc01,9bfecf16c9c12792589dd2b843f850d5b89b81a04f8ab91c083bdf6709fbefee01,3ec0ca5770a356d6cd1a9bfcbf6cd151eb1bd85c388cc00648ec4ef5853fdb7401" -# export STACKS_LOG_JSON=1 -export SERVICE_NAME=monitor - -npx tsx monitor.ts diff --git a/docker/stacker/stacking/monitor.ts b/docker/stacker/stacking/monitor.ts deleted file mode 100644 index 43020ab..0000000 --- a/docker/stacker/stacking/monitor.ts +++ /dev/null @@ -1,236 +0,0 @@ -import { - accountsApi, - nodeUrl, - waitForSetup, - EPOCH_30_START, - didCrossPreparePhase, - blocksApi, - parseEnvInt, - txApi, - logger, -} from './common'; -import { Transaction, ContractCallTransaction } from '@stacks/stacks-blockchain-api-types'; - -let lastBurnHeight = 0; -let lastStxHeight = 0; -let lastRewardCycle = 0; -let lastStxBlockTime = new Date().getTime(); -let lastStxBlockDiff = 0; -let lastBlockWarnTime = 0; - -logger.info('Starting monitor script...'); - -const EXIT_FROM_MONITOR = process.env.EXIT_FROM_MONITOR === '1'; -const monitorInterval = parseEnvInt('MONITOR_INTERVAL') ?? 2; - -logger.debug('Exit from monitor?', EXIT_FROM_MONITOR); - -async function getTransactions(): Promise { - let res = await txApi.getTransactionsByBlock({ - heightOrHash: 'latest', - }); - let txs = res.results as Transaction[]; - return txs.filter(tx => { - return tx.tx_type === 'contract_call'; - }) as ContractCallTransaction[]; -} - -async function getInfo() { - let { client } = accountsApi[0]; - const [poxInfo, blockInfo, txs] = await Promise.all([ - client.getPoxInfo(), - blocksApi.getBlock({ - heightOrHash: 'latest', - }), - getTransactions(), - ]); - const { reward_cycle_id } = poxInfo; - return { - poxInfo, - blockInfo, - nextCycleId: reward_cycle_id + 1, - txs, - }; -} - -type StackerSet = { - stacker_set: { - signers: { - signer_key: string; - }[]; - }; -}; - -async function getSignerSet(cycle: number) { - const url = `${nodeUrl}/v2/stacker_set/${cycle}`; - try { - const res = await fetch(url); - if (!res.ok) { - return null; - } - const data = (await res.json()) as StackerSet; - return data; - } catch (error) { - return null; - } -} - -async function loop() { - try { - const { poxInfo, blockInfo, ...info } = await getInfo(); - let { reward_cycle_id, current_burnchain_block_height } = poxInfo; - let { height } = blockInfo; - let showBurnMsg = false; - let showPrepareMsg = false; - let showCycleMsg = false; - let showStxBlockMsg = false; - let burnHeightDate = new Date(blockInfo.burn_block_time * 1000); - let burnHeightTimeAgo = (new Date().getTime() - burnHeightDate.getTime()) / 1000; - const loopLog = logger.child({ - height, - burnHeight: current_burnchain_block_height, - // burnHeightTime: - cycle: reward_cycle_id, - txCount: blockInfo.tx_count, - rewardCycle: reward_cycle_id, - lastBurnBlock: `${burnHeightTimeAgo.toFixed(0)}s ago`, - burnHash: blockInfo.burn_block_hash, - }); - - if (current_burnchain_block_height && current_burnchain_block_height !== lastBurnHeight) { - if (didCrossPreparePhase(lastBurnHeight, current_burnchain_block_height)) { - showPrepareMsg = true; - } - showBurnMsg = true; - lastBurnHeight = current_burnchain_block_height; - } - - if (reward_cycle_id !== lastRewardCycle) { - showCycleMsg = true; - lastRewardCycle = reward_cycle_id; - } - - const now = new Date().getTime(); - lastStxBlockDiff = now - lastStxBlockTime; - - if (height !== lastStxHeight) { - showStxBlockMsg = true; - lastStxHeight = height; - lastStxBlockTime = now; - lastBlockWarnTime = now; - } - - // how many ms to warn about no stx blocks - const blockWarnInterval = 60 * 1000; - const lastWarnDiff = now - lastBlockWarnTime; - // if no stx block in a minute - if (lastStxBlockDiff > blockWarnInterval && lastWarnDiff > blockWarnInterval) { - // const diff = new Date().getTime() - lastStxBlockTime; - const lastSeen = new Date(lastStxBlockTime).toISOString(); - const minSinceStxBlock = (lastStxBlockDiff / (1000 * 60)).toFixed(2); - lastBlockWarnTime = now; - loopLog.warn( - { - lastSeen, - secSinceStxBlock: lastStxBlockDiff / 1000, - minSinceStxBlock, - lastStxBlockTime, - }, - `No new stx block since ${minSinceStxBlock} minutes ago` - ); - } - - if (showBurnMsg) { - loopLog.info('New burn block'); - if (current_burnchain_block_height === EPOCH_30_START) { - loopLog.info('Starting Nakamoto'); - } - } - if (showPrepareMsg) { - loopLog.info( - { - nextRewardCycle: reward_cycle_id + 1, - }, - 'Prepare phase started' - ); - const nextSigners = await getSignerSet(reward_cycle_id + 1); - if (nextSigners) { - loopLog.info( - { - nextSigners: nextSigners.stacker_set.signers.length, - }, - `Next cycle (${reward_cycle_id + 1}) has ${ - nextSigners.stacker_set.signers.length - } signers` - ); - } - } - - if (!showBurnMsg && showStxBlockMsg && blockInfo.burn_block_height >= EPOCH_30_START) { - loopLog.info({ lastStxBlockDiff: lastStxBlockDiff / 1000 }, 'Nakamoto block'); - } - if (showStxBlockMsg && info.txs.length > 0) { - info.txs.forEach(({ contract_call, sender_address, tx_status, ...tx }) => { - if (contract_call.contract_id.includes('flood')) { - return; - } - loopLog.info( - { - sender_address, - contract_call: contract_call.function_name, - tx_status, - tx_result: tx.tx_result.repr, - tx_id: tx.tx_id, - }, - 'New transaction confirmed' - ); - }); - } - - if (showCycleMsg) { - const currentSigners = await getSignerSet(reward_cycle_id); - const signerCount = currentSigners?.stacker_set.signers.length ?? 0; - loopLog.info( - { signerCount }, - `New cycle started (${reward_cycle_id}) with ${signerCount} signers` - ); - } - - if (reward_cycle_id >= EPOCH_30_START && !poxInfo.reward_slots) { - logger.error('FATAL: no signers while going in to Epoch 3.0'); - exit(); - } - } catch (error) { - let message = 'Caught error in monitor run loop'; - if (error instanceof Error) { - message += `: ${error.message}`; - } else { - console.error(error); - } - logger.error(message); - } -} - -function exit() { - if (EXIT_FROM_MONITOR) { - logger.info('Exiting...'); - process.exit(1); - } -} - -async function runLoop() { - await loop(); - setTimeout(runLoop, monitorInterval * 1000); -} - -async function run() { - await waitForSetup(); - await runLoop(); -} -process.on('SIGTERM', () => { - process.exit(0); -}); -process.on('SIGINT', () => { - process.exit(0); -}); -run(); From 5288762b22e5e3be0d0b4f67200e68e7ea0b0398 Mon Sep 17 00:00:00 2001 From: wileyj <2847772+wileyj@users.noreply.github.com> Date: Tue, 23 Sep 2025 09:20:10 -0700 Subject: [PATCH 7/9] Remove extra line breaks between targets --- Makefile | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/Makefile b/Makefile index 9a74c9b..fddcc10 100644 --- a/Makefile +++ b/Makefile @@ -44,7 +44,6 @@ $(CHAINSTATE_DIR): /usr/bin/tar /usr/bin/zstd fi fi - # Build the images with a cache if present build: check-not-running COMPOSE_BAKE=true PWD=$(PWD) docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) build @@ -91,7 +90,6 @@ up: check-not-running | build $(CHAINSTATE_DIR) echo "$(CHAINSTATE_DIR)" > .current-chainstate-dir docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) up -d - # Boot the network from genesis genesis: check-not-running | build $(CHAINSTATE_DIR) /usr/bin/sudo @echo "Starting $(PROJECT) network from genesis" @@ -115,7 +113,6 @@ down: backup-logs current-chainstate-dir rm -f .current-chainstate-dir fi - # Secondary name to bring down the genesis network down-genesis: down @@ -127,18 +124,15 @@ down-force: rm -f .current-chainstate-dir fi - # Stream specified service logs to STDOUT. Does not validate if PARAMS is supplied log: current-chainstate-dir @echo "Logs for service $(PARAMS)" docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) logs -t --no-log-prefix $(PARAMS) -f - # Stream all services logs to STDOUT log-all: current-chainstate-dir docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) logs -t -f - # Backup all service logs to $ACTIVE_CHAINSTATE_DIR/logs/.log backup-logs: current-chainstate-dir /usr/bin/sudo @if [ -f .current-chainstate-dir ]; then \ @@ -156,7 +150,6 @@ backup-logs: current-chainstate-dir /usr/bin/sudo done; \ fi - # Replace the existing chainstate archive. Will be used with target `up` snapshot: current-chainstate-dir down @echo "Creating $(PROJECT) chainstate snapshot from $(ACTIVE_CHAINSTATE_DIR)" @@ -167,19 +160,16 @@ snapshot: current-chainstate-dir down @echo "cd $(ACTIVE_CHAINSTATE_DIR); sudo tar --zstd -cf $(CHAINSTATE_ARCHIVE) *; cd $(PWD)" cd $(ACTIVE_CHAINSTATE_DIR); sudo tar --zstd -cf $(CHAINSTATE_ARCHIVE) *; cd $(PWD) - # Pause all services in the network (netork is down, but recoverably with target 'unpause') pause: @echo "Pausing all services" docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) pause $(SERVICES) - # Unpause all services in the network (only used after first using target 'pause') unpause: @echo "Unpausing all services" docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) unpause $(SERVICES) - # Stop an individual service stop: check-params current-chainstate-dir | check-running @echo "Killing service $(PARAMS)" @@ -188,7 +178,6 @@ stop: check-params current-chainstate-dir | check-running @echo " Params: $(PARAMS)" CHAINSTATE_DIR=$(ACTIVE_CHAINSTATE_DIR) docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) down $(PARAMS) - # Start an individual service start: check-params current-chainstate-dir | check-running @echo "Resuming service $(PARAMS)" @@ -197,7 +186,6 @@ start: check-params current-chainstate-dir | check-running @echo " Params: $(PARAMS)" CHAINSTATE_DIR=$(ACTIVE_CHAINSTATE_DIR) docker compose -f docker/docker-compose.yml --profile default -p $(PROJECT) up -d $(PARAMS) - # Restart a service with a defined servicename/duration - the script will validate PARAMS # If no duration is provided, a default of 30s shall be used restart: check-params | check-running @@ -205,7 +193,6 @@ restart: check-params | check-running @echo " Params: $(PARAMS)" ./docker/tests/restart-container.sh $(PARAMS) - # Use 'stress' binary to consume defined cpu over a specified time stress: @echo "Stressing system CPU $(PARAMS)" @@ -213,21 +200,17 @@ stress: @echo " Timeout: $(STRESS_TIMEOUT)" stress --cpu $(STRESS_CORES) --timeout $(STRESS_TIMEOUT) - # Run the liveness script to verify the services are all loaded and operating as expected test: ./docker/tests/devnet-liveness.sh - # Run the chain monitor script (loops and curls /v2/info, parsing the output to show current heights of miners) monitor: ./docker/tests/chain-monitor.sh - # Force stop and remove any existing chainstates (leaving all docker images/layers) clean: down-force sudo rm -rf ./docker/chainstate/* - .PHONY: build build-no-cache current-chainstate-dir check-not-running check-running check-params up genesis up-genesis down down-genesis down-force log log-all backup-logs snapshot pause unpause stop start restart stress test monitor clean .ONESHELL: all-in-one-shell From ec9022c492e6b133c092a15b485845a7c0f98271 Mon Sep 17 00:00:00 2001 From: wileyj <2847772+wileyj@users.noreply.github.com> Date: Tue, 23 Sep 2025 09:30:26 -0700 Subject: [PATCH 8/9] reorder readme so the quickstart actually quickstarts --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index 4dbaba8..d36eb0d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,4 @@ # Devnet -Modified from: https://github.com/stacks-sbtc/sbtc/tree/v1.0.2/docker, changes: - -- Deleted services related to sBTC, mempool and grafana - Configured for 3 stacks miners and signers - bind-mounts a local filesystem for data persistence - Uses a chainstate archive to boot the network quickly @@ -33,11 +30,11 @@ make genesis ``` ### Stop the network -*note*: `down-genesis` target calls `down` ```sh make down ``` +## Full list of options ### Logs `docker logs -f ` will work, along with some defined Makefile targets From 01c1551b0ede865a5240d724eb0fc9ce38281420 Mon Sep 17 00:00:00 2001 From: BowTiedRadone Date: Tue, 23 Sep 2025 20:16:35 +0300 Subject: [PATCH 9/9] Cleanup stacking script --- docker/stacker/stacking/flood.ts | 2 - docker/stacker/stacking/stacking.ts | 93 +++++++---------------------- 2 files changed, 20 insertions(+), 75 deletions(-) diff --git a/docker/stacker/stacking/flood.ts b/docker/stacker/stacking/flood.ts index c2fc5aa..dd7a5c5 100644 --- a/docker/stacker/stacking/flood.ts +++ b/docker/stacker/stacking/flood.ts @@ -4,13 +4,11 @@ import { TransactionVersion, getAddressFromPrivateKey, getNonce, - makeSTXTokenTransfer, broadcastTransaction, makeRandomPrivKey, StacksTransaction, makeContractDeploy, makeContractCall, - tupleCV, uintCV, AnchorMode, PostConditionMode, diff --git a/docker/stacker/stacking/stacking.ts b/docker/stacker/stacking/stacking.ts index d8171af..5a91606 100644 --- a/docker/stacker/stacking/stacking.ts +++ b/docker/stacker/stacking/stacking.ts @@ -15,9 +15,6 @@ const stackingInterval = parseEnvInt('STACKING_INTERVAL', true); const postTxWait = parseEnvInt('POST_TX_WAIT', true); const stackingCycles = parseEnvInt('STACKING_CYCLES', true); -// TODO: Decide multiplier value. This is used to bump the threshold to avoid -// getting stuck if the threshold increases slightly after the first stacker -// stacks. const SLOT_MULTIPLIER = 1.1; const DEFAULT_NUM_SLOTS = 2; @@ -58,7 +55,7 @@ function getFixedStackingAmount( } // Use the threshold at the time this target cycle was first encountered. - // Bump by multiplier% to avoid getting stuck if threshold increases slightly + // Bump by multiplier to avoid getting stuck if threshold increases slightly // over time. const fixedAmount = BigInt(Math.floor(currentThreshold * multiplier)); cycleStackingAmounts.set(targetRewardCycle, fixedAmount); @@ -80,7 +77,6 @@ async function run(stackingKeys: string[], stackingSlotDistribution: number[]) { const accounts = getAccounts(stackingKeys, stackingSlotDistribution); const poxInfo = await accounts[0].client.getPoxInfo(); if (!poxInfo.contract_id.endsWith('.pox-4')) { - // console.log(`Pox contract is not .pox-4, skipping stacking (contract=${poxInfo.contract_id})`); logger.info( { poxContract: poxInfo.contract_id, @@ -106,7 +102,8 @@ async function run(stackingKeys: string[], stackingSlotDistribution: number[]) { let txSubmitted = false; - // Bump min threshold by 50% to avoid getting stuck if threshold increases + // Bump min threshold by SLOT_MULTIPLIER to avoid getting stuck if threshold + // increases. const minStx = Math.floor(poxInfo.next_cycle.min_threshold_ustx * SLOT_MULTIPLIER); const nextCycleStx = poxInfo.next_cycle.stacked_ustx; if (nextCycleStx < minStx) { @@ -172,17 +169,12 @@ async function stackStx(poxInfo: PoxInfo, account: Account, balance: bigint) { poxInfo.next_cycle.min_threshold_ustx ); - // Calculate total amount needed based on target slots and fixed base amount + // Calculate total amount needed based on target slots and fixed base amount. const amountToStack = baseStackingAmount * BigInt(account.targetSlots); - // Compare with current threshold + // Compare with current threshold. const currentThreshold = poxInfo.next_cycle.min_threshold_ustx; const adjustedThreshold = Math.floor(currentThreshold * SLOT_MULTIPLIER); - const meetsCurrentThreshold = amountToStack >= BigInt(adjustedThreshold); - const thresholdRatio = Number(amountToStack) / adjustedThreshold; - - // // Ensure we don't exceed the stacker's balance - // const finalAmount = amountToStack > balance ? balance : amountToStack; if (balance < baseStackingAmount) { throw new Error( @@ -222,14 +214,18 @@ async function stackStx(poxInfo: PoxInfo, account: Account, balance: bigint) { { ...stackingArgs, ...sigArgs, - // TODO: Decide what extra data to log. Choose from below. - // baseStackingAmount: baseStackingAmount.toString(), - // targetSlots: account.targetSlots, - // amountToStack: amountToStack.toString(), - // currentThreshold, - // adjustedThreshold, - // meetsCurrentThreshold, - // thresholdRatio, + // The total amount to stack. + stackedAmount: amountToStack.toString(), + // The fixed amount per slot for the target reward cycle. + baseStackingAmount: baseStackingAmount.toString(), + // How many slots the account is targeting to stack. Will stack this + // amount multiplied by a constant multiplier to avoid getting locked out + // if the threshold increases. + targetSlots: account.targetSlots, + // The current minimum threshold for the cycle. + currentThreshold, + // The threshold after applying the multiplier. + adjustedThreshold, }, `Stack-stx with args:` ); @@ -237,20 +233,8 @@ async function stackStx(poxInfo: PoxInfo, account: Account, balance: bigint) { account.logger.info( { ...stackResult, - // TODO: Decide what extra data to log. Choose from below. - // stackedAmount: amountToStack.toString(), - // stackedAmountMicroStx: amountToStack, - // baseStackingAmount: baseStackingAmount.toString(), - // targetSlots: account.targetSlots, - // account: account.index, - // currentThreshold, - // adjustedThreshold, - // meetsCurrentThreshold, - // thresholdRatio, }, - `STACKED: ${amountToStack.toString()} micro-STX (account ${account.index}, ${ - account.targetSlots - } slots, meets threshold: ${meetsCurrentThreshold}, tx: ${stackResult.txid})` + `Stack-stx tx result` ); } @@ -258,38 +242,6 @@ async function stackExtend( poxInfo: PoxInfo, account: Account & { lockedAmount: bigint; balance: bigint } ) { - // Get the current locked amount from account info to show what's being extended - const currentLockedAmount = account.lockedAmount; - const currentThreshold = poxInfo.next_cycle.min_threshold_ustx; - const adjustedThreshold = Math.floor(currentThreshold * SLOT_MULTIPLIER); - - // Check if current locked amount still meets the threshold - const meetsThreshold = currentLockedAmount >= BigInt(adjustedThreshold); - - // TODO: Used for debugging. Decide to keep or not. Can be useful to see the - // amount that would be extended, and more importantly if it still meets - // the threshold. - - // const baseStackingAmount = getFixedStackingAmount(poxInfo.reward_cycle_id, currentThreshold); - // const expectedAmountForSlots = baseStackingAmount * BigInt(account.targetSlots); - - // account.logger.info( - // { - // account: account.index, - // currentLockedAmount: currentLockedAmount.toString(), - // currentThreshold, - // adjustedThreshold, - // baseStackingAmount: baseStackingAmount.toString(), - // expectedAmountForSlots: expectedAmountForSlots.toString(), - // targetSlots: account.targetSlots, - // meetsThreshold, - // thresholdRatio: Number(currentLockedAmount) / adjustedThreshold, - // }, - // `🔄 EXTENDING: ${currentLockedAmount.toString()} micro-STX for ${stackingCycles} cycles (account ${ - // account.index - // }, meets threshold: ${meetsThreshold})` - // ); - const authId = randInt(); const sigArgs = { topic: Pox4SignatureTopic.StackExtend, @@ -325,14 +277,9 @@ async function stackExtend( { stxAddress: account.stxAddress, account: account.index, - // TODO: Decide what extra data to log. Choose from below. - // extendedAmountMicroStx: currentLockedAmount, - // meetsThreshold, ...stackResult, - } - // `EXTENDED: ${currentLockedAmount.toString()} micro-STX for ${stackingCycles} cycles (account ${ - // account.index - // }, tx: ${stackResult.txid})` + }, + `Stack-extend tx result` ); }