@toon-protocol/client-mcp 0.26.2

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 TOON Protocol Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,261 @@
+# @toon-protocol/client-mcp
+
+Let a Claude agent — **Claude Desktop or Claude Code** — act as a full TOON
+Protocol client: **pay-to-write** publishing, **free** reads/subscriptions,
+payment-channel/balance management, and mill swaps.
+
+The agent surface is an **MCP server** — bin **`toon-mcp`**, which registers
+with the host under the server name **`toon-client`** (this is the name that
+appears in Claude's MCP server list and in the `initialize` handshake;
+`mcpServers.toon` in config is just your local alias). The two long-lived
+connections that can't live in an ephemeral agent session — a **BTP** session
+(paid writes via the connector/apex, optionally over a managed `.anyone`
+SOCKS5h proxy) and a **town-relay Nostr-WS** subscription (free reads) — live in
+an **always-on detached daemon** (`toon-clientd`). The MCP server is a thin
+stdio proxy that auto-spawns the daemon and never holds chain keys.
+
+| | Name |
+|---|---|
+| npm package | `@toon-protocol/client-mcp` |
+| MCP server name (handshake) | `toon-client` |
+| MCP server bin | `toon-mcp` |
+| Daemon bin | `toon-clientd` |
+
+```
+Claude (Desktop / Code)
+        │  stdio (MCP)
+        ▼
+   toon-mcp  ──HTTP──▶  toon-clientd (detached, always-on)
+                          ├─ ToonClient: BTP session + payment channels + signer
+                          └─ RelaySubscription: persistent town-relay Nostr-WS
+```
+
+## Architecture
+
+| Layer | Bin / module | Responsibility |
+|---|---|---|
+| **Daemon** | `toon-clientd` | Owns one `ToonClient` (BTP + managed anon + channels + mnemonic keystore + network targeting) **plus** a persistent town-relay subscription. Loopback HTTP control API, single-instance PID lock, channel nonce-watermark persistence, graceful shutdown. |
+| **MCP server** | `toon-mcp` | `@modelcontextprotocol/sdk` stdio server. Maps tools → daemon HTTP; auto-spawns the daemon detached if down; reports "bootstrapping — retry" while anon boots; holds no keys. |
+| **Skill** | `.claude/skills/toon-client/` | Teaches the agent pay-to-write / free-read / settlement semantics. |
+
+## Tools
+
+The `toon-client` MCP server exposes **8 tools**:
+
+| MCP tool | Daemon endpoint | Backing |
+|---|---|---|
+| `toon_status` | `GET /status` | ready/bootstrapping, transport, relay health, per-chain settlement, active chain |
+| `toon_identity` | `GET /status` | Nostr pubkey + EVM/Solana/Mina addresses (no keys) |
+| `toon_publish(event,{destination?,fee?})` | `POST /publish` | `signBalanceProof` + `publishEvent` (paid write) |
+| `toon_subscribe(filters,{subId?})` | `POST /subscribe` | register a persistent free-read subscription |
+| `toon_read({subId?,cursor?,limit?})` | `GET /events` | drain buffered events by cursor (free) |
+| `toon_open_channel({destination?})` | `POST /channels` | `openChannel` (pre-open / fetch a channel) |
+| `toon_channels` | `GET /channels` | `getTrackedChannels` + nonce watermark + cumulative spend |
+| `toon_swap(destination,amount,{toonData?})` | `POST /swap` | `sendSwapPacket` (mill swap) |
+
+## Install
+
+```bash
+pnpm add -g @toon-protocol/client-mcp     # or use npx/pnpm dlx
+```
+
+This installs two bins: `toon-clientd` and `toon-mcp`.
+
+## Configure the daemon
+
+The daemon reads `~/.toon-client/config.json` (override with `TOON_CLIENT_CONFIG`).
+The **mnemonic is never stored in plaintext by default** — supply it via env or an
+encrypted keystore (scrypt + AES-256-GCM, mode 0600).
+
+```jsonc
+// ~/.toon-client/config.json
+{
+  "network": "testnet",                       // settlement presets (#209)
+  "keystorePath": "~/.toon-client/keystore.json",
+  "btpUrl": "ws://<apex-host>.anyone:3000/btp",
+  "relayUrl": "wss://<relay-host>.anyone/",   // free reads
+  "destination": "g.townhouse.town",
+  "feePerEvent": "1",
+  "httpPort": 8787,
+  // HS / direct-apex mode: bootstrap finds 0 peers, so name the apex's
+  // settlement address directly (mirrors the docker entrypoint):
+  "apex": {
+    "destination": "g.townhouse.town",
+    "peerId": "town",
+    "chain": "evm",
+    "chainKey": "evm:base:84532",
+    "chainId": 84532,
+    "settlementAddress": "0x<apex-receive-addr>",
+    "tokenAddress": "0x<usdc>",
+    "tokenNetwork": "0x<token-network>"
+  }
+}
+```
+
+Environment overrides: `TOON_CLIENT_MNEMONIC`, `TOON_CLIENT_KEYSTORE_PASSWORD`,
+`TOON_CLIENT_BTP_URL`, `TOON_CLIENT_RELAY_URL`, `TOON_CLIENT_SOCKS`,
+`TOON_CLIENT_HTTP_PORT`, `TOON_CLIENT_NETWORK`, `TOON_CLIENT_HOME`.
+
+The managed `.anyone` SOCKS5h proxy auto-starts when `btpUrl` is a `.anyone`
+host and no explicit `socksProxy` is set. The first bootstrap pays the anon
+warm-up cost (~30–90s) **once** — the detached daemon then stays up.
+
+### Create an encrypted keystore
+
+```bash
+TOON_CLIENT_MNEMONIC="word word ..." \
+TOON_CLIENT_KEYSTORE_PASSWORD="…" \
+node -e "import('@toon-protocol/client').then(m => m.importKeystore(process.env.HOME+'/.toon-client/keystore.json', process.env.TOON_CLIENT_MNEMONIC, process.env.TOON_CLIENT_KEYSTORE_PASSWORD))"
+```
+
+## Daemon lifecycle (Claude Code only — it has a shell)
+
+```bash
+toon-clientd start     # spawn detached, wait until reachable
+toon-clientd status    # print status JSON
+toon-clientd stop      # SIGTERM the locked PID
+toon-clientd run       # run in the foreground (what the detached spawn runs)
+```
+
+The MCP server auto-spawns the daemon, so `start` is optional.
+
+## Register with Claude
+
+### Claude Code
+
+```bash
+claude mcp add toon -- toon-mcp
+```
+
+…or add to `.mcp.json` in your project:
+
+```json
+{
+  "mcpServers": {
+    "toon": { "command": "toon-mcp" }
+  }
+}
+```
+
+### Claude Desktop
+
+Add to `claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "toon": {
+      "command": "toon-mcp",
+      "env": {
+        "TOON_CLIENT_KEYSTORE_PASSWORD": "…"
+      }
+    }
+  }
+}
+```
+
+Then restart Claude Desktop. The TOON tools appear in the tool list; the first
+`toon_publish` after a cold start may report "bootstrapping — retry" while the
+anon proxy + BTP session come up.
+
+## Usage example
+
+You don't call these tools by hand — the agent does, in response to plain
+requests. A typical "post a note, then read it back" flow:
+
+> **You:** Post a note to TOON saying "gm from my agent", then show me when it lands.
+
+The agent runs:
+
+1. **`toon_status`** → confirm the client is up.
+   ```json
+   { "ready": true, "bootstrapping": false, "settlementChain": "evm",
+     "relay": { "connected": true }, "identity": { "evmAddress": "0x99ed…" } }
+   ```
+   (If it returns `bootstrapping: true` or a "retry shortly" message, wait ~30–90s
+   for the anon proxy + BTP session, then retry.)
+
+2. **`toon_subscribe`** for its own author so it can read the note back:
+   ```json
+   { "filters": { "authors": ["<my-hex-pubkey>"], "kinds": [1] } }
+   → { "subId": "sub-1" }
+   ```
+
+3. **`toon_publish`** the signed kind:1 event (the daemon signs the payment-channel
+   claim and forwards it over BTP):
+   ```json
+   { "event": { "kind": 1, "content": "gm from my agent", "id": "…", "sig": "…", … } }
+   → { "eventId": "0d0c1f98…", "channelId": "0xc73a77…", "nonce": 7 }
+   ```
+
+4. **`toon_read`** until the event appears (free; cursor long-poll):
+   ```json
+   { "subId": "sub-1" }
+   → { "events": [ { "id": "0d0c1f98…", "content": "gm from my agent", … } ],
+       "cursor": 12, "hasMore": false }
+   ```
+
+5. **`toon_channels`** to show what it cost:
+   ```json
+   → { "channels": [ { "channelId": "0xc73a77…", "nonce": 7, "cumulativeAmount": "7" } ] }
+   ```
+
+Other common calls: **`toon_open_channel`** to pre-open a channel before a burst
+of publishes, and **`toon_swap({ destination, amount })`** to pay a mill peer and
+receive a target-chain claim.
+
+> **CLI equivalent** (handy for scripting/debugging — the MCP tools map 1:1 to
+> these daemon endpoints):
+> ```bash
+> toon-clientd start                                   # boot the daemon
+> curl -s localhost:8787/status | jq                   # toon_status
+> curl -s -XPOST localhost:8787/subscribe \
+>   -H content-type:application/json \
+>   -d '{"filters":{"authors":["<hex>"],"kinds":[1]}}' # toon_subscribe
+> curl -s -XPOST localhost:8787/publish \
+>   -H content-type:application/json \
+>   -d '{"event":{…signed kind:1…}}'                   # toon_publish
+> curl -s 'localhost:8787/events?subId=sub-1' | jq     # toon_read
+> curl -s localhost:8787/channels | jq                 # toon_channels
+> ```
+
+## Security
+
+- The daemon holds the mnemonic/keystore; the agent sees **only addresses and
+  results**, never private keys.
+- A single-instance PID lock prevents two daemons from racing the channel nonce
+  watermark (which would corrupt the payment proof).
+- The control plane binds `127.0.0.1` only (no auth layer — it never leaves
+  loopback).
+
+## Tests
+
+```bash
+pnpm --filter @toon-protocol/client-mcp test              # unit
+RUN_LIVE_HS_E2E=1 …env… \
+  pnpm --filter @toon-protocol/client-mcp test:integration # gated live-HS round-trip
+```
+
+The gated integration test boots the daemon against a live `.anyone` HS apex,
+publishes a paid event, reads it back through the subscription, verifies the
+channel nonce advanced, restarts the daemon, and confirms the nonce watermark
+persisted. See `src/__integration__/`.
+
+## Publishing
+
+This package is **published to npm automatically by CI/CD**, in lockstep with the
+repo's release tag (the same `vX.Y.Z` semantic-release cuts for
+`@toon-protocol/townhouse`). On a release, `publish-townhouse-images.yml` builds
+this package, sets its version to the tag, and runs
+`pnpm --filter @toon-protocol/client-mcp publish --access public`.
+
+It is **self-contained**: its `@toon-protocol/*` workspace deps (`client`, `core`)
+are **bundled into `dist`** at build time (tsup `noExternal`), so the published
+`package.json` carries **zero `@toon-protocol/*` runtime deps** — only npm
+packages (`fastify`, `@modelcontextprotocol/sdk`, `nostr-tools`, `viem`, `ws`,
+`@toon-format/toon`) plus optional chain libs (`o1js`, `mina-signer`,
+`@solana/web3.js`, `socks-proxy-agent`) installed only when you use those chains.
+A guard test (`src/package-structure.test.ts`) fails the build if a
+`@toon-protocol/*` runtime dep ever leaks in.
+
+To publish manually: `pnpm --filter @toon-protocol/client-mcp build && pnpm --filter @toon-protocol/client-mcp publish --access public`.

package/dist/anon-proxy-6N362VEV-M7AX2QD7.js

@@ -0,0 +1,24 @@
+import { createRequire as __cr } from 'module'; const require = __cr(import.meta.url);
+import {
+  ANON_ASSETS,
+  ANON_VERSION,
+  defaultCacheDir,
+  ensureAnonBinary,
+  renderTorrc,
+  selectAnonAsset,
+  startManagedAnonProxy,
+  tcpProbe,
+  waitForAnonSocks
+} from "./chunk-245J23EB.js";
+export {
+  ANON_ASSETS,
+  ANON_VERSION,
+  defaultCacheDir,
+  ensureAnonBinary,
+  renderTorrc,
+  selectAnonAsset,
+  startManagedAnonProxy,
+  tcpProbe,
+  waitForAnonSocks
+};
+//# sourceMappingURL=anon-proxy-6N362VEV-M7AX2QD7.js.map

package/dist/anon-proxy-6N362VEV-M7AX2QD7.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}