Skip to content

docs: fix gRPC signatures, DID parse, and TrustStore examples #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
beonde merged 2 commits into from
May 2, 2026
Merged

docs: fix gRPC signatures, DID parse, and TrustStore examples #58

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
390a07f
docs: fix gRPC method signatures to match implementation
beonde May 2, 2026
5e2a928
docs: fix DID parse example and TrustStore docs
beonde May 2, 2026
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
40 changes: 21 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,11 +442,14 @@ with CapiscioRPCClient() as client:
claims, error = client.badge.parse_badge(token)

# Request CA-signed badge
token, error = client.badge.request_badge(
success, result, error = client.badge.request_badge(
agent_id="my-agent-123",
api_key="capi_key_...",
ca_url="https://registry.capisc.io"
)
if success:
token = result["token"]
print(f"Badge expires: {result['expires_at']}")

# Start badge keeper (auto-renewal)
for event in client.badge.start_keeper(
Expand All @@ -456,8 +459,8 @@ with CapiscioRPCClient() as client:
ttl_seconds=300,
Comment on lines 455 to 459
renew_before_seconds=60
):
if event.event_type == "renewed":
print(f"Badge renewed: {event.badge_token}")
if event["type"] == "renewed":
print(f"Badge renewed: {event['token']}")
```

### 2. DIDService - DID Parsing
Expand All @@ -470,22 +473,23 @@ with CapiscioRPCClient() as client:
if did_info:
print(f"Method: {did_info['method']}") # "web"
print(f"Domain: {did_info['domain']}") # "registry.capisc.io"
print(f"Path: {did_info['path']}") # "agents/my-agent"
print(f"Document URL: {did_info['document_url']}") # "https://registry.capisc.io/agents/my-agent/did.json"
print(f"Path: {did_info['path']}") # ["agents", "my-agent"]

# Get document URL (separate call)
url, error = client.did.document_url("did:web:registry.capisc.io:agents:my-agent")
print(f"Document URL: {url}") # "https://registry.capisc.io/agents/my-agent/did.json"
```

### 3. TrustStoreService - Manage Trusted CA Keys

> **Note**: `add_key()` is not yet implemented (raises `NotImplementedError`).
> `is_trusted()` is available for checking trust status.

```python
with CapiscioRPCClient() as client:
# Add trusted CA key
kid, error = client.trust.add_key(
did="did:web:registry.capisc.io",
public_key=b'{"kty":"OKP",...}',
format="JWK"
)

print(f"Added key: {kid}")
# Check if a DID is in the trust store
trusted = client.trust.is_trusted("did:web:registry.capisc.io")
print(f"Trusted: {trusted}")
```

### 4. RevocationService - Check Revocation Status
Expand Down Expand Up @@ -543,10 +547,9 @@ with CapiscioRPCClient() as client:
)

# Verify a signature
valid, payload, error = client.simpleguard.verify(
valid, key_id, error = client.simpleguard.verify(
payload=b"important message",
signature=signature,
expected_payload=b"important message",
public_key_jwk='{"kty":"OKP",...}'
)

# Sign with attached payload (JWS Compact)
Expand All @@ -555,10 +558,9 @@ with CapiscioRPCClient() as client:
key_id="my-key-1"
)

# Verify attached signature
valid, payload, error = client.simpleguard.verify_attached(
# Verify attached signature (key resolved from JWS header)
valid, payload, key_id, error = client.simpleguard.verify_attached(
jws=jws,
public_key_jwk='{"kty":"OKP",...}'
)

# Get key information
Expand Down
Loading