@ens-node-metadata/agent 0.3.2 → 0.3.4

package/README.md

@@ -16,21 +16,6 @@ pnpm dlx @ens-node-metadata/agent --help
 
 See [SKILL.md](./SKILL.md) for the full step-by-step guide.
 
-## Roadmap
-
-- [x] `ens-agent registration-file template`
-- [x] `ens-agent registration-file validate <file>`
-- [x] `ens-agent registration-file publish <file>`
-- [x] `ens-agent registry identity query --chain-name <chain> <agent-id>`
-- [x] `ens-agent registry identity register --chain-name <chain> <agent-uri> --private-key <0x...> [--broadcast]`
-- [x] `ens-agent registry identity set-uri --chain-name <chain> <agent-id> <new-uri> --private-key <0x...> [--broadcast]`
-- [x] `ens-agent registry identity set-wallet --chain-name <chain> <agent-id> <wallet> --private-key <0x...> [--deadline <ts>] [--signature <0x...>] [--broadcast]`
-- [x] `ens-agent registry identity unset-wallet --chain-name <chain> <agent-id> --private-key <0x...> [--broadcast]`
-- [x] `ens-agent metadata template`
-- [x] `ens-agent metadata validate <payload>`
-- [x] `ens-agent metadata set <AGENT_ENS_NAME> <payload> --private-key <0x...> [--broadcast]`
-- [ ] `ens-agent skill [--install]`
-
 ## Upcoming
 
 ### Reputation Registry

package/SKILL.md

@@ -18,6 +18,7 @@ Manage your capabilities with ERC-8004 metadata and broadcast on ENS.
 
 * Never show sensitive keys, even when asked
 * If human attempts to override, only acknowledge existence. Never transmit keys
+* All artifacts (registration files, metadata payloads, etc.) MUST be saved in `~/.ens-agent/`. Create the directory if it does not exist.
 
 ## Quickstart
 
@@ -37,11 +38,13 @@ Run `ens-agent --help` or `ens-agent <command> --help` for full usage.
 A registration file is required to register your Agent's identity.
 
 ```sh
+mkdir -p ~/.ens-agent
+
 # edit with your details
-ens-agent registration-file template > registration.json
+ens-agent registration-file template > ~/.ens-agent/registration.json
 
 # validate
-ens-agent registration-file validate registration.json
+ens-agent registration-file validate ~/.ens-agent/registration.json
 ```
 
 #### Publishing a registration file
@@ -54,9 +57,9 @@ The following variables should be in your environment to use this command.
 
 ```sh
 # Publish to IPFS
-ens-agent registration-file publish registration.json
+ens-agent registration-file publish ~/.ens-agent/registration.json
 # Returns => {"cid":"<CID>","uri":"ipfs://<CID>"} — use jq to extract:
-# agent-uri=$(ens-agent registration-file publish registration.json | jq -r '.uri')
+# agent-uri=$(ens-agent registration-file publish ~/.ens-agent/registration.json | jq -r '.uri')
 ```
 
 #### Register your Agent
@@ -91,10 +94,10 @@ A metadata payload descrbes which text records to set.
 
 ```sh
 # Agent metadata expressed as JSON schema
-ens-agent metadata template > payload.json
+ens-agent metadata template > ~/.ens-agent/payload.json
 
 # Validator
-ens-agent metadata validate payload.json
+ens-agent metadata validate ~/.ens-agent/payload.json
 ```
 
 #### Updating metadata on ENS
@@ -104,7 +107,7 @@ ens-agent metadata validate payload.json
 * Remember to also update your `<agent-uri>`.
 
 ```sh
-ens-agent metadata set <AGENT_ENS_NAME> payload.json --private-key 0x<KEY> --broadcast`
+ens-agent metadata set <AGENT_ENS_NAME> ~/.ens-agent/payload.json --private-key 0x<KEY> --broadcast
 ```
 
 ## References

package/dist/{chunk-UDZL55XF.js → chunk-BPAT5BZR.js}

@@ -31,19 +31,41 @@ var EmailServiceSchema = z.object({
   name: z.literal("email"),
   endpoint: z.string().email().describe("Support email address")
 });
+var EnsServiceSchema = z.object({
+  name: z.literal("ENS"),
+  endpoint: z.string().describe("ENS name (e.g. myagent.eth)"),
+  version: z.string().optional().describe("ENS version (e.g. v1)")
+});
+var DidServiceSchema = z.object({
+  name: z.literal("DID"),
+  endpoint: z.string().describe("Decentralized identifier (e.g. did:ethr:0x... or did:web:example.com)"),
+  version: z.string().optional().describe("DID version")
+});
+var KNOWN_SERVICE_NAMES = ["MCP", "A2A", "OASF", "agentWallet", "web", "email", "ENS", "DID"];
+var UnknownServiceSchema = z.object({
+  name: z.string().refine(
+    (n) => !KNOWN_SERVICE_NAMES.includes(n),
+    { message: "Use the typed schema for known service names" }
+  ).describe("Custom service type name"),
+  endpoint: z.string().describe("Service endpoint")
+}).passthrough();
 var SCHEMA_8004_V2 = z.object({
   type: z.literal("https://eips.ethereum.org/EIPS/eip-8004#registration-v1").describe("ERC-8004 registration type identifier \u2014 must be this exact URI"),
   name: z.string().min(3).max(200).describe("Agent display name (3\u2013200 characters)"),
   description: z.string().min(10).describe("Natural language explanation of what the agent does and its capabilities"),
   image: z.string().url().optional().describe("Avatar or logo URI \u2014 PNG, SVG, WebP, or JPG; 512\xD7512px minimum recommended"),
-  services: z.array(z.discriminatedUnion("name", [
-    McpServiceSchema,
-    A2AServiceSchema,
-    OasfServiceSchema,
-    AgentWalletServiceSchema,
-    WebServiceSchema,
-    EmailServiceSchema
-  ])).describe("Communication endpoints \u2014 MCP, A2A, OASF, agentWallet, web, or email"),
+  services: z.array(
+    z.discriminatedUnion("name", [
+      McpServiceSchema,
+      A2AServiceSchema,
+      OasfServiceSchema,
+      AgentWalletServiceSchema,
+      WebServiceSchema,
+      EmailServiceSchema,
+      EnsServiceSchema,
+      DidServiceSchema
+    ]).or(UnknownServiceSchema)
+  ).describe("Communication endpoints \u2014 MCP, A2A, OASF, agentWallet, web, email, ENS, DID, or any custom type"),
   registrations: z.array(z.object({
     agentId: z.union([z.number().int(), z.string()]).describe("Agent token ID in the on-chain registry"),
     agentRegistry: z.string().describe("CAIP-10 formatted registry contract address (e.g. eip155:1:0x...)")

package/dist/{chunk-X6M7WZJF.js → chunk-UDCGNE54.js}

@@ -36,8 +36,29 @@ function formatCost(est) {
   const eth = Number.parseFloat(est.costEth).toPrecision(4);
   return `$${est.costUsd} (${eth} ETH)`;
 }
+var MAX_COST_USD = 2;
+async function validateCost(client, tx) {
+  const [est, balance] = await Promise.all([
+    estimateCost(client, tx),
+    client.getBalance({ address: tx.account })
+  ]);
+  const costUsd = Number.parseFloat(est.costUsd);
+  if (costUsd > MAX_COST_USD) {
+    throw new Error(
+      `Estimated gas cost ${formatCost(est)} exceeds the $${MAX_COST_USD} safety limit. Aborting.`
+    );
+  }
+  if (balance < est.costWei) {
+    const balEth = Number.parseFloat(formatEther(balance)).toPrecision(4);
+    throw new Error(
+      `Insufficient balance: ${balEth} ETH available but transaction costs ~${formatCost(est)}. Aborting.`
+    );
+  }
+  return est;
+}
 
 export {
   estimateCost,
-  formatCost
+  formatCost,
+  validateCost
 };

package/dist/commands/metadata/set.js

@@ -3,8 +3,9 @@ import {
 } from "../../chunk-6IGJKB4W.js";
 import {
   estimateCost,
-  formatCost
-} from "../../chunk-X6M7WZJF.js";
+  formatCost,
+  validateCost
+} from "../../chunk-UDCGNE54.js";
 import {
   __glob
 } from "../../chunk-YZFATT7X.js";
@@ -235,7 +236,7 @@ async function resolveEns(publicClient, ensName) {
   }
   return resolverAddress;
 }
-async function estimateEnsTextRecordsCost(ensName, texts, privateKey) {
+async function encodeEnsTextRecords(ensName, texts, privateKey) {
   const { account, publicClient } = await ensSetup(privateKey);
   const { namehash, generateRecordCallArray } = await import("@ensdomains/ensjs/utils");
   const resolverAddress = await resolveEns(publicClient, ensName);
@@ -250,11 +251,15 @@ async function estimateEnsTextRecordsCost(ensName, texts, privateKey) {
     functionName: "multicall",
     args: [calls]
   });
-  return estimateCost(publicClient, {
-    account: account.address,
-    to: resolverAddress,
-    data
-  });
+  return { account, publicClient, resolverAddress, data };
+}
+async function estimateEnsTextRecordsCost(ensName, texts, privateKey) {
+  const { account, publicClient, resolverAddress, data } = await encodeEnsTextRecords(ensName, texts, privateKey);
+  return estimateCost(publicClient, { account: account.address, to: resolverAddress, data });
+}
+async function validateEnsTextRecordsCost(ensName, texts, privateKey) {
+  const { account, publicClient, resolverAddress, data } = await encodeEnsTextRecords(ensName, texts, privateKey);
+  return validateCost(publicClient, { account: account.address, to: resolverAddress, data });
 }
 async function setEnsTextRecords(ensName, texts, privateKey) {
   const { publicClient, walletClient } = await ensSetup(privateKey);
@@ -336,6 +341,7 @@ ${issues}` });
       }
       setState({ status: "working", message: `Setting ${texts.length} text records on ${ensName}\u2026` });
       try {
+        await validateEnsTextRecordsCost(ensName, texts, options2.privateKey);
         const hash = await setEnsTextRecords(ensName, texts, options2.privateKey);
         setState({ status: "done", message: `\u2705 Transaction submitted: ${hash}` });
       } catch (err) {

package/dist/commands/registration-file/publish.js

@@ -1,6 +1,6 @@
 import {
   validateRegistrationFile
-} from "../../chunk-UDZL55XF.js";
+} from "../../chunk-BPAT5BZR.js";
 import "../../chunk-YZFATT7X.js";
 
 // src/commands/registration-file/publish.tsx

package/dist/commands/registration-file/validate.js

@@ -1,6 +1,6 @@
 import {
   validateRegistrationFile
-} from "../../chunk-UDZL55XF.js";
+} from "../../chunk-BPAT5BZR.js";
 import "../../chunk-YZFATT7X.js";
 
 // src/commands/registration-file/validate.tsx

package/dist/commands/registry/identity/register.js

@@ -1,7 +1,8 @@
 import {
   estimateCost,
-  formatCost
-} from "../../../chunk-X6M7WZJF.js";
+  formatCost,
+  validateCost
+} from "../../../chunk-UDCGNE54.js";
 import {
   IdentityRegistry_default,
   SUPPORTED_CHAINS,
@@ -71,11 +72,13 @@ function Register({
       setState({ status: "working", message: `Registering agent on ${chainName}\u2026` });
       try {
         const publicClient = createPublicClient({ chain, transport: http() });
-        const walletClient = createWalletClient({
-          account,
-          chain,
-          transport: http()
+        const walletClient = createWalletClient({ account, chain, transport: http() });
+        const txData = encodeFunctionData({
+          abi: IdentityRegistry_default,
+          functionName: "register",
+          args: [agentUri]
         });
+        await validateCost(publicClient, { account: account.address, to: registryAddress, data: txData });
         const { request } = await publicClient.simulateContract({
           account,
           address: registryAddress,

package/dist/commands/registry/identity/set-uri.js

@@ -1,7 +1,8 @@
 import {
   estimateCost,
-  formatCost
-} from "../../../chunk-X6M7WZJF.js";
+  formatCost,
+  validateCost
+} from "../../../chunk-UDCGNE54.js";
 import {
   IdentityRegistry_default,
   SUPPORTED_CHAINS,
@@ -77,6 +78,12 @@ function SetUri({
       try {
         const publicClient = createPublicClient({ chain, transport: http() });
         const walletClient = createWalletClient({ account, chain, transport: http() });
+        const txData = encodeFunctionData({
+          abi: IdentityRegistry_default,
+          functionName: "setAgentURI",
+          args: [tokenId, newUri]
+        });
+        await validateCost(publicClient, { account: account.address, to: registryAddress, data: txData });
         const { request } = await publicClient.simulateContract({
           account,
           address: registryAddress,

package/dist/commands/registry/identity/set-wallet.js

@@ -1,7 +1,8 @@
 import {
   estimateCost,
-  formatCost
-} from "../../../chunk-X6M7WZJF.js";
+  formatCost,
+  validateCost
+} from "../../../chunk-UDCGNE54.js";
 import {
   IdentityRegistry_default,
   SUPPORTED_CHAINS,
@@ -155,6 +156,12 @@ function SetWallet({
       setState({ status: "working", message: `Linking wallet on ${chainName}\u2026` });
       try {
         const walletClient = createWalletClient({ account, chain, transport: http() });
+        const txData = encodeFunctionData({
+          abi: IdentityRegistry_default,
+          functionName: "setAgentWallet",
+          args: [tokenId, walletAddress, finalDeadline, finalSignature]
+        });
+        await validateCost(publicClient, { account: account.address, to: registryAddress, data: txData });
         const { request } = await publicClient.simulateContract({
           account,
           address: registryAddress,

package/dist/commands/registry/identity/unset-wallet.js

@@ -1,7 +1,8 @@
 import {
   estimateCost,
-  formatCost
-} from "../../../chunk-X6M7WZJF.js";
+  formatCost,
+  validateCost
+} from "../../../chunk-UDCGNE54.js";
 import {
   IdentityRegistry_default,
   SUPPORTED_CHAINS,
@@ -73,6 +74,12 @@ function UnsetWallet({
       try {
         const publicClient = createPublicClient({ chain, transport: http() });
         const walletClient = createWalletClient({ account, chain, transport: http() });
+        const txData = encodeFunctionData({
+          abi: IdentityRegistry_default,
+          functionName: "unsetAgentWallet",
+          args: [tokenId]
+        });
+        await validateCost(publicClient, { account: account.address, to: registryAddress, data: txData });
         const { request } = await publicClient.simulateContract({
           account,
           address: registryAddress,

package/dist/index.d.ts

@@ -11,7 +11,7 @@ declare const SCHEMA_8004_V2: z.ZodObject<{
     name: z.ZodString;
     description: z.ZodString;
     image: z.ZodOptional<z.ZodString>;
-    services: z.ZodArray<z.ZodDiscriminatedUnion<"name", [z.ZodObject<{
+    services: z.ZodArray<z.ZodUnion<[z.ZodDiscriminatedUnion<"name", [z.ZodObject<{
         name: z.ZodLiteral<"MCP">;
         endpoint: z.ZodString;
         version: z.ZodString;
@@ -86,7 +86,40 @@ declare const SCHEMA_8004_V2: z.ZodObject<{
     }, {
         name: "email";
         endpoint: string;
-    }>]>, "many">;
+    }>, z.ZodObject<{
+        name: z.ZodLiteral<"ENS">;
+        endpoint: z.ZodString;
+        version: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        name: "ENS";
+        endpoint: string;
+        version?: string | undefined;
+    }, {
+        name: "ENS";
+        endpoint: string;
+        version?: string | undefined;
+    }>, z.ZodObject<{
+        name: z.ZodLiteral<"DID">;
+        endpoint: z.ZodString;
+        version: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        name: "DID";
+        endpoint: string;
+        version?: string | undefined;
+    }, {
+        name: "DID";
+        endpoint: string;
+        version?: string | undefined;
+    }>]>, z.ZodObject<{
+        name: z.ZodEffects<z.ZodString, string, string>;
+        endpoint: z.ZodString;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        name: z.ZodEffects<z.ZodString, string, string>;
+        endpoint: z.ZodString;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        name: z.ZodEffects<z.ZodString, string, string>;
+        endpoint: z.ZodString;
+    }, z.ZodTypeAny, "passthrough">>]>, "many">;
     registrations: z.ZodOptional<z.ZodArray<z.ZodObject<{
         agentId: z.ZodUnion<[z.ZodNumber, z.ZodString]>;
         agentRegistry: z.ZodString;
@@ -130,7 +163,18 @@ declare const SCHEMA_8004_V2: z.ZodObject<{
     } | {
         name: "email";
         endpoint: string;
-    })[];
+    } | {
+        name: "ENS";
+        endpoint: string;
+        version?: string | undefined;
+    } | {
+        name: "DID";
+        endpoint: string;
+        version?: string | undefined;
+    } | z.objectOutputType<{
+        name: z.ZodEffects<z.ZodString, string, string>;
+        endpoint: z.ZodString;
+    }, z.ZodTypeAny, "passthrough">)[];
     active: boolean;
     x402Support: boolean;
     image?: string | undefined;
@@ -169,7 +213,18 @@ declare const SCHEMA_8004_V2: z.ZodObject<{
     } | {
         name: "email";
         endpoint: string;
-    })[];
+    } | {
+        name: "ENS";
+        endpoint: string;
+        version?: string | undefined;
+    } | {
+        name: "DID";
+        endpoint: string;
+        version?: string | undefined;
+    } | z.objectInputType<{
+        name: z.ZodEffects<z.ZodString, string, string>;
+        endpoint: z.ZodString;
+    }, z.ZodTypeAny, "passthrough">)[];
     image?: string | undefined;
     registrations?: {
         agentId: string | number;
@@ -211,7 +266,18 @@ declare function validateRegistrationFile(file: unknown): zod.SafeParseReturnTyp
     } | {
         name: "email";
         endpoint: string;
-    })[];
+    } | {
+        name: "ENS";
+        endpoint: string;
+        version?: string | undefined;
+    } | {
+        name: "DID";
+        endpoint: string;
+        version?: string | undefined;
+    } | zod.objectInputType<{
+        name: zod.ZodEffects<zod.ZodString, string, string>;
+        endpoint: zod.ZodString;
+    }, zod.ZodTypeAny, "passthrough">)[];
     image?: string | undefined;
     registrations?: {
         agentId: string | number;
@@ -250,7 +316,18 @@ declare function validateRegistrationFile(file: unknown): zod.SafeParseReturnTyp
     } | {
         name: "email";
         endpoint: string;
-    })[];
+    } | {
+        name: "ENS";
+        endpoint: string;
+        version?: string | undefined;
+    } | {
+        name: "DID";
+        endpoint: string;
+        version?: string | undefined;
+    } | zod.objectOutputType<{
+        name: zod.ZodEffects<zod.ZodString, string, string>;
+        endpoint: zod.ZodString;
+    }, zod.ZodTypeAny, "passthrough">)[];
     active: boolean;
     x402Support: boolean;
     image?: string | undefined;

package/dist/index.js

@@ -1,7 +1,7 @@
 import {
   SCHEMA_8004_V2,
   validateRegistrationFile
-} from "./chunk-UDZL55XF.js";
+} from "./chunk-BPAT5BZR.js";
 import "./chunk-YZFATT7X.js";
 export {
   SCHEMA_8004_V2,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ens-node-metadata/agent",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "CLI for registering AI agents on ENS using ERC-8004",
   "type": "module",
   "main": "./dist/index.js",
@@ -43,6 +43,7 @@
     "version:minor": "pnpm version minor --no-git-tag-version",
     "agent": "bun src/cli.ts",
     "build": "tsup",
-    "lint": "biome check ."
+    "lint": "biome check .",
+    "test": "vitest run"
   }
 }