@lombard.finance/sdk-agent 0.1.0

package/dist/validation.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Shared validation helpers for prepare_* tools.
+ *
+ * The agent must validate inputs against SDK constraints (minimums, address
+ * formats, required fields) BEFORE constructing a transaction. Tools return
+ * a structured ValidationFailure when checks fail so the LLM can surface
+ * the missing or invalid fields to the user and ask, instead of producing
+ * an executable card with bad data.
+ */
+import { Env } from "@lombard.finance/sdk";
+/**
+ * Verifies that a string looks like a Bitcoin address for the network
+ * implied by the EVM chain the user is on. Format check only; does NOT
+ * validate the base58/bech32 checksum.
+ */
+export declare function isBitcoinAddress(addr: string, evmChainId: number): boolean;
+/** Verifies a string parses as a positive numeric amount. */
+export declare function isPositiveAmount(amount: unknown): amount is string;
+/**
+ * Structured validation failure surfaced to the LLM as a tool result.
+ * `missing` lists field names the LLM should re-prompt the user for.
+ * `errors` lists field-level problems (invalid format, below minimum, etc).
+ * `note` is a single-sentence instruction for the LLM (what to do next).
+ */
+export interface ValidationFailure {
+    valid: false;
+    missing: string[];
+    errors: string[];
+    note: string;
+}
+/** Tags a successful validation; spread alongside tool-specific output. */
+export interface ValidationSuccess {
+    valid: true;
+}
+export type ValidationResult = ValidationFailure | ValidationSuccess;
+/**
+ * Validates the inputs to prepare_unstake. Asks for a Bitcoin recipient
+ * when outputAsset is "BTC" and checks the format against the network.
+ */
+export declare function validateUnstakeInputs(params: {
+    amount: unknown;
+    outputAsset: unknown;
+    recipient?: unknown;
+    chainId: number;
+}): ValidationResult;
+/** Validates the inputs to prepare_stake (BTC.b → LBTC). */
+export declare function validateStakeInputs(params: {
+    amount: unknown;
+}): ValidationResult;
+/**
+ * Validates the inputs to prepare_redeem_btcb (BTC.b -> native BTC).
+ * BTC.b has its own minimum-redeem floor today (same MIN_REDEEM_AMOUNT_BTC
+ * as LBTC); kept here so the agent can advertise it without an extra
+ * round trip.
+ */
+export declare function validateRedeemBtcbInputs(params: {
+    amount: unknown;
+    recipient: unknown;
+    chainId: number;
+}): ValidationResult;
+/** Validates the inputs to prepare_deploy_to_vault / prepare_vault_withdrawal. */
+export declare function validateAmountInputs(params: {
+    amount: unknown;
+}): ValidationResult;
+/**
+ * Resolves the partner ID used for BTC deposit address generation.
+ *
+ * Testnet and mainnet have separate partner registries on the BFF, so the
+ * same partner string is rarely registered on both — `okx` on testnet
+ * returns "partner not found", `test1` on prod returns the same.
+ *
+ * Defaults are non-revenue test partners so accidental traffic from the
+ * chatbot example never routes through a real partner (which would incur
+ * fee payouts):
+ *   - testnet: `test1`   (overridable via LOMBARD_TESTNET_PARTNER_ID)
+ *   - mainnet: `lombardtest1` (overridable via LOMBARD_PARTNER_ID)
+ *
+ * To actually run through a real partner like `okx` or `lombard`, set
+ * LOMBARD_PARTNER_ID explicitly.
+ */
+export declare function resolvePartnerId(env: Env, configured?: {
+    mainnet?: string;
+    testnet?: string;
+}): string;
+//# sourceMappingURL=validation.d.ts.map

package/dist/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EACL,GAAG,EAGJ,MAAM,sBAAsB,CAAC;AAgB9B;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAO1E;AAED,6DAA6D;AAC7D,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,MAAM,CAKlE;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,KAAK,CAAC;IACb,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,2EAA2E;AAC3E,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,IAAI,CAAC;CACb;AAED,MAAM,MAAM,gBAAgB,GAAG,iBAAiB,GAAG,iBAAiB,CAAC;AAErE;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE;IAC5C,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;CACjB,GAAG,gBAAgB,CAkDnB;AAED,4DAA4D;AAC5D,wBAAgB,mBAAmB,CAAC,MAAM,EAAE;IAC1C,MAAM,EAAE,OAAO,CAAC;CACjB,GAAG,gBAAgB,CAkBnB;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE;IAC/C,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;CACjB,GAAG,gBAAgB,CAwCnB;AAED,kFAAkF;AAClF,wBAAgB,oBAAoB,CAAC,MAAM,EAAE;IAC3C,MAAM,EAAE,OAAO,CAAC;CACjB,GAAG,gBAAgB,CAUnB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,GAAG,EACR,UAAU,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,GAClD,MAAM,CAMR"}

package/dist/vercel.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r=require("ai"),l=require("./tools.cjs");function e(o){const t=r.tool;return t({name:o.name,description:o.description,parameters:o.schema,execute:o.execute})}const n=Object.fromEntries(l.allTools.map(o=>[o.name,e(o)]));exports.lombardTools=n;exports.toAiTool=e;

package/dist/vercel.d.ts

@@ -0,0 +1,12 @@
+import { type ToolDefinition } from "./tools";
+/**
+ * Converts a framework-agnostic ToolDefinition into a Vercel AI SDK tool.
+ * Uses Zod schemas directly — Vercel AI SDK accepts Zod natively.
+ */
+declare function toAiTool(def: ToolDefinition<any, any>): any;
+/**
+ * All Lombard tools formatted for the Vercel AI SDK's `tools` parameter.
+ */
+export declare const lombardTools: Record<string, any>;
+export { toAiTool };
+//# sourceMappingURL=vercel.d.ts.map

package/dist/vercel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vercel.d.ts","sourceRoot":"","sources":["../src/vercel.ts"],"names":[],"mappings":"AAaA,OAAO,EAAY,KAAK,cAAc,EAAE,MAAM,SAAS,CAAC;AAExD;;;GAGG;AAEH,iBAAS,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,GAAG,CAapD;AAED;;GAEG;AAEH,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAE5C,CAAC;AAEF,OAAO,EAAE,QAAQ,EAAE,CAAC"}

package/dist/vercel.js

@@ -0,0 +1,17 @@
+import { tool as e } from "ai";
+import { K as t } from "./tools.js";
+function r(o) {
+  return e({
+    name: o.name,
+    description: o.description,
+    parameters: o.schema,
+    execute: o.execute
+  });
+}
+const n = Object.fromEntries(
+  t.map((o) => [o.name, r(o)])
+);
+export {
+  n as lombardTools,
+  r as toAiTool
+};

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@lombard.finance/sdk-agent",
+  "version": "0.1.0",
+  "description": "Framework-agnostic AI agent tool definitions for the Lombard protocol",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./vercel": {
+      "types": "./dist/vercel.d.ts",
+      "import": "./dist/vercel.js",
+      "require": "./dist/vercel.cjs"
+    },
+    "./langchain": {
+      "types": "./dist/langchain.d.ts",
+      "import": "./dist/langchain.js",
+      "require": "./dist/langchain.cjs"
+    }
+  },
+  "license": "MIT",
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">= 18.0.0"
+  },
+  "scripts": {
+    "types": "tsc --noEmit",
+    "build": "yarn types && vite build && tsc -p tsconfig.build.json",
+    "lint": "eslint . --ext .js,.jsx,.ts,.tsx --max-warnings=0",
+    "test": "vitest run",
+    "test:watch": "vitest watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lombard-finance/sdk.git",
+    "directory": "packages/sdk-agent"
+  },
+  "homepage": "https://docs.lombard.finance",
+  "keywords": [
+    "lombard",
+    "sdk",
+    "ai",
+    "agent",
+    "tools",
+    "bitcoin",
+    "lbtc"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@langchain/core": "^0.3.0",
+    "ai": "^4.0.0",
+    "viem": "^2.21.0"
+  },
+  "peerDependenciesMeta": {
+    "@langchain/core": {
+      "optional": true
+    },
+    "ai": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@lombard.finance/sdk": "5.0.4",
+    "@lombard.finance/sdk-common": "4.0.0",
+    "zod": "^3.25.28",
+    "zod-to-json-schema": "^3.25.2"
+  },
+  "devDependencies": {
+    "@langchain/core": "^0.3.0",
+    "ai": "^4.0.0",
+    "typescript": "^5.4.5",
+    "viem": "^2.21.0",
+    "vite": "^6.3.5",
+    "vitest": "^3.2.4"
+  }
+}