@yummybait/uniswap-tx-builder-mcp 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,11 @@
1
+ {
2
+ "name": "yummybait",
3
+ "owner": { "name": "Yummybait" },
4
+ "plugins": [
5
+ {
6
+ "name": "uniswap-tx-builder",
7
+ "source": "./",
8
+ "description": "Build unsigned Uniswap v3 liquidity-position transactions and hand the calldata to your own wallet to sign. Pairs with the uniswap-tx-builder MCP."
9
+ }
10
+ ]
11
+ }
@@ -0,0 +1,16 @@
1
+ {
2
+ "name": "uniswap-tx-builder",
3
+ "description": "Skill for driving the uniswap-tx-builder MCP: build unsigned Uniswap v3 liquidity-position transactions (collect, close/burn, mint, increase, plan), simulate them, and sign with your own wallet.",
4
+ "version": "0.3.1",
5
+ "author": {
6
+ "name": "Yummybait"
7
+ },
8
+ "homepage": "https://github.com/Yummybait-fin/uniswap-tx-builder-mcp",
9
+ "keywords": [
10
+ "uniswap",
11
+ "defi",
12
+ "liquidity",
13
+ "mcp",
14
+ "ethereum"
15
+ ]
16
+ }
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,195 @@
1
+ # uniswap-tx-builder-mcp
2
+
3
+ A **keyless** [MCP](https://modelcontextprotocol.io) server that builds *unsigned* Uniswap v3
4
+ liquidity-position transactions and optionally simulates them via `eth_call`. **It never holds
5
+ keys and never signs** — you take the returned calldata and sign + broadcast it with your own
6
+ wallet (viem, a CDP wallet MCP, any signer).
7
+
8
+ Because it's keyless, the only limits that apply to a built tx are *your wallet's* — the server's
9
+ threat surface is just "it returns calldata and reads public RPCs."
10
+
11
+ ## Tools
12
+
13
+ Every build tool returns `tx = { to, data, value, chainId }` plus `rlp` — the **unsigned
14
+ EIP-1559 (type-2)** serialization of `tx` with nonce/fees/gas zeroed (signing services like the
15
+ CDP API populate them; serialize `tx` yourself if you manage nonces) — and a human `description`.
16
+ `value` is `"0"` except the payable Universal Router wrap/swap builds. Addresses are `0x…40`;
17
+ `positionId` and amounts are decimal **strings** (they exceed JS safe integers).
18
+
19
+ | Tool | Purpose |
20
+ |------|---------|
21
+ | `build_collect` | Collect all uncollected fees from a position to `recipient`. |
22
+ | `build_close` | Remove all liquidity **+** collect; `burn: true` also burns the empty NFT. Returns the read position. |
23
+ | `build_mint` | Mint a new position (raw ticks + wei amounts). |
24
+ | `build_increase` | Add liquidity to an existing position. |
25
+ | `build_wrap` | Wrap native ETH → WETH via the Universal Router (`WRAP_ETH`). |
26
+ | `build_swap` | Exact-in WETH → token swap via the Universal Router; with `wrapWei` it wraps native ETH first and sweeps the WETH remainder in the same tx. |
27
+ | `plan_position` | **Read-only.** Turn a human price range + human amounts into aligned ticks + wei amounts for `build_mint`. Reads token decimals over RPC. |
28
+ | `get_pool_state` | **Read-only.** Live pool state (tick, sqrtPriceX96, human price, spacing); optional ±pct range suggestion (rounded inward) and live-ratio `amount0Desired`/`amount1Desired` from wallet balances. |
29
+
30
+ `simulate` runs an opt-in `eth_call` dry-run: **on by default** for collect/close, **off** for
31
+ mint/increase (those need approvals + balances, so the dry-run usually reverts); wrap/swap
32
+ simulate when you pass `sender` (the signing wallet). A reverted simulation comes back as an
33
+ error — don't sign a tx that failed to simulate. See the companion skill for the full argument
34
+ reference and position lifecycle.
35
+
36
+ ## Install & run
37
+
38
+ From npm (no clone, stdio transport — what MCP clients spawn):
39
+
40
+ ```bash
41
+ npx -y @yummybait/uniswap-tx-builder-mcp
42
+ ```
43
+
44
+ From source:
45
+
46
+ ```bash
47
+ npm install
48
+ npm run dev # stdio MCP from source via tsx
49
+ npm run build && npm start # compile to dist/, then run the built server
50
+ npm test # vitest
51
+ ```
52
+
53
+ Set `MCP_HTTP_PORT` to serve the streamable-HTTP transport instead of stdio (endpoint:
54
+ `http://<host>:<port>/mcp`). HTTP runs **stateless** — every POST gets a fresh server/transport
55
+ pair, so any number of clients can connect and reconnect freely with no session bookkeeping:
56
+
57
+ ```bash
58
+ MCP_HTTP_PORT=8102 npm run dev
59
+ ```
60
+
61
+ Docker — build locally, or pull a released image from GHCR:
62
+
63
+ ```bash
64
+ docker build -t uniswap-tx-builder-mcp:local . # local build
65
+ docker pull ghcr.io/yummybait-fin/uniswap-tx-builder-mcp:latest # released image
66
+
67
+ docker run -i --rm uniswap-tx-builder-mcp:local # stdio
68
+ docker run --rm -p 8102:8102 -e MCP_HTTP_PORT=8102 uniswap-tx-builder-mcp:local # HTTP
69
+ ```
70
+
71
+ ## Connect to an MCP client
72
+
73
+ **Claude Code** (stdio via npm):
74
+
75
+ ```bash
76
+ claude mcp add uniswap-tx-builder -- npx -y @yummybait/uniswap-tx-builder-mcp
77
+ ```
78
+
79
+ **Generic client config** (Claude Desktop, etc.) — add to the client's `mcpServers`:
80
+
81
+ ```json
82
+ {
83
+ "mcpServers": {
84
+ "uniswap-tx-builder": {
85
+ "command": "npx",
86
+ "args": ["-y", "@yummybait/uniswap-tx-builder-mcp"],
87
+ "env": { "RPC_ETH": "https://your-eth-rpc" }
88
+ }
89
+ }
90
+ }
91
+ ```
92
+
93
+ (For a local build, swap the command for `node /abs/path/to/uniswap-tx-builder-mcp/dist/mcp.js`.)
94
+
95
+ For HTTP, run the server with `MCP_HTTP_PORT` and point the client at `http://<host>:<port>/mcp`.
96
+
97
+ ## Install the companion skill
98
+
99
+ `skills/uniswap-tx-builder/` is a generic agent **skill** (no app- or wallet-specific knowledge)
100
+ that teaches an agent how to drive these tools: the argument reference, simulate-first, the
101
+ close→mint rebalance sequence, and the "your wallet signs" handoff. It pairs with the MCP — install
102
+ both. Pick whichever install path suits you.
103
+
104
+ **A. Claude Code plugin (`/plugin`)** — the repo doubles as a plugin marketplace:
105
+
106
+ ```text
107
+ /plugin marketplace add Yummybait-fin/uniswap-tx-builder-mcp
108
+ /plugin install uniswap-tx-builder@yummybait
109
+ ```
110
+
111
+ **B. npx** — copies the skill into a skills dir (no clone needed):
112
+
113
+ ```bash
114
+ # personal (~/.claude/skills, every project)
115
+ npx -p @yummybait/uniswap-tx-builder-mcp uniswap-tx-builder-skill
116
+
117
+ # or project-scoped (./.claude/skills, checked in with a repo)
118
+ npx -p @yummybait/uniswap-tx-builder-mcp uniswap-tx-builder-skill --project
119
+ ```
120
+
121
+ **C. Manual copy** — straight from a checkout:
122
+
123
+ ```bash
124
+ cp -r skills/uniswap-tx-builder ~/.claude/skills/ # personal
125
+ mkdir -p .claude/skills && cp -r skills/uniswap-tx-builder .claude/skills/ # project
126
+ ```
127
+
128
+ The agent picks it up by its `SKILL.md` frontmatter — no restart needed for project skills.
129
+
130
+ ## Configuration
131
+
132
+ Per-chain RPCs default to public endpoints; override with env vars (see `src/config.ts`):
133
+
134
+ | Chain | ID | RPC env var |
135
+ |-------|----|-------------|
136
+ | Ethereum | 1 | `RPC_ETH` |
137
+ | Optimism | 10 | `RPC_OP` |
138
+ | Polygon | 137 | `RPC_POLYGON` |
139
+ | Base | 8453 | `RPC_BASE` |
140
+ | Arbitrum | 42161 | `RPC_ARB` |
141
+
142
+ Public RPCs are rate-limited and best-effort — set your own for anything beyond casual use.
143
+
144
+ ## Architecture
145
+
146
+ One code path, transport kept separate so it stays testable and ready for a future v4 tool set:
147
+
148
+ ```
149
+ builder.ts calldata + unsigned-RLP encoding (viem), position/pool reads
150
+ ticks.ts pure tick / sqrt-price / liquidity math (no I/O)
151
+ operations.ts build + optional eth_call simulate + response shaping
152
+ mcp.ts the MCP transport (stdio / stateless streamable HTTP)
153
+ ```
154
+
155
+ ## CI / releases
156
+
157
+ GitHub Actions (`.github/workflows/`):
158
+
159
+ - **CI** — typecheck + tests + npm-tarball allowlist check on every push to `main` and on PRs.
160
+ - **Release** — pushing a `v*` tag re-runs the tests, bumps the version on `main` to match the tag
161
+ (`package.json` + `.claude-plugin/plugin.json`), publishes the npm package
162
+ (`@yummybait/uniswap-tx-builder-mcp`) **with provenance**, and builds + publishes the Docker
163
+ image to GHCR (`ghcr.io/yummybait-fin/uniswap-tx-builder-mcp`), tagged with the version (and
164
+ `latest`). The tag is the single version source for both artifacts; the bump lands on `main`
165
+ after the tag, so the tagged commit keeps its old version.
166
+
167
+ ```bash
168
+ git tag v0.3.0 && git push origin v0.3.0 # cut a release
169
+ ```
170
+
171
+ ### npm supply-chain posture
172
+
173
+ The npm publish job is locked down; keep these properties when touching it:
174
+
175
+ - **Trusted publishing (OIDC)** — no long-lived npm token in CI. Configured on npmjs.com under
176
+ *package → Settings → Trusted publisher* (GitHub Actions, this repo, `release.yml`). The
177
+ `NPM_TOKEN` secret path in the workflow exists **only to bootstrap the first release** (trusted
178
+ publishers can't be configured before the package exists) — delete the secret afterwards and
179
+ set the package's publishing access to *"Require two-factor authentication and disallow
180
+ tokens"*.
181
+ - **Provenance** — `publishConfig.provenance: true` attaches a Sigstore attestation linking every
182
+ published tarball to the exact workflow run and commit. It also makes an accidental local
183
+ `npm publish` fail (no OIDC outside CI). Consumers verify with `npm audit signatures`.
184
+ - **Gates before publish** — `npm audit signatures` (registry attestations of the dep tree),
185
+ `npm audit --omit=dev --audit-level=high` (no known high/critical vulns in shipped deps),
186
+ typecheck + full test suite (`prepublishOnly`), and `scripts/verify-tarball.mjs` (the tarball
187
+ must contain exactly the allowlisted files — no secrets, no strays).
188
+ - **Hardened job** — `npm ci --ignore-scripts` (no dependency postinstall runs where publish
189
+ credentials live), minimal per-job permissions, actions pinned to commit SHAs, Dependabot
190
+ keeping pins and deps fresh.
191
+
192
+ ## Scope
193
+
194
+ Uniswap v3 `NonfungiblePositionManager` on the chains above. Calling an unconfigured chain returns
195
+ an "Unsupported chain" error. Roadmap: Uniswap v4 as a separate set of tools alongside these.
@@ -0,0 +1,34 @@
1
+ #!/usr/bin/env node
2
+ // Copies the bundled `uniswap-tx-builder` agent skill into a Claude skills
3
+ // directory. Personal scope (~/.claude/skills) by default; pass --project to
4
+ // install into ./.claude/skills instead. Uses only Node builtins, so it runs
5
+ // from npx without a build step.
6
+ import { cpSync, existsSync, mkdirSync } from "node:fs";
7
+ import { homedir } from "node:os";
8
+ import { dirname, join } from "node:path";
9
+ import { fileURLToPath } from "node:url";
10
+
11
+ const SKILL = "uniswap-tx-builder";
12
+ const here = dirname(fileURLToPath(import.meta.url));
13
+ const source = join(here, "..", "skills", SKILL);
14
+
15
+ if (!existsSync(source)) {
16
+ console.error(`[install-skill] skill source not found at ${source}`);
17
+ process.exit(1);
18
+ }
19
+
20
+ const project = process.argv.includes("--project");
21
+ const base = project
22
+ ? join(process.cwd(), ".claude", "skills")
23
+ : join(homedir(), ".claude", "skills");
24
+ const dest = join(base, SKILL);
25
+
26
+ mkdirSync(base, { recursive: true });
27
+ cpSync(source, dest, { recursive: true });
28
+
29
+ console.log(`[install-skill] installed "${SKILL}" → ${dest}`);
30
+ console.log(
31
+ project
32
+ ? "[install-skill] scope: this project (.claude/skills) — commit it to share with the repo."
33
+ : "[install-skill] scope: personal (~/.claude/skills) — available in every project.",
34
+ );