PluginBench
Skill
Fail
Audit score 45

grimoire-uniswap

franalgaba/grimoire

Query Uniswap router metadata, tokens, and pools via Grimoire CLI for V3/V4 integration.

What is grimoire-uniswap?

Retrieves Uniswap router addresses, token lists, and pool data using the Grimoire venue CLI. Use this skill when you need to look up Uniswap adapter metadata, find pools for token pairs, or generate spell parameter blocks for swap actions.

  • Fetch router addresses and adapter metadata for Uniswap V3 and V4
  • Look up token lists by symbol or address across supported chains
  • Query pools for token pairs with configurable fee tiers and limits
  • Generate spell `params:` blocks for tokens and pools (agent-only)
  • Support both The Graph subgraph and on-chain RPC pool lookups
  • Emit metric surfaces for protocol comparison via `quote_out`

How to install grimoire-uniswap

npx skills add https://github.com/franalgaba/grimoire --skill grimoire-uniswap
Prerequisites
  • Grimoire CLI installed (`npx skills add https://github.com/franalgaba/grimoire --skill grimoire-uniswap`)
  • Optional: The Graph API key (`GRAPH_API_KEY`) for subgraph queries, or RPC URL (`RPC_URL`) for on-chain lookups
  • Chain ID and token symbols or addresses for pool/token queries
Claude Code
Cursor
Windsurf
Cline

How to use grimoire-uniswap

  1. 1.Run `grimoire venue doctor --adapter uniswap --chain 1 --rpc-url <rpc> --json` to validate adapter setup
  2. 2.Use `grimoire venue uniswap routers --chain <id>` to retrieve router addresses for your target chain
  3. 3.Query tokens with `grimoire venue uniswap tokens --chain 1 --symbol USDC --format spell` to list available tokens
  4. 4.Find pools using `grimoire venue uniswap pools --token0 USDC --token1 WETH --chain 1 --fee 3000` to discover liquidity
  5. 5.Generate spell params blocks with `tokens-snapshot` or `pools-snapshot` for agent-only automation
  6. 6.Reference the fee tier and constraints in your spell's `with()` clause when calling swap actions

Use cases

Good for
  • Find the correct Uniswap V3 router address and fee tier before writing a swap spell
  • Query available pools between USDC and WETH to determine optimal fee tier
  • Generate a token snapshot to populate spell parameters for multiple assets
  • Compare V3 and V4 swap quotes using the metric surface for protocol selection
  • Validate adapter configuration with preflight health checks before deployment
Who it's for
  • Spell developers writing Uniswap swap actions
  • Agents automating token and pool discovery
  • DeFi engineers comparing Uniswap V3 vs V4 routing
  • Teams using Grimoire for multi-chain liquidity queries

grimoire-uniswap FAQ

What is the difference between `pools` and `pools-snapshot`?

`pools` outputs human-readable JSON or table format; `pools-snapshot` generates a `params:` block for direct use in spell files (agent-only, suppressed in interactive mode).

Do I need a Graph API key to use this skill?

No. If `GRAPH_API_KEY` is not set, the skill falls back to on-chain RPC lookups using factory contracts. Set it to query The Graph subgraph for faster, more comprehensive pool data.

Which Uniswap fee tiers are supported?

Common fee tiers are 500 (0.05%), 3000 (0.3%), and 10000 (1%). The `--fee` parameter accepts any integer in basis points; use `pools` to discover available tiers for a pair.

Is `fee_tier` required in swap spells?

Yes. The Uniswap adapter throws an error if `fee_tier` is not specified in the `with()` clause. Always set it based on your pool's fee tier.

Can I use this skill for both V3 and V4?

CLI metadata commands work for both V3 and V4. V4 adapter is available programmatically via `createUniswapV4Adapter()`. Always use `grimoire venue uniswap ...` for metadata lookups regardless of your spell's venue.

Full instructions (SKILL.md)

Source of truth, from franalgaba/grimoire.


name: grimoire-uniswap description: Retrieves Uniswap router metadata using the Grimoire venue CLI. Use when you need router addresses, adapter information, or Uniswap V3/V4 details.

Grimoire Uniswap Skill

Use this skill to inspect Uniswap metadata and produce token/pool snapshots for spells.

Preferred invocations:

  • grimoire venue uniswap ...
  • npx -y @grimoirelabs/cli venue uniswap ... (no-install)
  • bun run packages/cli/src/index.ts venue uniswap ... (repo-local)
  • grimoire-uniswap ... (direct binary from @grimoirelabs/venues)

Recommended preflight:

  • grimoire venue doctor --adapter uniswap --chain 1 --rpc-url <rpc> --json

Commands

  • grimoire venue uniswap info — adapter metadata
  • grimoire venue uniswap routers [--chain <id>] — router addresses per chain
  • grimoire venue uniswap tokens [--chain <id>] [--symbol <sym>] [--address <addr>] [--source <url>] — token list lookup
  • grimoire venue uniswap tokens-snapshot [--chain <id>] [--symbol <sym>] [--address <addr>] [--source <url>] — generate spell params: block for tokens (agent-only)
  • grimoire venue uniswap pools --token0 <address|symbol> --token1 <address|symbol> [--chain <id>] [--fee <bps>] [--limit <n>] [--source <url>] [--endpoint <url>] [--graph-key <key>] [--subgraph-id <id>] [--rpc-url <url>] [--factory <address>] — find pools for a token pair
  • grimoire venue uniswap pools-snapshot --token0 <address|symbol> --token1 <address|symbol> [--chain <id>] [--fee <bps>] [--limit <n>] [--source <url>] [--endpoint <url>] [--graph-key <key>] [--subgraph-id <id>] [--rpc-url <url>] [--factory <address>] — generate spell params: block for pools (agent-only)

Pool Data Sources

Pools can be fetched from The Graph (subgraph) or directly from on-chain factory contracts:

  • Subgraph (default when GRAPH_API_KEY is set): queries The Graph decentralized network. Built-in subgraph IDs for Ethereum, Optimism, Polygon, Base, Arbitrum.
  • RPC (fallback): if no usable graph config is present, pools uses on-chain factory lookups (with --rpc-url/RPC_URL when provided, otherwise chain default RPC where available).
  • To force RPC mode: provide --rpc-url and omit --graph-key.

Environment Variables

VariableDescription
GRAPH_API_KEYThe Graph API key for subgraph queries (get one at https://thegraph.com/studio/apikeys/)
RPC_URLFallback RPC URL for on-chain pool lookups

Examples

grimoire venue uniswap info --format table
grimoire venue uniswap routers
grimoire venue uniswap routers --chain 1
grimoire venue uniswap tokens --chain 1 --symbol USDC --format spell
grimoire venue uniswap pools --chain 1 --token0 USDC --token1 WETH --fee 3000 --format spell
grimoire venue uniswap pools --chain 8453 --token0 USDC --token1 WETH --fee 500 --rpc-url $RPC_URL --format table
grimoire venue uniswap pools --chain 8453 --token0 USDC --token1 WETH --fee 500 --graph-key $GRAPH_API_KEY --subgraph-id <id>
grimoire venue uniswap tokens-snapshot --chain 1 --symbol USDC
grimoire venue uniswap pools-snapshot --chain 1 --token0 USDC --token1 WETH --rpc-url $RPC_URL

Use tokens-snapshot or pools-snapshot to emit a params: block for spell inputs. These are agent-only commands (output suppressed in interactive mode).

Metric Surface (Spell Comparisons)

Uniswap V3 and V4 expose quote_out for protocol comparison:

v3_out = metric("quote_out", uni_v3, USDC, "asset_out=WETH,amount=1000000,fee_tier=3000")
v4_out = metric("quote_out", uni_v4, USDC, "asset_out=WETH,amount=1000000,fee_tier=3000,tick_spacing=60")

Selector fields:

  • required: asset_out
  • optional: amount (defaults to 1 unit of input asset), fee_tier
  • V4 optional: tick_spacing

Spell Constraints

When writing swap actions in .spell files targeting Uniswap, use with clauses to set constraints:

uniswap_v3.swap(USDC, WETH, params.amount) with (
  fee_tier=3000,
  max_slippage=50,
  min_output=900000000000000,
  deadline=300,
)

fee_tier is required. The adapter throws if fee_tier is not specified. It is an action parameter (not a constraint) and is extracted from the with() clause.

Common fee tiers: 500 (0.05%), 3000 (0.3%), 10000 (1%).

ParameterTypeDescription
fee_tierinteger (bps)Required. Uniswap pool fee tier (e.g. 500, 3000, 10000)
ConstraintTypeDescription
max_slippageinteger (bps)Maximum slippage in basis points (e.g. 50 = 0.5%)
min_outputinteger (wei)Minimum output amount floor
max_inputinteger (wei)Maximum input amount cap
deadlineinteger (seconds)Transaction deadline from now
require_quotebooleanFail if on-chain quote fetch fails
require_simulationbooleanFail if simulation unavailable
max_gasinteger (wei)Gas estimate cap

Always set both max_slippage and min_output for swaps to prevent unexpected losses.

Supported Adapters

AdapterRouterApproval Flow
@uniswap_v3SwapRouter02Standard ERC20 approve
@uniswap_v4Universal RouterPermit2

Notes

  • CLI currently exposes V3 metadata. V4 adapter is available programmatically via createUniswapV4Adapter().
  • For metadata lookups (tokens, pools), use grimoire venue uniswap ... even when your spell venue is uniswap_v4.
  • Outputs JSON/table; tokens and pools also support --format spell.
  • Prefer --format json for automation and reproducible snapshots.
  • Only metadata is exposed (no on-chain quote endpoints).