@openserv-labs/client 2.0.2 → 2.1.1

package/README.md

@@ -307,6 +307,137 @@ console.log(`Pay to: ${preflight.x402WalletAddress}`)
 console.log(`Input schema: ${JSON.stringify(preflight.jsonSchema)}`)
 ```
 
+### ERC-8004 (Agent Identity)
+
+ERC-8004 is an on-chain agent identity standard. The `registerOnChain` method handles the entire flow in a single call -- building the agent card, uploading to IPFS, and registering on-chain.
+
+> **Note**: The wallet used for `registerOnChain` must have ETH for gas on the target chain (Base mainnet by default).
+
+```typescript
+// Register an agent on-chain in one call
+const result = await client.erc8004.registerOnChain({
+  workflowId: 123,
+  privateKey: process.env.WALLET_PRIVATE_KEY!,
+  name: 'My AI Agent',
+  description: 'An agent that does amazing things',
+})
+
+console.log(result.agentId)         // "8453:42"
+console.log(result.txHash)          // "0xabc..."
+console.log(result.ipfsCid)         // "bafkrei..."
+console.log(result.agentCardUrl)     // "https://gateway.pinata.cloud/ipfs/bafkrei..."
+console.log(result.blockExplorerUrl) // "https://basescan.org/tx/0xabc..."
+console.log(result.scanUrl)          // "https://www.8004scan.io/agents/base/42"
+```
+
+Under the hood, `registerOnChain` does the following:
+
+1. Reads the workspace wallet and callable triggers
+2. Builds the ERC-8004 agent card JSON (with services and wallet info)
+3. Uploads the agent card to IPFS via a presigned Pinata URL
+4. Registers on-chain (first deploy) or updates the URI (re-deploy)
+5. Saves the deployment state back to the platform
+
+Re-deploying (updating an existing registration) uses the same call -- it automatically detects whether the workspace already has an `erc8004AgentId` and uploads a fresh agent card with the latest name, description, services, and wallet info, then updates the on-chain URI to point to it. No new token is minted; only the metadata changes.
+
+#### Supported Chains
+
+`registerOnChain` defaults to Base mainnet (`chainId: 8453`). You can target any supported chain:
+
+```typescript
+// Deploy on a different chain
+const result = await client.erc8004.registerOnChain({
+  workflowId: 123,
+  privateKey: process.env.WALLET_PRIVATE_KEY!,
+  chainId: 42161,                              // Arbitrum One
+  rpcUrl: 'https://arb1.arbitrum.io/rpc',
+  name: 'My Agent',
+})
+```
+
+**Mainnets:** Ethereum (1), Base (8453), Polygon (137), Arbitrum One (42161), Celo (42220), Gnosis (100), Scroll (534352), Taiko (167000), BNB Smart Chain (56)
+
+**Testnets:** Ethereum Sepolia (11155111), Base Sepolia (84532), Polygon Amoy (80002), Arbitrum Sepolia (421614), Celo Alfajores (44787), Scroll Sepolia (534351), BNB Testnet (97)
+
+You can also query supported chains programmatically:
+
+```typescript
+import { listErc8004ChainIds, getErc8004Chain } from '@openserv-labs/client'
+
+const mainnets = listErc8004ChainIds('mainnet')  // [1, 8453, 137, ...]
+const testnets = listErc8004ChainIds('testnet')  // [11155111, 84532, ...]
+
+const baseConfig = getErc8004Chain(8453)
+console.log(baseConfig?.contracts.IDENTITY_REGISTRY)
+// "0x8004A169FB4a3325136EB29fA0ceB6D2e539a432"
+```
+
+#### Low-level ERC-8004 Operations
+
+For more control over individual steps, use the lower-level methods directly:
+
+```typescript
+// Generate a web3 wallet for the workspace
+const wallet = await client.erc8004.generateWallet({ workflowId: 123 })
+console.log('Wallet address:', wallet.address)
+
+// Import an existing wallet
+const imported = await client.erc8004.importWallet({
+  workflowId: 123,
+  address: '0x...',
+  network: 'base',
+  chainId: 8453,
+  privateKey: '0x...'
+})
+
+// Get the workspace wallet
+const existing = await client.erc8004.getWallet({ workflowId: 123 })
+console.log(existing.deployed, existing.erc8004AgentId)
+
+// Delete the workspace wallet
+await client.erc8004.deleteWallet({ workflowId: 123 })
+
+// Get a presigned IPFS URL for uploading the agent card
+const { url } = await client.erc8004.presignIpfsUrl({ workflowId: 123 })
+// Upload agent card to IPFS within 60 seconds using the signed URL
+
+// Deploy to ERC-8004 (before on-chain registration)
+await client.erc8004.deploy({
+  workflowId: 123,
+  erc8004AgentId: '',
+  stringifiedAgentCard: JSON.stringify(registrationFile),
+  walletAddress: '0x...',
+  network: 'base',
+  chainId: 8453,
+  rpcUrl: 'https://mainnet.base.org'
+})
+
+// Deploy to ERC-8004 (after on-chain registration, with tx hash)
+await client.erc8004.deploy({
+  workflowId: 123,
+  erc8004AgentId: '8453:42',
+  stringifiedAgentCard: JSON.stringify(updatedRegistrationFile),
+  latestDeploymentTransactionHash: '0xabc...',
+  latestDeploymentTimestamp: new Date(),
+  walletAddress: '0x...',
+  network: 'base',
+  chainId: 8453,
+  rpcUrl: 'https://mainnet.base.org'
+})
+
+// Get callable triggers for on-chain service registration
+const callableTriggers = await client.erc8004.getCallableTriggers({ workflowId: 123 })
+for (const trigger of callableTriggers) {
+  console.log(trigger.name, trigger.webEndpoint)
+}
+
+// Sign feedback auth for the reputation system
+const { signature } = await client.erc8004.signFeedbackAuth({
+  workflowId: 123,
+  buyerAddress: '0xBuyer...'
+})
+```
+
 ### Integrations
 
 Manage integration connections for triggers and external services.
@@ -556,9 +687,9 @@ triggers.webhook({
   description: 'Receives data from external systems for processing',
   input: { message: { type: 'string' } },
   waitForCompletion: true,
-  timeout: 180
+  timeout: 600
 })
-// { type: 'webhook', name: '...', waitForCompletion: true, timeout: 180, inputSchema: {...} }
+// { type: 'webhook', name: '...', waitForCompletion: true, timeout: 600, inputSchema: {...} }
 
 // Cron trigger
 triggers.cron({
@@ -647,6 +778,15 @@ import type {
   // x402 Payment types
   X402PaymentRequest,
   X402PaymentResult,
+  // ERC-8004 types
+  Erc8004DeployRequest,
+  RegisterOnChainResult,
+  Erc8004ChainConfig,
+  Web3Wallet,
+  ImportWeb3WalletRequest,
+  CallableTrigger,
+  PresignIpfsUrlResponse,
+  SignFeedbackAuthResponse,
   // Provision types
   ProvisionConfig,
   ProvisionResult,

package/dist/client.d.ts

@@ -6,6 +6,7 @@ import { TasksAPI } from "./tasks-api";
 import { WorkflowsAPI } from "./workflows-api";
 import { Web3API } from "./web3-api";
 import { PaymentsAPI } from "./payments-api";
+import { Erc8004API } from "./erc8004-api";
 /**
  * Client for interacting with the OpenServ Platform API.
  *
@@ -40,6 +41,8 @@ export declare class PlatformClient {
     readonly web3: Web3API;
     /** API for x402 payments to access paid workflows */
     readonly payments: PaymentsAPI;
+    /** API for ERC-8004 agent identity (deployment, wallets, IPFS, reputation) */
+    readonly erc8004: Erc8004API;
     /**
      * Get the raw axios client for advanced use cases.
      * @returns The underlying axios instance

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,KAAK,aAAa,EAAE,KAAK,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAE3E,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAK7C;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,UAAU,CAAgB;IAElC,gHAAgH;IAChH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,8BAA8B;IAC9B,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B,+CAA+C;IAC/C,QAAQ,CAAC,YAAY,EAAE,eAAe,CAAC;IACvC,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAC/B,sCAAsC;IACtC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IACzB,iCAAiC;IACjC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;IACjC,4CAA4C;IAC5C,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,qDAAqD;IACrD,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAE/B;;;OAGG;IACH,IAAI,SAAS,IAAI,aAAa,CAE7B;IAED;;;;;OAKG;IACG,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IAKnE;;;;;;OAMG;IACG,IAAI,CAAC,CAAC,EACV,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,EACd,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,CAAC,CAAC;IAKb;;;;;;OAMG;IACG,GAAG,CAAC,CAAC,EACT,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,EACd,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,CAAC,CAAC;IAKb;;;;;OAKG;IACG,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IAKtE;;;;;;OAMG;gBACS,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE;IAqB3D;;;;;;;;;;;;;;;;;OAiBG;IACG,YAAY,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAmExD;;;;;;;;OAQG;IACH,oBAAoB,IAAI,MAAM,GAAG,SAAS;CAO3C"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,KAAK,aAAa,EAAE,KAAK,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAE3E,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAK3C;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,UAAU,CAAgB;IAElC,gHAAgH;IAChH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,8BAA8B;IAC9B,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B,+CAA+C;IAC/C,QAAQ,CAAC,YAAY,EAAE,eAAe,CAAC;IACvC,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAC/B,sCAAsC;IACtC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IACzB,iCAAiC;IACjC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;IACjC,4CAA4C;IAC5C,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,qDAAqD;IACrD,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAC/B,8EAA8E;IAC9E,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAE7B;;;OAGG;IACH,IAAI,SAAS,IAAI,aAAa,CAE7B;IAED;;;;;OAKG;IACG,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IAKnE;;;;;;OAMG;IACG,IAAI,CAAC,CAAC,EACV,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,EACd,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,CAAC,CAAC;IAKb;;;;;;OAMG;IACG,GAAG,CAAC,CAAC,EACT,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,OAAO,EACd,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,CAAC,CAAC;IAKb;;;;;OAKG;IACG,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IAKtE;;;;;;OAMG;gBACS,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE;IAsB3D;;;;;;;;;;;;;;;;;OAiBG;IACG,YAAY,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAmExD;;;;;;;;OAQG;IACH,oBAAoB,IAAI,MAAM,GAAG,SAAS;CAO3C"}

package/dist/client.js

@@ -13,6 +13,7 @@ const tasks_api_1 = require("./tasks-api");
 const workflows_api_1 = require("./workflows-api");
 const web3_api_1 = require("./web3-api");
 const payments_api_1 = require("./payments-api");
+const erc8004_api_1 = require("./erc8004-api");
 const PLATFORM_URL = process.env.OPENSERV_API_URL || "https://api.openserv.ai";
 /**
  * Client for interacting with the OpenServ Platform API.
@@ -48,6 +49,8 @@ class PlatformClient {
     web3;
     /** API for x402 payments to access paid workflows */
     payments;
+    /** API for ERC-8004 agent identity (deployment, wallets, IPFS, reputation) */
+    erc8004;
     /**
      * Get the raw axios client for advanced use cases.
      * @returns The underlying axios instance
@@ -121,6 +124,7 @@ class PlatformClient {
         this.workflows = new workflows_api_1.WorkflowsAPI(this);
         this.web3 = new web3_api_1.Web3API(this);
         this.payments = new payments_api_1.PaymentsAPI(this);
+        this.erc8004 = new erc8004_api_1.Erc8004API(this);
     }
     /**
      * Authenticate using an Ethereum wallet (SIWE - EIP-4361).

package/dist/erc8004-abi.d.ts

@@ -0,0 +1,113 @@
+/**
+ * Minimal IdentityRegistry ABI for ERC-8004 on-chain operations.
+ *
+ * Contains only the functions needed for agent registration:
+ * - register() — mint a new agent NFT
+ * - setAgentURI() — set/update the IPFS URI for an agent
+ * - tokenURI() — read the current URI (for verification)
+ * - Registered event — extract agentId from registration receipt
+ * - Transfer event — fallback for extracting agentId
+ *
+ * Sourced from the full ABI in the OpenServ monorepo:
+ * packages/ai/agent0/core/contracts.ts
+ */
+export declare const IDENTITY_REGISTRY_ABI: readonly [{
+    readonly inputs: readonly [];
+    readonly name: "register";
+    readonly outputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "agentId";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "agentId";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "string";
+        readonly name: "newURI";
+        readonly type: "string";
+    }];
+    readonly name: "setAgentURI";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "tokenId";
+        readonly type: "uint256";
+    }];
+    readonly name: "tokenURI";
+    readonly outputs: readonly [{
+        readonly internalType: "string";
+        readonly name: "";
+        readonly type: "string";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly internalType: "uint256";
+        readonly name: "agentId";
+        readonly type: "uint256";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "string";
+        readonly name: "agentURI";
+        readonly type: "string";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "owner";
+        readonly type: "address";
+    }];
+    readonly name: "Registered";
+    readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly internalType: "uint256";
+        readonly name: "agentId";
+        readonly type: "uint256";
+    }, {
+        readonly indexed: false;
+        readonly internalType: "string";
+        readonly name: "newURI";
+        readonly type: "string";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "updatedBy";
+        readonly type: "address";
+    }];
+    readonly name: "URIUpdated";
+    readonly type: "event";
+}, {
+    readonly anonymous: false;
+    readonly inputs: readonly [{
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "from";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "address";
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly indexed: true;
+        readonly internalType: "uint256";
+        readonly name: "tokenId";
+        readonly type: "uint256";
+    }];
+    readonly name: "Transfer";
+    readonly type: "event";
+}];
+//# sourceMappingURL=erc8004-abi.d.ts.map

package/dist/erc8004-abi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"erc8004-abi.d.ts","sourceRoot":"","sources":["../src/erc8004-abi.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0GxB,CAAC"}

package/dist/erc8004-abi.js

@@ -0,0 +1,123 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IDENTITY_REGISTRY_ABI = void 0;
+/**
+ * Minimal IdentityRegistry ABI for ERC-8004 on-chain operations.
+ *
+ * Contains only the functions needed for agent registration:
+ * - register() — mint a new agent NFT
+ * - setAgentURI() — set/update the IPFS URI for an agent
+ * - tokenURI() — read the current URI (for verification)
+ * - Registered event — extract agentId from registration receipt
+ * - Transfer event — fallback for extracting agentId
+ *
+ * Sourced from the full ABI in the OpenServ monorepo:
+ * packages/ai/agent0/core/contracts.ts
+ */
+exports.IDENTITY_REGISTRY_ABI = [
+    // register() — no-args overload, mints a new agent ID
+    {
+        inputs: [],
+        name: "register",
+        outputs: [{ internalType: "uint256", name: "agentId", type: "uint256" }],
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+    // setAgentURI(uint256 agentId, string newURI)
+    {
+        inputs: [
+            { internalType: "uint256", name: "agentId", type: "uint256" },
+            { internalType: "string", name: "newURI", type: "string" },
+        ],
+        name: "setAgentURI",
+        outputs: [],
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+    // tokenURI(uint256 tokenId) — read the IPFS URI for verification
+    {
+        inputs: [{ internalType: "uint256", name: "tokenId", type: "uint256" }],
+        name: "tokenURI",
+        outputs: [{ internalType: "string", name: "", type: "string" }],
+        stateMutability: "view",
+        type: "function",
+    },
+    // Registered event — emitted on register()
+    {
+        anonymous: false,
+        inputs: [
+            {
+                indexed: true,
+                internalType: "uint256",
+                name: "agentId",
+                type: "uint256",
+            },
+            {
+                indexed: false,
+                internalType: "string",
+                name: "agentURI",
+                type: "string",
+            },
+            {
+                indexed: true,
+                internalType: "address",
+                name: "owner",
+                type: "address",
+            },
+        ],
+        name: "Registered",
+        type: "event",
+    },
+    // URIUpdated event — emitted on setAgentURI()
+    {
+        anonymous: false,
+        inputs: [
+            {
+                indexed: true,
+                internalType: "uint256",
+                name: "agentId",
+                type: "uint256",
+            },
+            {
+                indexed: false,
+                internalType: "string",
+                name: "newURI",
+                type: "string",
+            },
+            {
+                indexed: true,
+                internalType: "address",
+                name: "updatedBy",
+                type: "address",
+            },
+        ],
+        name: "URIUpdated",
+        type: "event",
+    },
+    // Transfer event (ERC-721) — fallback for extracting agentId
+    {
+        anonymous: false,
+        inputs: [
+            {
+                indexed: true,
+                internalType: "address",
+                name: "from",
+                type: "address",
+            },
+            {
+                indexed: true,
+                internalType: "address",
+                name: "to",
+                type: "address",
+            },
+            {
+                indexed: true,
+                internalType: "uint256",
+                name: "tokenId",
+                type: "uint256",
+            },
+        ],
+        name: "Transfer",
+        type: "event",
+    },
+];