NFTX Docs

Internal documentation for the NFTX protocol, written for the frontend team integrating against the on-chain contracts and the Envio HyperIndex subgraph.

This site is intentionally narrow:

It documents what’s deployed, not what’s been proposed.
Every code example uses viem as the canonical client. wagmi and ethers tabs are stubbed; populate them only once a journey is settled.
Every journey calls out prerequisites, failure modes, and the subgraph follow-through so the FE can render optimistic state without guessing.

How to read these docs

Architecture Subgraph overview User journeys Contract reference

Repo layout

The protocol lives across three sibling repositories:

Path	What lives here
`Contracts/`	Foundry repo. Solidity sources for `Locker`, `Listings`, `NFTXV4Hook`, `CollectionShutdown`, `AirdropRecipient`, `NFTXZap`, plus deployment artifacts and audits.
`Subgraph/`	Envio HyperIndex multichain indexer. `schema.graphql` + handler files, deployed against Base mainnet + Base Sepolia.
`Frontend/`	The web client + API. Consumes both the contracts (via `viem` + the wagmi-cli-generated hooks in `packages/contracts`) and the subgraph.

This Docs/ workspace lives alongside them and is consumed by humans only — nothing else imports from it.

Contract rename note

As of May 2026 the historic UniswapV4Implementation (interface IBaseImplementation) has been renamed to NFTXV4Hook / INFTXV4Hook. All errors, events, and structs have moved into the interface so external integrators can pin against a single source of truth. The legacy beneficiary / donate-threshold model has been retired in favour of flat per-beneficiary fee overrides (FeeOverrideSet / FeeOverrideRemoved).

If you’re reading older audit notes or commit history, treat UniswapV4Implementation and NFTXV4Hook as the same contract.

Getting started