@agether/agether 1.0.0 → 1.2.0

package/README.md

@@ -1,4 +1,4 @@
-# @agether/openclaw-plugin
+# @agether/agether
 
 OpenClaw plugin for **Agether** — on-chain credit protocol for AI agents on Base.
 
@@ -11,7 +11,7 @@ OpenClaw plugin for **Agether** — on-chain credit protocol for AI agents on Ba
 ## Install
 
 ```bash
-openclaw plugins install @agether/openclaw-plugin
+openclaw plugins install @agether/agether
 ```
 
 ## Configure
@@ -61,35 +61,35 @@ Once installed, the following tools are available to your AI agent:
 |---|---|
 | `agether_balance` | Check ETH & USDC balances (EOA + AgentAccount) |
 | `agether_register` | Mint ERC-8004 identity & create AgentAccount |
+| `agether_set_agent` | Set a known agentId (from memory) and save to config |
 | `agether_score` | Get Bayesian credit score with 5-factor breakdown |
 | `morpho_status` | Show all Morpho credit positions |
+| `morpho_markets` | List supported Morpho Blue markets |
 | `morpho_deposit` | Deposit collateral (WETH, wstETH, cbETH) |
 | `morpho_deposit_and_borrow` | Deposit collateral + borrow USDC in one step |
-| `morpho_sponsor` | Human deposits collateral for an agent (by ID or address) |
 | `morpho_borrow` | Borrow USDC against deposited collateral |
 | `morpho_repay` | Repay USDC debt |
 | `morpho_withdraw` | Withdraw collateral back to EOA |
-| `morpho_compare` | Compare collateral options with current prices |
-| `morpho_markets` | List supported Morpho Blue markets |
+| `morpho_sponsor` | Human deposits collateral for an agent (by ID or address) |
 | `wallet_fund` | Transfer USDC from EOA into AgentAccount |
 | `x402_pay` | Make paid API calls via x402 protocol (supports auto-draw) |
 
-## Commands
+## Slash Commands
 
-Quick commands that run without AI:
+Quick commands that run without AI reasoning:
 
 - `/balance` — wallet balances
 - `/morpho` — Morpho positions overview
 
 ## Quick Start
 
-1. Install the plugin: `openclaw plugins install @agether/openclaw-plugin`
+1. Install: `openclaw plugins install @agether/agether`
 2. Add config to `~/.openclaw/openclaw.json` (see above)
 3. Restart: `openclaw gateway --force`
-4. Open Telegram and send to your bot: *"What is my balance?"*
-5. Ask: *"Register me as an agent on Agether"*
-6. Fund your wallet with ETH (for gas) and WETH/wstETH/cbETH (for collateral)
-7. Ask: *"Deposit 0.05 WETH and borrow $50 USDC"*
+4. Open Telegram → *"What is my balance?"*
+5. *"Register me as an agent on Agether"*
+6. Fund your wallet with ETH (gas) + WETH/wstETH/cbETH (collateral)
+7. *"Deposit 0.05 WETH and borrow $50 USDC"*
 
 ## Getting Collateral on Base
 
@@ -105,9 +105,11 @@ Quick commands that run without AI:
 | `rpcUrl` | — | `https://base-rpc.publicnode.com` | Base RPC endpoint |
 | `backendUrl` | — | `http://95.179.189.214:3001` | Agether backend API |
 | `autoDraw` | — | `false` | Auto-borrow from credit line when USDC is insufficient for x402 payments |
+| `agentId` | — | — | Pre-set agent ID (auto-saved after registration) |
 
 ## Links
 
+- [Agether Dashboard](http://95.179.189.214) — Web UI
 - [Agether SDK](https://www.npmjs.com/package/@agether/sdk) — CLI + TypeScript clients
 - [ERC-8004 Standard](https://eips.ethereum.org/EIPS/eip-8004) — Agent Identity
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agether/agether",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "OpenClaw plugin for Agether — on-chain credit for AI agents",
   "main": "src/index.ts",
   "openclaw": {
@@ -9,7 +9,7 @@
     ]
   },
   "dependencies": {
-    "@agether/sdk": "^1.6.5",
+    "@agether/sdk": "^1.9.0",
     "axios": "^1.6.0",
     "ethers": "^6.9.0"
   },
@@ -23,8 +23,13 @@
     "credit",
     "defi"
   ],
+  "scripts": {
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
   "license": "MIT",
   "devDependencies": {
-    "typescript": "^5.9.3"
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
   }
 }

package/src/index.ts

@@ -129,11 +129,16 @@ export default function register(api: any) {
         const client = createClient(cfg);
         const result = await client.register(params.name);
         const persistStatus = persistAgentId(result.agentId);
+        const kyaMessage = result.kyaRequired
+          ? "⚠️ KYA required: submit your agent code hash for review before using credit"
+          : "✅ KYA gate disabled — agent can use credit immediately";
         return ok(JSON.stringify({
           status: result.alreadyRegistered ? "already_registered" : "registered",
           agentId: result.agentId,
           address: result.address,
           agentAccount: result.agentAccount,
+          kyaRequired: result.kyaRequired,
+          kyaMessage,
           tx: result.tx ? txLink(result.tx) : undefined,
           configSaved: persistStatus,
         }));
@@ -177,6 +182,86 @@ export default function register(api: any) {
     },
   });
 
+  // ═══════════════════════════════════════════════════════
+  //  TOOL: agether_kya_status
+  // ═══════════════════════════════════════════════════════
+  api.registerTool({
+    name: "agether_kya_status",
+    description:
+      "Check if KYA code verification is required for this deployment.",
+    parameters: { type: "object", properties: {}, required: [] },
+    async execute() {
+      try {
+        const cfg = getConfig(api);
+        const client = createClient(cfg);
+        const required = await client.isKyaRequired();
+        return ok(
+          required
+            ? "KYA verification is ENABLED — agents must have code approved before using credit"
+            : "KYA verification is DISABLED — agents can use credit immediately after registration",
+        );
+      } catch (e) { return fail(e); }
+    },
+  });
+
+  // ═══════════════════════════════════════════════════════
+  //  TOOL: agether_set_kya
+  // ═══════════════════════════════════════════════════════
+  api.registerTool({
+    name: "agether_set_kya",
+    description:
+      "Enable or disable KYA verification gate (owner only). " +
+      "Pass the ValidationRegistry address to enable, or '0x0000000000000000000000000000000000000000' to disable. " +
+      "Note: the actual transaction must be executed by the owner (TimelockController).",
+    parameters: {
+      type: "object",
+      properties: {
+        registryAddress: {
+          type: "string",
+          description:
+            "Address of ValidationRegistry, or '0x0000000000000000000000000000000000000000' to disable",
+        },
+      },
+      required: ["registryAddress"],
+    },
+    async execute(_id: string, params: { registryAddress: string }) {
+      try {
+        const cfg = getConfig(api);
+        const client = createClient(cfg);
+
+        // Build the calldata for setValidationRegistry — the owner (Timelock) must execute it
+        const { ethers } = await import("ethers");
+        const iface = new ethers.Interface([
+          "function setValidationRegistry(address newRegistry)",
+        ]);
+        const calldata = iface.encodeFunctionData("setValidationRegistry", [
+          params.registryAddress,
+        ]);
+
+        const isDisabling =
+          params.registryAddress === ethers.ZeroAddress;
+        const action = isDisabling ? "DISABLE" : "ENABLE";
+
+        return ok(
+          JSON.stringify(
+            {
+              action: `${action} KYA gate`,
+              registryAddress: params.registryAddress,
+              calldata,
+              note:
+                "This calldata must be submitted to the TimelockController by the owner. " +
+                "Schedule via timelock.schedule(accountFactoryAddr, 0, calldata, predecessor, salt, delay).",
+            },
+            null,
+            2,
+          ),
+        );
+      } catch (e) {
+        return fail(e);
+      }
+    },
+  });
+
   // ═══════════════════════════════════════════════════════
   //  TOOL: morpho_status
   // ═══════════════════════════════════════════════════════

package/test/kya.test.ts

@@ -0,0 +1,157 @@
+/**
+ * KYA gate feature — unit tests for plugin tools.
+ *
+ * Mocks MorphoClient so no blockchain connection is needed.
+ */
+
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+
+// ── Mock state ──
+
+const mockIsKyaRequired = vi.fn<() => Promise<boolean>>();
+const mockRegister = vi.fn();
+const mockGetBalances = vi.fn();
+const mockGetAgentId = vi.fn().mockReturnValue('12345');
+const mockGetAccountAddress = vi.fn().mockResolvedValue('0xAGENTACCOUNT');
+
+vi.mock('@agether/sdk', () => {
+  // MorphoClient must work with `new` — use a class
+  class MockMorphoClient {
+    isKyaRequired = mockIsKyaRequired;
+    register = mockRegister;
+    getBalances = mockGetBalances;
+    getAgentId = mockGetAgentId;
+    getAccountAddress = mockGetAccountAddress;
+  }
+  class MockX402Client {}
+  return {
+    MorphoClient: MockMorphoClient,
+    X402Client: MockX402Client,
+  };
+});
+
+// Suppress fs.readFileSync for persistAgentId
+vi.mock('fs', async (importOriginal) => {
+  const orig = await importOriginal<typeof import('fs')>();
+  return {
+    ...orig,
+    default: {
+      ...orig,
+      readFileSync: vi.fn().mockReturnValue('{}'),
+      writeFileSync: vi.fn(),
+    },
+    readFileSync: vi.fn().mockReturnValue('{}'),
+    writeFileSync: vi.fn(),
+  };
+});
+
+import registerPlugin from '../src/index';
+
+// ── Helpers ──
+
+/** Minimal mock for the OpenClaw plugin API */
+function createMockApi(config?: Record<string, any>) {
+  const tools = new Map<string, { execute: Function }>();
+  return {
+    config: {
+      plugins: {
+        entries: {
+          agether: {
+            config: {
+              privateKey: '0x' + 'ab'.repeat(32),
+              agentId: '12345',
+              rpcUrl: 'http://127.0.0.1:8545',
+              backendUrl: 'http://localhost:3001',
+              ...config,
+            },
+          },
+        },
+      },
+    },
+    registerTool(def: { name: string; execute: Function }) {
+      tools.set(def.name, def);
+    },
+    registerCommand() { /* noop */ },
+    getTool(name: string) {
+      return tools.get(name);
+    },
+  };
+}
+
+// ── Tests ──
+
+describe('agether_kya_status tool', () => {
+  let api: ReturnType<typeof createMockApi>;
+
+  beforeEach(() => {
+    vi.clearAllMocks();
+    api = createMockApi();
+    registerPlugin(api);
+  });
+
+  it('returns DISABLED message when isKyaRequired = false', async () => {
+    mockIsKyaRequired.mockResolvedValue(false);
+
+    const tool = api.getTool('agether_kya_status')!;
+    const result = await tool.execute();
+
+    expect(result.content[0].text).toContain('DISABLED');
+    expect(result.isError).toBeUndefined();
+  });
+
+  it('returns ENABLED message when isKyaRequired = true', async () => {
+    mockIsKyaRequired.mockResolvedValue(true);
+
+    const tool = api.getTool('agether_kya_status')!;
+    const result = await tool.execute();
+
+    expect(result.content[0].text).toContain('ENABLED');
+    expect(result.isError).toBeUndefined();
+  });
+});
+
+describe('agether_register kyaMessage', () => {
+  let api: ReturnType<typeof createMockApi>;
+
+  beforeEach(() => {
+    vi.clearAllMocks();
+    api = createMockApi();
+    registerPlugin(api);
+  });
+
+  it('includes "gate disabled" kyaMessage when kyaRequired = false', async () => {
+    mockRegister.mockResolvedValue({
+      agentId: '99999',
+      address: '0xWALLET',
+      agentAccount: '0xACCOUNT',
+      alreadyRegistered: false,
+      kyaRequired: false,
+      tx: '0xTXHASH',
+    });
+
+    const tool = api.getTool('agether_register')!;
+    const result = await tool.execute('test-id', { name: 'TestAgent' });
+    const data = JSON.parse(result.content[0].text);
+
+    expect(data.kyaRequired).toBe(false);
+    expect(data.kyaMessage).toContain('gate disabled');
+  });
+
+  it('includes "KYA required" kyaMessage when kyaRequired = true', async () => {
+    mockRegister.mockResolvedValue({
+      agentId: '99999',
+      address: '0xWALLET',
+      agentAccount: '0xACCOUNT',
+      alreadyRegistered: false,
+      kyaRequired: true,
+      tx: '0xTXHASH',
+    });
+
+    const tool = api.getTool('agether_register')!;
+    const result = await tool.execute('test-id', { name: 'TestAgent' });
+    const data = JSON.parse(result.content[0].text);
+
+    expect(data.kyaRequired).toBe(true);
+    expect(data.kyaMessage).toContain('KYA required');
+  });
+});

package/vitest.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globals: true,
+    testTimeout: 10_000,
+  },
+});