Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -134,4 +134,6 @@ dmypy.json
.idea

# vscode specific
.vscode
.vscode

.tmp/
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,25 @@ Run the fast test suite with:
make test
```

### Agent signaling

KERIA can publish transient server-sent events for the connected agent at
`GET /signals/stream`. SignifyPy exposes this generic channel through
`client.signals()`.

The signaling API is deliberately separate from topic APIs:

- `client.signals().stream()` opens the authenticated SSE stream.
- `client.signals().verifyReplyEnvelope(envelope, route=...)` verifies that the
SSE payload is a KERI `rpy` envelope signed by the connected KERIA agent AID.
- Topic resources own durable fallback and approval behavior. For did:webs,
use `client.didwebs().requests()`, `client.didwebs().request(id)`, and
`client.didwebs().approve(request)`.

SSE delivery is not durable. A client that is offline or disconnected must poll
the relevant topic endpoint. For did:webs publication, the durable fallback is
`/didwebs/signing/requests`.

### Packaging

```bash
Expand Down
33 changes: 33 additions & 0 deletions docs/signify_app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,39 @@ signify.app.delegating
.. automodule:: signify.app.delegating
:members:

signify.app.signaling
---------------------

``signify.app.signaling`` is the generic KERIA agent signaling API for
SignifyPy. It is deliberately separate from topic helpers such as did:webs.

Ownership boundary:

- ``AgentSignals`` opens the authenticated ``GET /signals/stream`` SSE stream.
- ``AgentSignals`` verifies KERIA agent-signed KERI ``rpy`` envelopes.
- Topic modules interpret event names, expected reply routes, and payloads.
- Topic modules also own durable polling fallback because SSE delivery is
transient.

For did:webs publication, a live event should be verified with
``client.signals().verifyReplyEnvelope(envelope, route=DIDWEBS_SIGNING_ROUTE)``
before auto-approval. A disconnected client should recover through
``client.didwebs().requests()``.

.. automodule:: signify.app.signaling
:members:

signify.app.didwebing
---------------------

``signify.app.didwebing`` owns did:webs publication request polling and
approval. It does not own SSE transport. KERIA coordinates publication for
managed AIDs, but the Signify edge client remains the signer for registry
creation and designated-alias ACDC issuance.

.. automodule:: signify.app.didwebing
:members:

signify.app.exchanging
----------------------

Expand Down
8 changes: 7 additions & 1 deletion scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ To inspect the current live-scenario coverage:
material for integration scenarios.
- `keri/` keeps legacy config assets that may still be useful for reference
during future harness cleanup.
- `setup_vrd_projection_chain.py` is an operator setup tool, not test
coverage. It builds a real GEDA -> QVI -> LE -> VRD chain against a running
KERIA instance, writes the manifest consumed by W3C projection acceptance
work, and prints the LE wallet passcode for manual `signify-react-ts` login.

Verdict: do not add new integration workflows back under `scripts/`. New live
coverage belongs under `tests/integration`.
coverage belongs under `tests/integration`; durable operator setup tooling can
live here when it is meant to prepare a local environment for manual or
cross-repo acceptance.
Loading
Loading