@rubric-protocol/sdk 1.0.4 → 1.0.5

package/README.md

@@ -1,107 +1,109 @@
-# @tempus-protocol/sdk
+# @rubric-protocol/sdk
 
-TypeScript SDK for TEMPUS Protocol — post-quantum attestation infrastructure for AI agents on Hedera.
+Post-quantum AI attestation with ZK inclusion proofs.
+
+Rubric Protocol is the independent witness layer for the AI economy - providing tamper-evident, independently verifiable audit trails for AI decisions, anchored to Hedera Consensus Service.
+
+## Installation
+
+    npm install @rubric-protocol/sdk
 
 ## Quick Start
 
-\`\`\`typescript
-import { TempusClient } from '@tempus-protocol/sdk';
+    import { RubricClient } from "@rubric-protocol/sdk";
+    const client = new RubricClient({
+      baseUrl: "https://rubric-protocol.com/verify",
+      apiKey: "your-api-key",
+    });
 
-const tempus = new TempusClient({ baseUrl: 'https://api.tempusprotocol.com/v1', apiKey: 'your-key' });
-const task = await tempus.tasks.submit({ type: 'compute', description: 'VWAP for HBAR/USD' });
-const proof = await tempus.proof.get(task.attestation?.hcs_sequence!);
-\`\`\`
+Get an API key at https://rubric-protocol.com
 
-## Installation
+## Core Concepts
+
+Every AI decision submitted to Rubric receives:
+
+1. An attestation record - signed with ML-DSA-65 (NIST FIPS 204 post-quantum signature)
+2. A Merkle inclusion - aggregated into a cryptographic tree and anchored to Hedera Consensus Service
+3. A ZK inclusion proof - independently verifiable proof your record was included in the anchored tree
+
+The ZK proof means you hold cryptographic evidence of your record that does not require Rubric to verify.
+
+## Submitting Attestations
+
+    const result = await client.attestations.tieredAttest({
+      data: { model: "gpt-4o", decision: "approved", confidence: 0.94 },
+      sourceId: "your-system-id",
+      pipelineId: "my-pipeline",
+    });
+    console.log(result.attestationId); // retain this
+    console.log(result.status);        // buffered
+
+## Retrieving ZK Inclusion Proofs
+
+The proof generates asynchronously after the ~30s Merkle flush. Use the built-in polling helper:
+
+    const proof = await client.attestations.getZkProof(result.attestationId, {
+      timeoutMs: 120_000,  // default 120s
+      intervalMs: 10_000,  // default 10s
+    });
+    console.log(proof.status);           // ready
+    console.log(proof.proof.zkRoot);     // Poseidon2 Merkle root
+    console.log(proof.proof.zkPath);     // 20-level inclusion path
+    console.log(proof.proof.zkLeaf);     // your record leaf hash
+    console.log(proof.hcsSeqNum);        // HCS sequence number
+    console.log(proof.verifyEndpoint);   // endpoint to verify this proof
+
+HTTP status codes: 202 = pending (retry), 200 = ready, 404 = not found
+
+## ZK Proof Response Fields
+
+  status          ready or pending
+  attestationId   your record ID
+  flushId         Merkle batch ID
+  hcsSeqNum       HCS sequence number (populated ~60s after submission)
+  hcsExplorerUrl  Hashscan link for on-chain verification
+  proof.zkLeaf    BN254 field element - your record leaf hash
+  proof.zkRoot    Poseidon2 Merkle root - matches HCS anchor
+  proof.zkPath    20-element sibling path
+  proof.zkIndices left/right indices per level
+  proof.leafIndex your position in the Merkle tree
+  circuitVersion  noir-beta19-poseidon2-depth20
+
+## Full Example
+
+    import { RubricClient } from "@rubric-protocol/sdk";
+    const client = new RubricClient({
+      baseUrl: "https://rubric-protocol.com/verify",
+      apiKey: process.env.RUBRIC_API_KEY,
+    });
+    const attest = await client.attestations.tieredAttest({
+      data: { model: "claude-3-5-sonnet", action: "content_moderation", result: "approved" },
+      sourceId: "my-ai-system",
+    });
+    const proof = await client.attestations.getZkProof(attest.attestationId);
+    console.log("zkRoot:   ", proof.proof.zkRoot);
+    console.log("leafIndex:", proof.proof.leafIndex);
+    console.log("hcsSeqNum:", proof.hcsSeqNum ?? "pending");
+
+## EU AI Act Article 12 Compliance
+
+Rubric satisfies the tamper-evident logging requirements of EU AI Act Article 12 for high-risk AI systems.
+
+- Timestamp independence: consensus timestamps generated by Hedera network, not Rubric
+- Structural immutability: HCS has no DELETE or UPDATE operation by design
+- Third-party verifiability: records verifiable against Hedera public mirror nodes without Rubric
+- Post-quantum integrity: ML-DSA-65 signatures valid against quantum adversaries
+- ZK inclusion proofs: customers hold independent cryptographic evidence of inclusion
+
+## Framework Integrations
+
+    pip install autogen-rubric
+
+Supports AutoGen, LlamaIndex, CrewAI, LangGraph, OpenAI Agents SDK, Google ADK, and more.
+
+## Support
+
+Website: https://rubric-protocol.com
+Email: scott@rubric-protocol.com
 
-\`\`\`bash
-npm install @tempus-protocol/sdk
-\`\`\`
-
-## Usage
-
-### Submit a task and get attestation
-
-\`\`\`typescript
-const task = await tempus.tasks.submit({
-  type: 'compute',
-  description: 'HBAR/USD volume-weighted average',
-  priority: 'high',
-  capabilities_required: ['price-feed', 'aggregation'],
-  parameters: {
-    pair: 'HBAR/USD',
-    sources: ['binance', 'coinbase', 'kraken'],
-  },
-});
-
-// Poll for completion
-const detail = await tempus.tasks.get(task.id);
-console.log(detail.result);
-console.log(detail.attestation);
-\`\`\`
-
-### Register an agent
-
-\`\`\`typescript
-const agent = await tempus.agents.register({
-  name: 'My Price Agent',
-  capabilities: ['price-feed', 'aggregation'],
-  description: 'Fetches and aggregates crypto prices',
-  version: '1.0.0',
-});
-
-// Heartbeat loop
-setInterval(() => {
-  tempus.agents.heartbeat(agent.id, { status: 'idle', max_concurrent: 3 });
-}, 30000);
-\`\`\`
-
-### Verify an attestation
-
-\`\`\`typescript
-// Public — no API key required
-const proof = await tempus.proof.get(73);
-console.log(proof.verification.is_valid);
-console.log(proof.verification.hedera_explorer_url);
-\`\`\`
-
-### Create a pipeline
-
-\`\`\`typescript
-const pipeline = await tempus.pipelines.create({
-  name: 'HBAR Price Oracle',
-  steps: [
-    { name: 'fetch', type: 'fetch', capabilities_required: ['price-feed'] },
-    { name: 'aggregate', type: 'compute', input_from: 'fetch' },
-    { name: 'attest', type: 'attest', input_from: 'aggregate' },
-  ],
-});
-await tempus.pipelines.start(pipeline.id);
-\`\`\`
-
-### Browse marketplace
-
-\`\`\`typescript
-const { agents } = await tempus.marketplace.browse({
-  capability: 'price-feed',
-  min_reputation: 70,
-  sort: 'reputation',
-});
-\`\`\`
-
-## All Services
-
-| Service | Methods |
-|---------|---------|
-| \`tempus.health\` | \`check()\`, \`protocol()\`, \`stats()\` |
-| \`tempus.tasks\` | \`list()\`, \`submit()\`, \`batch()\`, \`get()\`, \`bid()\`, \`assign()\`, \`submitResult()\`, \`cancel()\` |
-| \`tempus.agents\` | \`list()\`, \`register()\`, \`get()\`, \`update()\`, \`delete()\`, \`heartbeat()\`, \`reputation()\` |
-| \`tempus.proof\` | \`get()\` |
-| \`tempus.pipelines\` | \`list()\`, \`create()\`, \`get()\`, \`start()\`, \`submitStepResult()\` |
-| \`tempus.marketplace\` | \`browse()\`, \`getAgent()\`, \`getReviews()\`, \`submitReview()\`, \`upsertProfile()\`, \`categories()\`, \`featured()\`, \`stats()\` |
-| \`tempus.analytics\` | \`get()\`, \`economics()\`, \`events()\`, \`leaderboard()\`, \`dashboard()\` |
-| \`tempus.admin\` | \`listKeys()\`, \`createKey()\`, \`revokeKey()\`, \`retryQueue()\`, \`webhooks()\` |
-
-## License
-
-MIT — Echelon Intelligence Systems LLC
+Built by Echelon Intelligence Group.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rubric-protocol/sdk",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Rubric Protocol SDK \u2014 post-quantum AI attestation with ZK inclusion proofs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",