@continuumdao/ctm-mpc-defi 0.2.0 → 0.2.1

package/README.md

@@ -1,6 +1,6 @@
 # @continuumdao/ctm-mpc-defi
 
-Continuum MPC DeFi protocol library — builds **multiSignRequest** payloads for EVM (and future chain categories). Usable from the Next.js app and from AI agents / Node scripts.
+Continuum MPC DeFi protocol library — builds **multiSignRequest** payloads for EVM (and future chain categories). Bundled into the **continuum-mcp-server** Docker image; linked locally via `file:../ctm-mpc-defi`.
 
 **License:** [Business Source License 1.1](LICENSE) (ContinuumDAO). Converts to GPL-3.0-or-later on 2030-01-01.
 
@@ -8,92 +8,55 @@ Continuum MPC DeFi protocol library — builds **multiSignRequest** payloads for
 
 | Layer | Path | Role |
 |-------|------|------|
-| Core | `src/core/` | KeyGen, purpose, mpc-auth envelope, **management POST sig**, registry |
-| Chain categories | `src/chains/<category>/` | EVM batch builder, fees; Solana/NEAR stubs |
+| Core | `src/core/` | Purpose text, mpc-auth envelope, protocol registry |
+| Chain categories | `src/chains/<category>/` | EVM batch builder; Solana/NEAR stubs |
 | Protocols | `src/protocols/<category>/<name>/` | DeFi actions (Uniswap V4, Curve DAO, …) |
+| Agent | `src/agent/` | MCP tool catalog, SKILL.md, support advisors |
 
-## Install
+Management reads, fee helpers, and client-sign utilities live in **`@continuumdao/continuum-node-sdk`** — import those from the SDK, not from this package.
 
-```bash
-npm install @continuumdao/ctm-mpc-defi viem
-```
+## Install
 
-Local link with the app:
+This package is published to npm for production deploys (e.g. Railway). For local development against unreleased changes, use a `file:` link:
 
 ```json
 "@continuumdao/ctm-mpc-defi": "file:../ctm-mpc-defi"
 ```
 
-Run `npm run build` in this repo after changes so `dist/` is up to date.
+Run `npm run build` in this repo after changes so `dist/` is up to date before linking.
 
 ## Package exports
 
-- `@continuumdao/ctm-mpc-defi` — core + registry
-- `@continuumdao/ctm-mpc-defi/core`
-- `@continuumdao/ctm-mpc-defi/chains/evm`
-- `@continuumdao/ctm-mpc-defi/protocols/evm/uniswap-v4`
-- `@continuumdao/ctm-mpc-defi/protocols/evm/curve-dao`
-- `@continuumdao/ctm-mpc-defi/agent` — action catalog for agents
+- `@continuumdao/ctm-mpc-defi` — registry + protocol modules
+- `@continuumdao/ctm-mpc-defi/core` — envelope, registry, `KeyGenSubset`, `firstClientIdFromKeyGen`
+- `@continuumdao/ctm-mpc-defi/chains/evm` — `buildEvmMultisignBatch`, chain helpers
+- `@continuumdao/ctm-mpc-defi/protocols/evm/<protocol>` — per-protocol builders
+- `@continuumdao/ctm-mpc-defi/agent` — MCP tool catalog and SKILL.md paths
 
-## Agent example (Uniswap V4)
+## Protocol example (Uniswap V4)
 
 ```typescript
 import { uniswapV4 } from '@continuumdao/ctm-mpc-defi/protocols/evm/uniswap-v4'
 
-const quote = await uniswapV4.quote({
-  type: 'EXACT_INPUT',
-  amount: '1000000',
-  tokenIn: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
-  tokenOut: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2',
-  chainId: 1,
-  uniswapApiKey: process.env.UNISWAP_API_KEY!,
-  swapper: '0xYourMpcExecutor',
-})
-
+const quote = await uniswapV4.quote({ /* … */ })
 const { bodyForSign, messageToSign } = await uniswapV4.buildSwapMultisignBody({ /* … */ })
 // Sign messageToSign, POST { ...bodyForSign, clientSig, signedMessage }
-
-// Management POST routes (Get Sig, shelve, keyGen, …) use NodeMgtKeySig:
-import {
-  buildManagementPostBody,
-  fetchManagementNonce,
-  fetchNodeKey,
-  messageToSignManagementBody,
-  withManagementClientSig,
-} from '@continuumdao/ctm-mpc-defi/core'
-
-const { nodeKey } = await fetchNodeKey(managementNodeUrl)
-const { nonce } = await fetchManagementNonce(managementNodeUrl, true, ed25519PublicKey)
-const body = buildManagementPostBody(nonce, nodeKey, { requestId: '…' })
-const messageToSign = messageToSignManagementBody(body)
-// sign messageToSign → POST with withManagementClientSig(body, sig)
 ```
 
-## Agent catalog
+## MCP servers
 
-Short registry (protocol actions):
-
-```typescript
-import { getAgentCatalog } from '@continuumdao/ctm-mpc-defi/agent'
-console.log(getAgentCatalog().byCategory.evm)
-```
-
-**MCP servers** should use the richer tool definitions (descriptions, input/output schema, handler mapping, prerequisites):
+Use the agent export for tool registration and discovery:
 
 ```typescript
 import { getMcpToolDefinitions, getAgentCatalogForMcp } from '@continuumdao/ctm-mpc-defi/agent'
 
 for (const tool of getMcpToolDefinitions()) {
-  // Register each tool with your MCP server using tool.name, tool.description,
-  // tool.inputSchema, tool.outputSchema; invoke via tool.handler.importPath + exportName
+  // Register tool.name, tool.description, tool.inputSchema, tool.outputSchema
+  // Invoke via tool.handler.importPath + exportName
 }
 ```
 
-Each MCP tool includes:
-- Long `description` (what it does and does not do)
-- `inputSchema` / `outputSchema` (including `MultisignBuildResult` for sign builders)
-- `prerequisites` / `followUp` (typical quote → swap → multisign → sign → POST flow)
-- `handler`: `{ importPath, exportName }` pointing at the library export to call
+Each MCP tool includes descriptions, Zod-derived JSON schemas, prerequisites/followUp hints, and a handler pointing at the library export. The continuum-node-sdk MCP server enriches slim inputs (`keyGenId`, `chainId`) before calling builders.
 
 ## Development
 
@@ -103,24 +66,3 @@ npm run build
 npm test
 npm run typecheck
 ```
-
-## Publish (npm)
-
-Scoped package for the [ContinuumDAO npm org](https://www.npmjs.com/org/continuumdao):
-
-```bash
-npm login
-npm publish
-```
-
-Install in consumers:
-
-```bash
-npm install @continuumdao/ctm-mpc-defi
-```
-
-For local development against the sibling repo:
-
-```json
-"@continuumdao/ctm-mpc-defi": "file:../ctm-mpc-defi"
-```