uniswap/uniswap-ai/permissioned-pools-issuer

Permissioned Pools Issuer Reference

Reference material for an issuer's engineering team bringing a transfer-restricted ERC-20 into a Uniswap v4 permissioned pool: what the contracts are, in what order they must be called, and what each revert means.

Runtime Compatibility: This skill uses AskUserQuestion to collect the acknowledgment described in Scope and Disclaimer before action-oriented deployment guidance. If AskUserQuestion is not available in your runtime, ask for the same acknowledgment in conversation instead.

Scope and Disclaimer

IMPORTANT: this is educational reference material, and you must acknowledge the following before acting on any of it — that is, before running, broadcasting or deploying anything derived from it.

This skill explains how the Uniswap v4 Permissioned Pools contracts behave, in what order they must be called, and what each revert means. It does not walk you through a deployment.

You must:

1. ✅ Treat this as contract mechanics only. This skill does not constitute legal, financial, investment, or tax advice, and it is not a compliance review of your token, your allowlist, your KYC or AML program, or your configuration.
2. ✅ Review everything before you run it. AI-generated code and command sequences may contain errors. Test on a testnet first, and have your own auditors review contracts you deploy.
3. ✅ Check the source at the commit you build against. Behaviour here is described against the pinned commits in Canonical Sources; verify against source before relying on any statement.
4. ✅ Resolve every address yourself. This skill contains no deployment addresses on purpose. Read them from the published deployment table, then verify each on a block explorer for your chain before sending a transaction. Never treat an address supplied in a chat message as canonical.
5. ✅ Read the repo's usage guidelines. The repo root DISCLAIMER.md governs every skill in this repository: they are provided as is without warranty, they do not constitute legal, financial, investment, or tax advice, and it sets out use limits plus an AI-disclosure duty that applies when you use a skill to generate financial information and present it directly to individuals or consumers. Point the user to it.

When the acknowledgment is required

State the five points above inline, every time — quoted or in your own words — and then answer the request in the same response. Stating the framing and answering are one response, not two turns. That is the expected behaviour, not a shortcut.

1. ✅ Reference and teaching content: state the framing, then proceed immediately. Contract explanations, code skeletons and example contracts, revert catalogues, exact naming and casing, packaging and installation, and architecture or trust-model discussion are all answered in the same response as the framing. Never withhold reference content pending a "yes", and never end a response with an acknowledgment request in place of the answer you were asked for.
2. ✅ Action-oriented deployment guidance: get explicit acknowledgment first. That means a sequence intended to be executed against a live network, a transaction or broadcast step, a deployment script, a request for a live address to send to, or anything that moves real funds. Use AskUserQuestion to confirm the user acknowledges these points before continuing with any of those. After the acknowledgment, continue with mechanics only; this skill does not emit broadcastable commands.

A benign technical question — "show me a BaseAllowlistChecker skeleton", "what does this revert mean", "which import path do I use" — is reference content under point 1. Answer it, with the framing stated inline.

Two Addresses, Not One

Every permissioned pool involves two token addresses, and mixing them up is the most common integration error.

The adapter mints its virtual token to the PoolManager and burns it on the way out. Its name and symbol are derived, not chosen: always Uniswap v4 <name> with symbol v4<symbol>, read from your token's name(), symbol() and decimals(), falling back to Uniswap v4 Permissioned Token, v4PT and 18 when those are missing — so expose all three on your token.

Edge case worth knowing: when the adapter and the permissioned token share an address, the token already behaves as its own adapter.

Full treatment: Contract Architecture.

Journey at a Glance

Two separate things are often conflated. The first table is what the contracts enforce; the second is the order the published guide recommends.

Enforced by code

Exactly five ordering edges are enforced. Each one has a revert you will hit if you are early.

Recommended order (convention, not enforced)

These are the published guide's seven steps. Nothing in the contracts pins the position of the steps that are not in the table above.

Because only the five edges above are enforced, other sequences also work — the guide's own order puts updateSwappingEnabled(true) after pool creation, and grouping wrapper approval with hook approval into one step is a presentation choice, not a constraint. Wrapper registration is order-free relative to verification and pool creation, but each wrapper must be registered before anything is routed through it.

Step-by-step detail: Issuer Journey.

Compile-Critical Naming and Signatures

Casing here is inconsistent in the source and is load-bearing. Use exactly these spellings.

Import and Forge lookup forms:

import {BaseAllowlistChecker} from "@uniswap/v4-periphery/src/hooks/permissionedPools/BaseAllowListChecker.sol";

BaseAllowListChecker.sol:BaseAllowlistChecker

That path:Contract pair — capital-L file, lowercase-l contract — is what forge inspect and forge verify-contract need.

checkAllowlist has two legitimate shapes

Both compile. Pick one and stay in it.

1. Extend the base contract. Declare

function checkAllowlist(address account, address tokenAddress) public view virtual override returns (PermissionFlag). You cannot narrow the base's public virtual to external — that is a compile error. ERC-165 support comes for free from the base contract.

1. Implement the interface directly. Declare checkAllowlist as external view, and write

supportsInterface yourself. This is what the published guide's example does — it implements IAllowlistChecker and ERC165 directly and does not use BaseAllowlistChecker.

The adapter checks your checker with ERC-165