@aixyz/erc-8004 0.0.6

package/dist/src/schemas/registration.d.ts

@@ -0,0 +1,219 @@
+import { z } from "zod";
+/**
+ * ERC-8004 Raw Agent Registration File Schema
+ * For parsing raw registration files fetched from IPFS/URIs
+ *
+ * Based on: https://github.com/erc-8004/erc-8004-contracts/blob/093d7b91eb9c22048d411896ed397d695742a5f8/ERC8004SPEC.md#agent-uri-and-agent-registration-file
+ */
+export declare const ERC8004_REGISTRATION_TYPE = "https://eips.ethereum.org/EIPS/eip-8004#registration-v1";
+/**
+ * Supported trust mechanisms for agent validation
+ */
+export declare const TrustMechanismSchema: z.ZodEnum<{
+    reputation: "reputation";
+    "crypto-economic": "crypto-economic";
+    "tee-attestation": "tee-attestation";
+    social: "social";
+    governance: "governance";
+}>;
+/**
+ * Service/Endpoint - represents a single service endpoint
+ * Examples: MCP server, A2A endpoint, web interface, OASF spec
+ */
+export declare const ServiceSchema: z.ZodObject<{
+    name: z.ZodString;
+    endpoint: z.ZodURL;
+    version: z.ZodOptional<z.ZodString>;
+    skills: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    domains: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    tools: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    prompts: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    resources: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * Registration entry - links to agent registrations on other chains
+ * Format: { agentId: "123", agentRegistry: "eip155:1:0x..." }
+ */
+export declare const RegistrationEntrySchema: z.ZodObject<{
+    agentId: z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<number, string | number>>, z.ZodNumber>;
+    agentRegistry: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Raw Agent Registration File Schema
+ * For parsing registration files fetched from IPFS/URIs
+ */
+export declare const RawAgentRegistrationFileSchema: z.ZodObject<{
+    type: z.ZodOptional<z.ZodString>;
+    $schema: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    description: z.ZodString;
+    image: z.ZodString;
+    services: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        endpoint: z.ZodURL;
+        version: z.ZodOptional<z.ZodString>;
+        skills: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        domains: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        tools: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        prompts: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        resources: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>>;
+    endpoints: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        endpoint: z.ZodURL;
+        version: z.ZodOptional<z.ZodString>;
+        skills: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        domains: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        tools: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        prompts: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        resources: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>>;
+    active: z.ZodOptional<z.ZodBoolean>;
+    x402support: z.ZodOptional<z.ZodBoolean>;
+    x402Support: z.ZodOptional<z.ZodBoolean>;
+    registrations: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        agentId: z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<number, string | number>>, z.ZodNumber>;
+        agentRegistry: z.ZodString;
+    }, z.core.$strip>>>;
+    supportedTrust: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    ens: z.ZodOptional<z.ZodString>;
+    did: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Strict Schema - for creating new registration files
+ * Requires correct type literal and at least one service
+ */
+export declare const StrictAgentRegistrationFileSchema: z.ZodObject<{
+    $schema: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    description: z.ZodString;
+    image: z.ZodString;
+    endpoints: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        endpoint: z.ZodURL;
+        version: z.ZodOptional<z.ZodString>;
+        skills: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        domains: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        tools: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        prompts: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        resources: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>>;
+    active: z.ZodOptional<z.ZodBoolean>;
+    x402support: z.ZodOptional<z.ZodBoolean>;
+    x402Support: z.ZodOptional<z.ZodBoolean>;
+    registrations: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        agentId: z.ZodPipe<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>, z.ZodTransform<number, string | number>>, z.ZodNumber>;
+        agentRegistry: z.ZodString;
+    }, z.core.$strip>>>;
+    supportedTrust: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    ens: z.ZodOptional<z.ZodString>;
+    did: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"https://eips.ethereum.org/EIPS/eip-8004#registration-v1">;
+    services: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        endpoint: z.ZodURL;
+        version: z.ZodOptional<z.ZodString>;
+        skills: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        domains: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        tools: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        prompts: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        resources: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type TrustMechanism = z.infer<typeof TrustMechanismSchema>;
+export type Service = z.infer<typeof ServiceSchema>;
+export type RegistrationEntry = z.infer<typeof RegistrationEntrySchema>;
+export type RawAgentRegistrationFile = z.infer<typeof RawAgentRegistrationFileSchema>;
+export type StrictAgentRegistrationFile = z.infer<typeof StrictAgentRegistrationFileSchema>;
+/**
+ * Parse a raw registration file
+ * Use for existing/untrusted data fetched from IPFS/URIs - won't throw on malformed input
+ */
+export declare function parseRawRegistrationFile(data: unknown): z.ZodSafeParseResult<{
+    name: string;
+    description: string;
+    image: string;
+    type?: string | undefined;
+    $schema?: string | undefined;
+    services?: {
+        name: string;
+        endpoint: string;
+        version?: string | undefined;
+        skills?: string[] | undefined;
+        domains?: string[] | undefined;
+        tools?: string[] | undefined;
+        prompts?: string[] | undefined;
+        resources?: string[] | undefined;
+    }[] | undefined;
+    endpoints?: {
+        name: string;
+        endpoint: string;
+        version?: string | undefined;
+        skills?: string[] | undefined;
+        domains?: string[] | undefined;
+        tools?: string[] | undefined;
+        prompts?: string[] | undefined;
+        resources?: string[] | undefined;
+    }[] | undefined;
+    active?: boolean | undefined;
+    x402support?: boolean | undefined;
+    x402Support?: boolean | undefined;
+    registrations?: {
+        agentId: number;
+        agentRegistry: string;
+    }[] | undefined;
+    supportedTrust?: string[] | undefined;
+    ens?: string | undefined;
+    did?: string | undefined;
+}>;
+/**
+ * Validate a registration file with strict validation
+ * Use when creating or submitting new registration files
+ */
+export declare function validateRegistrationFile(data: unknown): z.ZodSafeParseResult<{
+    name: string;
+    description: string;
+    image: string;
+    type: "https://eips.ethereum.org/EIPS/eip-8004#registration-v1";
+    services: {
+        name: string;
+        endpoint: string;
+        version?: string | undefined;
+        skills?: string[] | undefined;
+        domains?: string[] | undefined;
+        tools?: string[] | undefined;
+        prompts?: string[] | undefined;
+        resources?: string[] | undefined;
+    }[];
+    $schema?: string | undefined;
+    endpoints?: {
+        name: string;
+        endpoint: string;
+        version?: string | undefined;
+        skills?: string[] | undefined;
+        domains?: string[] | undefined;
+        tools?: string[] | undefined;
+        prompts?: string[] | undefined;
+        resources?: string[] | undefined;
+    }[] | undefined;
+    active?: boolean | undefined;
+    x402support?: boolean | undefined;
+    x402Support?: boolean | undefined;
+    registrations?: {
+        agentId: number;
+        agentRegistry: string;
+    }[] | undefined;
+    supportedTrust?: string[] | undefined;
+    ens?: string | undefined;
+    did?: string | undefined;
+}>;
+/**
+ * Get services from a registration file
+ * Handles both `services` (new) and `endpoints` (legacy) field names
+ */
+export declare function getServices(file: RawAgentRegistrationFile | StrictAgentRegistrationFile): Service[];
+/**
+ * Check if agent supports x402 payment protocol
+ * Handles both `x402support` and `x402Support` casing variants
+ */
+export declare function hasX402Support(file: RawAgentRegistrationFile | StrictAgentRegistrationFile): boolean;

package/dist/src/schemas/registration.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StrictAgentRegistrationFileSchema = exports.RawAgentRegistrationFileSchema = exports.RegistrationEntrySchema = exports.ServiceSchema = exports.TrustMechanismSchema = exports.ERC8004_REGISTRATION_TYPE = void 0;
+exports.parseRawRegistrationFile = parseRawRegistrationFile;
+exports.validateRegistrationFile = validateRegistrationFile;
+exports.getServices = getServices;
+exports.hasX402Support = hasX402Support;
+const zod_1 = require("zod");
+/**
+ * ERC-8004 Raw Agent Registration File Schema
+ * For parsing raw registration files fetched from IPFS/URIs
+ *
+ * Based on: https://github.com/erc-8004/erc-8004-contracts/blob/093d7b91eb9c22048d411896ed397d695742a5f8/ERC8004SPEC.md#agent-uri-and-agent-registration-file
+ */
+// =============================================================================
+// Constants
+// =============================================================================
+exports.ERC8004_REGISTRATION_TYPE = "https://eips.ethereum.org/EIPS/eip-8004#registration-v1";
+// =============================================================================
+// Building Block Schemas
+// =============================================================================
+/**
+ * Supported trust mechanisms for agent validation
+ */
+exports.TrustMechanismSchema = zod_1.z.enum([
+    "reputation",
+    "crypto-economic",
+    "tee-attestation",
+    "social",
+    "governance",
+]);
+/**
+ * Service/Endpoint - represents a single service endpoint
+ * Examples: MCP server, A2A endpoint, web interface, OASF spec
+ */
+exports.ServiceSchema = zod_1.z.object({
+    name: zod_1.z.string(),
+    endpoint: zod_1.z.url(),
+    version: zod_1.z.string().optional(),
+    // OASF-specific fields
+    skills: zod_1.z.array(zod_1.z.string()).optional(),
+    domains: zod_1.z.array(zod_1.z.string()).optional(),
+    // MCP-specific fields
+    tools: zod_1.z.array(zod_1.z.string()).optional(),
+    prompts: zod_1.z.array(zod_1.z.string()).optional(),
+    resources: zod_1.z.array(zod_1.z.string()).optional(),
+});
+/**
+ * Registration entry - links to agent registrations on other chains
+ * Format: { agentId: "123", agentRegistry: "eip155:1:0x..." }
+ */
+exports.RegistrationEntrySchema = zod_1.z.object({
+    agentId: zod_1.z
+        .union([zod_1.z.string().trim().regex(/^\d+$/), zod_1.z.number()])
+        .transform((val) => Number(val))
+        .pipe(zod_1.z.number().int().nonnegative()),
+    agentRegistry: zod_1.z.string(),
+});
+// =============================================================================
+// Main Schemas
+// =============================================================================
+/**
+ * Raw Agent Registration File Schema
+ * For parsing registration files fetched from IPFS/URIs
+ */
+exports.RawAgentRegistrationFileSchema = zod_1.z.object({
+    // Schema identifiers
+    type: zod_1.z.string().optional(),
+    $schema: zod_1.z.string().optional(),
+    // ERC-721 metadata compatibility (required)
+    name: zod_1.z.string(),
+    description: zod_1.z.string(),
+    image: zod_1.z.string(),
+    // Service endpoints
+    services: zod_1.z.array(exports.ServiceSchema).optional(),
+    endpoints: zod_1.z.array(exports.ServiceSchema).optional(), // Legacy field name
+    // Agent configuration
+    active: zod_1.z.boolean().optional(),
+    x402support: zod_1.z.boolean().optional(),
+    x402Support: zod_1.z.boolean().optional(), // Alternative casing
+    // Cross-chain & identity
+    registrations: zod_1.z.array(exports.RegistrationEntrySchema).optional(),
+    supportedTrust: zod_1.z.array(zod_1.z.string()).optional(),
+    ens: zod_1.z.string().optional(),
+    did: zod_1.z.string().optional(),
+});
+/**
+ * Strict Schema - for creating new registration files
+ * Requires correct type literal and at least one service
+ */
+exports.StrictAgentRegistrationFileSchema = exports.RawAgentRegistrationFileSchema.extend({
+    type: zod_1.z.literal(exports.ERC8004_REGISTRATION_TYPE),
+    services: zod_1.z.array(exports.ServiceSchema).min(1, "At least one service endpoint is required"),
+});
+// =============================================================================
+// Helper Functions
+// =============================================================================
+/**
+ * Parse a raw registration file
+ * Use for existing/untrusted data fetched from IPFS/URIs - won't throw on malformed input
+ */
+function parseRawRegistrationFile(data) {
+    return exports.RawAgentRegistrationFileSchema.safeParse(data);
+}
+/**
+ * Validate a registration file with strict validation
+ * Use when creating or submitting new registration files
+ */
+function validateRegistrationFile(data) {
+    return exports.StrictAgentRegistrationFileSchema.safeParse(data);
+}
+/**
+ * Get services from a registration file
+ * Handles both `services` (new) and `endpoints` (legacy) field names
+ */
+function getServices(file) {
+    return file.services ?? file.endpoints ?? [];
+}
+/**
+ * Check if agent supports x402 payment protocol
+ * Handles both `x402support` and `x402Support` casing variants
+ */
+function hasX402Support(file) {
+    return file.x402support === true || file.x402Support === true;
+}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@aixyz/erc-8004",
+  "version": "0.0.6",
+  "description": "Shared ERC-8004 contract ABIs, addresses, and Solidity sources for the aixyz ecosystem.",
+  "homepage": "https://github.com/AgentlyHQ/aixyz#readme",
+  "bugs": {
+    "url": "https://github.com/AgentlyHQ/aixyz/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AgentlyHQ/aixyz.git"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "kevzzsk"
+  },
+  "type": "commonjs",
+  "exports": {
+    ".": {
+      "require": "./dist/src/index.js",
+      "default": "./dist/src/index.js"
+    },
+    "./*": {
+      "require": "./dist/src/*.js",
+      "default": "./dist/src/*.js"
+    }
+  },
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "files": [
+    "dist",
+    "contracts"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "bun test"
+  },
+  "dependencies": {
+    "zod": "^4.3.6"
+  }
+}