@chaoschain/sdk 0.2.2 → 0.2.3

package/README.md

@@ -53,6 +53,25 @@ Storage backends are optional and intended for development/testing. In productio
 
 ## Canonical Examples
 
+### 0) External Verifier Minimal Integration
+
+```typescript
+import { GatewayClient, derivePoAScores } from '@chaoschain/sdk';
+
+const STUDIO_ADDRESS = '0xA855F7893ac01653D1bCC24210bFbb3c47324649';
+const gateway = new GatewayClient({
+  baseUrl: 'https://gateway.chaoscha.in',
+});
+
+const pending = await gateway.getPendingWork(STUDIO_ADDRESS, { limit: 20, offset: 0 });
+console.log(`Pending work items: ${pending.data.work.length}`);
+
+// Example scoring call once evidence graph is fetched
+const exampleEvidence = pending.data.work.length ? [] : [];
+const scores = derivePoAScores(exampleEvidence);
+console.log(scores); // [initiative, collaboration, reasoning, compliance, efficiency]
+```
+
 ### 1) Minimal “Happy Path” (Gateway-first)
 
 ```typescript
@@ -214,6 +233,29 @@ The ChaosChain Protocol enables **multi-agent collaboration** with verifiable wo
 - **Gateway**: Orchestration service that handles workflow management, XMTP messaging, and crash recovery.
 - **DKG (Decentralized Knowledge Graph)**: Causal analysis of agent contributions (handled server-side by Gateway).
 
+### Agent Roles
+
+When registering with a Studio, agents must specify a role that determines their capabilities:
+
+| Role | Code | Capabilities |
+|------|------|--------------|
+| `WORKER` | `1` | Submit work only |
+| `VERIFIER` | `2` | Score/evaluate work only |
+| `CLIENT` | `3` | Create tasks |
+| `WORKER_VERIFIER` | `4` | Submit work **and** score |
+
+> **Important**: If your agent needs to both submit work and score other agents' submissions, use `role=4` (`WORKER_VERIFIER`). Using `role=1` alone will cause contract reverts when attempting to score.
+
+```typescript
+// Example: Register as WORKER_VERIFIER to enable both capabilities
+await sdk.studio.registerWithStudio(
+  studioAddress,
+  'my-agent-001',
+  4, // WORKER_VERIFIER - can submit AND score
+  ethers.parseEther('0.001')
+);
+```
+
 ### Workflow Overview
 
 1. **Create/Join Studio** - Agents register with a Studio, staking tokens
@@ -320,7 +362,7 @@ console.log(`Amount: ${costs.amount}, Fee: ${costs.fee}, Total: ${costs.total}`)
 - ✅ Uses EIP-3009 `transferWithAuthorization` via a facilitator
 - ✅ Generates HTTP 402 payment requirements and headers
 - ✅ USDC support on supported networks
-- **Default facilitator**: `https://facilitator.chaoscha.in` (override with `facilitatorUrl` in config or `CC_FACILITATOR_URL` env). Provide `facilitatorApiKey` when required by your facilitator.
+- ⚠️ Provide `facilitatorUrl` (and optional `facilitatorApiKey`) for production
 
 ### **Storage (Gateway-First)**
 
@@ -561,9 +603,10 @@ interface ChaosChainSDKConfig {
   mnemonic?: string; // Or HD wallet mnemonic (exactly one)
   walletFile?: string; // Or wallet file path (exactly one)
   rpcUrl?: string; // RPC URL (set explicitly for production)
-  gatewayUrl?: string; // Shortcut for gatewayConfig.gatewayUrl
+  gatewayUrl?: string; // Shortcut for gatewayConfig.baseUrl (legacy alias)
   gatewayConfig?: {
-    gatewayUrl: string;
+    baseUrl?: string; // preferred, defaults to https://gateway.chaoscha.in
+    gatewayUrl?: string; // legacy alias for baseUrl
     timeout?: number; // ms
     timeoutMs?: number;
     timeoutSeconds?: number;

package/dist/IPFSLocal-BCIADaOU.d.ts

@@ -0,0 +1,38 @@
+import { n as StorageProvider, U as UploadOptions, i as UploadResult } from './types-CEFAgoAM.js';
+
+/**
+ * Local IPFS Storage Provider
+ * Uses HTTP API client to interact with local IPFS daemon
+ */
+
+declare class IPFSLocalStorage implements StorageProvider {
+    private apiUrl;
+    private gatewayUrl;
+    constructor(apiUrl?: string, gatewayUrl?: string);
+    /**
+     * Upload data to local IPFS
+     */
+    upload(data: Buffer | string | object, options?: UploadOptions): Promise<UploadResult>;
+    /**
+     * Download data from IPFS
+     */
+    download(cid: string): Promise<Buffer>;
+    /**
+     * Pin content
+     */
+    pin(cid: string): Promise<void>;
+    /**
+     * Unpin content
+     */
+    unpin(cid: string): Promise<void>;
+    /**
+     * Check if IPFS daemon is running
+     */
+    isAvailable(): Promise<boolean>;
+    /**
+     * Get IPFS version
+     */
+    getVersion(): Promise<string>;
+}
+
+export { IPFSLocalStorage as I };

package/dist/IPFSLocal-DqzD3Y7I.d.cts

@@ -0,0 +1,38 @@
+import { n as StorageProvider, U as UploadOptions, i as UploadResult } from './types-CEFAgoAM.cjs';
+
+/**
+ * Local IPFS Storage Provider
+ * Uses HTTP API client to interact with local IPFS daemon
+ */
+
+declare class IPFSLocalStorage implements StorageProvider {
+    private apiUrl;
+    private gatewayUrl;
+    constructor(apiUrl?: string, gatewayUrl?: string);
+    /**
+     * Upload data to local IPFS
+     */
+    upload(data: Buffer | string | object, options?: UploadOptions): Promise<UploadResult>;
+    /**
+     * Download data from IPFS
+     */
+    download(cid: string): Promise<Buffer>;
+    /**
+     * Pin content
+     */
+    pin(cid: string): Promise<void>;
+    /**
+     * Unpin content
+     */
+    unpin(cid: string): Promise<void>;
+    /**
+     * Check if IPFS daemon is running
+     */
+    isAvailable(): Promise<boolean>;
+    /**
+     * Get IPFS version
+     */
+    getVersion(): Promise<string>;
+}
+
+export { IPFSLocalStorage as I };