zeam-pass 1.0.0__tar.gz

zeam_pass-1.0.0/LICENSE

@@ -0,0 +1,349 @@
+Copyright (C) 2026 ZEAM Labs, LLC
+
+This program is free software; you can redistribute it and/or modify it under the terms of the
+GNU General Public License, version 2, as published by the Free Software Foundation. It is NOT
+licensed under any later version.
+
+No license under any patent or patent application is granted, express or implied, beyond what
+version 2 of the GNU General Public License itself requires. Patent pending.
+
+
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+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
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the 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 a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE 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.
+
+                     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
+convey 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 General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

zeam_pass-1.0.0/MANIFEST.in

@@ -0,0 +1,2 @@
+prune tests
+include examples/server.py

zeam_pass-1.0.0/PKG-INFO

@@ -0,0 +1,246 @@
+Metadata-Version: 2.4
+Name: zeam-pass
+Version: 1.0.0
+Summary: ZEAM :: Pass for your own server: a paywall (x402; you keep 90.01%), a key gate, or both, for your MCP and HTTP tools. Runs in your process with your keys.
+Author-email: "ZEAM Labs, LLC" <info@zeamlabs.com>
+License-Expression: GPL-2.0-only
+Project-URL: Homepage, https://zeampass.com
+Keywords: x402,mcp,agents,paywall,gate,batch-settlement,usdc,base
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: coincurve<22,>=20
+Requires-Dist: pycryptodome<4,>=3.19
+Dynamic: license-file
+
+# zeam-pass (Python)
+
+ZEAM :: Pass for your own server. Define your tools once; agents pay per call over MCP and x402 HTTP on your domain.
+The Pass engine runs in your process: keys, channel records, gate usage and settlement stay on your server. ZEAM runs
+the relay (gas for transactions that cover their own gas) and the credit service (gate checks). You keep 90.01% of
+every sale, paid to your own split; the relay pays the gas.
+
+## Install
+
+Published: `pip install zeam-pass` (Python ≥3.9).
+Dependencies: `coincurve` (libsecp256k1, signing) and `pycryptodome` (Keccak, key sealing).
+
+## Start
+
+```python
+from zeam_pass import Pass
+
+agents = Pass(name="acme", payout="0xYourWalletAddress", price="0.01")
+
+@agents.tool(description="A price for a symbol.",
+             input_schema={"type": "object", "properties": {"symbol": {"type": "string"}}, "required": ["symbol"]})
+def quote(symbol):
+    return {"symbol": symbol, "price": lookup(symbol)}
+```
+
+FastAPI / Starlette:
+
+```python
+app.mount("/agents", agents.asgi())
+```
+
+Flask (werkzeug):
+
+```python
+app.wsgi_app = DispatcherMiddleware(app.wsgi_app, {"/agents": agents.wsgi()})
+```
+
+Routes: `/agents/mcp` (MCP; payment in the tool call's `_meta`), `POST /agents/v1/<tool>` (x402 headers),
+`/agents/openapi.json` and `/agents/refund`, with CORS. Django mounts `agents.wsgi()` or `agents.asgi()` the same
+way. `examples/server.py` is a whole server on the standard library.
+
+The agent side: [zeampass.com/docs/agents](https://zeampass.com/docs/agents).
+
+## Modes
+
+| `mode` | What an agent does |
+|---|---|
+| `paywall` (default) | pays `price` USD per call with x402 `batch-settlement` (USDC on Base) |
+| `gate` | signs each call with its key as a zero-value x402 `exact` payment: nothing is paid, the key needs no funds; `admit=[...]` lists the admitted key addresses; a grant (`x-grant`) from one of them admits one other key |
+| `both` | its key must be admitted; it pays per call |
+
+`name` (2 to 32 of a-z, 0-9 and -, starting with a letter) and `payout` (the wallet address earnings go to) fix your
+split's address: keep both once you have sold.
+
+Other keyword arguments to `Pass(...)`:
+
+| Argument | Default | |
+|---|---|---|
+| `price` | | USD per call, up to 6 decimals (`"0.02"`); the default for tools with no price of their own |
+| `prices` | | per tool: `{"tool": "0.05"}` or `{"tool": {"price": "0.05", "unit": "0.0001"}}`, or a callable `(tool, args) -> spec`; a paywall needs `price` or `prices` |
+| `free` | `[]` | tool names served with no payment and no admission |
+| `time` | none | line time: `{"block": "0.00025", "blockMs": 250, "idleMs": 0, "maxBlocks": 14400}`; `paywall` and `both` only; adds `buy_time`, `line` and `POST <base>/line` |
+| `free_limit` | none | `N` or `{"perHour": N}`: N free calls per tool per client address per clock hour, kept in `state_dir/free.json` (a restart keeps the hour); no client address: one shared count; over it: 429 `free_limit`, `retry-after` |
+| `site` | the request's origin | your public origin, used in the 402's resource and refund URL |
+| `admit` | `[]` | admitted key addresses |
+| `on_empty` | `"refuse"` | gate credit at 0: `"refuse"`, or `"allow"` and warn |
+| `contact` | none | an `https://` URL or a `mailto:` address; goes in every 402, in the 403 `refused` answer (`how` and `contact`) and in `openapi.json` `info.contact` |
+| `state_dir` | `$PASS_STATE_DIR` or `~/.zeam-pass/<name>` | keys, channel records, gate usage |
+| `rpc` | `https://mainnet.base.org` | a Base RPC URL |
+| `relay` | `https://api.zeampass.com/relay` | ZEAM's relay |
+| `credits` | `https://api.zeampass.com/credits` | ZEAM's gate credit service |
+| `refund_url` | | the refund URL the 402 names |
+| `tick_seconds` | `60` | seconds between background runs; `0` turns the thread off |
+| `server_name`, `version` | | the MCP handshake's server info |
+| `fee_recipient`, `credit_issuer` | `$PASS_FEE_RECIPIENT`, `$PASS_CREDIT_ISSUER` | development only |
+| `payout_is_fee_recipient` | `False` | `True` only when `payout` is the fee address: the split pays it 100% |
+| `settings` | | engine tuning; `gateFreePerMonth` and `gateCreditBlock` set the gate's free checks and credit block, for tests |
+
+The Python plugin does not read `pass.json`.
+
+`@agents.tool(...)` keyword arguments:
+
+| Argument | Default | |
+|---|---|---|
+| `name`, `description`, `input_schema` | the function's name and docstring, `{"type": "object"}` | |
+| `price` | `prices[name]`, then `price` | USD per call; an invalid price raises at registration |
+| `unit` | none | USD per unit: the call reserves `price`; the tool calls `zeam_pass.units(n)`; charge = min(`price`, n × `unit`) |
+| `free` | `False` | `True`: no payment, no admission; arguments still validated |
+| `meter` | none | `"time"`: on a line (`x-line`) the call burns the line's time; without one it is a paid call bounded to floor(price × `blockMs` / `block`) ms (past it: 402 `out_of_time`, not charged); needs `time`, never free |
+
+Order: the tool's `price`/`unit`, then `prices`, then `price`. The 402 carries this call's amount in `accepts`,
+`pricing` for this call and `prices` for every tool; `tools/list` entries carry `_meta["zeam-pass/price"]`; `openapi.json`
+operations carry `x-price`. A price the callable cannot give: 500 `price_invalid`. `gate` mode never prices.
+
+## The gate
+
+```python
+import os
+
+from zeam_pass import Pass, sign_grant
+
+agents = Pass(name="acme", payout="0xYourWalletAddress", mode="gate", admit=["0xAgentKeyAddress"])
+
+grant = sign_grant(os.environ["ADMITTED_KEY"], "0xTheirKeyAddress", "2026-12-31T00:00:00Z", scope="quote")
+```
+
+An agent signs each call with its own key; nothing is paid, nothing goes on chain. `sign_grant(key, delegate, until,
+scope="*")`: `key` is the private key of an address in `admit`, `delegate` the address of the key you admit, `until`
+an ISO time or a timezone-aware `datetime`, `scope` one tool name or `"*"`. It returns the `x-grant` header value for
+the agent that holds `delegate`. A call signed by any other key is refused `bad_grant`; so is one past `until`.
+Removing the signing key from `admit` ends every grant it signed.
+
+Agent side, in Python: `new_key()` makes a key; `key_address(key)` is the address the seller lists;
+`gate_proof(key, payment_required)` signs the zero-value row of a gate's 402 (the body, or its `PAYMENT-REQUIRED`
+header) and returns the `PAYMENT-SIGNATURE` value. [Pass a gate](https://zeampass.com/docs/agents#pass-a-gate).
+
+## Keys
+
+On first start the plugin writes its keys to `state_dir`: the settle key (signs your claims and refunds) and, for
+`gate` and `both`, a credit wallet, which holds the gate's USDC; `agents.status()` shows its address. Gate mode: send
+it USDC on Base; it needs no ETH. Credit is 2,000 checks at a time for $1 USDC ($0.50 per 1,000), bought after the
+month's 10,000 free checks are used and again below 200 remaining. Keep $1 USDC on Base in the credit wallet. `both`
+mode needs no USDC in the credit wallet: paid calls are not gate checks.
+
+`keys.json` has mode 0600 in a 0700 directory. `PASS_KEY_SECRET` seals the keys with AES-256-GCM (key from scrypt);
+unsealed keys are sealed on the next start. Secret missing or wrong: paid calls answer 503 and nothing is served.
+
+Put `state_dir` on storage that survives a redeploy, and back it up: it holds the keys and the channel records your
+earnings are claimed from. `agents.status()` shows the settle key and credit wallet addresses, unclaimed and unpaid
+earnings, and gate usage. Fields: [Status](https://zeampass.com/docs/sell#status).
+
+## A call
+
+1. Arguments are checked against your `input_schema` (types, `required`, `enum`, `minimum`, `maximum`, `minLength`,
+   `maxLength`, and the same for an object argument's properties, 1 level deep). Bad arguments, and bodies with
+   `NaN`, `Infinity` or numbers too large for a float: 400 (MCP: an error result); nothing held. Properties the
+   schema does not name are allowed, as in Node: your function gets the ones its signature takes (all of them with
+   `**kwargs`).
+2. The payment is verified and held.
+3. Your tool runs. With a `unit`, it reports whole units with `zeam_pass.units(n)` (outside a tool run: `RuntimeError`).
+4. The payment settles only on success. With a `unit`: no report, or a bad one (negative, not whole, bool, str),
+   is a failure: released, nothing charged. The settle response's `extra` carries `chargedAmount` and
+   `reservedAmount`. The tool raised, returned a dict with `"isError": True`, or returned a value
+   that is not valid JSON (a set, a non-finite float, a non-string dict key): the hold is released, nothing is
+   charged; the last answers 500 `tool_failed` with the message every engine gives: "the result is not valid JSON (a
+   non-finite number or a non-JSON value); nothing was charged".
+
+The payment does not settle: the result is not delivered. Chain unreadable: nothing is served. Request bodies are
+capped at 1 MB.
+
+A voucher settles in your process with no transaction. A deposit (the first call on a channel, and every top-up) goes
+through the relay and waits for its receipt: that call takes a few seconds.
+
+Behind a proxy or on localhost, pass `site="https://your.domain"`: the 402's resource and refund URL use that origin.
+
+Flask routes you already have: `@agents.paid` holds, runs and settles the same way; an exception or a status of 400
+or more releases the hold. Add the refund route:
+
+```python
+@app.post("/quote")
+@agents.paid
+def quote():
+    ...
+
+app.add_url_rule("/refund", view_func=agents.refund_view(), methods=["POST"])
+```
+
+## Line time
+
+With `time` set, an agent buys time and spends it on a line with no payment per call:
+
+1. `buy_time {"blocks": n}` (1 to `maxBlocks`): a paid call of n × `block`; the n × `blockMs` ms are credited to the
+   paying channel once the payment settles, once per payment.
+2. `POST <base>/line {"op": "open", "channelId"}` (or the free `line` tool): a message to sign with the payer key.
+3. `{"op": "prove", "channelId", "nonce", "signature"}`: the credential; the meter is on. A nonce is one attempt, 300 s.
+4. Calls to a `meter="time"` tool with the credential in `x-line` (MCP: `_meta["zeam-pass/line"]` or the request's
+   `x-line`) run until the time runs out; answers carry `x-pass-ms-remaining` and `x-pass-ms-elapsed` (MCP:
+   `_meta["zeam-pass/meter"]`). Time burns while a call runs, once for calls at the same time, plus `idleMs` after each.
+   Refusals: 403 `line_unknown`, 402 `meter_off`, `out_of_time`, `channel_leaving`.
+5. `{"op": "off"}`, `"on"`, `"status"`, `"close"` with `credential` or `x-line`.
+
+`zeam_pass.deadline_ms()` inside a time tool: the epoch ms its call must end by (`None` elsewhere). The call runs in a
+worker thread; past the deadline the caller gets `out_of_time` and a late result is discarded, so stop by then.
+Claims and payouts take what burned; a refund switches the meter off, returns the unburned time with the balance
+(`timeReturnedMs`) and closes the channel's lines. State: `<state_dir>/meter`.
+
+## Refunds
+
+The buyer posts `{"channelId", "issued", "signature"}`, signed by the channel's payer over
+`ZEAM Pass refund\nchannel: <id>\nissued: <ISO time>` within 5 minutes, plus `channelConfig` for a channel with no
+calls. The balance goes back through the relay:
+
+- The channel's spend times the fee address's share of your split (9.99%; 100% with `payout_is_fee_recipient`), in
+  whole micro-dollars, ≥ its deposit and refund gas × 1.15: ZEAM pays the gas. `"op": "refunded"`, `gasMicroUSD: 0`.
+- Otherwise: 409 `"op": "refund_quote"` (`gas_payment_needed`), an EIP-3009 `TransferWithAuthorization` of the quoted
+  gas (15% margin) for the buyer to sign. The relay prices it; relay unreachable: the engine prices from `GAS`
+  (`quotedBy: "engine"`). Public check: `https://api.zeampass.com/relay/quote`. The buyer posts again with
+  `"gasPayment"`; the relay sends the refund, then the payment, in one transaction.
+- `"selfSend": true`: the buyer gets a signed refund of the full balance and sends it with ETH on Base for gas.
+- 1 refund per channel per hour; sooner: `refund_too_soon` with `retry_after_seconds`.
+
+Every field and error: [Errors](https://zeampass.com/docs/agents#errors) and
+[Refunds](https://zeampass.com/docs/agents#refunds).
+
+## Background work
+
+A daemon thread runs `agents.tick()` every `tick_seconds` (60): it stamps channels whose payer started a withdrawal,
+claims earnings once the fee covers the gas and pays them out in the same relay request, and, in `gate` mode, buys
+credit. Several workers can share one `state_dir`; overlapping ticks skip. `tick_seconds=0` and `agents.tick()` from
+your cron schedules it yourself. `agents.payout_now()` pays out now, or returns the transaction to send from your
+wallet with ETH on Base for gas.
+
+A paid call waits on the chain and, for a deposit, on the relay: serve with threads or workers (gunicorn, uvicorn, or
+`wsgiref` with `socketserver.ThreadingMixIn` as in `examples/server.py`).
+
+## Tests
+
+`python -m unittest` from this directory runs the plugin tests and the 5 fixture sets every engine shares
+(`wordpress/tests/vectors.json`, `settlement/fixtures.json`, `gate/fixtures.json`, `pricing/fixtures.json`,
+`meter/fixtures.json`).