wavvon-sdk 0.1.0__tar.gz

wavvon_sdk-0.1.0/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

wavvon_sdk-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ["3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
+        with:
+          repository: Wavvon/Wavvon-server
+          ref: eb11d75657ee8362dd42a7982fc5b13a3dcc4e68
+          path: wavvon-server
+          sparse-checkout: crates/identity/wire-vectors.json
+          sparse-checkout-cone-mode: false
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+          cache: pip
+          cache-dependency-path: pyproject.toml
+      - run: python -m pip install --upgrade pip
+      - run: python -m pip install -e . --group dev
+      - run: python scripts/check
+        env:
+          CI: "true"
+          WAVVON_WIRE_VECTORS: wavvon-server/crates/identity/wire-vectors.json

wavvon_sdk-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,87 @@
+name: Release
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.ver.outputs.version }}
+      release: ${{ steps.tag.outputs.exists == 'false' }}
+    steps:
+      - uses: actions/checkout@v4
+      - id: ver
+        run: echo "version=$(sed -n 's/^version = "\(.*\)"$/\1/p' pyproject.toml | head -1)" >> "$GITHUB_OUTPUT"
+      - run: test -n "${{ steps.ver.outputs.version }}"
+      - id: tag
+        run: |
+          if git ls-remote --exit-code --tags origin "refs/tags/v${{ steps.ver.outputs.version }}" >/dev/null; then
+            echo "exists=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "exists=false" >> "$GITHUB_OUTPUT"
+          fi
+      - if: steps.tag.outputs.exists == 'false'
+        uses: actions/checkout@v4
+        with:
+          repository: Wavvon/Wavvon-server
+          ref: eb11d75657ee8362dd42a7982fc5b13a3dcc4e68
+          path: wavvon-server
+          sparse-checkout: crates/identity/wire-vectors.json
+          sparse-checkout-cone-mode: false
+      - if: steps.tag.outputs.exists == 'false'
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - if: steps.tag.outputs.exists == 'false'
+        run: |
+          python -m pip install --upgrade pip build
+          python -m pip install -e . --group dev
+      - if: steps.tag.outputs.exists == 'false'
+        run: python scripts/check
+        env:
+          CI: "true"
+          WAVVON_WIRE_VECTORS: wavvon-server/crates/identity/wire-vectors.json
+      - if: steps.tag.outputs.exists == 'false'
+        run: python -m build
+      - if: steps.tag.outputs.exists == 'false'
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    if: needs.build.outputs.release == 'true'
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/wavvon-sdk/${{ needs.build.outputs.version }}/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33
+        with:
+          skip-existing: true
+
+  tag:
+    needs: [build, publish]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          git tag "v${{ needs.build.outputs.version }}"
+          git push origin "v${{ needs.build.outputs.version }}"
+          gh release create "v${{ needs.build.outputs.version }}" --generate-notes --title "v${{ needs.build.outputs.version }}"

wavvon_sdk-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+.venv/
+__pycache__/
+*.egg-info/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+dist/
+build/

wavvon_sdk-0.1.0/CLAUDE.md

@@ -0,0 +1,113 @@
+# CLAUDE.md
+
+Guidance for working in this repo: `wavvon-sdk` (import `wavvon`), the Python
+SDK for programs (bots and apps) that talk to a Wavvon hub. The design is
+[sdk.md](https://github.com/Wavvon/Wavvon-docs/blob/main/docs/sdk.md); this is
+its tier 1. The TypeScript SDK
+([Wavvon-sdk-js](https://github.com/Wavvon/Wavvon-sdk-js)) is the reference
+for surface and behaviour; this one mirrors it idiomatically. Hub code lives in
+[Wavvon-server](https://github.com/Wavvon/Wavvon-server), the REST spec and
+protocol docs in [Wavvon-docs](https://github.com/Wavvon/Wavvon-docs).
+
+## Commands
+
+```sh
+python -m venv .venv && .venv/bin/pip install -e . --group dev   # .venv\Scripts on Windows
+python scripts/check          # ruff check + ruff format --check + mypy --strict + pytest. Must pass before a commit.
+python -m pytest -q           # tests only
+python scripts/generate.py [<path-to-Wavvon-docs>] [--ref <git-ref>]   # regenerate src/wavvon/rest
+python scripts/smoke_local.py # real hub binary, see below
+```
+
+Code comments in English, only where the why is not obvious. No comments in
+GitHub Actions workflow files: explain choices in the commit message.
+
+## Layers
+
+1. **Generated REST** - `src/wavvon/rest/`, from Wavvon-docs `openapi.yaml`
+   by `scripts/generate.py` (openapi-python-client, pinned in the dev group).
+   Committed; never edit by hand. `SPEC_COMMIT` records the docs commit:
+   `-dirty` means local edits. Excluded from ruff and from mypy
+   errors.
+2. **Hand-written core** - `src/wavvon/`:
+   `auth.py` challenge rules and login; `retry.py` backoff; `client.py`
+   `WavvonClient` (the generated client over an httpx transport that adds the
+   bearer, retries and re-authenticates on 401), capabilities, app
+   registration, polling, `ok()`; `pager.py`; `events.py` the WebSocket stream
+   and frame TypedDicts; `webhooks.py` dispatch and outgoing-webhook
+   verification, reply TypedDicts, the framework-agnostic handler and `to_asgi`.
+3. **Conformance** - `tests/test_conformance.py` reads Wavvon-server
+   `crates/identity/wire-vectors.json` (default `../../server/...` relative
+   to the working directory, or `WAVVON_WIRE_VECTORS`). Strings starting with
+   `@` refer to `fixtures`. Never copied into this repo. Missing file: loud
+   skip locally, failure when `CI` is set.
+
+## Rules the SDK must keep (sdk.md §5, §6)
+
+- **Capabilities, never versions.** Gate features on `GET /info`
+  `capabilities` and raise `UnsupportedByHubError`. Never compare `version`.
+- **429 is "not now", never "no".** Retry 429/5xx/timeouts/transport errors
+  with capped exponential backoff and jitter. On exhaustion raise
+  `HubUnavailableError`; never turn a transient failure into an empty list,
+  "not found", or any other definitive answer. A pager page that fails must
+  raise, not end the list. Only transport errors and timeouts are retried;
+  a programming error propagates.
+- **Unknown is loud.** Unknown socket frames and dispatch types are delivered
+  as an `unknown` variant with the raw payload, never dropped. `info()`
+  returns the hub's JSON rather than a generated model because generated enums
+  raise on a value they do not know.
+- **Re-auth on its own**, with the state observable (`on_state_change`).
+- **Auth challenge**: `scheme: "tagged-v1"` -> sign
+  `"wavvon/auth-challenge/v1\0" || challenge`; no scheme -> raw only at exactly
+  32 bytes; unknown scheme -> error.
+- **Never send the seed** or any private key anywhere. Never invent a wire
+  format: signed bytes come from wire-format.md and the vectors; a new one is
+  a server-side change first. Never model a bot as an account or send
+  `is_bot`. Tier 1 is community-axis only (no DMs E2E, pairing, home hub).
+
+Code is authoritative over docs. When they disagree, follow the hub code and
+report the doc bug to Wavvon-docs.
+
+## Facts verified against the hub that the docs get wrong or omit
+
+- The challenge is hex. The hub removes a pending challenge when verify reads
+  it, so a transient verify failure restarts from a fresh challenge.
+- `resume` and `hub_event` push only work on a socket whose identity had an
+  app profile **when it connected** (`is_app` is read at connect). Register
+  first, then `connect()`. Replay can re-deliver: drop `seq <= last`.
+- The app side of a mini-app sends `app_announce` / `app_dismiss` and talks to
+  players with `mini_app_message` + `to_pubkey`. `app_join` is answered by the
+  hub, not the app.
+- Paging: a bare array plus `limit` (default 100, max 500) and `cursor` = key
+  of the previous page's last row; the key differs per endpoint (`code`,
+  `public_key`, `id`). Channel messages still page with `before`.
+- Outgoing-webhook HKDF input is the **decoded** secret bytes (the admin sees
+  base64url without padding); the HMAC key is the 32 HKDF bytes, not hex.
+- `GET /me/events` rows are never written by the hub today
+  (Wavvon-server#170); `poll_events` follows the spec and nothing relies on it.
+
+## Smoke test
+
+`tests/smoke.py` runs against a real hub (`WAVVON_SMOKE_HUB`,
+`WAVVON_SMOKE_INVITE` for an invite whose role grants `apps.register`,
+optional `WAVVON_SMOKE_CHANNEL`). `scripts/smoke_local.py` copies a hub binary
+(`WAVVON_HUB_BIN`, default a sibling Wavvon-server checkout's
+`target/debug/wavvon-hub`) into a temp directory, boots it on a fresh database
+in a PostgreSQL docker container (`WAVVON_PG_CONTAINER`, default `wavvon-pg`),
+sets up a role, invite and channel as owner, runs the smoke, and kills only
+the hub it started. In-process tests have missed every cross-process bug this
+project has had: run it when touching auth, the socket or webhooks.
+
+## Git
+
+Work on `develop`; `main` is for releases. Commit in logical steps.
+
+## Releasing
+
+Bump `version` in `pyproject.toml` on `develop`, open a PR from `develop` to
+`main`; a maintainer merges it with a merge commit. `.github/workflows/release.yml`
+then builds and checks on `main`; the `publish` job runs in the GitHub
+environment `pypi`, which only `main` may use and which waits for a
+maintainer's approval in the Actions tab. PyPI trusted publishing is bound to
+that environment, so nothing outside it can publish; there is no token. After
+the upload the workflow tags `v<version>` and creates the GitHub release.

wavvon_sdk-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,15 @@
+# Contributing
+
+1. Branch from `develop` and open the pull request against `develop`.
+2. `pip install -e . --group dev && python scripts/check` must pass. If you
+   touched auth, the socket or webhooks, also run the smoke test against a
+   real hub (`python scripts/smoke_local.py`, see CLAUDE.md).
+3. Do not edit `src/wavvon/rest/` by hand. Run `python scripts/generate.py
+   <Wavvon-docs checkout>` and commit the result with the new `SPEC_COMMIT`.
+4. A new signed byte sequence starts as a change in
+   [Wavvon-server](https://github.com/Wavvon/Wavvon-server) with a wire
+   vector, never here.
+5. A feature that needs a hub capability checks it with `require_capability`
+   and lists it in the README table.
+
+Contributions are licensed under Apache-2.0 (see LICENSE).

wavvon_sdk-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.

wavvon_sdk-0.1.0/NOTICE

@@ -0,0 +1,5 @@
+Wavvon SDK for Python
+Copyright 2026 The Wavvon contributors
+
+This product includes software developed as part of the Wavvon project
+(https://github.com/Wavvon).

wavvon_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,158 @@
+Metadata-Version: 2.5
+Name: wavvon-sdk
+Version: 0.1.0
+Summary: Write programs (bots and apps) that talk to a Wavvon hub.
+Project-URL: Homepage, https://github.com/Wavvon/Wavvon-docs/blob/main/docs/sdk.md
+Project-URL: Repository, https://github.com/Wavvon/Wavvon-sdk-python
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Classifier: Framework :: AsyncIO
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: attrs>=22.2
+Requires-Dist: cryptography>=42
+Requires-Dist: httpx>=0.27
+Requires-Dist: python-dateutil>=2.8
+Requires-Dist: websockets>=13
+Description-Content-Type: text/markdown
+
+# wavvon-sdk
+
+Write programs that talk to a [Wavvon](https://github.com/Wavvon) hub: bots,
+apps with slash commands and buttons, event consumers, mini-app hosts, and
+receivers for outgoing webhooks.
+
+A program on Wavvon is a client like any other: an Ed25519 keypair, the same
+challenge-response login, the same permissions. There is no bot account. What
+makes a program an *app* is a role carrying `apps.register`. The design this
+package implements is
+[sdk.md](https://github.com/Wavvon/Wavvon-docs/blob/main/docs/sdk.md) (tier 1).
+
+- Python 3.11 or later, asyncio, fully typed (`py.typed`, checked with `mypy --strict`).
+- Depends on `httpx`, `websockets` and `cryptography`, plus `attrs`,
+  `python-dateutil` and `typing-extensions` for the generated REST models.
+- Apache-2.0, so a closed-source program can use it.
+
+## Install
+
+```sh
+pip install wavvon-sdk
+```
+
+The import package is `wavvon`.
+
+## Quick start
+
+```python
+import asyncio, os
+import uvicorn  # any ASGI server; or call the handler from your own framework
+from wavvon import WavvonClient, create_dispatch_handler, to_asgi
+
+
+async def main() -> None:
+    async with WavvonClient(
+        "https://hub.example",
+        seed=os.environ["WAVVON_SEED"],  # 32-byte Ed25519 seed, hex. Never sent anywhere.
+        invite_code=os.environ.get("WAVVON_INVITE"),  # only needed the first time, on an invite-only hub
+    ) as client:
+        info = await client.info()
+        app = to_asgi(
+            create_dispatch_handler(
+                hub_public_key=info["public_key"],
+                on_slash_command=lambda inv: {"reply": {"body": f"you said: {inv['args_raw']}"}},
+            )
+        )
+
+        await client.set_app_profile({"name": "Echo", "webhook_url": "https://bot.example/hook"})
+        await client.set_app_commands([{"name": "echo", "description": "Repeat after me"}])
+
+        events = client.connect()  # after set_app_profile, see below
+        events.on("message", lambda e: print(e["message"].get("sender"), e["message"].get("content")))
+        events.on("unknown", lambda e: print("new frame type:", e["raw_type"]))
+
+        await uvicorn.Server(uvicorn.Config(app, port=8080)).serve()
+
+
+asyncio.run(main())
+```
+
+A fuller one is [examples/echo_bot.py](examples/echo_bot.py).
+
+Every REST route is a generated function under `wavvon.rest.api`; pass
+`client.rest` and unwrap with `ok()`, which raises `HubError` on a refusal:
+
+```python
+from wavvon import ok
+from wavvon.rest.api.channels import list_channels
+
+channels = ok(await list_channels.asyncio_detailed(client=client.rest))
+```
+
+## What is in it
+
+| Piece | Entry point |
+|---|---|
+| Login (challenge, sign, verify) that renews itself | `WavvonClient`, `authenticate`, `identity_from_seed` |
+| Every REST route, typed from `openapi.yaml` | `wavvon.rest.api.*` with `client=client.rest`; `ok()` |
+| Retry with backoff on 429, 5xx, timeouts | built into `client.rest`; `fetch_with_retry` |
+| Capability checks | `client.has_capability`, `client.require_capability` |
+| Keyset paging to the end of a list | `paginate` (async iterator) |
+| WebSocket events with resume after reconnect | `client.connect()` -> `EventStream` |
+| HTTP polling instead of a socket | `client.poll_events`, `client.ack_events` |
+| App registration | `set_app_profile`, `set_app_commands`, `set_app_subscriptions` |
+| Slash command and button webhooks | `create_dispatch_handler`, `verify_dispatch`, `to_asgi` |
+| Outgoing webhook receiver | `verify_outgoing_webhook` |
+| Mini-app host | `EventStream.announce_app`, `dismiss_app`, `send_mini_app_message` |
+
+`create_dispatch_handler` returns a plain `async (method, headers, body) ->
+WebhookResponse` function, so it fits any framework; `to_asgi` wraps it for
+uvicorn, hypercorn, Starlette or FastAPI.
+
+## Capabilities each feature needs
+
+Hubs say what they support in `GET /info` `capabilities`. The SDK checks those
+strings and never compares version numbers. A feature the hub does not
+advertise raises `UnsupportedByHubError`.
+
+| Feature | Capability |
+|---|---|
+| `set_app_profile`, `set_app_commands`, `set_app_subscriptions`, embeds, game cards | `apps.register` |
+| `verify_dispatch` / `verify_outgoing_webhook` (they require `X-Wavvon-Signature-V1`) | `webhooks.signedtimestamp` |
+| Paging `GET /users`, `/conversations/{id}/messages`, `/admin/reports` | `list.cursor` |
+| Paging bans, mutes, invites, pending, conversations, pins, polls | `list.cursor.lists` |
+| `ping` / `pong` over the socket | `ws.ping` |
+
+Login, REST, the socket and polling need no capability.
+
+## Behaviour you can rely on
+
+- **A transient failure is never an answer.** 429, 5xx, timeouts and dropped
+  connections are retried with capped exponential backoff and jitter. If the
+  budget runs out you get `HubUnavailableError`, not an empty list or a 404.
+  Set `RetryOptions(max_attempts=math.inf)` to wait forever.
+- **Sessions renew themselves.** A 401 triggers one fresh login and a retry.
+  `client.on_state_change` and `events.on_state_change` show when it is happening.
+- **Unknown is delivered.** A socket frame or dispatch type this version does
+  not model reaches you as `{"type": "unknown", "raw_type": ..., "raw": ...}`.
+- **Missed events are replayed.** The event stream remembers the last
+  `hub_event` seq and asks the hub to resume from it after every reconnect.
+  If the gap is older than the hub keeps (72 hours) you get
+  `replay_unavailable`. Register the app profile before `connect()`: the hub
+  only pushes and replays events on a socket opened by a registered app.
+- **The seed stays with you.** No call sends a seed or private key anywhere.
+
+## Conformance
+
+Every signed byte sequence is checked against the shared wire vectors in
+Wavvon-server (`crates/identity/wire-vectors.json`): the auth challenge, the
+Ed25519 dispatch signature, and the outgoing-webhook HKDF + HMAC. CI reads them
+from Wavvon-server at commit `eb11d75657ee8362dd42a7982fc5b13a3dcc4e68`.
+
+The REST client was generated from Wavvon-docs at the commit in
+[src/wavvon/rest/SPEC_COMMIT](src/wavvon/rest/SPEC_COMMIT).
+
+## Licence
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).