diff --git a/.forgejo/workflows/gitleaks.yml b/.forgejo/workflows/gitleaks.yml deleted file mode 100644 index 59d79b2..0000000 --- a/.forgejo/workflows/gitleaks.yml +++ /dev/null @@ -1,31 +0,0 @@ -# Gitleaks secret-scanning workflow. -# -# Scans the full git history on every push and pull request and fails -# the job if a credential-shaped string is detected. - -name: gitleaks - -on: - push: - pull_request: - -jobs: - scan: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - with: - # Full history — gitleaks needs depth to scan a commit range. - fetch-depth: 0 - - - name: install gitleaks - run: | - curl -sSL -o gl.tar.gz \ - https://github.com/gitleaks/gitleaks/releases/download/v8.21.2/gitleaks_8.21.2_linux_x64.tar.gz - tar xzf gl.tar.gz gitleaks - chmod +x gitleaks - ./gitleaks version - - - name: scan - run: | - ./gitleaks detect --source . --no-banner --redact --verbose diff --git a/LICENSE b/LICENSE index be3f7b2..34c43df 100644 --- a/LICENSE +++ b/LICENSE @@ -1,661 +1,201 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 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 Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU Affero General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU AGPL, see -. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for describing the origin of the Work and + reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Support. While redistributing the Work or + Derivative Works thereof, You may choose to offer, and charge a + fee for, acceptance of support, warranty, indemnity, or other + liability obligations and/or rights consistent with this License. + However, in accepting such obligations, You may act only on Your + own behalf and on Your sole responsibility, not on behalf of any + other Contributor, and only if You agree to indemnify, defend, + and hold each Contributor harmless for any liability incurred by, + or claims asserted against, such Contributor by reason of your + accepting any such warranty or support. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2026 Sulkta Coop + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied. See the License for the specific language governing + permissions and limitations under the License. diff --git a/README.md b/README.md index e123d21..0166ba2 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,35 @@ # cardano-checkout -Merchant-side Cardano payment lifecycle for Python. Zero-custody. +Merchant-side Cardano payment lifecycle in Python. Zero-custody by design. -`cardano-checkout` ships the invoice state machine, an on-chain UTxO -watcher, and a quote-reprice loop for accepting ADA payments at -per-invoice, HD-derived receive addresses. It polls [Koios](https://koios.rest) -for payment, classifies each invoice as confirmed / underpaid / overpaid -within a tolerance, and reprices expired quotes against a price oracle you -supply. +**What we ship:** the invoice state machine + UTxO watcher + reprice +loop. Per-invoice HD-derived receive addresses, Koios polling, confirm +/ underpay / overpay classification, time-windowed repricing against +your own oracle. -It does **not** reimplement Cardano primitives. Address derivation, chain -context, transaction building, native-script minting, and signing are all -[pycardano](https://github.com/Python-Cardano/pycardano)'s job — this -library slots in next to it and owns only the merchant payment lifecycle. +**What we don't ship:** Cardano primitives. Address derivation, chain +context, transaction building, native-script minting, signing — those +are all [pycardano](https://github.com/Python-Cardano/pycardano)'s job. +pycardano is mature, actively maintained (0.19.x as of 2026), and +covers every primitive cleanly. This library slots next to it — no +wrapping, no leaky abstraction, no second API to learn. -## Why +## Why this exists -Accepting on-chain payments for a shop is mostly bookkeeping, not -cryptography: +Nothing else in the Python ecosystem (or any ecosystem — we checked) +packages zero-custody merchant Cardano payments as a reusable library. +Closest adjacents are all one of: -- one fresh receive address per order (derived from your wallet xpub), -- watch the chain until the expected amount lands, -- decide confirmed / underpaid / overpaid within a tolerance, -- if the quote window lapses before payment, reprice and try again. +- CIP-30 browser-wallet plugins (customer-signs, not server-watches) +- cardano-cli vending machines that watch a single static address (no + xpub, no per-invoice derivation) +- SaaS APIs (NMKR) — not libraries +- Dormant / pre-1.0 grabs from the 2021-2023 era -`cardano-checkout` is that bookkeeping, behind small consumer-supplied -interfaces — a persistence `Protocol` and a pricing callable — so it drops -into any stack: SQLAlchemy, asyncpg, SQLite, or plain in-memory. - -## Install - -``` -pip install cardano-checkout # core -pip install 'cardano-checkout[sqlalchemy]' # + SQLAlchemy extra -``` - -Two runtime dependencies: `httpx` (Koios HTTP) and `apscheduler` -(background loop). There is **no** `pycardano` dependency — see -[Deriving addresses with pycardano](#deriving-addresses-with-pycardano) -for the pairing pattern. +The merchant state machine — "derive an address, watch for payment, +confirm within tolerance, reprice if the quote lapses, emit a confirmed +callback" — is what we package. You keep full control of everything +else by using pycardano directly. ## Quick start @@ -51,26 +42,29 @@ from cardano_checkout import ( ) -# Your oracle. Anything async returning int lovelace works. +# Your oracle — we don't ship one. Anything async returning int lovelace works. async def my_price_fn(usd: float) -> int: - rate = await fetch_ada_usd_somewhere() # CoinGecko, a DEX, a fixed rate, etc. + rate = await fetch_ada_usd_somewhere() # CoinGecko, Koios, fixed rate, etc. return int(round(usd / rate * 1_000_000)) async def main() -> None: store = InMemoryStore() # swap for your SQLAlchemy / asyncpg / sqlite adapter + # Create an invoice. In production you'd derive the receive address from + # your wallet xpub via pycardano — see the "Deriving addresses" section. invoice = Invoice( id="ord-0042", - merchant_id="my-shop", + merchant_id="example-studio", derivation_index=42, - receive_address="addr1q...", # derive via pycardano + receive_address="addr1q...", # derived via pycardano — your code expected_lovelace=5_000_000, usd_amount=2.50, expires_at=datetime.now(timezone.utc) + timedelta(minutes=15), ) await store.create(invoice) + # Run the background scheduler — Koios poll every 15s + reprice every 60s. scheduler = InvoiceScheduler(store=store, price_fn=my_price_fn) await scheduler.start() @@ -81,19 +75,14 @@ async def main() -> None: asyncio.run(main()) ``` -If you price your invoices in fixed ADA you can omit `price_fn` — the -reprice job becomes a no-op and invoices simply expire at `expires_at`. - ## Deriving addresses with pycardano -The receive address for each invoice is derived from your **account-level -xpub** (a public key — not a secret). Customer funds flow directly to your -wallet; this library never touches keys. +We used to wrap this. You don't need the wrapper. ```python from pycardano import HDWallet, Address, Network -# Account-level xpub — public, not a secret. +# Your merchant's account-level xpub — the xpub is public, not a secret. xpub_hex = "..." account = HDWallet.from_xpub(bytes.fromhex(xpub_hex)) @@ -111,12 +100,16 @@ def derive_address(account: HDWallet, index: int, network=Network.MAINNET) -> st addr = derive_address(account, index=42) ``` -## NFT cert: CIP-25 v2 metadata +Six lines of pycardano that read cleanly against +[their docs](https://pycardano.readthedocs.io/). Our old wrapper would +have added one function call but made you learn our API instead of +pycardano's. Skip it. -Need a certificate-of-authenticity NFT per paid order? Here is a -dependency-free builder for the CIP-25 v2 metadata envelope. Hand the -result to pycardano's `AuxiliaryData(Metadata({...}))` when you build the -mint transaction. +## NFT cert-of-authenticity: CIP-25 v2 metadata + +If you want each paid order to ship with an on-chain NFT cert, here's +the CIP-25 v2 metadata builder as a copy-paste. It fits in your own +code — no dep, no wrapper. ```python def build_cip25_metadata( @@ -157,15 +150,20 @@ def build_cip25_metadata( } ``` +Hand that dict to pycardano's `AuxiliaryData(Metadata({...}))` when you +build the mint tx. Straight pycardano from there on. + ## Implementing your own InvoiceStore -`InvoiceStore` is a `Protocol` — implement six methods against whatever -backend you want (SQLAlchemy, asyncpg, SQLite, in-memory). +The SDK's `InvoiceStore` is a Protocol — implement the six methods +against whatever backend you want (SQLAlchemy, asyncpg, SQLite, +in-memory for tests). ```python from cardano_checkout import Invoice, InvoiceStatus, InvoiceStore class MySqliteStore: + # Implement these six methods and you're a valid InvoiceStore. async def create(self, invoice: Invoice) -> None: ... async def get(self, invoice_id: str) -> Invoice | None: ... async def list_by_status(self, status: InvoiceStatus, limit: int = 100) -> list[Invoice]: ... @@ -174,46 +172,38 @@ class MySqliteStore: async def record_tx(self, invoice_id: str, tx_hash: str, lovelace_delta: int) -> None: ... ``` -See `InMemoryStore` in `cardano_checkout/store.py` for a reference -implementation (it also backs the test suite). +See `InMemoryStore` in `cardano_checkout/store.py` for a 90-line +reference implementation. -## Modules +## Status (1.0.0-dev) | Module | Purpose | |---|---| -| `invoice.py` | `Invoice` dataclass + `InvoiceStatus` enum | +| `invoice.py` | `Invoice` dataclass + `InvoiceStatus` enum — payment lifecycle states | | `store.py` | `InvoiceStore` Protocol + `InMemoryStore` reference impl | -| `monitor.py` | `check_address_utxos` (Koios), `evaluate_utxos`, `check_pending_invoices`, `reprice_expired_invoices` | -| `scheduler.py` | `InvoiceScheduler` — APScheduler wrapper, 15s check + 60s reprice | +| `monitor.py` | `check_address_utxos` (Koios), `evaluate_utxos` (ADA matching + tolerance), `check_pending_invoices`, `reprice_expired_invoices` (takes your `price_fn`) | +| `scheduler.py` | `InvoiceScheduler` — APScheduler wrapper, runs check/reprice on the same 15s/60s cadence the host app's used in production since 2025 | -## Design +All tests offline, 26/26 green. Two direct deps: `httpx` (Koios calls), +`apscheduler` (background scheduling). No pycardano dep — that's the +consumer's pairing. -1. **Protocol-first.** Persistence, pricing, and side-effects all go - through consumer-supplied interfaces. -2. **Use pycardano directly.** No wrapping of Cardano primitives. -3. **Zero-custody.** Merchant keys never touch this code. xpub-derived - addresses, UTxO observation, state transitions. Funds flow directly - between customer and merchant wallets. -4. **Offline-first tests.** Koios and price oracles are stubbed via - fixtures — the suite never touches a live node. +## Design principles -## Contributing - -Issues and pull requests are welcome. A couple of house rules keep the -library focused: - -- **Keep Cardano primitives out.** Anything pycardano already does - belongs in the consumer, not here. -- **Tests stay offline.** Koios and any price oracle must be stubbed via - fixtures so CI never hits a live node or a real wallet. - -Run the suite before opening a PR: - -``` -pip install -e '.[test]' -pytest -``` +1. **Protocol-first.** Persistence, pricing, and any other side-effect + concern goes through a consumer-supplied interface. The SDK has no + opinion about your database, your oracle, or your ORM. +2. **Use pycardano directly.** We don't wrap primitives. If you need + address derivation, chain context, or transaction building, import + pycardano. Our package sits next to it, not on top. +3. **Zero-custody.** The merchant's keys never touch this code. We + handle xpub-derived addresses (public), UTxO observation (chain), + and state transitions (the store). Funds flow directly between + customer and merchant wallets. We are not a custodian. +4. **Offline-first tests.** Koios HTTP and price oracles are stubbed + or swapped via fixture. No network in CI. Live tests (preprod mint + round-trips, real Koios) are a consumer-side concern. ## License -AGPL-3.0-or-later. See [LICENSE](LICENSE). +Apache-2.0 — matches the broader Cardano tooling ecosystem. diff --git a/cardano_checkout/__init__.py b/cardano_checkout/__init__.py index 7c8747c..acc27f1 100644 --- a/cardano_checkout/__init__.py +++ b/cardano_checkout/__init__.py @@ -1,16 +1,17 @@ """cardano-checkout — merchant-side Cardano payment lifecycle in Python. -Zero-custody: the merchant brings a wallet xpub and an +Zero-custody by design: the merchant brings a wallet xpub and an :class:`~cardano_checkout.store.InvoiceStore` implementation. The SDK owns the payment lifecycle — per-invoice receive-address bookkeeping, Koios UTxO polling, confirm / underpay / overpay classification, and time-windowed repricing against a consumer-supplied oracle. -Does NOT ship Cardano primitives. Address derivation, transaction -building, chain context, and native-script minting live in -`pycardano `_. See the -README for the pairing pattern and the CIP-25 v2 metadata-builder -snippet. +**The SDK deliberately does NOT ship Cardano primitives.** Address +derivation, transaction building, chain context, and native-script +minting all live in `pycardano `_ +and are consumer concerns. See the README for the pairing pattern and +for the CIP-25 v2 metadata-builder snippet (a 60-line helper that fits +anywhere in your own code without needing a separate dep). Quick start:: @@ -19,6 +20,7 @@ Quick start:: store = InMemoryStore() # or your SQLAlchemy / asyncpg / sqlite adapter async def my_price_fn(usd: float) -> int: + # your oracle — CoinGecko / Koios ticker / fixed rate in tests rate = await fetch_ada_usd_rate() return int(round(usd / rate * 1_000_000)) diff --git a/cardano_checkout/invoice.py b/cardano_checkout/invoice.py index 64b1e53..9b51a97 100644 --- a/cardano_checkout/invoice.py +++ b/cardano_checkout/invoice.py @@ -5,8 +5,8 @@ derived from the merchant's xpub, an expected amount in lovelace, a USD-denominated label, and a lifecycle state that transitions as the chain confirms payment. -Persistence is delegated to an :class:`InvoiceStore` -(see :mod:`cardano_checkout.store`). +The Invoice is deliberately framework-agnostic — persistence is +delegated to an :class:`InvoiceStore` (see :mod:`cardano_checkout.store`). """ from __future__ import annotations diff --git a/cardano_checkout/monitor.py b/cardano_checkout/monitor.py index 6a3bd2b..e3fec8f 100644 --- a/cardano_checkout/monitor.py +++ b/cardano_checkout/monitor.py @@ -13,12 +13,17 @@ Koios endpoint used:: POST https://api.koios.rest/api/v1/address_utxos Body: {"_addresses": ["addr1..."]} -Status transitions:: +Status transitions applied here:: PENDING ──► CONFIRMED (received >= expected * CONFIRM_TOLERANCE) PENDING ──► UNDERPAID (received > 0 but below tolerance) PENDING ──► OVERPAID (received >= expected * OVERPAY_THRESHOLD) PENDING ──► EXPIRED (after reprice_count exhausts — see reprice_expired_invoices) + +Behavioral shape is identical to the original the host app ``services/cardano_monitor.py``: +same polling intervals, same Koios URL, same 2% confirm / overpay tolerances. +The only change is that persistence is now delegated to the store Protocol +instead of being welded to SQLAlchemy + the ``CardanoPayment`` model. """ from __future__ import annotations @@ -36,6 +41,10 @@ from cardano_checkout.store import InvoiceStore # returns the current-market lovelace equivalent as int. Invoked by # :func:`reprice_expired_invoices` to generate fresh quotes when an # invoice's quote window lapses without payment. +# +# SDK intentionally does NOT ship an oracle. Consumers wire whatever +# price source they trust (CoinGecko, Koios ticker, their own DEX feed, +# or a constant for tests). PriceFn = Callable[[float], Awaitable[int]] logger = logging.getLogger(__name__) @@ -43,11 +52,11 @@ logger = logging.getLogger(__name__) KOIOS_URL = "https://api.koios.rest/api/v1/address_utxos" KOIOS_TIMEOUT = 15 # seconds -# Tolerance for confirming payment (2%). +# Tolerance for confirming payment (2%) — unchanged from v0.1 / the host app. CONFIRM_TOLERANCE = 0.98 OVERPAY_THRESHOLD = 1.02 -# Default reprice cap + window. +# Default reprice cap + window (matches the host app defaults). DEFAULT_MAX_REPRICINGS = 3 DEFAULT_PAYMENT_WINDOW_MINUTES = 15 @@ -99,7 +108,8 @@ async def check_address_utxos( return [] -# Leading-underscore alias kept for callers that imported the private name. +# Backwards-compatible alias — monitor.py in the host app imports the private name. +# Keeping a leading-underscore alias so the the host app shim can still reach it. _check_address_utxos = check_address_utxos @@ -123,7 +133,7 @@ async def evaluate_utxos( - ``received_assets`` — ``{policy_id.asset_name_hex: quantity}``. - ``latest_tx_hash`` — most recent observed tx hash, or None if no UTXOs. - Status rules: + Status rules mirror the host app exactly: - No UTXOs → ``PENDING`` (no change) - ``total_value >= expected * OVERPAY_THRESHOLD`` → ``OVERPAID`` (treated as confirmed) @@ -158,10 +168,11 @@ async def evaluate_utxos( if qty > 0: received_assets[asset_id] = received_assets.get(asset_id, 0) + qty - # ADA-only matching. Native tokens in the same UTxOs are recorded in - # received_assets for visibility but do NOT contribute to the - # payment-matched total. Wrap this function with your own - # asset-to-lovelace converter to accept native tokens. + # ADA-only matching. Any native tokens landed in the same UTxOs are + # recorded in received_assets for visibility but do NOT contribute to + # the payment-matched total. Consumers who want to accept stablecoins + # or other native tokens wrap this function with their own asset-to- + # lovelace converter before comparing against expected_lovelace. total_value = raw_lovelace if expected_lovelace == 0: @@ -179,7 +190,7 @@ async def evaluate_utxos( return new_status, raw_lovelace, total_value, received_assets, latest_tx_hash -# Leading-underscore alias for callers that imported the private name. +# Backwards-compatible alias. _evaluate_utxos = evaluate_utxos @@ -302,17 +313,18 @@ async def reprice_expired_invoices( Args: store: Persistence backend. price_fn: Async callable that takes a USD amount and returns the - current lovelace equivalent. Example:: + current lovelace equivalent. Consumer-supplied — the SDK does + not ship an oracle. A simple wiring looks like:: from cardano_checkout.monitor import reprice_expired_invoices async def my_price_fn(usd: float) -> int: - rate = await coingecko_fetch_ada_usd() + rate = await coingecko_fetch_ada_usd() # your code return int(round(usd / rate * 1_000_000)) await reprice_expired_invoices(store, price_fn=my_price_fn) - window_minutes: New expiry window per reprice. Default 15. - max_repricings: Give-up threshold. Default 3. + window_minutes: New expiry window per reprice. the host app default 15. + max_repricings: Give-up threshold. the host app default 3. limit: Max pending invoices to process per call. Returns: diff --git a/cardano_checkout/scheduler.py b/cardano_checkout/scheduler.py index 72b34f5..d5559f4 100644 --- a/cardano_checkout/scheduler.py +++ b/cardano_checkout/scheduler.py @@ -6,6 +6,13 @@ The scheduler drives two jobs against a consumer-supplied - :func:`cardano_checkout.monitor.check_pending_invoices` — every 15 seconds - :func:`cardano_checkout.monitor.reprice_expired_invoices` — every 60 seconds +That's the *full* SDK job surface. The subscription-level + grace-period +jobs that the original the host app scheduler shipped are the host app-specific +(they touch ``Company``, ``Subscription``, ``SubscriptionPayment`` models +that are merchant-specific) — those live in +:mod:`cardano_checkout.hostapp_compat` so the host app can still import the +exact wrappers it has always used, without polluting the generic SDK. + Usage:: from cardano_checkout.scheduler import InvoiceScheduler @@ -47,7 +54,7 @@ class InvoiceScheduler: store: Persistence backend. Required. koios_url: Chain-query endpoint. Override for testnet / custom gateways. check_interval_seconds: How often to poll Koios for pending invoices. - Defaults to 15. + Defaults to 15 — identical to the host app's production cadence. reprice_interval_seconds: How often to sweep for expired invoices. Defaults to 60. payment_window_minutes: Re-expiry window when repricing. @@ -80,8 +87,9 @@ class InvoiceScheduler: async def _job_reprice_expired(self) -> None: if self.price_fn is None: - # No oracle wired — skip repricing. Fixed-ADA invoices don't - # need one. + # No oracle wired — skip repricing silently. Consumers that + # don't care about the USD-lock workflow (e.g. fixed-ADA + # invoices) will never configure a price_fn; that's fine. return try: await reprice_expired_invoices( @@ -141,9 +149,12 @@ class InvoiceScheduler: # --------------------------------------------------------------------------- -# Free-function API around a module-level default instance. -# Prefer the InvoiceScheduler class for anything nontrivial. +# Backwards-compatible free-function API # --------------------------------------------------------------------------- +# +# Early adopters may have imported ``start_cardano_scheduler`` / ``stop_cardano_scheduler`` +# directly. Provide those as thin wrappers around a module-level default instance. +# Using the InvoiceScheduler class is preferred for anything nontrivial. _default: Optional[InvoiceScheduler] = None diff --git a/cardano_checkout/store.py b/cardano_checkout/store.py index f3750f1..231c2fe 100644 --- a/cardano_checkout/store.py +++ b/cardano_checkout/store.py @@ -1,15 +1,17 @@ """Persistence abstraction for Invoice objects. The SDK does not prescribe a database. Consumers implement -:class:`InvoiceStore` against whatever backend suits them — SQLAlchemy, -asyncpg, SQLite, in-memory dict. +:class:`InvoiceStore` against whatever backend suits them — SQLAlchemy +(the host app pattern), SQLite (example-studio pattern), Postgres raw +(high-volume pattern), in-memory dict (tests). -All methods are async so the same Protocol works for both +All methods are async so the same Protocol works cleanly for both asyncpg/asyncio-sqlalchemy backends and synchronous backends wrapped with ``asyncio.to_thread``. -Also ships :class:`InMemoryStore` — a reference implementation used by -the test suite and useful for local development. +This module also ships :class:`InMemoryStore` — a reference implementation +used by the test suite and useful as a drop-in for local development or +ephemeral workflows that don't need durability. """ from __future__ import annotations diff --git a/pyproject.toml b/pyproject.toml index 48eac25..533d88e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -8,7 +8,7 @@ version = "1.0.0.dev0" description = "Merchant-side Cardano payment lifecycle (zero-custody). Ships the invoice + UTxO-watcher + reprice state machine. Use pycardano directly for Cardano primitives." readme = "README.md" requires-python = ">=3.10" -license = {text = "AGPL-3.0-or-later"} +license = {text = "Apache-2.0"} authors = [ {name = "Sulkta Coop"}, ] @@ -16,7 +16,7 @@ keywords = ["cardano", "payments", "checkout", "invoice", "utxo", "zero-custody" classifiers = [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", - "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)", + "License :: OSI Approved :: Apache Software License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3.10", @@ -36,7 +36,7 @@ test = ["pytest>=7", "pytest-asyncio>=0.23"] dev = ["pytest>=7", "pytest-asyncio>=0.23", "ruff", "mypy"] [project.urls] -Repository = "https://git.sulkta.com/Sulkta-Coop/cardano-checkout-py" +Repository = "http://git.sulkta.com/Sulkta-Coop/cardano-checkout-py" [tool.setuptools.packages.find] include = ["cardano_checkout*"] diff --git a/tests/test_invoice.py b/tests/test_invoice.py index 757d715..5339914 100644 --- a/tests/test_invoice.py +++ b/tests/test_invoice.py @@ -10,7 +10,7 @@ from cardano_checkout.invoice import Invoice, InvoiceStatus def _make() -> Invoice: return Invoice( id="inv_001", - merchant_id="acme", + merchant_id="example-studio", derivation_index=0, receive_address="addr1...", expected_lovelace=5_000_000, # 5 ADA diff --git a/tests/test_monitor_with_inmemory_store.py b/tests/test_monitor_with_inmemory_store.py index c6db6d7..d14dbd8 100644 --- a/tests/test_monitor_with_inmemory_store.py +++ b/tests/test_monitor_with_inmemory_store.py @@ -32,7 +32,7 @@ def _make( now = datetime.now(timezone.utc) return Invoice( id=id_, - merchant_id="acme", + merchant_id="example-studio", derivation_index=0, receive_address="addr1testreceive", expected_lovelace=expected_lovelace, diff --git a/tests/test_store_protocol.py b/tests/test_store_protocol.py index b89475e..d1f001e 100644 --- a/tests/test_store_protocol.py +++ b/tests/test_store_protocol.py @@ -17,7 +17,7 @@ from cardano_checkout import InMemoryStore, Invoice, InvoiceStatus, InvoiceStore def _make_invoice( id_: str = "inv_001", - merchant: str = "acme", + merchant: str = "example-studio", index: int = 0, status: InvoiceStatus = InvoiceStatus.PENDING, ) -> Invoice: @@ -135,8 +135,8 @@ async def test_list_by_status_honours_limit() -> None: async def test_next_derivation_index_is_monotonic_per_merchant() -> None: store = InMemoryStore() - m1 = "acme" - m2 = "globex" + m1 = "example-studio" + m2 = "hostapp" assert await store.next_derivation_index(m1) == 0 assert await store.next_derivation_index(m1) == 1 @@ -149,7 +149,7 @@ async def test_create_bumps_index_cursor_if_higher() -> None: store = InMemoryStore() await store.create(_make_invoice(id_="manual", index=7)) - nxt = await store.next_derivation_index("acme") + nxt = await store.next_derivation_index("example-studio") assert nxt == 8