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