@verusidx/definecurrency-mcp 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 VerusIDX Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,74 @@
+# @verusidx/definecurrency-mcp
+
+MCP server for defining and launching new currencies on Verus — simple tokens, fractional basket currencies, centralized tokens, ID control tokens, and Ethereum ERC-20 mapped tokens.
+
+## Setup
+
+**Prerequisite:** `@verusidx/chain-mcp` must be configured and `refresh_chains` called at least once so the chain registry exists.
+
+Add to your MCP client config (e.g., Claude Code `claude_desktop_config.json`):
+
+```json
+{
+  "mcpServers": {
+    "verusidx-definecurrency": {
+      "command": "npx",
+      "args": ["@verusidx/definecurrency-mcp"],
+      "env": {}
+    }
+  }
+}
+```
+
+**Alternative: local install.** If you prefer a pinned version or offline use, install into a project directory with `npm install @verusidx/definecurrency-mcp` (or `pnpm add` / `yarn add`) and point your config at the local path instead of using `npx`.
+
+### Environment Variables
+
+| Variable | Default | Description |
+|---|---|---|
+| `VERUSIDX_READ_ONLY` | `false` | Set to `true` to disable all tools. This is a write-only MCP — no tools are available in read-only mode. |
+| `VERUSIDX_AUDIT_LOG` | `true` | Set to `false` to disable audit logging. |
+| `VERUSIDX_AUDIT_DIR` | OS default | Custom directory for audit log files. |
+
+### Read-Only Mode
+
+This is a **write-only MCP**. Setting `VERUSIDX_READ_ONLY=true` disables the only tool (`definecurrency`), leaving zero tools registered.
+
+## Tools
+
+| Tool | Description |
+|---|---|
+| `definecurrency` | Define a new currency — returns signed tx hex to broadcast via `sendrawtransaction` (chain-mcp) |
+
+## Launch Workflow
+
+`definecurrency` creates a signed transaction but does **not** broadcast it:
+
+1. Ensure a VerusID with the currency name exists and is controlled by the wallet
+2. **`definecurrency`** — returns `{txid, tx, hex}`
+3. **`sendrawtransaction`** (chain-mcp) with the `hex` — broadcasts the definition
+4. Wait for the preconversion timeframe (minimum 20 blocks)
+5. **`getcurrency`** (chain-mcp) to verify the currency launched
+
+## Currency Types
+
+| Options | Type | Description |
+|---|---|---|
+| `32` | Simple token | Basic token, optionally with preconversion funding |
+| `33` | Basket currency | Fractional reserve currency supporting on-chain conversions |
+| `2080` | ID control token | Single-satoshi token granting revoke/recover authority |
+
+Common options shown. Combine values for variants (e.g., `41` = basket + referrals, `34` = token + ID-restricted). See `tool-specs/definecurrency.md` for the full options table, field reference, and examples.
+
+Set `proofprotocol: 2` for centralized tokens (rootID can mint/burn), or `proofprotocol: 3` for Ethereum ERC-20 mapped tokens.
+
+## Audit Logging
+
+All `definecurrency` calls are logged to date-stamped JSONL files in the audit directory. The hex is truncated in audit entries. Logs are append-only with `0600` permissions.
+
+## Requirements
+
+- Node.js >= 18.0.0
+- `@verusidx/chain-mcp` installed and `refresh_chains` called (chain registry must exist)
+- At least one Verus daemon running
+- A VerusID matching the currency name, controlled by the wallet

package/build/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/build/index.js

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
+import { registerTools } from './tools.js';
+const server = new McpServer({
+    name: 'verusidx-definecurrency-mcp',
+    version: '0.1.0',
+});
+registerTools(server);
+const transport = new StdioServerTransport();
+await server.connect(transport);
+process.on('SIGINT', async () => {
+    await server.close();
+    process.exit(0);
+});
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;IAC3B,IAAI,EAAE,6BAA6B;IACnC,OAAO,EAAE,OAAO;CACjB,CAAC,CAAC;AAEH,aAAa,CAAC,MAAM,CAAC,CAAC;AAEtB,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;AAC7C,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;AAEhC,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE;IAC9B,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;IACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/build/tools.d.ts

@@ -0,0 +1,3 @@
+import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+export declare function registerTools(server: McpServer): void;
+//# sourceMappingURL=tools.d.ts.map

package/build/tools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools.d.ts","sourceRoot":"","sources":["../src/tools.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAuCzE,wBAAgB,aAAa,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,CA6CrD"}

package/build/tools.js

@@ -0,0 +1,64 @@
+import { z } from 'zod';
+import { rpcCall, auditLog, isReadOnly, assertWriteEnabled, VerusError, } from '@verusidx/shared';
+// ---------------------------------------------------------------------------
+// Response helpers
+// ---------------------------------------------------------------------------
+function ok(data) {
+    return {
+        content: [{ type: 'text', text: JSON.stringify(data, null, 2) }],
+    };
+}
+function fail(category, message) {
+    return {
+        content: [{ type: 'text', text: JSON.stringify({ error: category, message }, null, 2) }],
+        isError: true,
+    };
+}
+function handleError(err) {
+    if (err instanceof VerusError) {
+        return fail(err.category, err.message);
+    }
+    return fail('INTERNAL_ERROR', err instanceof Error ? err.message : 'Unknown error');
+}
+const SERVER_NAME = 'verusidx-definecurrency-mcp';
+// ---------------------------------------------------------------------------
+// Tool registration
+// ---------------------------------------------------------------------------
+export function registerTools(server) {
+    // definecurrency is write-only — no tools registered in read-only mode
+    if (!isReadOnly()) {
+        server.tool('definecurrency', 'Define a new currency on the blockchain. Creates a signed transaction that defines the currency — the transaction is NOT broadcast automatically. The returned hex must be sent via sendrawtransaction (in chain-mcp) to actually launch the currency. Supports simple tokens (options: 32), fractional basket currencies (options: 33), centralized tokens (proofprotocol: 2), ID control tokens (options: 2080), and Ethereum ERC-20 mapped tokens (proofprotocol: 3). A VerusID with the same name must exist, be controlled by the wallet, and have sufficient funds to pay the definition fee. Only root IDs can define currencies (except ID control tokens, which subIDs can also define). After broadcasting, wait for the preconversion timeframe (minimum 20 blocks), then verify with getcurrency (chain-mcp). FEE DISCOVERY: Call getcurrency (chain-mcp) on the chain\'s own currency (e.g., "VRSC" or the PBaaS chain name). Regular currencies cost currencyregistrationfee (e.g., 200 VRSC on mainnet). ID control tokens (options: 2080) cost much less — the chain\'s idimportfees value (e.g., 0.02 VRSC on mainnet). The defining ID must hold these funds.', {
+            chain: z.string().describe('Chain to define the currency on (e.g., "VRSC", "vrsctest")'),
+            definition: z.record(z.unknown()).describe('Currency definition object. Required fields: name (string, must match an existing VerusID), options (number, bitfield — 32=token, 33=basket, 2080=ID control token). Optional fields: proofprotocol (1=decentralized, 2=centralized, 3=ERC-20), currencies (string[], reserve currencies), weights (number[], must sum to 1.0), conversions (number[], preconversion prices), initialsupply (number, required for baskets), preallocations (object[]), initialcontributions (number[]), minpreconversion (number[]), maxpreconversion (number[]), prelaunchcarveout (number), prelaunchdiscount (number), idregistrationfees (number), idreferrallevels (number), idimportfees (number), startblock (number), endblock (number), expiryheight (number), nativecurrencyid (object, for ERC-20), systemid (string), parent (string), launchsystemid (string).'),
+        }, async ({ chain, definition }) => {
+            try {
+                assertWriteEnabled();
+                // definecurrency '{"name":"...","options":...}'
+                const result = await rpcCall(chain, 'definecurrency', [definition]);
+                const defName = definition.name;
+                auditLog({
+                    server: SERVER_NAME,
+                    tool: 'definecurrency',
+                    chain,
+                    params: {
+                        name: defName,
+                        options: definition.options,
+                        proofprotocol: definition.proofprotocol,
+                    },
+                    result: {
+                        txid: result?.txid,
+                        hex: typeof result?.hex === 'string'
+                            ? result.hex.slice(0, 20) + '...'
+                            : undefined,
+                    },
+                    success: true,
+                });
+                return ok(result);
+            }
+            catch (err) {
+                return handleError(err);
+            }
+        });
+    }
+}
+//# sourceMappingURL=tools.js.map

package/build/tools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools.js","sourceRoot":"","sources":["../src/tools.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,OAAO,EACP,QAAQ,EACR,UAAU,EACV,kBAAkB,EAClB,UAAU,GACX,MAAM,kBAAkB,CAAC;AAE1B,8EAA8E;AAC9E,mBAAmB;AACnB,8EAA8E;AAE9E,SAAS,EAAE,CAAC,IAAa;IACvB,OAAO;QACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;KAC1E,CAAC;AACJ,CAAC;AAED,SAAS,IAAI,CAAC,QAAgB,EAAE,OAAe;IAC7C,OAAO;QACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;QACjG,OAAO,EAAE,IAAa;KACvB,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,GAAY;IAC/B,IAAI,GAAG,YAAY,UAAU,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACzC,CAAC;IACD,OAAO,IAAI,CAAC,gBAAgB,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;AACtF,CAAC;AAED,MAAM,WAAW,GAAG,6BAA6B,CAAC;AAElD,8EAA8E;AAC9E,oBAAoB;AACpB,8EAA8E;AAE9E,MAAM,UAAU,aAAa,CAAC,MAAiB;IAC7C,uEAAuE;IAEvE,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;QAClB,MAAM,CAAC,IAAI,CACT,gBAAgB,EAChB,inCAAinC,EACjnC;YACE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,4DAA4D,CAAC;YACxF,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,6zBAA6zB,CAAC;SAC12B,EACD,KAAK,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE;YAC9B,IAAI,CAAC;gBACH,kBAAkB,EAAE,CAAC;gBAErB,gDAAgD;gBAChD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,KAAK,EAAE,gBAAgB,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;gBAEpE,MAAM,OAAO,GAAI,UAAsC,CAAC,IAA0B,CAAC;gBAEnF,QAAQ,CAAC;oBACP,MAAM,EAAE,WAAW;oBACnB,IAAI,EAAE,gBAAgB;oBACtB,KAAK;oBACL,MAAM,EAAE;wBACN,IAAI,EAAE,OAAO;wBACb,OAAO,EAAG,UAAsC,CAAC,OAAO;wBACxD,aAAa,EAAG,UAAsC,CAAC,aAAa;qBACrE;oBACD,MAAM,EAAE;wBACN,IAAI,EAAG,MAAkC,EAAE,IAAI;wBAC/C,GAAG,EAAE,OAAQ,MAAkC,EAAE,GAAG,KAAK,QAAQ;4BAC/D,CAAC,CAAG,MAAkC,CAAC,GAAc,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK;4BAC1E,CAAC,CAAC,SAAS;qBACd;oBACD,OAAO,EAAE,IAAI;iBACd,CAAC,CAAC;gBAEH,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC;YACpB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC;YAC1B,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@verusidx/definecurrency-mcp",
+  "version": "0.1.0",
+  "description": "MCP server for defining Verus currencies — tokens, fractional baskets, centralized currencies, and ERC-20 mapped tokens",
+  "license": "MIT",
+  "type": "module",
+  "bin": {
+    "verusidx-definecurrency-mcp": "./build/index.js"
+  },
+  "files": [
+    "build"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.27.0",
+    "zod": "^3.23.0",
+    "@verusidx/shared": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "typescript": "^5.7.0",
+    "vitest": "^3.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run"
+  }
+}