@peridot-agent/agent-kit 0.2.0

package/dist/types-Cg95um6s.d.ts

@@ -0,0 +1,212 @@
+import { Address, Hex } from 'viem';
+import { z } from 'zod';
+
+interface PeridotConfig {
+    /** Peridot platform API base URL. Defaults to https://app.peridot.finance */
+    apiBaseUrl?: string;
+    /** Required for cross-chain operations (Biconomy compose/status). */
+    biconomyApiKey?: string;
+    /** Optional RPC URL overrides for direct contract reads. */
+    rpcUrls?: Partial<Record<number, string>>;
+    /** Defaults to 'mainnet'. */
+    network?: 'mainnet' | 'testnet';
+}
+/**
+ * Feature categories — new feature modules (margin, liquidations) add their
+ * own category here so the MCP server and adapters can filter by category.
+ */
+type ToolCategory = 'lending' | 'margin' | 'liquidations' | 'info' | 'status';
+interface ToolDefinition<TInput = unknown, TOutput = unknown> {
+    name: string;
+    description: string;
+    /** Zod schema used for runtime validation and LLM schema generation. */
+    inputSchema: z.ZodType<TInput>;
+    execute: (input: TInput, config: PeridotConfig) => Promise<TOutput> | TOutput;
+    category: ToolCategory;
+}
+interface MarketRates {
+    asset: string;
+    chainId: number;
+    /** Base lending supply APY from the interest rate model. */
+    supplyApyPct: number;
+    /** Base lending borrow APY from the interest rate model. */
+    borrowApyPct: number;
+    /** Additional supply APY paid in PERIDOT/ASTER rewards. */
+    peridotSupplyApyPct: number;
+    /** PERIDOT/ASTER rewards that offset the borrow cost. */
+    peridotBorrowApyPct: number;
+    /** Supply APY from an external boost source (Morpho vault, PancakeSwap LP fees, Magma staking). */
+    boostSourceSupplyApyPct: number;
+    /** Additional reward APY for boosted markets (e.g. Morpho reward tokens). */
+    boostRewardsSupplyApyPct: number;
+    /** Total supply APY = base + peridot + boost_source + boost_rewards. */
+    totalSupplyApyPct: number;
+    /** Net borrow APY = base borrow APY − peridot borrow reward APY. */
+    netBorrowApyPct: number;
+    tvlUsd: number;
+    utilizationPct: number;
+    liquidityUsd: number;
+    priceUsd: number;
+    collateralFactorPct: number;
+    updatedAt: string;
+    /** Seconds elapsed since updatedAt. Use this to detect stale market data. */
+    dataAgeSeconds: number;
+    /**
+     * False when the APY table has no entry for this asset/chain.
+     * All APY fields will be 0 — do NOT present them as real rates.
+     * Inform the user that yield data is not yet available.
+     */
+    apyDataAvailable: boolean;
+    /** Present when apyDataAvailable=false or data is unusually stale (>5 min). */
+    warning?: string | undefined;
+}
+interface MarketSummary {
+    asset: string;
+    chainId: number;
+    priceUsd: number;
+    tvlUsd: number;
+    utilizationPct: number;
+    liquidityUsd: number;
+    collateralFactorPct: number;
+    updatedAt: string;
+    /** Seconds elapsed since updatedAt. Values above 300 indicate a stale data feed. */
+    dataAgeSeconds: number;
+}
+interface LeaderboardEntry {
+    rank: number;
+    address: string;
+    totalPoints: number;
+    supplyCount: number;
+    borrowCount: number;
+    repayCount: number;
+    redeemCount: number;
+    updatedAt: string;
+}
+interface UserPosition {
+    address: string;
+    totalSuppliedUsd: number;
+    totalBorrowedUsd: number;
+    netWorthUsd: number;
+    netApyPct: number;
+    /** Simplified ratio: totalSupplied / totalBorrowed. Null when no debt. */
+    healthFactor: number | null;
+    assets: Array<{
+        assetId: string;
+        suppliedUsd: number;
+        borrowedUsd: number;
+        netUsd: number;
+    }>;
+    transactions: {
+        supplyCount: number;
+        borrowCount: number;
+        repayCount: number;
+        redeemCount: number;
+    };
+    /** ISO timestamp of when this data was fetched. Portfolio data is indexed from chain events
+     *  and may lag recent on-chain activity by up to ~60 seconds. */
+    fetchedAt: string;
+}
+interface SimulateBorrowResult {
+    currentHealthFactor: number | null;
+    projectedHealthFactor: number | null;
+    borrowAmountUsd: number;
+    isSafe: boolean;
+    riskLevel: 'safe' | 'moderate' | 'high' | 'critical' | 'liquidatable';
+    /** Maximum additional safe borrow in USD before health factor drops below 1.5 */
+    maxSafeBorrowUsd: number;
+    warning?: string | undefined;
+}
+interface AccountLiquidity {
+    address: string;
+    chainId: number;
+    /** Excess borrowing capacity in USD (0 means at limit). */
+    liquidityUsd: number;
+    /** How far underwater in USD (0 means healthy). */
+    shortfallUsd: number;
+    isHealthy: boolean;
+}
+interface LiquidatableAccount {
+    address: string;
+    chainId: number;
+    /** Remaining borrow capacity (0 when underwater). */
+    liquidityUsd: number;
+    /** How far underwater in USD — positive means liquidatable. */
+    shortfallUsd: number;
+    /** When this account was last health-checked by the scanner. */
+    checkedAt: string;
+}
+interface LiquidatablePositions {
+    accounts: LiquidatableAccount[];
+    count: number;
+}
+/** A single on-chain call within an intent. */
+interface TransactionCall {
+    to: Address;
+    data: Hex;
+    value: bigint;
+    description: string;
+}
+/**
+ * Hub-chain intent — same-chain actions (user is already on BSC/Monad/Somnia).
+ * The `calls` array must be executed in order. User signs each with their wallet.
+ */
+interface HubTransactionIntent {
+    type: 'hub';
+    chainId: number;
+    calls: TransactionCall[];
+    summary: string;
+    /** Present when the action carries liquidation risk. */
+    warning?: string;
+}
+/**
+ * Cross-chain intent — user is on a spoke chain (Arbitrum, Base, etc.).
+ * Built via Biconomy MEE compose. The user does NOT sign individual calls;
+ * they sign the single Biconomy execute payload in their wallet/dApp.
+ */
+interface CrossChainIntent {
+    type: 'cross-chain';
+    sourceChainId: number;
+    destinationChainId: number;
+    summary: string;
+    /** Human-readable steps shown to the user before they sign. */
+    userSteps: string[];
+    /** The raw response from Biconomy /compose — pass this to /execute. */
+    biconomyInstructions: BiconomyResponse;
+    estimatedGas: string;
+}
+type TransactionIntent = HubTransactionIntent | CrossChainIntent;
+interface TransactionStatus {
+    superTxHash: string;
+    status: 'pending' | 'processing' | 'success' | 'failed' | 'not_found';
+    chainTxHashes?: string[];
+    error?: string;
+}
+type ExecutionMode = 'eoa' | 'smart-account' | 'eoa-7702';
+interface ComposeFlow {
+    type: '/instructions/build' | '/instructions/intent-simple' | '/instructions/intent';
+    data: Record<string, unknown>;
+    batch?: boolean;
+}
+interface ComposeRequest {
+    ownerAddress: Address;
+    mode: ExecutionMode;
+    composeFlows: ComposeFlow[];
+}
+interface BiconomyResponse {
+    instructions: Array<{
+        calls: Array<{
+            to: Address;
+            value: string;
+            functionSig: string;
+            inputParams: unknown[];
+            outputParams: unknown[];
+        }>;
+        chainId: number;
+        isComposable: boolean;
+    }>;
+    returnedData?: unknown[];
+    route?: unknown;
+    estimatedGas?: string;
+}
+
+export type { AccountLiquidity as A, BiconomyResponse as B, ComposeRequest as C, HubTransactionIntent as H, LiquidatablePositions as L, MarketSummary as M, PeridotConfig as P, SimulateBorrowResult as S, ToolDefinition as T, UserPosition as U, TransactionStatus as a, LeaderboardEntry as b, MarketRates as c, CrossChainIntent as d, ComposeFlow as e, ToolCategory as f, TransactionCall as g, TransactionIntent as h };

package/package.json

@@ -0,0 +1,95 @@
+{
+  "name": "@peridot-agent/agent-kit",
+  "version": "0.2.0",
+  "description": "AI Agent toolkit for Peridot DeFi money markets — read, simulate, and build transaction intents for lending, borrowing, and cross-chain operations",
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/AsyncSan/peridot-agent-kit.git"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./langchain": {
+      "types": "./dist/adapters/langchain/index.d.ts",
+      "import": "./dist/adapters/langchain/index.js",
+      "require": "./dist/adapters/langchain/index.cjs"
+    },
+    "./vercel-ai": {
+      "types": "./dist/adapters/vercel-ai/index.d.ts",
+      "import": "./dist/adapters/vercel-ai/index.js",
+      "require": "./dist/adapters/vercel-ai/index.cjs"
+    },
+    "./mcp": {
+      "types": "./dist/adapters/mcp/server.d.ts",
+      "import": "./dist/adapters/mcp/server.js"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "peridot-mcp": "./dist/adapters/mcp/server.js"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.0.0",
+    "decimal.js": "^10.6.0",
+    "viem": "^2.0.0",
+    "zod": "^3.22.0",
+    "zod-to-json-schema": "^3.22.0"
+  },
+  "peerDependencies": {
+    "@langchain/core": ">=0.2.0",
+    "ai": ">=3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@langchain/core": {
+      "optional": true
+    },
+    "ai": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.27.0",
+    "@langchain/core": "^0.2.0",
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^7.0.0",
+    "@typescript-eslint/parser": "^7.0.0",
+    "@vitest/coverage-v8": "^1.6.0",
+    "ai": "^3.0.0",
+    "eslint": "^8.57.0",
+    "openai": "^6.32.0",
+    "tsup": "^8.0.0",
+    "tsx": "^4.7.0",
+    "typescript": "^5.4.0",
+    "vitest": "^1.6.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src scripts --ext .ts",
+    "lint:fix": "eslint src scripts --ext .ts --fix",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:integration": "vitest run --config vitest.integration.config.ts",
+    "test:routing": "npx tsx scripts/test-tool-routing.ts",
+    "test:coverage": "vitest run --coverage",
+    "changeset": "changeset",
+    "version-packages": "changeset version",
+    "release": "pnpm build && changeset publish",
+    "clean": "rm -rf dist"
+  }
+}