Wagmi llms.txt · AI Docs Browser · mdream

[llms.txt Tools](https://mdream.dev/llms-txt/wagmi/llms-txt)

# Wagmi llms.txt

Browse Wagmi documentation as markdown. Click any page in the sidebar to view it, or copy the full llms.txt for your AI tools.

wagmi.sh/llms.txt

[Raw llms.txt](https://wagmi.sh/llms.txt) [Raw llms-full.txt](https://wagmi.sh/llms-full.txt)

Copy Markdown [](https://wagmi.sh/llms.txt)

llms.txt

Table of Contents

Why Wagmi

Installation

Getting Started

TypeScript

Comparison

TanStack Query

Viem

Error Handling

Ethers.js Adapters

Chain Properties

SSR

Connect Wallet

Send Transaction

Read from Contract

Write to Contract

FAQ / Troubleshooting

Migrate from v2 to v3

Migrate from v1 to v2

createConfig

createStorage

Chains

Connectors

Transports

WagmiProvider

baseAccount

coinbaseWallet

injected

metaMask

mock

safe

tempoWallet

walletConnect

custom

fallback

http

unstable_connector

webSocket

useBalance

useBlobBaseFee

useBlockNumber

useBlock

useBlockTransactionCount

useBytecode

useCall

useCallsStatus

useCapabilities

useChainId

useChains

useClient

useConfig

useConnect

useConnection

useConnectionEffect

useConnections

useConnectorClient

useConnectors

useContractEvents

useDeployContract

useDisconnect

useEnsAddress

useEnsAvatar

useEnsName

useEnsResolver

useEnsText

useFeeHistory

useProof

usePublicClient

useEstimateFeesPerGas

useEstimateGas

useEstimateMaxPriorityFeePerGas

useGasPrice

useInfiniteReadContracts

usePrepareTransactionRequest

useReadContract

useReadContracts

useReconnect

useSendCalls

useSendTransaction

useShowCallsStatus

useSignMessage

useSignTransaction

useSignTypedData

useSimulateContract

useStorageAt

useSwitchChain

useSwitchConnection

useTransaction

useTransactionConfirmations

useTransactionCount

useTransactionReceipt

useWaitForCallsStatus

useWaitForTransactionReceipt

useVerifyMessage

useVerifyTypedData

useWalletClient

useWatchAsset

useWatchBlocks

useWatchBlockNumber

useWatchContractEvent

useWatchPendingTransactions

useWriteContract

Actions

Errors

cookieToInitialState

deserialize

serialize

Why Wagmi

Installation

Getting Started

TypeScript

TanStack Query

Viem

Error Handling

Chain Properties

SSR

Connect Wallet

Send Transaction

Read from Contract

Write to Contract

FAQ / Troubleshooting

createConfig

createStorage

Chains

Connectors

Transports

WagmiPlugin

Nuxt

baseAccount

coinbaseWallet

injected

metaMask

mock

safe

tempoWallet

walletConnect

custom

fallback

http

unstable_connector

webSocket

useBalance

useBlockNumber

useBytecode

useChainId

useChains

useClient

useConfig

useConnect

useConnection

useConnectionEffect

useConnections

useConnectorClient

useConnectors

useDisconnect

useEnsAddress

useEnsAvatar

useEstimateGas

useReadContract

useReconnect

useSendTransaction

useSignMessage

useSignTransaction

useSignTypedData

useSimulateContract

useSwitchChain

useSwitchConnection

useTransaction

useTransactionReceipt

useWaitForTransactionReceipt

useWatchBlockNumber

useWatchContractEvent

useWriteContract

Actions

Errors

deserialize

serialize

Why Wagmi Core

Installation

Getting Started

TypeScript

Viem

Framework Adapters

Error Handling

Ethers.js Adapters

Chain Properties

FAQ / Troubleshooting

Migrate from v2 to v3

Migrate from v1 to v2

createConfig

createConnector

createStorage

Chains

Connectors

Transports

baseAccount

coinbaseWallet

injected

metaMask

mock

safe

tempoWallet

walletConnect

custom

fallback

http

unstable_connector

webSocket

call

connect

deployContract&#x20;

disconnect

estimateFeesPerGas

estimateGas

estimateMaxPriorityFeePerGas

getBalance

getBlobBaseFee

getBlock

getBlockNumber

getBlockTransactionCount

getBytecode

getCallsStatus

getCapabilities

getChainId

getChains

getClient

getConnection

getConnections

getConnectorClient

getConnectors

getContractEvents

getEnsAddress

getEnsAvatar

getEnsName

getEnsResolver

getEnsText

getFeeHistory

getGasPrice

getProof

getPublicClient

getStorageAt

getTransaction

getTransactionConfirmations

getTransactionCount

getTransactionReceipt

getWalletClient

multicall

prepareTransactionRequest

reconnect

readContract

readContracts

sendCalls

sendTransaction

showCallsStatus

signMessage

signTypedData

simulateContract

switchChain

switchConnection

verifyMessage

verifyTypedData

waitForCallsStatus

waitForTransactionReceipt

watchAsset

watchBlocks

watchBlockNumber

watchChainId

watchClient

watchConnection

watchConnections

watchConnectors

watchContractEvent

watchPendingTransactions

watchPublicClient

writeContract

Errors

cookieToInitialState

deserialize

serialize

Why Wagmi CLI

Installation

Getting Started

Migrate from v1 to v2

Configuring CLI

Config Options

generate

init

actions

blockExplorer

etherscan

fetch

foundry

hardhat

react

sourcify

Why Wagmi

Installation

Getting Started

TypeScript

TanStack Query

Viem

Error Handling

Connect Wallet

createConfig

createStorage

Chains

Connectors

Transports

WagmiProvider

baseAccount

injected

metaMask

mock

safe

tempoWallet

walletConnect

custom

fallback

http

webSocket

useBalance

useBlockNumber

useChainId

useChains

useClient

useConfig

useConnect

useConnection

useConnectionEffect

useConnections

useConnectorClient

useConnectors

useDisconnect

useInfiniteReadContracts

useReadContract

useReadContracts

useReconnect

useSimulateContract

useSwitchChain

useSwitchConnection

useWatchBlockNumber

useWatchContractEvent

useWriteContract

useWriteContractSync

Actions

Errors

Contributing

Creating Connectors

Getting Started

Chains

Connectors

amm.useBurn

amm.useLiquidityBalance

amm.useMint

amm.usePool

amm.useRebalanceSwap

amm.useWatchBurn

amm.useWatchMint

amm.useWatchRebalanceSwap

dex.useBalance

dex.useBuy

dex.useBuyQuote

dex.useCancel

dex.useCreatePair

dex.useOrder

dex.usePlace

dex.usePlaceFlip

dex.useSell

dex.useSellQuote

dex.useTickLevel

dex.useWatchFlipOrderPlaced

dex.useWatchOrderCancelled

dex.useWatchOrderFilled

dex.useWatchOrderPlaced

dex.useWithdraw

faucet.useFund

fee.useSetUserToken

fee.useUserToken

fee.useWatchSetUserToken

nonce.useNonce

nonce.useWatchNonceIncremented

policy.useCreate

policy.useData

policy.useIsAuthorized

policy.useModifyBlacklist

policy.useModifyWhitelist

policy.useSetAdmin

policy.useWatchAdminUpdated

policy.useWatchBlacklistUpdated

policy.useWatchCreate

policy.useWatchWhitelistUpdated

reward.useClaim

reward.useSetRecipient

reward.useUserRewardInfo

reward.useWatchRewardRecipientSet

token.useApprove

token.useBurn

token.useBurnBlocked

token.useChangeTransferPolicy

token.useCreate

token.useGetAllowance

token.useGetBalance

token.useGetMetadata

token.useGrantRoles

token.useHasRole

token.useMint

token.usePause

token.useRenounceRoles

token.useRevokeRoles

token.useSetRoleAdmin

token.useSetSupplyCap

token.useTransfer

token.useUnpause

token.useWatchAdminRole

token.useWatchApprove

token.useWatchBurn

token.useWatchCreate

token.useWatchMint

token.useWatchRole

token.useWatchTransfer

wallet.useDeposit

wallet.useSwap

wallet.useTransfer

zone.useAuthorizationTokenInfo

zone.useDeposit

zone.useDepositStatus

zone.useEncryptedDeposit

zone.useRequestVerifiableWithdrawal

zone.useRequestWithdrawal

zone.useSignAuthorizationToken

zone.useWithdrawalFee

zone.useZoneInfo

amm.burn

amm.getLiquidityBalance

amm.getPool

amm.mint

amm.rebalanceSwap

amm.watchBurn

amm.watchMint

amm.watchRebalanceSwap

dex.buy

dex.cancel

dex.createPair

dex.getBalance

dex.getBuyQuote

dex.getOrder

dex.getSellQuote

dex.getTickLevel

dex.place

dex.placeFlip

dex.sell

dex.watchFlipOrderPlaced

dex.watchOrderCancelled

dex.watchOrderFilled

dex.watchOrderPlaced

dex.withdraw

faucet.fund

fee.getUserToken

fee.setUserToken

fee.watchSetUserToken

nonce.getNonce

nonce.watchNonceIncremented

policy.create

policy.getData

policy.isAuthorized

policy.modifyBlacklist

policy.modifyWhitelist

policy.setAdmin

policy.watchAdminUpdated

policy.watchBlacklistUpdated

policy.watchCreate

policy.watchWhitelistUpdated

reward.claim

reward.getUserRewardInfo

reward.setRecipient

reward.watchRewardRecipientSet

token.approve

token.burn

token.burnBlocked

token.changeTransferPolicy

token.create

token.getAllowance

token.getBalance

token.getMetadata

token.grantRoles

token.hasRole

token.mint

token.pause

token.renounceRoles

token.revokeRoles

token.setRoleAdmin

token.setSupplyCap

token.transfer

token.unpause

token.watchAdminRole

token.watchApprove

token.watchBurn

token.watchCreate

token.watchMint

token.watchRole

token.watchTransfer

wallet.deposit

wallet.swap

wallet.transfer

zone.deposit

zone.getAuthorizationTokenInfo

zone.getDepositStatus

zone.encryptedDeposit

zone.getWithdrawalFee

zone.getZoneInfo

zone.requestVerifiableWithdrawal

zone.requestWithdrawal

zone.signAuthorizationToken

tempoWallet

dangerous_secp256k1

webAuthn

reward.distribute

reward.useDistribute

reward.useWatchRewardDistributed

reward.watchRewardDistributed

Agent Guidelines

baseAccount

coinbaseWallet

cookieToInitialState

create-wagmi

createConfig

createStorage

custom

deserialize

fallback

http

injected

metaMask

mock

safe

serialize

signTransaction

tempoWallet

Testing

Testing

unstable_connector

Untitled

Untitled

Untitled

Untitled

Untitled

Untitled

Untitled

Untitled

Untitled

Untitled

Untitled

Untitled

Untitled

useEnsName

useWriteContracts

walletConnect

webSocket

writeContracts

## What is Wagmi's llms.txt?

Wagmi publishes an `/llms.txt` file that provides AI systems with a structured index of its documentation. It follows the [llms.txt specification](https://llmstxt.org), organizing links to guides, API references, and tutorials under section headings so that LLMs like ChatGPT, Claude, and Gemini can quickly understand what Wagmi offers and where to find details.

Issues

Spec

1

Sections

558

Links

38.9 KB

Size

~10.0k

Tokens

Sections: Table of Contents

## Add Wagmi Docs to Your AI Assistant

Select your tool to see how to add Wagmi's llms.txt as a documentation source.

Cursor

 Windsurf

 Claude Code

 ChatGPT

 Zed

 Copilot

1. 1

   Open any chat or composer panel
2. 2

   Type @Docs and select "Add new doc"
3. 3

   Paste the URL: https://wagmi.sh/llms.txt
4. 4

   Wait for the green dot (indexing complete)
5. 5

   Reference @Docs in chat when asking about Wagmi

Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too.

## Spec Compliance 62 errors

## Frequently Asked Questions

Where is Wagmi's llms.txt file?

Wagmi publishes its llms.txt at https://wagmi.sh/llms.txt. This file provides a structured, markdown-formatted index of Wagmi's documentation that AI systems can consume to understand the project's APIs, guides, and references.

How do I use Wagmi's llms.txt with AI coding assistants?

Copy the llms.txt content and paste it into your AI assistant (Cursor, Windsurf, Claude, ChatGPT) as context. This gives the AI an accurate map of Wagmi's documentation so it can provide better code suggestions and answers about Wagmi.

What does Wagmi's llms.txt contain?

Wagmi's llms.txt contains 1 sections and 558 documentation links in 38.9 KB (~10.0k tokens). Key sections include Table of Contents.

How many tokens does Wagmi's llms.txt use?

The concise llms.txt index is approximately 10.0k tokens (38.9 KB). Most AI assistants can fit this within their context window. For the full expanded documentation, look for an llms-full.txt variant which embeds all content inline.

What is Wagmi?

React Hooks for Ethereum. Wagmi's llms.txt file helps AI systems understand this by providing a structured overview of its documentation, making it easier for developers to get accurate AI-assisted help when working with Wagmi.

Can I generate an llms.txt for my own project?

Yes. Use the free llms.txt generator at mdream.dev/tools/llms-txt/generator to crawl your site and produce a spec-compliant llms.txt file. You can also validate existing files with the llms.txt validator.

## Browse More llms.txt Files

[Tiptap The headless rich text editor framework](https://mdream.dev/llms-txt/wagmi/llms-txt/tiptap) [unstorage Universal Storage Layer](https://mdream.dev/llms-txt/wagmi/llms-txt/unstorage) [NativeWind Tailwind CSS for React Native](https://mdream.dev/llms-txt/wagmi/llms-txt/nativewind) [Kysely The type-safe SQL query builder for TypeScript](https://mdream.dev/llms-txt/wagmi/llms-txt/kysely) [Mastra The TypeScript AI agent framework](https://mdream.dev/llms-txt/wagmi/llms-txt/mastra) [Apollo GraphQL The GraphQL developer platform](https://mdream.dev/llms-txt/wagmi/llms-txt/apollo-graphql) [Drizzle TypeScript ORM that is lightweight and serverless-ready](https://mdream.dev/llms-txt/wagmi/llms-txt/drizzle) [SWR React Hooks for Data Fetching](https://mdream.dev/llms-txt/wagmi/llms-txt/swr)

[View all 99 projects ](https://mdream.dev/llms-txt/wagmi/llms-txt)

## Related Tools

[<h3>llms.txt Generator</h3>Generate an llms.txt for your own project.](https://mdream.dev/llms-txt/wagmi/tools/llms-txt/generator) [<h3>llms.txt Validator</h3>Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/wagmi/tools/llms-txt/validator)

© 2026 [Harlan Wilton](https://github.com/harlan-zw) · [MIT](https://github.com/harlan-zw/mdream/blob/main/license)

[GitHub](https://github.com/harlan-zw/mdream) [Discord](https://discord.com/invite/275MBUBvgP)