axorum-client 0.1.0__tar.gz

axorum_client-0.1.0/.gitignore

@@ -0,0 +1,7 @@
+.venv/
+__pycache__/
+*.pyc
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+dist/

axorum_client-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

axorum_client-0.1.0/PKG-INFO

@@ -0,0 +1,235 @@
+Metadata-Version: 2.4
+Name: axorum-client
+Version: 0.1.0
+Summary: The official Python client for the Axorum agent plane.
+Project-URL: Homepage, https://github.com/AxorumHQ/axorum/tree/main/clients/python#readme
+Project-URL: Repository, https://github.com/AxorumHQ/axorum
+Project-URL: Issues, https://github.com/AxorumHQ/axorum/issues
+Author-email: Roland Rodriguez <roland@axorum.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agent,axorum,deontic,ledger,policy
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27
+Description-Content-Type: text/markdown
+
+# axorum-client
+
+The official Python client for the **Axorum agent plane** — the wire an
+autonomous agent speaks to submit intents to a deontic financial-control ledger
+and read what the ledger did about them.
+
+```bash
+pip install axorum-client     # or: uv add axorum-client
+```
+
+Requires Python 3.11+. The only runtime dependency is [httpx](https://www.python-httpx.org/).
+
+---
+
+## The one rule: a refusal is a value, not an exception
+
+Axorum's job is to judge an intent against the policy in force. When the policy
+**forbids** the action, the intent still reaches the commit point, is still
+judged, and the refusal is still *recorded* — and **that record is the
+product**. It comes back as a `200`, as an ordinary `AgentOutcome` with
+`posted == False`.
+
+So this client returns it. It does not raise.
+
+```python
+outcome = client.submit_pinned(draft)
+
+if outcome.posted:
+    print("permitted, and the entries posted")
+else:
+    # NOT a failure. The ledger recorded a refusal, which is what you asked it to do.
+    print(f"refused, and the refusal is on the ledger: {outcome.verdict}")
+```
+
+An exception from this client means the ledger **never got to answer at all**:
+the caller was not who they claimed, the pin did not hold, the cluster could not
+confirm, the wire broke. A client that raised on a refusal would be throwing away
+the very artifact the ledger exists to produce.
+
+## Quickstart
+
+```python
+from axorum import ActionTerm, Amount, AxorumClient, Entry, IntentDraft
+
+draft = IntentDraft(
+    agent="agent://example.com/agent/clerk_01h455vb4pex5vsknk084sn02q",
+    attestation=paseto_token,          # the PASETO v4.public capability attestation
+    action=ActionTerm("post"),
+    entries=[
+        Entry.debit(cash_account, Amount(minor=1000, currency="USD")),
+        Entry.credit(revenue_account, Amount(minor=1000, currency="USD")),
+    ],
+    justification="settling invoice 42",
+)
+
+with AxorumClient("http://127.0.0.1:8080") as client:
+    outcome = client.submit_pinned(draft)
+
+    print(outcome.verdict)      # Verdict.PERMITTED
+    print(outcome.posted)       # True
+    print(outcome.policy)       # the policy it was judged under
+    print(outcome.transaction)  # the id you minted, echoed back
+```
+
+### …and the same call, refused
+
+Point the same draft at a ledger whose policy forbids `post`, and **nothing about
+your code changes**. You do not catch anything. You read the outcome:
+
+```python
+with AxorumClient("http://127.0.0.1:8080") as client:
+    outcome = client.submit_intent(draft.pin(policy_id))
+
+    assert outcome.posted is False
+    assert outcome.verdict is Verdict.FORBIDDEN_REJECTED
+
+    # The refusal is on the ledger, and reads back like any other record.
+    record = client.transaction(outcome.transaction)
+```
+
+## Async
+
+The same client, awaited. Same method names, same arguments, same semantics.
+
+```python
+from axorum import AsyncAxorumClient
+
+async with AsyncAxorumClient("http://127.0.0.1:8080") as client:
+    outcome = await client.submit_pinned(draft)
+    if not outcome.posted:
+        print(f"recorded as refused: {outcome.verdict}")
+```
+
+## Policy pinning, and why `submit_pinned` exists
+
+Every intent names the policy the agent believes is in force. If that pin is
+stale, the service refuses with a `409` and **nothing is written**. The recovery
+is always the same: re-pin against the policy now in force and submit again.
+
+That is the loop every correct agent writes, so it ships here instead:
+
+- **`submit_pinned(draft)`** — read `GET /policies/active`, stamp the pin, submit,
+  and on a `409` re-pin against the policy *the rejection itself named* and go
+  again. Bounded at 3 pin attempts.
+- **`submit_pinned_from(draft, policy_id)`** — the same, but starting from a policy
+  you already believe is in force. This is what a long-running agent wants: hold
+  the last policy you saw, submit straight against it, and let the `409` tell you
+  when your belief went stale.
+- **`submit_intent(envelope)`** — no recovery, no re-reads. You pinned it; you own it.
+
+Retrying is safe for one specific reason: the **transaction id is minted once**, on
+the draft, before the first attempt, and it is the substrate's idempotency key.
+Every re-pinned attempt carries the same id, so an attempt that in fact landed
+replays its stored outcome. The loop cannot double-post. (`IntentDraft` mints one
+for you from a UUID v4; supply your own if you have one.)
+
+## The exception taxonomy
+
+Everything below inherits from **`AxorumError`**. None of them is a refusal.
+
+| Exception | Status / code | What it means, and what to do |
+|---|---|---|
+| `StalePolicyError` | 409 `stale_policy` / `policy_pin_mismatch` | The pin did not hold and **nothing was written**. Carries `.pinned` and `.active` — re-pin against `.active`. `submit_pinned` does this for you. `.requires_repin` is `True`. |
+| `NoActivePolicyError` | 409 `no_active_policy` | No policy is in force at all. Re-pinning cannot help; an operator has to activate one. |
+| `UnknownAgentError` | 401 `unknown_agent` | The `agent://` URI is not bound to a party. Carries `.uri`. |
+| `AttestationError` | 403 `attestation` | The PASETO attestation was rejected — bad signature, expired, wrong audience, untrusted issuer. |
+| `NotPrimaryError` | 421 `not_primary` | A cluster mutation reached a follower. Nothing was written. Carries `.primary_client_addr` (which may be `None`). |
+| `CommitUnavailableError` | 503 `commit_unavailable` | The commit could not be confirmed. **It may or may not have landed.** `.is_retriable` is `True` — retrying the same transaction id is safe, or read it back with `client.transaction(id)`. |
+| `ApiError` | any documented code | A documented error with no distinct recovery: `unknown_account`, `unknown_transaction`, `substrate_rejected`, `capability_mapping`, … Carries `.status`, `.code`, and the full `.body`. |
+| `TransportError` | — | The service could not be reached. `.is_retriable` is `True`. |
+| `UnexpectedResponseError` | any | A non-2xx whose body is not an agent-plane error body — a proxy, a load balancer. The bytes are kept verbatim in `.body`. |
+| `DecodeError` | any | The service and this client disagree about the wire. Bytes kept verbatim. |
+| `ConfigError` | — | The client could not be built: a malformed base URL, an empty token. |
+
+Two convenience properties on every error say what to do next:
+
+```python
+try:
+    outcome = client.submit_intent(envelope)
+except AxorumError as failure:
+    if failure.requires_repin:
+        ...  # re-pin against failure.active and resubmit
+    elif failure.is_retriable:
+        ...  # re-send the IDENTICAL request — safe, the txn id is the idempotency key
+    else:
+        raise
+```
+
+## This client never auto-follows a `421`
+
+In cluster mode, a mutation that reaches a non-primary replica is refused `421
+not_primary`, with the primary's address in the body. **This client will not
+silently re-send there.** It raises `NotPrimaryError` and hands you
+`.primary_client_addr`.
+
+That is deliberate. Following the redirect is an *operational* decision: a client
+that auto-follows hides a topology change from the operator who most needs to see
+it — a follower answering your writes means something moved, and you should learn
+that from your client, not from a graph three days later. If you want to follow
+it, follow it on purpose:
+
+```python
+try:
+    outcome = client.submit_intent(envelope)
+except NotPrimaryError as failure:
+    if failure.primary_client_addr is None:
+        raise                                    # the follower doesn't know either
+    with AxorumClient(f"http://{failure.primary_client_addr}") as primary:
+        outcome = primary.submit_intent(envelope)   # same txn id — cannot double-post
+```
+
+## API surface
+
+```python
+AxorumClient(base_url, *, bearer_token=None, timeout=10.0, transport=None)
+AsyncAxorumClient(base_url, *, bearer_token=None, timeout=10.0, transport=None)
+
+client.active_policy()                            -> str | None
+client.submit_intent(envelope)                    -> AgentOutcome
+client.submit_pinned(draft)                       -> AgentOutcome
+client.submit_pinned_from(draft, policy_id)       -> AgentOutcome
+client.transaction(txn_id)                        -> TransactionRecord   # opaque JSON
+client.obligations(actor)                         -> ObligationsResponse
+client.balance(account_id)                        -> BalanceResponse
+```
+
+`active_policy()` returning `None` is **not** an error — "no policy is in force"
+is a true and useful fact about a ledger, not a failure to report one.
+
+Every request carries an auto-generated `x-request-id` (UUID v4) so you can find
+it in the service's logs. Pass your own through if you are already carrying a
+correlation id.
+
+## Pure protocol core
+
+`axorum.protocol` holds every request builder, every response decoder, the error
+mapper (`error_from(status, body)`), and the policy-pin loop (`pin_flow`) — all
+pure functions of their inputs, with no I/O anywhere. The sync and async clients
+are thin shells over them, which is why they cannot drift, and why the protocol
+is exhaustively testable without a socket.
+
+## Development
+
+```bash
+uv sync
+uv run ruff check . && uv run ruff format --check .
+uv run mypy --strict src/
+uv run pytest                              # unit tests
+uv run pytest -m conformance               # against a real axorum-serve
+```
+
+## License
+
+Apache-2.0

axorum_client-0.1.0/README.md

@@ -0,0 +1,214 @@
+# axorum-client
+
+The official Python client for the **Axorum agent plane** — the wire an
+autonomous agent speaks to submit intents to a deontic financial-control ledger
+and read what the ledger did about them.
+
+```bash
+pip install axorum-client     # or: uv add axorum-client
+```
+
+Requires Python 3.11+. The only runtime dependency is [httpx](https://www.python-httpx.org/).
+
+---
+
+## The one rule: a refusal is a value, not an exception
+
+Axorum's job is to judge an intent against the policy in force. When the policy
+**forbids** the action, the intent still reaches the commit point, is still
+judged, and the refusal is still *recorded* — and **that record is the
+product**. It comes back as a `200`, as an ordinary `AgentOutcome` with
+`posted == False`.
+
+So this client returns it. It does not raise.
+
+```python
+outcome = client.submit_pinned(draft)
+
+if outcome.posted:
+    print("permitted, and the entries posted")
+else:
+    # NOT a failure. The ledger recorded a refusal, which is what you asked it to do.
+    print(f"refused, and the refusal is on the ledger: {outcome.verdict}")
+```
+
+An exception from this client means the ledger **never got to answer at all**:
+the caller was not who they claimed, the pin did not hold, the cluster could not
+confirm, the wire broke. A client that raised on a refusal would be throwing away
+the very artifact the ledger exists to produce.
+
+## Quickstart
+
+```python
+from axorum import ActionTerm, Amount, AxorumClient, Entry, IntentDraft
+
+draft = IntentDraft(
+    agent="agent://example.com/agent/clerk_01h455vb4pex5vsknk084sn02q",
+    attestation=paseto_token,          # the PASETO v4.public capability attestation
+    action=ActionTerm("post"),
+    entries=[
+        Entry.debit(cash_account, Amount(minor=1000, currency="USD")),
+        Entry.credit(revenue_account, Amount(minor=1000, currency="USD")),
+    ],
+    justification="settling invoice 42",
+)
+
+with AxorumClient("http://127.0.0.1:8080") as client:
+    outcome = client.submit_pinned(draft)
+
+    print(outcome.verdict)      # Verdict.PERMITTED
+    print(outcome.posted)       # True
+    print(outcome.policy)       # the policy it was judged under
+    print(outcome.transaction)  # the id you minted, echoed back
+```
+
+### …and the same call, refused
+
+Point the same draft at a ledger whose policy forbids `post`, and **nothing about
+your code changes**. You do not catch anything. You read the outcome:
+
+```python
+with AxorumClient("http://127.0.0.1:8080") as client:
+    outcome = client.submit_intent(draft.pin(policy_id))
+
+    assert outcome.posted is False
+    assert outcome.verdict is Verdict.FORBIDDEN_REJECTED
+
+    # The refusal is on the ledger, and reads back like any other record.
+    record = client.transaction(outcome.transaction)
+```
+
+## Async
+
+The same client, awaited. Same method names, same arguments, same semantics.
+
+```python
+from axorum import AsyncAxorumClient
+
+async with AsyncAxorumClient("http://127.0.0.1:8080") as client:
+    outcome = await client.submit_pinned(draft)
+    if not outcome.posted:
+        print(f"recorded as refused: {outcome.verdict}")
+```
+
+## Policy pinning, and why `submit_pinned` exists
+
+Every intent names the policy the agent believes is in force. If that pin is
+stale, the service refuses with a `409` and **nothing is written**. The recovery
+is always the same: re-pin against the policy now in force and submit again.
+
+That is the loop every correct agent writes, so it ships here instead:
+
+- **`submit_pinned(draft)`** — read `GET /policies/active`, stamp the pin, submit,
+  and on a `409` re-pin against the policy *the rejection itself named* and go
+  again. Bounded at 3 pin attempts.
+- **`submit_pinned_from(draft, policy_id)`** — the same, but starting from a policy
+  you already believe is in force. This is what a long-running agent wants: hold
+  the last policy you saw, submit straight against it, and let the `409` tell you
+  when your belief went stale.
+- **`submit_intent(envelope)`** — no recovery, no re-reads. You pinned it; you own it.
+
+Retrying is safe for one specific reason: the **transaction id is minted once**, on
+the draft, before the first attempt, and it is the substrate's idempotency key.
+Every re-pinned attempt carries the same id, so an attempt that in fact landed
+replays its stored outcome. The loop cannot double-post. (`IntentDraft` mints one
+for you from a UUID v4; supply your own if you have one.)
+
+## The exception taxonomy
+
+Everything below inherits from **`AxorumError`**. None of them is a refusal.
+
+| Exception | Status / code | What it means, and what to do |
+|---|---|---|
+| `StalePolicyError` | 409 `stale_policy` / `policy_pin_mismatch` | The pin did not hold and **nothing was written**. Carries `.pinned` and `.active` — re-pin against `.active`. `submit_pinned` does this for you. `.requires_repin` is `True`. |
+| `NoActivePolicyError` | 409 `no_active_policy` | No policy is in force at all. Re-pinning cannot help; an operator has to activate one. |
+| `UnknownAgentError` | 401 `unknown_agent` | The `agent://` URI is not bound to a party. Carries `.uri`. |
+| `AttestationError` | 403 `attestation` | The PASETO attestation was rejected — bad signature, expired, wrong audience, untrusted issuer. |
+| `NotPrimaryError` | 421 `not_primary` | A cluster mutation reached a follower. Nothing was written. Carries `.primary_client_addr` (which may be `None`). |
+| `CommitUnavailableError` | 503 `commit_unavailable` | The commit could not be confirmed. **It may or may not have landed.** `.is_retriable` is `True` — retrying the same transaction id is safe, or read it back with `client.transaction(id)`. |
+| `ApiError` | any documented code | A documented error with no distinct recovery: `unknown_account`, `unknown_transaction`, `substrate_rejected`, `capability_mapping`, … Carries `.status`, `.code`, and the full `.body`. |
+| `TransportError` | — | The service could not be reached. `.is_retriable` is `True`. |
+| `UnexpectedResponseError` | any | A non-2xx whose body is not an agent-plane error body — a proxy, a load balancer. The bytes are kept verbatim in `.body`. |
+| `DecodeError` | any | The service and this client disagree about the wire. Bytes kept verbatim. |
+| `ConfigError` | — | The client could not be built: a malformed base URL, an empty token. |
+
+Two convenience properties on every error say what to do next:
+
+```python
+try:
+    outcome = client.submit_intent(envelope)
+except AxorumError as failure:
+    if failure.requires_repin:
+        ...  # re-pin against failure.active and resubmit
+    elif failure.is_retriable:
+        ...  # re-send the IDENTICAL request — safe, the txn id is the idempotency key
+    else:
+        raise
+```
+
+## This client never auto-follows a `421`
+
+In cluster mode, a mutation that reaches a non-primary replica is refused `421
+not_primary`, with the primary's address in the body. **This client will not
+silently re-send there.** It raises `NotPrimaryError` and hands you
+`.primary_client_addr`.
+
+That is deliberate. Following the redirect is an *operational* decision: a client
+that auto-follows hides a topology change from the operator who most needs to see
+it — a follower answering your writes means something moved, and you should learn
+that from your client, not from a graph three days later. If you want to follow
+it, follow it on purpose:
+
+```python
+try:
+    outcome = client.submit_intent(envelope)
+except NotPrimaryError as failure:
+    if failure.primary_client_addr is None:
+        raise                                    # the follower doesn't know either
+    with AxorumClient(f"http://{failure.primary_client_addr}") as primary:
+        outcome = primary.submit_intent(envelope)   # same txn id — cannot double-post
+```
+
+## API surface
+
+```python
+AxorumClient(base_url, *, bearer_token=None, timeout=10.0, transport=None)
+AsyncAxorumClient(base_url, *, bearer_token=None, timeout=10.0, transport=None)
+
+client.active_policy()                            -> str | None
+client.submit_intent(envelope)                    -> AgentOutcome
+client.submit_pinned(draft)                       -> AgentOutcome
+client.submit_pinned_from(draft, policy_id)       -> AgentOutcome
+client.transaction(txn_id)                        -> TransactionRecord   # opaque JSON
+client.obligations(actor)                         -> ObligationsResponse
+client.balance(account_id)                        -> BalanceResponse
+```
+
+`active_policy()` returning `None` is **not** an error — "no policy is in force"
+is a true and useful fact about a ledger, not a failure to report one.
+
+Every request carries an auto-generated `x-request-id` (UUID v4) so you can find
+it in the service's logs. Pass your own through if you are already carrying a
+correlation id.
+
+## Pure protocol core
+
+`axorum.protocol` holds every request builder, every response decoder, the error
+mapper (`error_from(status, body)`), and the policy-pin loop (`pin_flow`) — all
+pure functions of their inputs, with no I/O anywhere. The sync and async clients
+are thin shells over them, which is why they cannot drift, and why the protocol
+is exhaustively testable without a socket.
+
+## Development
+
+```bash
+uv sync
+uv run ruff check . && uv run ruff format --check .
+uv run mypy --strict src/
+uv run pytest                              # unit tests
+uv run pytest -m conformance               # against a real axorum-serve
+```
+
+## License
+
+Apache-2.0