Skip to main content

Confidential coprocessor client — compute on encrypted data via Koa's FHE service

Project description

koa-fhe

Confidential coprocessor client — compute on encrypted data via Koa's FHE service.

The server never sees plaintext. Your data is encrypted locally, evaluated under Fully Homomorphic Encryption, and decrypted locally. Every query costs $0.001–$0.10 USDC via x402.

Install

pip install koa-fhe            # core (compare, add, multiply, schedule analysis)
pip install koa-fhe[ml]        # + encrypted ML inference (XGBoost workload scoring)

CLI (Agent-to-Agent)

No install needed — run ephemeral via uvx:

uvx koa-fhe health                                    # service status
uvx koa-fhe compare 85 80                             # {"greater": true, ...}
uvx koa-fhe add 500 300                               # {"value": 800, ...}
uvx koa-fhe multiply 7 13                             # {"value": 91, ...}
uvx koa-fhe verify --circuit add --queries 5          # integrity check
uvx koa-fhe --server http://remote:3410 compare 85 80 # remote server

Every command outputs JSON to stdout. Exit code 1 if integrity verification fails. Agents can call this as a subprocess — no venv, no imports, no state management.

Also works with pipx run koa-fhe or python -m koa_fhe.

Python API

import koa_fhe

client = koa_fhe.Client()  # default: localhost:3410

# Encrypted comparison — server never sees 85 or 80
result = client.compare(85, 80)
print(result.greater)  # True

# Encrypted addition
result = client.add(500, 300)
print(result.value)  # 800

# Encrypted multiplication
result = client.multiply(7, 13)
print(result.value)  # 91

API Reference

Client(server, *, payment_proof)

Method Returns Latency Price
compare(a, b) CompareResult(greater, stats) ~625ms $0.002
add(a, b) ArithmeticResult(value, stats) ~260ms $0.001
multiply(a, b) ArithmeticResult(value, stats) ~685ms $0.002
measure_rigidity(old, new) RigidityResult(hamming_distance, rigidity_score, severity, stats) ~3.5s $0.05
analyze_schedule(old, new, *, constraints, alpha, beta) ScheduleAnalysis(objective, ...) ~5s $0.10
predict_workload(features) WorkloadPrediction(predictions, stats) ~7s $0.01
verify_integrity(circuit, n_queries, *, seed) IntegrityResult(passed, queries, proofs) varies same as circuit
health() ServiceHealth(status, circuits, ...) instant free
circuits() dict — circuit catalog with hashes, pricing instant free

Warm-up & Readiness

Key generation is the slowest step (~2-30s per circuit). Use warm_up() to pre-generate keys in background threads:

client = koa_fhe.Client()
client.warm_up(["add", "threshold"])  # keygen in background

# ... do other work ...

print(client.ready)  # {"add": True, "threshold": True}
result = client.add(1, 2)  # instant — keys already ready

Key Deduplication

Evaluation keys are content-addressed (SHA-256). If you create multiple Client instances with the same circuits, the SDK detects duplicate keys on the server via HEAD /keys/{circuit}?hash=... and reuses them — no redundant uploads.

How it works

  1. On first call, the SDK downloads circuit specs from the server
  2. Keys are generated locally — the server never sees your secret key
  3. Key hash is checked against server — if a matching key exists, it's reused
  4. Otherwise, keys are uploaded (with integrity verification via X-Content-Hash)
  5. Inputs are encrypted locally, sent as ciphertext
  6. Server evaluates the FHE circuit on ciphertext
  7. Encrypted result returns, SDK decrypts locally

Key setup is cached per circuit. Subsequent calls skip steps 1-4. Server-side key management enforces TTL (24h default) and per-circuit caps (10 keys max).

LangChain Integration

pip install koa-fhe[langchain]
from koa_fhe.langchain import koa_tools
from langchain.agents import initialize_agent, AgentType
from langchain_openai import ChatOpenAI

agent = initialize_agent(
    tools=koa_tools("http://your-koa-server:3410"),
    llm=ChatOpenAI(),
    agent=AgentType.OPENAI_FUNCTIONS,
)

agent.run("Is 85 greater than 80? Use encrypted comparison.")

Tools: koa_encrypted_compare, koa_encrypted_add, koa_encrypted_multiply, koa_encrypted_rigidity, koa_encrypted_schedule_analysis, koa_fhe_health.

Integrity Verification

Agents can verify that the FHE service computes correctly by interleaving trap queries — test vectors with known plaintext answers. Because FHE hides the inputs, the server cannot distinguish trap queries from real ones.

result = client.verify_integrity("add", n_queries=5, seed=42)
print(result.passed)   # True — all trap queries returned correct results
print(len(result.queries))  # 5

# If the server ever returns a wrong result:
if not result.passed:
    for proof in result.proofs:
        print(proof.circuit, proof.inputs, proof.expected, proof.actual)
        # → Submit proof to KoaIntegrity smart contract for on-chain slashing

Supported circuits: add, multiply, threshold. See contracts/KoaIntegrity.sol for the on-chain slashing mechanism.

Discovery

The FHE service exposes machine-readable metadata for agent-to-agent integration:

  • OpenAPI spec: GET /openapi.yaml
  • Service manifest: GET /.well-known/x402 — x402 payment info, service catalog, ERC-8004 identity
  • Agent aliases: /v1/confidential/{predicate,aggregate,arithmetic,rigidity,analysis,predict}

On-chain identity: ERC-8004 Agent #21648 on Base mainnet.

Dependencies

Core (pip install koa-fhe): concrete-python + numpy. Handles compare, add, multiply, rigidity, and schedule analysis.

ML (pip install koa-fhe[ml]): adds concrete-ml for encrypted XGBoost inference. This pulls in PyTorch, scikit-learn, etc. — only install if you need predict_workload().

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

koa_fhe-0.1.3.tar.gz (17.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

koa_fhe-0.1.3-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

Details for the file koa_fhe-0.1.3.tar.gz.

File metadata

  • Download URL: koa_fhe-0.1.3.tar.gz
  • Upload date:
  • Size: 17.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for koa_fhe-0.1.3.tar.gz
Algorithm Hash digest
SHA256 53bfd62b7e01c0f224cbecab9ddcf14980a39217ed28cf26cf1693cc3e6ef0d5
MD5 56b476cfce6e8bd26869a4f985df4d71
BLAKE2b-256 4a65a11b031dd08232a5a1a95589b4785a52743b24ee22477955475ed6e01c9c

See more details on using hashes here.

File details

Details for the file koa_fhe-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: koa_fhe-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 18.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for koa_fhe-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2d59ecea3c6085208652a3687322b531f30e64701fd741ebdcf1ac4b48822917
MD5 779b8201b2bc94a2cfabba3613a11afe
BLAKE2b-256 acfd922b151f34d160193510aae75179e4fc2135fb7ac92085df7262be64137b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page