---
url: /tempo/actions/amm.burn.md
---
# `amm.burn`

Burns liquidity tokens and receives the underlying token pair. [Learn more about the Fee AMM](https://docs.tempo.xyz/protocol/fees/spec-fee-amm)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.burn.md","from":213,"to":8601}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"15a04714fe58dc0283f87db9029cec245122d1b5c43e71becacad49ab6778a83","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScAGYArmD8gmCcWJJwMACqYIxocEFEobEwiJxipBZKFJywvCyhcCVgscwARmQRJS2MShZoADrZrOxcqaTpWTmmUBC8CAYAsrFyAljm8JzipWjlypykMFj76WASxskQ0RucTa1knC0YVz0kyXRsliecF/fhMJwAjNZOEFAW8hIo0BEAHQDAYAWk4ABEZg1OPg0GgsA0APTYoiMGDMKFwfDY6azbGxATmATwbGjcbZXKUajiJRzZDIEB0cSsBQslhsDicYApNKZJlwTiuGKkCDMTgAcnxhMVsLADIlkyCioALAAmayKqrSCIDXGcA3Wa0221gEAAXQdom0+l1mjMihUakQgK0kl0gU1E2Z8gsVn+dgcpCcNHIiGk7k8ODwhBI5H89DwITCkU4vBMXALYGi3RKAGEhKWlANBcN81XuiyxJJ9AAOSOe5SqJAANn9Oj0eGL1ZZ5ksSH1UccznjiY81C8qd8GeoAWHhY2zAg8TQGXSpAAKhAANaKTrdXrN11If7/ACs8i9Pd9j9Zg8CvJ3J33ZGPZ/tMMJ0QXVpxjWckDbJNFxTAw0z8NcswMYsxC3b80AANVCRgoHENB2H/c97kvE5r1bW8AGYpy7b1J1sd9AzwL9dyw8xcPwo9T0UMdwyQUCQHsGc40ne9oMwWCfHTFkaCQgTN32XgYEYLA0BKQ8Y2EWMkgAJRgRTlIYKhyTmEB1PETTEiEPY9KUlSoTIqRX34hRux9D1tEYgwFNswyzF4kCwNjFwQPUMSlzgldpPXAw62FIwklMFtHP+dRnOfNyB08wxLOEHjgLfQTwOExAoIXcTvHg1cZMCWKuF5ZgHP0f422olzaMQCjMqHAx6ryqwCujIL43+XswokyqotkuIEjOe5YlIMAAGUMASAAeSsS26AA+IIRzLTgNurKpRl5PQyFReKTCheqoRaealpW3goQABUcZgzrGdbGyULaOk4Z65WYRh0lW4ABk4CHSkUWBSBKAADaxaAAEmAMoKlcOGAG5wch2ID0IsB4cRlG0eUDHseSSGCjYvCCK4wnOAR5HUe2dGsZxiHmJ/fH6YvHoTgpyG0JY7D2LpgC+d6QXIfMABHWIcJyDBJYFjnOHwonmdJpRybV7yDLUjS4C0oRdP0lSKdcLaBjAU64FSRS5oW5aEhZYy8F07cSClOWFagJXZXlK42AgOR7P9dkkE5blaF5VZcCoOGk9yWshmFUVeH2PCYEO7oqnRTFpUDhVFQAAQAdzZIHsQLfY1UGIUuFFGghiL6JAaVCuq8YGv2BgGuHAsOB69qkUeByqUZXboOy8rpRq9r/uW7YeuBhQotvs4ABefMs5oXOlCCMHKcEoeSmQZeIEPeA0EsNBnRx7ZzPt4ZUWPoWL8JNgoRwh0SgLrAQQIgUBxu4AYrgzRgDXvJeASwuA73EJXHI48zhwGuswIkd1naPV2t9Ko79OB4z/LzJUiNDS8GsFCKhbQYDRGNDjamOFaacQlqQ2g5DKHUPEG0ehlNfaK0wCUe81gwAgMphrNh0QYAwCgFQqEUjYC8IgQMJOcNHQUC5CdBqdhN4IgPvZZ0mi3osi0R9KUCJXoxnenGNB6iuT7DQPdUwh58B/CfhZWa+sVIbDAFATgMAXhcHYuIAxzoQBJSam2fsNEXxti6oELBD1XZAX6oFCCiBDRjQqpFTMgQcyMHCFEdeDZNpKArN9VOjcSmjhdORX00g3xtRfNEjy3U5KlL6kgAaQlgr6nnMmbJUlcnZkOBAHAHAMBRH4f7QRxF+a+QiXRWQMSfTLNaYEaZStOmIGiYVIafEsnLiGYhPJ2FClijGFqXI+RCjFC2DsSo1Q9J1DkKiG4bRSB/S6PMyp9ZgySjdiiPAixljKTWFKTY2trKHHgBCPCSQviXE2O8u4DwniMBeP42g7wISIp+OkAEQIQTWDBB8SEMIoFgARMiWY/8MRYkQLiFURISRkhRJSakOQCRwHpOKEMpgJCRxQFyHkfIE4gFHqKf5kw24d2VASZgq8NR8slDqK0xpOCmnNNiS0hpbT6vtE6Wpjl9SGifK5W89F1l4GlaGPywFdmDXSQ+Q5EVjnVRGXKcZmAogSL6CARGqV9RQAovecsvBey9gorqcs1h7xUWkPqe84gKItDbLqXUAAhXg0gYDqHvA06I1gWgAFEWgtH9Y1Scuo4krMnPEvA+Ftkej2ek3UrrJIIQ9QYIIozvWTMITzVh/qyHWAofqidk6p3TusJW41+gKLWFaulGQDaDBEJYdxFJkE0nFXbWVcKnaqrRWCH2sgPrOCMLFpuhmI72FjpnY+p9Np/hzvCTeDqUbzXtX+Pxa1Bgr3MIJts5Zra90domsMgwtt3r2ycH8FCocYADAKKQEpcAkPlOEEhwFsw8AuL+HDRDCg4acG3FAJYfxRn4lgBC0ogoFBPLukofmSh0NIfVg4LgwN6NAzkJIdWEBOPIbAAAKXEAURamcDLscY+9QS2Q4AKmozhGR9xHjlxgC0e4cpy4HjQeqAjZHoCUaxY3KUaBy5Cfts80svAGxDDJQ0dUAAqHgjMNoYZI/mfjcApTlxyPgMjehCBQClHAWI9gNhSiIyYJDUI5AQEPhEOGVRYvYYUFCMgcpSBANI+ZPx6WvMwChJXBaeXON4XzOZe4fwiF+Pwpwcu5QaCCZ8Y8AActAErAArcL2wYC8gpW57gnAlCJZaKERmxGYCkaHhIBICHvrzTU415rOQ3FCeQHDUZik/PEjQNMKkcMHRBAATibEkBYB9ahOwJQbKKT8ZoGIOERB9S6ihLQbE4gsA912/ANB6JmByAAMT/b82II7kIfFQAGNt8HaDIfZZO2d+lF2rswBu3dh7PKns31e+9z733fv0jlHtwHaBgdg7JwDpHpBPlQk4EZ8bEBJtyGm3F7zvAattEHWpgLqgdzcbTgIXYqhCMY8QDN0j5HKMUoGAAfRcy5gA6pIbIyhlcK7Uq4sbE2psza+C0Hrek0CKilNY0LEL9jXCUuLtDKFgY0BOHIDAAw4CPXwHKSAeNODmDPMJnTEA9N3G4M9AAkhZ1xjwjiEhaAoKokA0OSDcdH9DTuISu4GOET33udw+0YAH0I7OID284F12AUI+v3MG8wNBnBFrSMD9tyArWrII84OH7EAB5FH53GWXe61jnQOPsR45e29j7X2ft/Zp/toHoPxBwlbzAOEQg4QI7hIIKI0R2ADG3Dbiwu/SDMHhUIeXYAS2xzFYOiogeWds45xl2biB1SqL69A5/CWks6lcXIRLTW7AcgUAioEQFMFoAMvQqIf+ABVmpAwBVQjWkOQun+xW3+h8ioMBQmAApMPFUIqHAcAaAeATqpAScNATAP/kJoQVAIgdZodigQkJziVtluwEEJYOXJwCWvTmwYqCroQGMnAFUBhpbnfpNn4g4FgDgJYCAREGAdqv9DsLkP4jwWhrBsbLoDDlsE4CeOrOBJtlsDDLDAoRDNwTliUPwRAIIcIfKCFmIeIBIT9tITIiYZDFVsgAEqEH/PeK+K4ZzFwFJuUHZKQPEOHmAC4sDBtNVMCJLkQMwL6FRL6G2JAhaELFVt3sbqblCCEWAGEREXAFEQEDEd1ogHER1NYNIB1MkX4RsFwJLr0GQLbHIKTjMADtiHQHpFSEkIgOoOoPUjUe4Z4XIA6HCM1k4WQDshkvqAMVwEMYETJuwSUQ0QtKEC0eTu0bQJ0WcD0b2DstYCkTqmkXUUsScI0asafhYO0dTArtrBkhRB1OqMUjBn8DvHwYwP/pwNpKzkPEIIqBTDNqVurkEHDIiOZLoGhijM8a4AAIRIhglkDQlwzyFgAQFKGoignKB3Aq7vHs5fFdDYZgCwkYngnQl0GGHZYqJJzqhX5xyMZ4x37i4ebMGka8C+bOaUrv5wCoFcBC7bxjZ6CLQDa8iLS2GEDlxAL/GbjZZ8mBiClZzMAinvRikSnclkYYCeYcY7wcGyYlYakKBBBC5VDZbIn77qnMHoG/6UGwFAGyEkGKFQH/xWnUE2lkmMHMBmlf6JYYFYGcC4EaoEE2nEEKFkG5COlUGAHwG0FtZukeloGsG5balmG8GWHWGlC2GqD2GOFSGKAyKgHImokOmcDIBJmwycAplYg2GiG7DiFojjEyHOhtYUmUpPGnR8lvEfF4k/FgB/Gml6klZlZgDAnEl3CQmnQwlwmYmkCIn5mkFoklDDlobYkdnfEElEnwlTlklNmqLSRsgchcjpDirIAYbzSKSnb964g9CqCxAtBQgFjMCD7XY8oY7Yjx6s54iE5fbmAtC9xf59YRCOhhKLIgQUSdhNIZQMRtIzbbL/DURgbBTWAQY5InLZiW7QBRB9kWnqFsgwAAD8JQ5kGAVQciYyZwoQlivIqIBFyADof0RAEAOEwIAA1P8F8OmIlg4f+UZECgYCGRZkJnDMgcdk1oFrbuXOOCVpwCCisIxgGM0BCFKNzskLzqkH5jIlUALkFuLgMKWGMFwPVtFoHocHUKQI8FhZoQVhsB8Q4TMkkFNvpeEKUNeWIDkF0UIChrcuFiwO8QJo1vDkodEEEBRClmefSgPqfmAOoLdiPuOLEF9uFRvthTyuFRRKTr0NEFCBRFCAvpAkEIybJe9OQRsDbsXmKKpQ1ltnDF0WHMfqfmgHliFZiOjkPmgtjsZGPtnBPh+cTj3FVVlZTqDlVTVXhENWgHCAGJENCG/knB/kwcIBvLuHyfeJKZ6T/oqAWLuCUNgSAVUOtScDOfaeQSULtapJwI+G1oJf0LNWgV6TqMdYgBqsdftbxUdehEImSRdZSXDOqI3n8Ntr1SNfVajo1QPhjsPvdm1ePqNZPkTjPhyu8X1VToNewLVSNWNToHmMfsZofiWMjWfmAOHKyEKtHHABYIpCyEQJQv8FCICNYABfOnxBRMsmBUgJ1BBRskltBbBU6sVKVAMkcl2iesUlzHuEOkRN8lePTSBL2LWsza+GuiAMLb+DepzbusFBRKFAeuNEhd2uAHbA7Ets/u5Q7swVhsVrhiZEZkVkhjLiZoxiprRlcCTTfrAMxqxjqZVtxp5Xxj5UJlpWJhJuIPMd4obvJg4IpspnKDRmpmipptpi0LpvphfkZrLoxmCBwBZlZqUDgLUHZg5jioda5u5nDH2SyWycJaoMFoLmFo5VFg5VbZljdSlmlgCfGRVhZfXf2UCSlh7dVkpXVukOVU1i1gYQReXt1lXv1vKcNu5g/lNh3XNnNeZI7HtEoCtoPetq1r5TtnPojgwcdg1QyriKDS1SPhDR1VDV1bDQjgjaDgjhdVEAVnDtva0ftnTqQH3mjiDc1VFeDeypDQTlPt1WsQDjfdTi/X5odsaYzszvruzvPb3bVnzn4hpbybVAybrnDJLtLsZhRpluqErqrurhUFrjrn8LPezobqzibvwObpXVbkVX8JYIFncI7mIJnm7sILnkIPnn7oXqnn8PHcHgeDwBHlHjADHrCq0AntcOwAw8Jo8Kw87mgFnrbB7gkF7tw77v7n8CVaXq4mhhXr1pPbXvXj9c3pg6Xn8O3jvZ3j3h/cDUfd/a1X/efQAzDSTtfQviDkvivmvlSpvtvjEHvmAAfn8EfrjWcBfjSTfvSWLrruQ0/sVnDK/hydNVyVdfFjdZgU6RGUQU9XOWiDkzQe9XvZdQCVkz6X6fgTQUGSibOYWT6cU+daU6gfFq3YmaoTqOWUIWmVWWxjWZIc4bIfk1ASoTlsFn5thVoS2LwLoU/I7EgZA/Tik6kVwaoRYQIRWb03YdWQ4bWdmTITMUWUMd4b4XU0LLUQ3tJsEaEeEfgJEUINEYsbAKUfEf8Ikc1AcRc+kZkfwNkbc/kYUfQMUS82UYupURRNUec0cTIy88sU0cA35hsVsd0b0f0dC24VwB4dTCMWMdmbDLsaakc3Mdc1wM88UPC6sQjsi7wK5YTOoLsb2PsUc/UacSsc0RcSiUMTcazMoHcQ8c2ZuM8W2UubiSuRht2ctWgQOUOeuZwKOe9OOQudOXac9ROeCWWTiZ8eK0IGuZOaSc00YZ9dSdfvHLfnE4RiXT5uEOyZ9TNcUryTvLKUKQqaKcHiqVdbMfTjKQKS64qTAMqcicUu6X2XydqQCX2QaVSEafTiaSE7GZk6tY04GSM4dYU+GU041jGRhRUzk1U0qDU6m6Gem9aZGa6VSL2eae0zAJwSWV05sz0yITs/03s4MzmcM6qwU8Wes2WQ25Wc2z8FmUMw2Y1k2aqcK68aK9q/iRKz2fGxhTKyCXKwqzAEq+uSq8GQUwuZq8uTO7q+qwiZufTp9TuUTfudIiyEeTuKQKeUDYfdiJefgNebefKA+Zjk+d1i+RNu+YA1+T+WgX+XTe+nUjWo0iuj0fLVBdugkarfGAhZrd4IKiyM8XgF6VWiBG2GBxajYFBiAGbEpCQH4huoJgBKiPeEms+jaIBPahGKzXBXB4he6iekEKhVAOheaTdWZbhfhWAIRZwMRSpLZXIORXXjxxgNRbRfRX4kEMxaxWQOxWx+bXgLxW1gJaU6RhpaJeJYzlJWCjozoHJYVYpYgypQPepSJX7TpahPZWIykOUKfiZRMxoTo74pZeztZVykIHZQPQZRFi0M5Y4mcO5XIEUF7d5WhlvUZScAFUFfY1gGFeZJFdjjFXFeZAlboEleZClVF2gOlZldlQMLlbrvlfJXIyVaZ6thVf9RE4DeeW+2DaPv/dDdPiTr1V40jSfsNRE2jeyHIRfpyaqcdYtVK4mxgXdb6dtQ2LuEW6iON2dYs1Dq0w3atXdQ9ehDNy9RtadSU4t2AKot9U3n9dSPIjV8FXe01Y+T/Y164810A21/1SDh1yjd1+NTvrI6E5wOE515E6e3ueEqTeKhTdTdTdaEB0BbqNIKzbLazf+mYBzdB+87B5BIxwLbJELduCLDTBxATCrAsh+uRx6LLWamzUxBjycKxEwtj/TNBXR9zcFAaB2kh1QChwYGh5LfeBD9+i+FaievhximpoBhxCR4oGRxR5RyItBd0kVPBa4GEgWLAEwCLmPJdMILKjPHPNXJfCPEr1KiqjKlPHKsytr1UhnJvAbzPFCD+dWEqsUqKIraLaIsLOT6LEBvTFUF4lwDKFvDjIguIMgir2gjdIki7LwLgqUvgmrJsrMrankIqICFCPeBqp82IkLBIoqIGgaCGmGhGlGjGnGgmkmimmmhmtmrmvmoWsWmWi0LwkLBujj2whwuL03/qjX1TC71T6wun/euOs383/8K38ooKytRgXz4R3zhF/TA0Bqvb8QgBJAuU6taPwL+37I/hKR/dVUMLRT9egTJAiyNYuIEgKAAECL0kI2ggK4K4EAA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { config } from './config'

const { amountUserToken, amountValidatorToken, receipt } =
  await Actions.amm.burnSync(config, {
    liquidity: parseUnits('10.5', 18),
    to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
    userToken: '0x20c0000000000000000000000000000000000000',
    validatorToken: '0x20c0000000000000000000000000000000000001',
  })

console.log('Received user tokens:', amountUserToken)
// @log: Received user tokens: 5250000000000000000n
console.log('Received validator tokens:', amountValidatorToken)
// @log: Received validator tokens: 5250000000000000000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `amm.burn` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.burn.md","from":8937,"to":9561}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'
import { parseUnits } from 'viem'

const hash = await Actions.amm.burn(config, {
  liquidity: parseUnits('10.5', 18),
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  userToken: '0x20c0000000000000000000000000000000000000',
  validatorToken: '0x20c0000000000000000000000000000000000001',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args: { amountUserToken, amountValidatorToken } } 
  = viem_Actions.amm.burn.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.burn.md","from":9588,"to":10122}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Amount of user tokens received */
  amountUserToken: bigint
  /** Amount of validator tokens received */
  amountValidatorToken: bigint
  /** Amount of liquidity tokens burned */
  liquidity: bigint
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Address that initiated the burn */
  sender: Address
  /** Address that received the underlying tokens */
  to: Address
  /** Address of the user token */
  userToken: Address
  /** Address of the validator token */
  validatorToken: Address
}
```

## Parameters

### liquidity

* **Type:** `bigint`

Amount of LP tokens to burn.

### to

* **Type:** `Address`

Address to send tokens to.

### userToken

* **Type:** `Address | bigint`

Address or ID of the user token.

### validatorToken

* **Type:** `Address | bigint`

Address or ID of the validator token.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`amm.burn`](https://viem.sh/tempo/actions/amm.burn)

---

---
url: /tempo/actions/amm.getLiquidityBalance.md
---
# `amm.getLiquidityBalance`

Gets the liquidity balance for an address in a specific pool.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.getLiquidityBalance.md","from":145,"to":5397}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"685594825d16d8c180f2d81984cf6bf8e0a654c6d4ca8ae78262e8340a1d1fb4","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinABGoeJgvDCpK8kWDKLa+uqytcqqGi06enhrchtbXRZWAMwDjs6jjRPUXtO+c2oASYrHYXCMgmEpXKUjGAFZ5HULogato2ngISYnj1EG8QPYPiMkAAmYk/TBTAwzPxAhYGfJgzjiZjMaFHPrWPEKc4NPFom4GZms+TPJB4glDT5i6zkv5UgGlGh0kAJACum2MYE4bQAMowAI6qxhQRiYABC602MAAPBlEskAHxBDrJVJ2rIUThYRzMPRkOCpTHCAB0QuDuoNRpN5stW2DAAUfX7SHBbcUlA6Iql46QIMxGHAbUG4KGWeG9HrDcbTRgLfcrcGAEp6VWkMAANVCqpgDtyYGZ8G9W21Fcj1Zj9ceVCgEF4CAMAHE9HBOKoYJwdfHVxAANaKVax9cJdhMrVOGLqrgWJmcOA4XiMJK8L0QCByYOK8RKefIZAgOjMlgCilAABmBaBwLkDKFMA0SkDA4g0O6ySevgaBoFgnCuJwCS5swnAAOQAAIAO5fvmAD0MTwQRUGgjBq4wKCWE4XhhGkeRjBUewMBUQ4FhwLReT0VwsHFixuF5uxZFKJR1G8TQoJCbkSxxOmnAALxwQhSHpkEwC5Jw0T8cIqTIIpbAACrwGglhoAAuhQhmrkMwgFBBqQGVqRmcOZTFsMGxr2akaEYUEEROd57i5K4ES5CpsQvm+ACSUCaUyZGmjw/CQiWYZtPGr5yKlzrpp6XlGaqhakJZu6KKkBHWLQwYtQRkVGUQoTGoh7C1XuYANU1LXBm1MVxWACXCFwdwPOuWniJl4I5SYpbMOWaCVlGNZ1rNpX2ko5XOWwKVQO1TJQFA8FwAGhFDa1kWxbkYEgSAjl/t6QzCvi6kALTpOmH5vSAH3MqUIO+iMK5/Ymn3JiWr0UH+8FoK2UJUJZ+Drpu279Qek4wIDjllOyiC9NYNTcvUfSnPygQRlW0a1oe2KvO8kpErilSypSPizIqwIGCEYSREUU2i1kbrpnR7niyUhwVH0xIU0iDTNNQrQCt9+0s2KbPDC4iBwlzHi/Dz1KAkqgRBFguY4BwGBROIF1XTdIFNQAJMAYikBYSiuC906zvOhjO/AK5oBAxkwLwO547NOHsB+8uwr0LynJTyKohrgRO5dYc64glR61KiBkibFLeOb/PKtbttkJgURVWQfX1ZwLdgKlADypDcKH12lDOc54AAqtVOOKEnxMK6T0hqxnDQ09neBNzVdVgAXCL4oM+ujGXkyVwq8xWzbEB2w3nCdeYUA9av/WpO3Xc933piD8HnZXzf49gJPML6MScKb3nn0Iu6triBEvt1COt9FAFzVhKHeJJuYHz5kfPA/ZfR3icOuJYb4YC5E6qQUWcBcGS2ELggeQc8AY3XCBHBCgQKcGYNAVUCgvS5iIMaeAN44D5FYbAFYqolBKF9kQ3Bq4HBXhXDw/M9xCER3EXgsAAApcQnUADKvAfZYDUmQ1hvoCR5DgPhE+HDYBpRWBgTgJEYArFWLmEi1USzxTANQxhzDWF0HcuHEikc7zR0fIwZ8MRQSWDAB5ZxAAqHgnAQJ2mIfQ6I9xrpWNNPgRhehCBQCkaqewTIVy0JMLg4McgIBKHCiBT0BTdEEzILmUg5TTxpSqfEgmZE2wNNUIhaIGxVjribmleRJEfY0G3KeSxAA5aABMABWUi0DwWZMGXIUTuDahKXcGJdCYAMIEhIK0sslCthgAMyOQzTTrnkcgECJ8tjXWDGIGcqo0AgXskEUKWAAwUQopAWAszgzsCUBRV+FF7g0DED9IgxJKjBloBRcQWAuI3LDsGNCzA5AAGIkXXQeRAJ5jswBQFyFcrFJYHm1JeW89CHzEBfJ+TAP5AKgVBxBYhGyEKoUwrhQiiiJKUVoDRZi3MtzrpoFgKQUgERgxt0xmsiAGzmm4IYbwHpKw+mFjSiRVJuKrwiREWuGJdLEBbIYUwqALCCbOIAPoRIiQAdUkHkZQNrLX3xlUodZoRRGsLldM6OaACIrghpklckh1yWFSWQIhBYaBhLkBgXIcAMCbHwLmSAVVODmD3AouxEAHGRu4PGZK4dMaWKukxFYChPSQEIaGhRliljRsUGgONuRwhJvsKm3FK5M3rlCHITgEA1yEMmbAYMszbzzIQswEsnA1EwAuTKq5kARlCDYbOMOnBkoUU7hS95nzvlTIZToJlc4WVgrQOy6FsL4WIqFci1FGLxA/WXTAH6Qgfokp+oIKIx5SC5CYfBTgFhf3MEQpCJZE0wAAFFaCAVYVVPVbqPX9oVfQxAzjnqzMmi04ppSggEUxnIEpVj2ByCgARCIABuXIXzOA5n2DdQjxGfGkDI56eROKnnYaKSUspBGYBEcjgAUkEp6AiLGyMUeo2AWj9GwmMYE8x0jp1RmcbQNxhQwZansCCJYEinAoPip0wRW1hBT5wE9MQoNIi1hpQcFgHAlhyMRCozRiidGfbyc4NpwhGC4Bfl7QSidThY7zKwap0VtT0Myfc0ZQzdTUimdfB8yzeYMk2adpwezjnjluZ8kZLpyAYCX2CnCUmcI8v5a6RorRaBgykHVMlFx+ACx2ktpwXTUzEBEGYKTF4xJSYAA5xq0aq1wTuKxfX8Hq415rrWhDtc67AbrvWXjWGkLiYblWfJdMNfsMg/Y5A8rvddCidBo5PMhCidQM9tsFa4EVkrP0hnwrtk0UuxI7tMi4MV0INXGDaI63tsJB3QjHfXad87vBLtCBRI0Jo1gRuxZ21wYHIxDsUVAxYM7l9LXe19qXF4uJnGqU4OguahFbWMCI5wRscqBJCAItJrZwY2lgCCCBAAIhsXQhDPbk9cAAQk4Nz5QZBBcgVczFjzDHUii955wKnNO6e7DIWAYX8vxfsd8ZF8VT0wLOJg3BtViGaFxMVYk8IAYMNgSw5sRK2r0ptDUZO5kai0uEBIuFZniValO70C7hZzB3e+k9977DXBmAYHN6wrSemvUExjzAII2rPS1Kl/+6PhTNO8fw0x05ympN5bkx5LLimC+sZU/I7Vmek+4b4/nzgIm2qEQk856TsnPOl8b237XA6uNgCj3XnzumYD6fi8ZpL5nUvWeUAeOzr3FDHIo1LzvsvfIT9IIlszKXbxpdUBlhfDml9QEcqM2pJPErk/SiZ6n/aVcM7AEz2v2fWkOo55rvnwABca55+LyXHe7mJeN0n+iud+tO9Oauv+YupAgufeF+YAz0n434SAv4ZQ86pQyAxCrYWwrye6NKFEwiqgqoKwwYwSB6vycAFBvEFacqFEkKV6IKjAKw3E1SY6kQr0RMv8YoxI/QZwVMKIVw6IBgWyBcpw8CJcMo5ccovMNIlseAQQQa0AUQdeuefmAWAA/KkBsBgJ6MNKfJqKEDDMyDdDocgPZFmBfBAMaB1gANS9ADqzAlJOwRAUJDwGDAGjIgRqYMKaqqBk5j7dAEycAACyLCAgQEvaOgqovoXmyqWoqqXoVuxynofhaSa4uQSQKYXA/SeS2aNsLAkgli6hugjSTINOucpokInquR4Qt4JBYgpoMOkGl83YUiLA1OkgoyxKXeCQQQLwEQu6VKBBoGYA6g/yx63QqosKoxH6AWVBoxLwx2+wCQwYLwfKaK40QQ+qrQMRTaIagGfaSR10xy3RIEl274IGiE5SeBVK+6dKR6gKwKoKbKDBnKN6FEFxGxGKFxVxaAfxP0rQkQkqNuIEdupOF4YS6UcIPubBueBEkJaAqQQm5GnoiJq+QBXeN0iJqQCIEWjy6m9ucJeGCJuKYSiALe6JgBMu8mqQOJnAeJHGoqNeiBBukGc664VyXxfxNxlKGE9xh6JYjKzxrK4Kbx163KXxD66Kvx7AoG/xcpiEgJOgIsv6bigGwGipmok8EgKBKAf4PCVopQRA1gwYvQZp1g1gnByc+g/W6cKsusoCwhZgpSYhxcHMg2SC/wKCtI7QiUM0VoOwewYSbI08LwACiIPIlwTpmsAZU4ZgooYw7pBsLwxs+8eAuppQ5OeAvGoZsILwjQICQCNgqCBgm044licZ2wnAZMcIlp9ZDZjZ9Z68IoOIvQfBEhHMMoRMMQsAIIMsYky0wgEkbE4mnEFEFkEAQk0EokByI5UkBEwYrBWQykRJywVZ6UC04gWUxYq0605ZjMO0Voe0HonAFU50ec10g0tA6glQxIUA4ZaQvAjQjQqZaQ1gcIdp/84gLwKwg2lQlQZovA0gMA6gcI0gcICQ1gKwUGKwKwo03kK87c15xI1gvATZGFmFWFGFCFHUXU18UCyFt0tAqF6F2F5FFFlpvQCFj0kGLO8JB5NYccgZLeVZ40pQEM4gSAoAAQigPCQgGZCArgrgQAA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const balance = await Actions.amm.getLiquidityBalance(config, {
  address: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  userToken: '0x20c0000000000000000000000000000000000000',
  validatorToken: '0x20c0000000000000000000000000000000000001',
})

console.log('Liquidity balance:', balance)
// @log: Liquidity balance: 10500000000000000000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Return Type

`bigint`

Liquidity balance.

## Parameters

### address

* **Type:** `Address`

Address to check balance for.

### poolId (optional)

* **Type:** `Hex`

Pool ID.

### userToken (optional)

* **Type:** `Address | bigint`

User token.

### validatorToken (optional)

* **Type:** `Address | bigint`

Validator token.

## Viem

* [`amm.getLiquidityBalance`](https://viem.sh/tempo/actions/amm.getLiquidityBalance)

---

---
url: /tempo/actions/amm.getPool.md
---
# `amm.getPool`

Gets the reserves for a liquidity pool.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.getPool.md","from":112,"to":9506}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"7dda7bb1ad17e8af2b2215af2a34e1eccb912d3acf16ffbd8338a2da0631fe20","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinGwQcqnAuZzbnKTwZCQAqnBkACoQANaKqQBGyRZoANxbO3snpCQAaqGMUOJo7HOVzAt3uYCeL22AIkcgAygBXLBYOQYUFKB7PMCuUrlKSIdSyWrKVRISotHR6PCrORdCxWADMA0czlGjQm1C8018c2oASYrHYXCMgmEOO0+mkACZ5HUSfjyW08MKTLSeohGSB7MyRn1xh4OVMDDM/LyFgZ8oLOOJmMwxRU+tZbET6kgNdpFQZrbb5HTXUyhiykJL1OzMIafLNSjQzSAEvCwPwRZw2gAFCBrAA8GUSyQAfEEOslUtmshQVo5mHoyHBUsrhAA6L311PpuT1lMVqukOBZ4pKXMRVIp0gQZiME4ZzZgHa7fYfGDHM6Xa6cO7o8GYmdvA4wb7mP4A0hAldrjGQzjQ0IIpEotFnrG53Jga3wLBOGDJvRptalKAQXgIAYADiehwBe+Aftu85gQk7BWpw5gAI7wr8jCYCsrb1lG4hKIByDICAdDWsiuBUAABhRaBwLkFqFMA0R7P8MAlskZb4GgaBYJwricAkI7MJwADkAACADuOFjgA9DEeyCTRAp0ReMACtxvH8UJYkSYw0nsDA0kOBYcByXkClcPRdZgTxfGjhp4lKFJMl6TQArGbkSxxH2nAALwMTATEsUoQRTtsWqGakyDOWwpzwGglhoAAuhQLxoEMwgFFRGznhFylsPWvzxak7GcUEERJdO3Fla4ES5G5sQYWs3lWuJaE8ImJiNjazZfq2BZ9mWwWcPC7zHiCQnWLQ9aTYJZXbEQPwHoCy6jYJ42TfW025FVuQUWRICJQRb5DN6mqeQAtOkfZYftICHdapS3ZWIxgedHZHV2cBXRQBF7Gg8KkKKVCnBB9VyLO7wkB9e2JWU4oOmSzpyjU7qUgYLY/j6aoalqAY6uqvShpyRrclGfIGCEYSREUwgeTmKQXbT8npVTnSiLDiC9L00oIw0zTUK0KMnbTqoMv6wwuOqeqTN4xo8tGgRBFgI44BwGBRENS7AqkI0AJJQAA8qQ3BQFAbymH+AFKsbpucHB2sACI2wk4EfurpAXktWGs/a7OSvDCjEg0hLI4ErsjcLpKi4GiCSgT4YyyTMYK0rZCYFEc37v8i2a5wOv64bVvwGb/6AYYBdwGBtsOxATuqB+6e/JnbsAsCnsw97vQABwav7Lrs/Dwd4PXC1Hkt4eIAArJHuMx/qYbS8T8yBM+lZwG+vAfksawwLkc1u5vCjFiYW+/sXeBAx+ZH7zAZGcMw0DwgoKwjkQvzwPBcD5I/sA3PCSjrkoVM4Bb3Av8Tg45OAfzHHISQ7tna5AAFLiDmrCXgpBGBYBpkAx+lYtR5DgAJRWxBX5QFXBgTgokYA3FXCOUS7wPo1TAOfW+99H50HSmBNAokIAQJwLwRgSReBFAFJYcENYGEACoeCcDItmLB19ojQPLuQtC+Bb56EIFAMCcB4T2CtGBS+R8FD1jkBAQKEQyJlgMcILe9YyAjlICVG+4gwAkKsXI+s4l/qOJAXEZxq4XYnBIQCchaCaCwOcWQgActAGA9YABWWiUp+WYPWXIkjuDJhMTcUI0ir430MhIBMG8+x/RgEE7holQkfmCcgMihD17l3rGIP88I0BkXikEIqWAaySUkpAWACT6zsCUJJc2cBJLQJoGIU6RBfb1loJJcQWBtL1MLvWdizA5AAGJVnl2aRAVpURnFQFyLU3ZH1ml2PaZ0ji3TEC9P6TAQZwzRnFwmUxaZszKjzMWcsyS5z1loE2TskcDTy5oFgKQUgER6w52BkoLJOS3FbxvrwPxNwAllOUaoA5XBaICGUM7aRjzEB5OYVAB+sSGEAH1xHiIAOqSDyMoOl1KtbwsRaDK+NsbhxJgPwQSYFHoaLApID8lgVFkEAeOGg4IUS5DgBgBM+ARyQCGghRgVwiU3Boe8HgKZtYcIgmQ7czAbgKDLJAN2YrnZkKWDKxQaB5XPkVcq1VBywLmC1aEUGEBa5u2ibAeJiTGLMA+pwWEMBqnA1qZAMJQgn7/kLpwbWkk9bXK6T0vpMTnk6FeQBd5Uy0AzLmQspZKzQVrI2ds8Qp040wFOkIU65zTqCCiLBUguQ757DAYkdgzB/gilSWAXIABRWgxFH5DQsAA2umSIDZNBsihQZFEAMJ2gk2q1ijEmMCoJCCcgTHkPYHIKAgkIiYl6ZwYcDwaycAPUerhpBT1lmCfs1pW73G7qCPumAh7uEAFIjJlkEk+0957L2SWvWg0RhU/2PpPVAV93D31oE/TYux7AgiWFEpwUdUKsOCXpYQCA3SyxAOFTO1c4gSEOCRIoMp56L25CvTe0RnBMNuxXnAHCH5jkQIkLwC4F4AzVJQxCuxa6wBXu2Ph+xqRiPpjIxA0c6iqPZNo0snAlgTnSagzOUByAYDpwKuPdm48WP6Z2KAlBaCMH1lIPGbWjD8DjmzHLTg2GYmICIMwdm9JJTsw7tVPTM4rRcD1ry/laAHNOZc25oQHmvOwB835+k1hpDqmC5ZsLoCSUPDIM+OQ/zK3l0knQflrSRT4nUOzaQOWDNcCMyZ06lStNkCaNHSUDXrNcGM1eVB6CuDJZgIgAr/1QglaTWVirvAqtCHxI0Jo1gQsyd65wfL4JCuTYHRYcr6dqViBgykSU9J1QMPchtl8jUiOMEPZwAASguwyQhBKYivh4plQQyJ22cboN2AASYAy8YCuAAIScF+8oMgYOyLMdC2xjKkO/tSvpXd0GT27jWLABDqH/2wfIYE5CztYAdoMPHZOgJVG50yMMfI3giixEjtJxRTdCY6q4sam0WESTrSwlU4QUSJV3t1TsVzvQPPQ388rIL4Xn6uDMAwLI4BPkcOAJscrhQQRcVljsfDrtSu6fGNMT+h9FTEMQZy4ju9Zvj3PqQ7A3FBvNexO/b+/9nAgPTSEmBs98PWMwaR7b33hOndgEVy72xBGHFq7k4RxTpG4DkdU6odTNH73tZ00xyD0Hb3hTj6QBTJHlMUbU4SjTGf6M6cSrAuxF26og5u2j+7mOXtgDe87o3niwDfbx1KoHIPwfI+h6QWH/uoPW9SH3t2zeMfPex7jlHo/Cd15Z7tFouEkD4TKFG0oyAgF/XXh0zN9zJLolUPCG49YYjMGzQM8ZjzJLmoXZJL5PzzA3B0tu2JCSIhQy9niL7ISD3IjAqALFfGPB3FPOLNYLHPPJGIvHgEEMKtAFEJHt+txrxgAPypARJlhrSkbGBFavTWh3oRLIDxSDicBEAQC/CeYADUvQNsswJiNGf+VAYyeA1usCZEqGN8okKiG2MAok3QsSnAAAsg/AICRFaDoPCJWOxmitOBiuWOXGUmWAIaoHAjmN2FwOrCQuEESorCwJIGQpgboFaC4laPdjRlAGhCKDkvoXohApfmIGhPNszunPCG/JAndjAjUnUoHgkEEPSOYsfrcqfgOmAOoEMnmt0PCAslEc2rxuMlEfSCVg8AkPWPSICpsiFkEHOq0PIY6qKj2j6qoYErArUlVm2B2gOmgI4uEZxFmo8rmiMmMoWjFCWt8mWn8jUbkdsjUXUf8MMcWq0JEDCuuqztROztTEUPGFwD5OPCLt/sbnujEAsakABmemWBseCOPrnrBvMeCKkJPLAqhuhjuiboJHsWgIgN7rcQcZPscXcZwGcW+hCmHmTszpGh+NUQILUf2v8I0Tcs0afq0R9C8h0ZMl0W/r0dpP0dWlskMUCWgKMadOMe2nBN2h+BYKMUOthJvigARB/EUqUEQNYPWL0FSY6P/m3IAePDUCAQ0G6PzIELupAdAaMB3HAVyAgaaO0HVNSJlOVNsFBEcMNEtHeBuOeOKbuPNI3CNNKRCKKe7DCNeMiKiKuGCCqdiAAfoJKB3H7LKA0P3GyVSK2JyZqIMGLKMPSOPLyUTPyXLEgYQsrKnGDDuIuCPNnKeOCCfBbAYA9nOCQI7INHqs3IoK3LiAaR3MASaX0LzAPAYHKd6WHBjFYFAdadqOLJULAbPITBGCaC6QYCDqvO+OrgoDvDAlfIfN/gGSXEwsuvInfBSo/IQi/LAKKhAp/B+N/L/P/JWdGqAuAr4dAk3NwrXAgkguILZkNkOWorguOAQs/MQqQuQpQtQhALQtWMOrkEwq2ZShxrQOwheFwjwvyvwowIIjfmwCIhlBIlIrTt/qioztiqoigZoi4booYc2WsY4pYh9pxt4vxn+d3t4qoKAkof4uGVisEpUmhGJpYVEjEsGgJqGsOukvOourknTvktTM4uvMzMkKUuUiEohVUYEdNhcp8a0hmrci0TmpCXmtCR8sWnCb8hWtRQMSCtRahkci4qclRWCk0hJlCvRWCQ8kxbEe0W8jCZ8qWpxVNiJUiecpclCjCnCh+AigukimStBSoU4ZoYQK0mAqZNTsDGRCSmSoeUYjSnSoyv9DOqyuytpZyguQunygKkKuotAKUeKjAJKnvCYA6nKhgAqkqvYO6uql6tGh+DqtuXqtwAakajACavsGahahtnBDarXHaiFWII6s6uEJFSqkIB6hqt6vdn6hBAGqhQkuhckuGr8USrGn6h+AmucimmmhJXclJffjJfmuMvJexYpeWspVWkCjWnWu1Y2mAM2qVnAK2hAFiSTjib2viUIHuWABTqwFOqSbOhyrpUunklJttNMZca7tccHhbk8YHjbvBubvboThcbMV+tdY9Z7sBj7rdTns8Tdc9ecbRWhm9RhtHthsIXhuDURsXknippRuXunnRtpoxhEHdbehxtHmouXLxpYSQuUEJiJhWR8cTlJmtgXkXkpnDaXqnojZplXmUj1tsIZv1nIKZuZkzeFhGoNvZo5mAM5kDAlltvQJ5iSr5v5oFp3KtlZszRFlFvwLFvzfFnAO5gEKLd5uLelplvSNlqFo1tlSluNkVhNTNrQJVkQTVnVpzSzS1m1vRoXktpKN1nretqzXORgurYbVthNsVucuVmbXNhbeoEto0CttbVwJtiMMbbttJqzYdilDOtHGdvSPXnMY3j5Ldi3vPkAu3ise4uBT9kvpwAPi+EPtPmPn9fdVPkXbPo9tnUIIviPgTkDcTudWROThOntVToSjTi7q+eEEzm3Wzpdpzj5NzrzswNLjALLvDpdmLmPRLhPVPTPXnQrobt/o1Grh9i7trq0rrhpZiJ3qsW7gDeBujUcafQ7sEmHhHkbifZ9V7iBr7pbgjlXfep9SHo7h+uHuve4sBbHtDQniXinq5nTZXijX7ufUjsgBTZwEA9TSA2nvTRAzXsEqvvLldpWE3ujnXVjjnR3j/ZHgXdPsXcDqXY3fjnDpXXnsPv9nAzg63gvrQzDivlCm3YSXhCSbvlQPvgcqQEfqCX1WfiopftfqOHfk8g/jEk/lkq/opR/l/u4r/nSTGa6NYEyQmfKHzBSIKfWRmTIFyUgPmVLHgBIEoKUCDngByfqWoxowHEY4gQYN6e7MCJ6fOKkL0I6F494z4749YGAGPISNjLaUY46UWbLKTMEJ+WgXfSbuYTADgchfgZNIQQ4XICQWGrgWABgBQVQTQXQUEIwcwWQKwVAOwSAJwQYNwcErwcDfwYIThqIbCpIXINIY/EUQoVRNEOih+G+GoQ7sZdoUkLobBQYalU/CYaQGYYXLjfxuUbYfYUII4ZUYYdojcG4b9EQdWXIN4VoiwH4ROZwGckESEWEYI5Ec4jES8vEYkc4skboKkc4ukcYeCFkTkdWvkYUXIZ0/5dYaDH05UQEf0aMSCSfv1ZI4NaxUWt0T8uNYiVNciQCaMeiZiZMczhujMZdrcY1MsZdf+TcQcicZ7jsS8VA3ercacS9cDXi27hSw8YS2gGS6kBS28VSy0iDd8bkC1f8XdvWCC2c2CxI20UNZ0QpT0UpfC8CiiaQPUSizoJTB2swj2niaiQSRvpw2UBYOvOSZSdSZ49YCo2zPSL0JPNzH6Nox6GYKYoE4Y4gDyQWXHAvAKYsEKa2CKVuCGQuJKb6TqZuK8J63uA3IeEqdqeuCqTOJeHCIiJqcqZiHqfSfoPSNUDKPY4gGaToxaejGYL6GMLa3mWE/HI48EG6SnKrG418AqcG1KaGw8A2XgMGeDB1U7EPI3C41GXaHiPaVzMyUGP0BawLHKYG8POmdm2qEEzaVHJUA6Q6/AcWZE2WWvMUt/tWcFd/nWXInWwYE2TZSwr06uV2e/L2ZwP2X/FRtypBXins1Av4ZORBNOcgjzZgsAjgg4HgiuUQrACQjcGQhQlQglTud2NtQebu8eaeZwihrwleTeaOHeSUWdWAFhc+XIv3UooM5+Vojoqor+R9t+uYoBUbsBeYnjbhaseBURxe908oZimRQhWEsEhEpwIGj/iGskphVIjpThc2fheUEUsRUoKRbArR0hcc9xXwU0UIxCZC3JWxTC/CSbR9KpYtfxXjUJQCupaQL1YxQNVCdJ9CxxeNQCop3xWJdCrCkwhx3pXhZRzBUZSopzvihZRfNZVZ7ZVSszrSgykys5eImylpdhTktyp5dFoKmojil+TahKv6tKoVWFRFW6uVTFZqnFVuQB/qoarap6ZlTAJajlT2nldF7Kk6uFS6qVdFZ6kl38zbFF0x2hUdk1bCi1XOm1fGtOF1amumuJ1pxCzpwWiNbJ0pYZwi7WvWnNQtdRctatV2rpBtaq1tR3ZTuGY5/5ydXhfBxizSx9R7s/Uy+/Vt4hmy2Hjh5t0eo/T9fbi/QHjQ5fQd9/UBeDQA/Yj+vA8ngjQAhXsjQxpA9Q+xpxtjTxhYfxgTcJilMTeJqTT1rA89/DWXm90jZnozS7bLUc6zezSa+HdzXZjFnzQLa5irYlmrSNqlhLUFtLblnLV5Vj3FoLXj8LcNmLWlhlllqT/rZHdtr7Ytf7ebdVuoLVr0PVoj1zc1qEPFK1kMPbZ1k7ej27Y+57aNkbZNn7bNh4Ytstsz+tqzz7ZJDHftqEPHcdknedszpdunUJLXYw/g3nTYsQ0XSXZWGXUvhXVbm/SQ2b/XTjsw8vi3avpyztZ3TIdOj3ZZX3QogPWtxdW9VwKPZ+GgJLsksvduXLhH5jW7AvTH0vQLgn7PXVLfRvarpDdvXTrvWgPvdCofYQ7E3upfRdxPm/dd1/SDTn+9ZXw/d9aBr9U71dx/ft/X0fX/fd5DQXk97DS9zD9Rsg599nh30cTA9HpTYniP7TbD+P9XqwyThgyb5nXPng69piI31b19oXSPqQ4PhQzDlQ1P0ji7ww276f572g2w2vhw1vlw6RCALw4fjAJ16fufvgKIzfkK1I1gAyMX8HFBRh9mUbxRoYqjdUOoFNY9stGyZQWBu30bswnQwTKOMYwNDeAzGFjF8FY2tY2MYBcAzRk6BLIgAh2rbSMtODlIeM/GdA3xgExQGeNbWmAueHyTnaJxom9MJvsgRma6BEmeBTgAQQwRpMMmZBbJrk1SD5MSEhTJgtyFKblNKmIAaptwlqbst6mWhRpnSGaZSF0E7Tb5iUWs4qEAW6hd8kM0YAjMnChhOdMYQHRTM/uszKwvM2NiLMisozZwmsw2YeFtmuzHste0ObHNMipzXqhc2iKDUbmWvO5m+AeaRCwAzzIItkQGKfNgYHTQwTanKImCyKPLQEjK2BICsGK4JaSj12Goyd9OfRAEjxWlaytUSGJeVmjW2rrck+2LJYpbyuLrEGWWxElo8W+5I4WW7xMHodwr4/o6WuxBljtz6E3cOWFEBhNyzIjAtUSoLAoeC2FZQtYSY1cobyyRJVCRiNQzErxGxLTcVWuQogq3DMYatSS2rKgBSSpI0kDWkAwgTrW7iaNWSGbAwNY1HZWBmB2ZHGOLHtYmMnSHA3RssGFKcABoYpT1mmWrZ+lw2/rRthQKrY+sw2frKEH6ivDRtbwNbGUliA7ZVBrAxpVNum0tbUgx4Xw9AdPElhYD2BETROCWxVhRBI2GpDEdCM3YgBzgMIFwjeDITVxOAAAGRTBtsGwOI0kBlhTa9wOYYBQIAyPREYASRaAidrjCTZhMcBVASxm8IIEJtSQTtUUXKFIGRM2ROSbRJyNoH0CTR/jEkVzDJEwFXA0MGILAH5BMxzIbUYQKpGsgCRQMWkSSJFAgDGR8UoIvji6PUiCR6wX+LIK5CT7UhGo4gZqEKCdEfQmwaMOQL1Fpj9QXgocatitFoCShrAvAU0bmLzHWANo5UFtgiJXAZisxOY/MZWN8a9BCxW0I3kMMEjOMqB5bUbN7mpAOYIR3rRQCFiO57p4RcEZsTQLbGYRB2lbLON2I257p9RoMQ0TG2HFrB6wUozkSFlKCPRxASAUAAEEUAfwhApjBAK4FcBAA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const pool = await Actions.amm.getPool(config, {
  userToken: '0x20c0000000000000000000000000000000000000',
  validatorToken: '0x20c0000000000000000000000000000000000001',
})

console.log('User token reserve:', pool.reserveUserToken)
// @log: User token reserve: 1000000000000000000000n
console.log('Validator token reserve:', pool.reserveValidatorToken)
// @log: Validator token reserve: 1000000000000000000000n
console.log('Total supply:', pool.totalSupply)
// @log: Total supply: 1000000000000000000000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.getPool.md","from":9592,"to":9797}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Reserve of user token */
  reserveUserToken: bigint
  /** Reserve of validator token */
  reserveValidatorToken: bigint
  /** Total supply of LP tokens */
  totalSupply: bigint
}
```

## Parameters

### userToken

* **Type:** `Address | bigint`

Address or ID of the user token.

### validatorToken

* **Type:** `Address | bigint`

Address or ID of the validator token.

## Viem

* [`amm.getPool`](https://viem.sh/tempo/actions/amm.getPool)

---

---
url: /tempo/actions/amm.mint.md
---
# `amm.mint`

Mints liquidity tokens by providing a token pair. [Learn more about the Fee AMM](https://docs.tempo.xyz/protocol/fees/spec-fee-amm)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.mint.md","from":201,"to":6391}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"8c8d9e3a10d7fc7ac97a66b8da388430eb2e46abfa5de1aeb9fd7c017dfd2448","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScAGYArmD8gmCcWJJwMACqYIxocEFEobEwiJxipBZKFJywvCyhcCVgscwARmQRJS2MShZoADrZrOxcqaTpWTmmUBC8CAYAsrFyAljm8JzipWjlypykMFj76WASxskQ0RucTa1knC0YVz0kyXRsliecF/fhMJwAjNZOEFAW8hIo0BEAHQDAYAWk4ABEZg1OPg0GgsA0APTYoiMGDMKFwfDY6azbGxATmATwbGjcbZXKUajiJRzZDIEB0cSsBQslhsDicYApNKZJlwTiuGKkCDMTgAcnxhMVsLADIlkyCioALAAmayKqrSCIDXGcA3Wa0221gEAAXQdom0+l1mjMihUakQgK0kl0gU1E2Z8gsVn+dgcpCcNHIiGk7k8ODwhBI5H89DwITCkU4vBMXALYGi3RKAGEhKWlANBcN81XuiyxJJ9AAOSOe5SqJAANn9Oj0eGL1ZZ5ksSH1UccznjiY81C8qd8GeoAWHhc45gAjrFGFAchhOt1es3XUh/v8AKzyL09hMDwN4Hd7g+YMfhpC66cx2dINtJouKYGGmfhrlmBjFmIewwLwMCMFgaAlAAKjGwixkkABKsHwYhLLknMICoeI6GJEIMFwQhaBQmerYXvq/Zdt6GiPkOBj7JReFhhOiDfiA9gznGF7zsm3igauNAQSAdbCkYSSmC2Ui+rqfEKN2PoetoT4GHJJgfjxfECb+QmIAAzOogGYMBPjpiykmBDJXC8swtFKdeU5MfepmsYEzn6VYhnRrGLi8VellLiBK52euBhxAkZycMwvQAMoYAkAA8lYlt0AB8QQjmWnBZdWVSjLyehkKiunCFCzlQklJypQkUIAAqOMwFVjJljZKDlHScC1cpJek6XAAMnATaUiiwKQJQAAbWLQAAkwBlBUrhzQA3ONk2xOkpDIRAADWijzYtK1rcoG3bckk0FOYUDiGg7CHSdYBnctq3bOtW07RNvIQPEaAZPtr2nfcJ4nDdk0bMwgMnAAaqE+5PS9x3g10PRQ39W6MLu+6HseWNoNDk0cbhSGcMRpFnNhnEkwMrg5QMYDlXAqRwYlKVpbw+Eong3BQFAUovgTmCcM9VxsBAcg0f67JIJy3K0Lyqy4FQc2a7ktZDMKoq8PsT0wMV3RVOimLSrK8pKgAAgA7mySXYgW+xqoMQpcKKNBDJb0RDbbDtKE7LswM7DgWHAbuOSKPBkcIvv+4q9uO4wzvsKH3tsG7AxQUWPWcAAvPmhs0CbShBGNt0CRHJTIJnEDIfAaCWGgzo7dsJHs8MqKVzDdeEmwUL7g6JTm1gQQRBQO3uIzZpgDnm5HEsXBF+IDs5LHZxwLVzBEg1aBNbw+U9VUvecHtZBg2AgtQEcqKKothq8NYUKv20MDRMaO33Sjz0Hej18hZ3xKA/WgT8X5v3EG0L+t0f6PT/lfbgcMgYlEBNYMAU9brPRAYtaIMAYBQFflCPBsAYGuDnprOajoKBcjKi5Ow+cERlxos6Wh7UWR0M6lKBEbUYwdTjNvahXJ9hoFiKQYQLJkL4D+B3GmSQKIUw2GAKAnAYAvC4PA8QLDnQgEUvoa8jE1LMUQG2HyeB96H38l+H8wV4y6hEkBMSUVMyBBzIwcIURc4NmykoCsPUdYe28aOF0dFfS9hvJ5H0jEtJsX4j1KxvEbF/kQFeACC4rJONsi47MhwIA4A4BgKI2DOB9BAItdQBooCmSvOWXgvZeymV1OWawV5TL6mkPqK84hTItDbCpAAQrwaQMB1BXmkFeaI1gWgAFEWgtFKa5fR6gPRGPvB5GJgRnoJIiUZWxk5wrWXEtFKSQRcn5MwFEC+/83o32ASUspYDrDP1tC815bz3mvIWSEpS+p2m3nUheaJAZYlXMQUA+AphxxWEYrs5J+oDmZLAvZHJcpzmFM4HA1G1zFC3IhSUUpj8nkfOJSS15/wvm6PPIgdpETVk+n1J2DZeBMUIIAbiuAkLPyIA9LCky8L0kRRskimKwQzlkAuRi5G8C0Y3OQScImp5vn6FMvU/5xjDRmIMCymVOK5UMG4lYUx/EgpwoRcuLJ4FXHIw8WKMYWpcj5EKMULYOxKjVFgnUOQqIbhtFIP1TGvQAn1mDJKPmsw8CLGWAhNYUpNiXSUDBQ48AIRPXkd8TYPq7gPCeIwF4qjaDvAhF8S4LRfgAiBCCawYIPiQhhPPMACJkSzFHhiLEiBcQqiJCSMkKJKTUhyASOA9JxQhlMBIBWKAuQ8j5OraSutPa2sZJMBO1tlQEmYNnDUI7JQ6itMaTgppzTYktIaD59onRKqQKZNsRq6UXlsKyQcQZt2TASUa3lIV9S6jNZFC1yKDCsw6uzJwfwoIyxgAMAopBvFwHA344Q4Gw2ESkX8OaYGFBzUStAJYfxcn4lgLG0ogoFDupaLEJQWME3oZkQ4LgjApRwBYIwOQkgJYQAltIgYAApcQBRkoGyojB8DiVYIOGyHABUeH9wEPuI8O2MAWj3DlHbfa291Qoaw1AHD+aPZSjQHbdj7MPWll4A2IYNaGjqgAFQ8E4HNLKsGMP5hYxyzgdscj4BE6oaADHYj2A2FKNDJhwNQjkBAcuEQ5pVCCwhhQUIyBylIBPTDJEVExcczAKEDtxHJY409fMJF7h/AvioyWdtyg0DY0ox4AA5aAmWABWDHtgwF5HWmz3BOBKDC6WuQdnqOYYjhIBIoGepiJk2VirMj2PIDmrkuCHLiRoGmFSOaDoghjxxNiSAsAmtQnYEoHtFIWM0DEHCIgX6oS0GxOILAqd5sQqhOiZgcgADED2OViBW5CJRUABizY+9vL7CW1sbdbVtnbMA9sHaO0Ok7TdzuXeu7d+7coFvb2e29wHwPSB+qhFTaRXWeuhH68FpzvBCttHPukFR7nvNUk4I5CoHHUOQ8QANzTOG60DAAPpWaswAdUkNkZQ/OecoUJ91iAvWhMkelw12CaBFRSn4YQYWGx9jXHgqoO4UF6M0BOHIDAAw4A83wHKSAe1cYnRZ0piAKm7jcBagAST09Ix4RxCQtAUFUSA0HJA0ZgI8PXYgIRG4GOEM3FvAYi0YDb0IfWIA6+g3V2AUImsuta8wbenBkr4Nt7NyAlXyKA84M77EAB5UHm323bfq9DnQsPsTw7Oxd3UV2bt3fpGjx7mPXviDhEXmAcIhBwkB3CQQURojsAGHDTXFhp+kGYKmoQ3OwDTJVjO6nzOddE+lyT9L4G5qIHVJQprC9YuZbC+XRU0i5Bhbc+wOQUBFQRBuhaQavRUR34fwZ0gz+qhJYvtAZ+gEgycr9wsdQf92MABSSOKoRUP/Z/V/d/Y9T/E4b/GAe/djJAqAQAwzZbEAi/DLeLXHdgIISwO2TgaZMgpLRUAXQgPJOAKoWDVXZnUtFRBwLAHASwF/CIN/I9AaHYXIVRWgkTDlNkP4VLLYJwI6CWX8abLYGaWaQQiaGgxLEoBgiAJglg+UPQfAdg8QTg27HgghVQyafLZANRUIEeK8X0K8cw/6LgfjcoRCKEUgeIZ3MAKRejLKeyYENnIgZgX0NpX0NsOeC0GGfLCvFoBXfgdwzw7wgwuAPwgIAI+rRAIIsyawaQMycIxwjYLgNnXoMgVmOQbvGYCFbEOgWCKkJIbldQX0aQAoyw6wuQB0OEcrEwsgRAXsalfUForgNolwwTCgjIko8RUICo9Hao2gWos4blPo3sawCI49KIoo8Yk4UoqY5fCwao+6HneNalUyMydULxQDP4Iueg5jPrTCaXCOIQRUG6ajLLYXIIOaREEiXQaDFaC41wAAQiRC+LIH+LmgELAA/2ENRE+OUDuAFxuM4DuK6AQzAEBJhO+P+PwKUISwGEoXVA31VhIz2h30J3s3AMw14Bc0s3rTPzgGIK4BAMLi6z0GSha15GSj0MIDtgnmeM3ASyZMDFZMNmYA5I6i5J5PpMSgwAc2EyLkoNl0yxlIUCCBAKqAS3BNn2lPANC0gNvywN/yfz4NQKEK/1Hn1JwMNKxKILAGYC1Mvx1Jv2gM4DgP3UQMNJQMEPQNyDNOwMf3/zwKq2tNtKVMywS3IPlPUPIPoMYKxF0LYN2A4LRG6N4Nf3BMhNNM4GQEjNmk4C0J0NKD0NUEMOMO4MUAIWdCqxxPrXOPKiZOuPv0RPuJRKeM1JDNeJyw+OBJ+OAD+LRK7NBLTLQKhJKHRLhIRKRIeNRKBNhNIExMrNx1xM1jsjZA5C5HSFnWQFgzETgnWxr1xB6FUFiBaChALGYDr12yHUh2xG92lzxCR2b0YBaDTntKawiEdB0T0S/H+FUjvA0k1TiUvwSUvCSRMmsB/SFQkhFSCFV2gCiDbOv2gohUkIAH4SgSIMAqgiE8kzhQheFeRUR0LkAHR+oiAIB9xgQABqf4L4dMMLIwt8qgAiPAL0vTdjOaYA1bNzDzLXO2KFfHSNFYEjAMZoCEKUCnZIKnVIDlAhKoOnTzHXAYUsMYLgErALW3Q4OoUgR4IDOASQ37DYBsowt8JIEnVS8IUoI8sQHIOooQSDJ1BjJjFjaDSWAHYQ6IIIUySLXc1tWvZfMAdQfbRvccWIa7PysfSQodPy0ybvXoaIKEUyJ7NAF7OeIIXfYSjqDAjXKQhsqSmnKrWbOo2WRfZfNAZLbyzECHevbeGHAiZvI2Vve8lHPtZjRKl7V7Qq4qp6TqtAOEAMSIaEU/TWc/MA4QPOIGJkq8Xk+0hCxUAsFBZ0l/KoOak4Qck0jAkoZaymG8KrDi0Al4mazaxAfdTa1alija+GLarE3axcuadUPPP4Aq6kYhdgEqsqsHCq2vSHBvQ7WqlvHqtvDvJqwq1qt7Dql6rq8GnqvqqfdgLDefEsSGpIOWVkCdJWRjEbFkIgF+f4KENBd8y9XiX5NVLyf86/ICzsD9eMNJUSc1YVKSLxUWN8I8CGYmRZL8d0Ymn0WQR9bSMwPGV8Q8cmkCkKUyUycC8dFkC458cLNm0KW9X8pAB9f9EAAAGX5rFm0pKKgFQXeXtANQvG8mNUEhCjAp0QLFgCYHnRjmqilBlD9lXUDidnrijittFBDWXTtsTk7RdsCX1nzk9tXShGfOrE3S8VFEZsPCqHJkExlFXnXi4Btp3j3m5gSGPh8VPnbggBwVoAqX1CqRqTqQaSaRaTaQ6S6R6T6V1EGWGVGXGUmRmTmRgQmlBTZXBQ5WzvAVJS7pJSbslQeixTBVvjxSVEJWeW7vHpeX+F7u1WxWvj1RKHdodUVDQX3V7EnlnjOO1JmrVvxiZq5i2O1v3QjouQGBZH4XECQFAACEUEYyEDwGZFcFcCAA"}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { config } from './config'

const { liquidity, receipt } = await Actions.amm.mintSync(config, {
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  userTokenAddress: '0x20c0000000000000000000000000000000000000',
  validatorTokenAddress: '0x20c0000000000000000000000000000000000001',
  validatorTokenAmount: parseUnits('100', 6),
})

console.log('Liquidity minted:', liquidity)
// @log: Liquidity minted: 100000000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `amm.mint` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.mint.md","from":6729,"to":7348}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'
import { parseUnits } from 'viem'

const hash = await Actions.amm.mint(config, {
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  userTokenAddress: '0x20c0000000000000000000000000000000000000',
  validatorTokenAddress: '0x20c0000000000000000000000000000000000001',
  validatorTokenAmount: parseUnits('100', 6),
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args: { liquidity } } 
  = viem_Actions.amm.mint.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.mint.md","from":7375,"to":7842}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Amount of user tokens provided */
  amountUserToken: bigint
  /** Amount of validator tokens provided */
  amountValidatorToken: bigint
  /** Amount of liquidity tokens minted */
  liquidity: bigint
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Address that initiated the mint */
  sender: Address
  /** Address of the user token */
  userToken: Address
  /** Address of the validator token */
  validatorToken: Address
}
```

## Parameters

### to

* **Type:** `Address`

Address to mint the liquidity tokens to.

### userTokenAddress

* **Type:** `Address | bigint`

User token address.

### validatorTokenAddress

* **Type:** `Address | bigint`

Validator token address.

### validatorTokenAmount

* **Type:** `bigint`

Amount of validator tokens to provide.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`amm.mint`](https://viem.sh/tempo/actions/amm.mint)

---

---
url: /tempo/actions/amm.rebalanceSwap.md
---
# `amm.rebalanceSwap`

Performs a rebalance swap between user and validator tokens. [Learn more about the Fee AMM](https://docs.tempo.xyz/protocol/fees/spec-fee-amm)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.rebalanceSwap.md","from":221,"to":6288}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"e399d67fb11f22f03c5401507bb51f3428c3c4c6a5e925ed4f4bc4e8e55c065a","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScAGYArmD8gmCcWJJwMACqYIxocEFEobEwiJxipBZKFJywvCyhcCVgscwARmQRJS2MShZoADrZrOxcqaTpWTmmUBC8CAYAsrFyAljm8JzipWjlypykMFj76WASxskQ0RucTa1knC0YVz0kyXRsliecF/fhMJwAjNZOEFAW8hIo0BEAHQDAYAWk4ABEZg1OPg0GgsA0APTYoiMGDMKFwfDY6azbGxATmATwbGjcbZXKUajiJRzZDIEB0cSsBQslhsDicYApNKZJlwTiuGKkCDMTgAcnxhMVsLADIlkyCioALAAmayKqrSCIDXGcA3Wa0221gEAAXQdom0+l1mjMihUakQgK0kl0gU1E2Z8gsVn+dgcpCcNHIiGk7k8ODwhBI5H89DwITCkU4vBMXALYGi3RKAGEhKWlANBcN81XuiyxJJ9AAOSOe5SqJAANn9Oj0eGL1ZZ5ksSH1UccznjiY81C8qd8GeoAWHhY2zAg8TQAEkwJ1ur1m66kP9/gBWeRenuINsDwN4Xk7k4HsfhpC66cx2dINtJouKYGGmfhrlmBjFmIewwLwMCMFgaAlAAKjGwixkkABKsHwYhLLknMICoeI6GJEIMFwQhaBQqerbnvq15dt6GiPkOBj7JReFhhOiDfiA9gznG54AQumDAT46YsjQEEgHWwpGEkpgtlIvq6gAzDe3Y+h62hPgYCkmB+PF8QJv5CYgam9oBYneKBq7SYEclcLyzC0SpV6dgoWlIBprKDoELlGVYJnRrGLi8bq1lLiBK5SeuBhxAkZwwS0oQkXBADKADu4hYBlGAJAAPJWJbdAAfEEI5lpwJXVlUoy8noZCogZwhQi5UL7KlcjpTA2W5flCRQgACo4zBNWMxWNkoZUdJww1yswjDpIVwADJwG2cLE6SkMhEAANaKCUAAG1i0AAJMAZQVK4x0ANzrZtBTmFA4hoOwe2HYenCnRdV3bDd92PRtcA5VgOCkCdZ2Xddyi3Q9ySbS+u4HkePQnAjm1bq+aAAPJUmjvSY5tHG4UhnDEaRZzYZxaAI64ZUDGAjVwKkcEpWlCR9WDg28PhKJ4MNZDROwzBSpsXWc+zoO5bK8qcM9jCve9pCcO9X1qxAW07ZrX00f67JIJy3K0Lyqy4FQx1W7ktZDMKoq8Psb0wLV3RVOimLSnLCqKgAAjlShLdiBb7GqgxClwoo0EMXvRItSr+2yQchzAwcOBYcBh05Io8GRwix/HfsB8n7Cp9HbBhwMUFFtNnAALz5k7NCu0oQRrYjAkZyUyDlxAyHwGglhoM6j3bCRrPDKi7dYz3hJsFCSsOiUHtYEEEQUI97gDK4ZpgFXm5HEsXAN+IOU5LnZxwO1zBEpLPVc/1eUFbwlXTVU0/a2Qn1HUqZ1Qv/xpHqK2Vh9A6P9FR/wARvRGyMTj43JoCawYBoEbXeiUCBtB/5QkAWAHeAwrbHUdBQLkDVXJ2FrgiFuNFnQkLGiyUhE0pQIlGjGcacYr5EK5PsNAsRSDCBZMhfAfwx5UySBRMmGwwBQE4DAF4XBlbiGoc6EAyl9BXkYl5ZivodIBjYiAO+vVH68yCl+H8YV4y6hEsmWysVMyBBzIwcIURq4NlKkoCs01bYR1caOF0dFtG+U0Xefsfk9L8WmiY3iZi/yIF7FZUS0UJJgQctmQ4EAIaYCiLAvGBN7jHhOG5NRbYNG3h9LIUJejsnwMiYxUy5jJxRXEnZOKMkHFOLFGMLUuR8iFGKFsHYlRqiwTqHIVENw2ikDml0dG/Rw71mDJKfmsw8CLGWAhNY4t+kVBgoceAEI3piO+JscZdwHhPEYC8GRtB3gQi+JcVK6QARAhBNYMEHxIQwj3mABEyJZjLwxFiRAuIVREhJGSFElJqQ5AJHAek4oQymAkIbFAXIeR8gtrJO2kcOmMkmAXeWyoCTMErhqeFkodRWmNJwU05psSWkNLaRl9onR+PctIEJQSfR+gqUGMlkwanRPMv8NSjSbGSTsakuUGSMBRDQZwPoIAzrqANFANSl5yy8DiWpXU5ZrCXjUvqaQDFxBqRaG2XUuoABCvBpAwHUJeaQl5ojWBaAAURaC0BVhTJz6k8qUycrFAjvUiSEupMT9SiuXOK8C9i0nSqiNtL+YDvoKrOoaXgjLM1ZuzTm60XrWX6H1OoQJ/qEyBrwIm3aybIkejDeZCNCSmm2JjZK9JZBMkK1CErN6oCvolFTbQdNubh0jptP8fNKizwWQNZpLR/w+K6T0cAntVavqRIfPxUK4bI0xWjSkgwzNxqsycH8KCEAFADAKKrM9CgPHCHPRigieBBF/GOjemAx1ODbigEsP4aT8SwE2XAQUCghktFiEodGShXFwAfWrBwXBlqlBYIwHqqt3rwZgAMAAUuIAoGVHZURg3B8aAlshwAVP+pWMBpFnKyjAFo9w5RZR2lfdUL6v3QF/VciOUo0BZS1qzYZpZeANiGO8ho6oABUPAfolVgwoT9vAepwClFlHI+Av16EIFAKUcBYj2A2FKN9JgH1QjkBAVuERjpVBM/ehQUIyBylIGvT9JFpF2YUzAKEOU+Gufg29fMJF7h/ETdIjDWVyg0E1pIx4AA5aA3mABWentgwF5J8mT3BOBKAs91H677P0ZwkFzHx3ReE0Zi5FnIwitbIGOmkuCqniRoGmFSY6DoggrxxNiSAsAUtQnYEocFFIeo0DEHCIg+pdRQloNiXKjB6Ryia1fdEzA5AAGJGvwFU61nckJJFQAGPV7bzWxCwFIKQDrXWAU9b6zAAbQ2RuwrGwPSb03ZvzawIt07q20Dra28tnb52nPQgpkInLeXQgFdM4poLyQ2if2kep1Q+3OBOW2aoV993ECFc4z+hz6oAD6UmpMAHVJDZGUKTonKEIe5YgPl99XwWhJdgmgRUUo2E6fFvsa48EsfXpMMtGgJw5AYAGHAZ++A5SQG2pwcwh1MNMYgCxu43Bhp7j40Ix4RxCQtAUFUSAqtJDCJ1zBkXEJxcDHCNL2XO4pSK7+KEOQXxBecAS7AKEKX+npbFlCTgGUYBm7+PVyA0XyK/c4HubEuNrvdaBb1xLj2dDPexK9ibU2ZtzYW0tmYO2oRrc2+IOE4eYBwiEHCX7cJBBRBFqQAY24+cWHr8wA5QhPkDFdabdF2tMf06h67zzD7jqIHVAQlL+97PeYs63RUQi5AWc4AJ0gcgoCKgiAjC0C1eiogX0vlfa+qgYfO/tqfXnzOWZ1PvrWABSTOVRFSH/X5v2l80di5GXjARfWtn/H8E3tlSOfmZk5uwEEJYFlJwK6pdmAYqGToQOknAFULBtztsqlNIg4ODIoDRhvq/mANvh/lKKAarEenAGyM7lIlsE4PtGrL+LVlsBdpDG/htNAc5iUPARAIgcgfKNpmgeIBgblDgJYEdvgXSljIFsgLIqEEvJeL6JeMwUjFwARuUIhJ1PEAeIIstCVA5MCDjkQMwL6Aar6G2LvBaOIVwLjKzuzmoWABofgFoUIDoeAYlogPoRZNYNIBZCYQoRtIFjjr0GQMzHIHnittiHQLBFSEkIgOoOoL6NID4RsFwJIc9A6HCJFoIWQLEogPqPqAkYFlIXIMoURs4bAIgAEXwqECETtmEbQBEWcNEb2LEtYKYWIYodcC4eUUEdiG3hYGEc9ETrDO4vqGpBZOqC4oen8A3HAahq7phIzhnEIIqAjO+j5pTkEMdIiCRLoKrJdBMa4AAIRIhbFkD7HHR4EEG74lCbHKB3Bk4zGcBzFdD3pgCHHXHbH7H/4MFOb4JWzqjd5mygbbT96vryYj75gqaSZfIT5wDn5cBo4NyBgZRpa8gZQ8GEBZRrzLGbhOb1w5Z6BIlOzMConjTomYmwlfoYCgmgYNwQHEYOZUkwBBD7ZVCg4IyN6Umw4z5X7z7f4H7sBr4b5b50o74nB768m/78lQCfFn5gDMAcnT6X5z436cD35UpP6SmClv4imf5ojinL6SnSlAGynykX7EHgEwCQGsGwEcFcGlA8GqB8ECFYHCG4FCnv6XGcDIBWmQycA2lYjcGoG7DoFogZHCHOgxbfFfLjGNS4nTGL4PHzHPFLHskMmrF+YbHHE7HAB7GvGZmnHnHCmEFXGZm+n3GPELEvFHE3GkAfERmXY/GEIGwchcjpAYrICwa8JwSdYJ64g9CqCxAtBQgFjMBJ79awr3bYgG6M54gfZzbmAtDBycne6RCOjKKqI+TSAbqcosQ8objT6RIXiCrhTWA7pJL2TxTBDc7QBRCpmz5BCkHkEAD8JQJEGAVQWC6SZwoQLCvIqIr5yADoc0RAEASswIAA1P8F8OmBZvwREEsoRNqXxlrMdKfu1svhpvzllOON5pwKsisKBgGM0BCFKLwMFojqkKpjRlUCjppljgMKWGMFwGFkZsrocHUKQI8A+boIdhsPGfwVANCkINDsxeEKUAOWIDkJEUIJer0npihmhjFidh/tEEEGpNZt2QConm3mAOoINqnuOLEHNtpVXuQbCtpWpEtr0NEFCGpIXv9nILvEEFjhsDoERaKS5c7vGRRekOFnVsdJEXIFCK3m9K5hpZiHdsnlfE9gROns7JnrOV9otgFXZQDgFcFWgOlXCAGJENCOPlbJPgkJuAWLuLiZeFiQqXeYqMVScCULfuvlUNVZCG6YhSUI1SUNeDFqhbMisZVW1VSo1QWe6aKa1TjO1Z8V1Q2eqEHqHv5dSEFaLCFepTduFYnvdinsNjFRnmgO9tnolZCqhilZtmlQtRlSdVlToHmPXpxs3iWCdUkPrKyMisbMBlzCyEQNYFCP8J9daKuQWl+NYByqWr5IuoELPgeZ2HWuFFYkBGKskheS4tkqjHkjMt6rxNNrOneBuiDc+NuCjPaNxBGBDVuvWvEtYngEiiyBMXgGDX9bxNqhjT6LYC2gYICL2HqjaPjWYJ+IYUefGCecogWLAEwFijnK1FKDKHHASsXItr3FnCLaKAsnihLYXCCnLd4g7LXMrQSlCIuW4iSi4qKIjcguIkRjKCfGfFwGLdfLfAxlLNzANM/K/G4u/I9FUrkord0oqICFCJeFSr2OvKPBAOgkqiqmqhqlqjqnqgakapeCamahataravao6s6m6h6jghtJWt/N9BgkOqOvnTmhnZ2i9CutncHYOtYBmgXdXbaP8DgnglGUuZVdwLjZ8BYIgFSkbbvCyGwuIEgKAAEIoMBkIOTQgK4K4EAA=="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { config } from './config'

const { amountIn, receipt } = await Actions.amm.rebalanceSwapSync(config, {
  amountOut: parseUnits('10.5', 6),
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  userToken: '0x20c0000000000000000000000000000000000000',
  validatorToken: '0x20c0000000000000000000000000000000000001',
})

console.log('Amount in:', amountIn)
// @log: 10605000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `amm.rebalanceSwap` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.rebalanceSwap.md","from":6635,"to":7247}<fsm-vh3gqscxm4e>
import { Actions } from 'wagmi/tempo'
import { Actions as viem_Actions } from 'viem/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'
import { parseUnits } from 'viem'

const hash = await Actions.amm.rebalanceSwap(config, {
  amountOut: parseUnits('10.5', 6),
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  userToken: '0x20c0000000000000000000000000000000000000',
  validatorToken: '0x20c0000000000000000000000000000000000001',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args: { amountIn } } 
  = viem_Actions.amm.rebalanceSwap.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.rebalanceSwap.md","from":7274,"to":7666}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Amount of tokens required for the swap */
  amountIn: bigint
  /** Amount of output tokens received */
  amountOut: bigint
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Address that initiated the swap */
  swapper: Address
  /** Address of the user token */
  userToken: Address
  /** Address of the validator token */
  validatorToken: Address
}
```

## Parameters

### amountOut

* **Type:** `bigint`

Amount of user token to receive.

### to

* **Type:** `Address`

Address to send the user token to.

### userToken

* **Type:** `Address | bigint`

Address or ID of the user token.

### validatorToken

* **Type:** `Address | bigint`

Address or ID of the validator token.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`amm.rebalanceSwap`](https://viem.sh/tempo/actions/amm.rebalanceSwap)

---

---
url: /tempo/hooks/amm.useBurn.md
---
# `amm.useBurn`

Burns liquidity tokens and receives the underlying token pair. [Learn more about the Fee AMM](https://docs.tempo.xyz/protocol/fees/spec-fee-amm)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/amm.useBurn.md","from":216,"to":10037}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"f352a044790f8cbde9e59508d0e42c0dd85e637c21507c3fb59ad6574684cfad","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUoiaicACUnABmAK5gjowQYJxY4nAwAKpgjGhwwURhcTCInCKkpgoUnLDWLGFwZWBxzABGZJFlbYwKpmgAOrms7FzppJk5eUZQENYIegCycTJojFgm8Jyi5WiVipykMFhHmWBiaymcEDHbnC3tZJxtGHd9JKl0bGbn17dtERgnAAjBZOMFQV8UvI0JEAHRDIYAWk4ABE5k1OPg0GgsE0APT4oiMGDMOFwfD42bzfFxNYmNbwfHjSa5fL+MQKBbIZAgOiiVhyfwsNgcTjANIZbJsuCcVyxUgQZicADkxNJKsRYBZ0umwRVABYAEwWFU1SSRIaEzjGix2+0OsAgAC6zuEml0BvUxnkShUiFBGnE2iCOqm7NkpnMwJsdlIDicUncnhweEIJHIGkCeGsKREzzipDAAGUMIkygZBHCBWS4pkAEKFktl6xwgBKOibABUvAAeADCKRivRqCX4kAA7mAAHz+ETiXQAdkXsl9yiQAA4g1odHg2k3S4l/CYzEgAMyx+yOPyIABsyeoXjTvkzAXoTBGYsrRnnEkQG63H1FHXRBvU0EM8G/Y8o3PS942vZxgUXB9MFTPR0z8LN3z0EVRm2ZhmDnD0pANVdgP9C9qGDXc9BraDT0QSjbCvRNECNM8UKfdCXw5bM9HiRJLlSOsYEbItD2sAchxHTgx0nGdgnGAUdDIOAAH4Kz4KsazhESxObRI4QABXsZgVImKSwGHapZLAccICnacuh4LS4GrAjdIbA8W3bTsix7HBLOs0c7Pk6chjAZS4HSawgT07yjyoakFn0LTYnYQ5SWIKpOBMABHOJGCgPJXhiRVlR2NgIBkBEwCGAA5CAaDKLt8EYWV2ruOAW3wRVIDrLE0uUUQuAnURpnS0hOGUIE9lEMA4ATZI6vOCBniBUxrBkOJYCga5Uh2NoZDmfh1pidggSONAmxynZTm+TI4Q5UQuSQHk+VoAUNlwKgAAN/vyWghlwsUJW/OUFSVVUxoUZhGHxGgRk1FaBKSK4AEEsCwYJomAIZOE4XMFq4CVmDpEaYBqdqjPkYqDnlABeFzDHc2svPElsca1AmrqbcF8YJzhe33HEUgFwX9v7ExrH4BngBxzgGfC1IJcFsmLhgYI8ZV1XBZE0guwEeQyhVCxaBNawLDha2OhgGIzXF3XOCKEwoBG9hDf4Y3VTNi2rZt0QOgdnWnfywriswMpVAsMAKEd3W0AgE2zZiGAYCga24VT2Bg6duVLRDgnXHj2p2sDuQoDl6naaqYuQ+V3WO2YXxOAAGUYAqipKx3e3xEXE5nAWC7r/7fpdCheSUwiqCn8zZRREz4zMpw3PH3leaLIxlguZbMrgFY0Ce113QXKRALkcikGBGMqJ3IJ4o5xLjBgxi4ITG8jWQjxHzQnwM147CIAib5n3I/awmkWY6QfgZVsHZrr+T7IOKyMk5IORnERU+AZJCkSAn6Tc24IJ6FATA+i5hbxvwQkgCwnFf4YVfDQQBilFQ4A4BgaI6sKZlEKOIRg5d4DdASq2ReykV5BV6NOGoEAsBCXUmUbeFMADy0jlpwF7NrCWZxYCkDKL9M2AASYAFRa6/QANyO31p7b2ujaAGKMYoVwpjHYuyKu7A2RswA6P0YYvYxizEhwFBABIaAsiZDcV7Dxzxej9D8RLAJQSABqYQXGJzCd7HofRzgxMFmHLukdIkZLQFkgmidPE2O8fsBQDiimZViusNALV4wLSWikDstTpF+PcJwesgIACipBFQGy8DUYhEljKmTnmIhQEjbL2UcpwAAPrZWAw4zBQGiErZ2EAir+GSngVqQIOFCViAkNGqQMCBMJvNS5MgZCcAnHkfAzseF8NlInaalQFDaCmjNTghzd7zT2lIoSYQZCvEIIYfa2woAR2WmEa5MgAQy2uMovMT0gyvRQJPUy/giiVBeZwFE+ynl4qOlsCAbQABWMBHDTTWukOAry1o/N+n8lIAAxMAv0j4TxAFPfwQKVFwhSMWOI1hYoMoJZwVqnVUZHPuTc2IjAjh3PwPIaaqrfnkyOZ1feYr4BwHiLcgFdzGAKo6JKBl6d1UHK1ctFUspTgH25Vipe/KUULSFWAPpAzJXStlLK3e8rbnDmVYwW4PzWWfESIE84qltifH6RlY1Qb1oWsyHtH5ZABnOt5diqgArUXCp0GgCuvq2r+pOXK01walVAgnKq1IEbbVXE6jAB5TxdXioNSsUFsQdC2CtRleQuYglxquVmpNYA9rmvpemzgbaZrfI1W7MQ1wpoTtIDmo4zBxCCH8CiAAkrcc5cRfmiC9pq1Y6w5CZQKvAfINRfrCtFV236JqFUhqBCkXtogYhOGtblCm+ZrAgs4CetUBzRCwFqiidGCqfkgZuYi06Aa8zgifSWF9+rfqPpSN69gOHOAYeLMWiuv1ojiCBEQLZe1UMLRqMan5G9VlPO2nW6tqbeiQCOBnF0boQC/l0CaSiF88F3gITREAhyfrPwYuQoBcZ37ODcN/VC3g6EAKCEwqRZBMDRByRHDA3QonnAwX+I0wIcGiZAtIW+hDn6d0M6QpAK4FMsQ/jQ9TPEsJaaSREaIYYZTcLY2UOxNk6gNBkJiB4HRSDOXSf0YGn4xhSnDDMDEeBlhXo2CSWUOwwuZROPAGEI1d43DuDFp4Lw3iMA+PO2g3wYR/GeICEEYIIQWChD8WEtVkRogxGUbEuICREhJGSCkVIMS0npHkXLzJUsymehi96/JBQyZBiTSUExdT5AhmVKGaoxvIyGIFvUhoTRmk4BaK0+IbQmgdA9p0x8BPETYkab01n/SBjs5J07EZZPmFc8xeCrFgQcVU1xP+mE3xaZODp1h0QSmcAGCAM2i5jRQDPKofs1hby3jPAafsFhVBniNJId7ogzxtA3AaA09ZrCSBgIuVQkhVAxAsG0HpbQ2go7M0J1QN9PtICNBJoIidnP/goaxI0nnnz/x83gbTLC9OyVCZYiJKPfYWEtg93Xev9cG4sLzk+f4zwWBE2uf0tnwKSYse4iXtngdKeF7L7i8uYeK7h8rthrHkke3cWUTX5tteG9D2H+0wJjcvcwWeW8IvcEgUs6LvAziV3+/CRL77TvKFsVd1D+hfFwBRRikCYB1UYBDFxYTPM5eyhILgOXnZGW9BEt+mXuQb7m5QBWECOHxJYB5fKCKG9sB9yfJyu32adguA6pYKa8QtLrVDAAFKiCKMWawlRpHV4WuX351K7C5DgMqPvRUrXVYnDANozxFQTlCW5LURKu89/q6KXbaAJxrWitSsNjBrDV5GG6yaC1AACpOB0YiN69y830toIhZR7llB99lBoBZRdVHkIgiNJ84RjoFAcZCM28a85A4QN08D409oCDd8iCxoixSDhouAQNUhzURIM01oJxKgaBF95pXhGpoMKVUC9gYABRaowCICFBjoARbkKCG8O9OBTB5xEhS9pIFBCwrU3k2C8hZo1pkBfo4cu1yQ0BZg6RfpnRgghs8REBCRIBYA+ChUtBJsaQZAgM0AkQiAjQDQ4RaB8RRAsB4ZdD9U4RsRmAZAABiPwhlEQQw2EMgoYbQsItyCIrNYw0wnEcwyw6AGAGw9gBQewuAfERwmgEQFwtwjwrwnw5kRUPQwIkIuIhI/peEKVDVMQ8lOFKQ6Ay5RguKOdBAwgOkWQ5LHKZlKw0oSfTvaAHvXrMAAAfRAJAIAHVxBchFAZjJiWpGjxC4VJ9rhKVqU0B7UkDCAoA8tlUzB20ppgF2oaBzhQUhhupEheoUhAlZQTAL0fk2hb9QlwCjID1XlVVXhThSRSUahuNthlUZpXhziRAYRrjIpbjbA+pHjcpGAL1QMmpVUpoeCYA4Q+DdgjgBQ3JOASMp8gRtDIAOCrg4jOAD18QFEkizCRshjMi7Dko8inCij3DPDvDfCKj/CqjgjRAkRSSYAkQUgkQ4ikRkhohzpSAhhm5Q0rJ2Ad0hIJielPo1tVcBi1jmjJCRjEAtRR4+ChgsCcD9RVUblWD2AZAoAVRIg/FrQjJ9h8hBsYAzS7kLSoAag3kIjAlBho1KDMTjSVRTTjpOAABSOAS7FUT/UgS0602027e0/oTEIM806M90xfL0ukQ0wgzEkgswCcTgfDUgfUWY8FPEGoBvZeNqA4AEPaOwLGeQdOa0m0m7TgBM84WUDdffBlF6IEY1ecJFOaWKdMgwrNXUsAa0AmQssoEsvgMs8oJUHQKshQFrWs7wnAVZFs2JLgZAGAF2Z0UCAMVQTcwWEaAkzfOpOEUgBIA9MAP1JBBhLgYIIYxAIgZgAMUnAMDcAuCck8rgBRbYxwS868288te8wIcEZ818xiCwSQRiL848gmU858/oMgSKGQcouYfVfEOgalOkZaRAZcLBBC7Ybc3csIZ0JENgtcsgO8N7Yi08simQDfLfR85C2NIsMIDCrtbC2gXCoSAi28O8Cwb827Lc+4dIxAFCji9CndUwbCl2SYsLNiM8RiLUYBLgSKMyRWVUWYjjNsclOQlIFUPxLA6gsAYIX6VEeaL5TgAxTSmAVwAAQjRGsrIEcvIzjNbIdMxCssUCeF0oVX0p6F3zAGct8q+Uco9K/xHP6SGFHi1BVK+hvTrA1KBF+igJkNgIZTHLiv+gNN9PzG9O0pDGLAEIFGLAXMIAnBxhMrzC4CzWKp0FKtxOYAqrMiqpqqzOJl+QwAyqBCZjzJ32kMxL6uCG9JqCzWbJWmYF6uzOwIgFwMDOdODKjJjKmrtO8qdJdNWrTLeW9JlNmr9PmsWuTNDPDJqEjLdNjJbLbMdKxGWpTMtKiuuEzLABmr6uIMTSLMGsLOLNLLgHLIXOUByhrKxGotWSbM8tusxGQCnM4BnKkQBvnMrJBqgzBvrNWTdEXyzTUrqvuGUm0pVACtuSCsMrAGMoOo+rMosvCqeDsuUicpcr8tIHcvWvjM2qZpsuJs4FJpCrCtcpZuepxs5X+iW25F5EyBk2QAb0LFihMLpIsPxD6GUDiDaDhFzGYHxAZNyKGL7nEKJGKM8JMDaHxCwL4MiD4xN09CNHPktxc2Tz0En0zyYkUxz2oQh1oW8w9z0GCErOgGiA+uNLMm7O0A0njQwBqEzgLTQuEWYExC4OQGdGcmoyKnBAAGpgRrgMxjooMLakpm8QBobF9foMy0A31uj7gYAJwTxMTOAss1hvoQTlCzJ2z2jU1Z104agK6ZohgQ18xmDtgfje9Kgd1SBXhg7FptAyDtgFUoMYUUg4UB6MD942gRA8g8KxYwAXYShUC59HDvktCdCHSYhggzxIhaSUjFad0wBFxbDsiTw4hPDr7RSezcjr6zxyj+gYg4QzwAi0AgiC5ggflgxWgYQjjeyFUO6WDOBtC8KaopTFS8D5aUj6T0jGTsjmT8j702SSjOTptTU/6gjgi4GEGRpSHnDgwoh4Q9S8q4AurgMY0uAmZVBaqjqAyR1zgygQyrSagOHYQoaOa+Go5nrS76Hy9jr9QhHLs+G2avLEyyghHOB1BhzIjcrfotRCSYHfo4Gs4FSRokHkjhtFbta76ciWSCjnDXD2TSj4YdHeSSG9G0ByGkRKHJSMpZSNp5TSBFTlo0UqJlsJbNoZMiArZgQ4RQQLBLbo8/wDRY8yIxNKIbcggcDnapcbwNw88NMFdHa8aRkWwIFtIPJoFRk4FuxEElCQpZl0ErakADRbwPs7bJcfsgg8mn4a6r4Xb3NnAzwv4UwvN3cHzPdmFdMfcV1RAyh1FBZNEaKiMvEwsqlzE1cA9Zmyl5nHEQ5U9XF1dSlbEfF7F1nYlm4gkQkyBtn8lolHY4lzhElXYtnlmEtMlHYDMSpjMClqkkdrFdmKkFmQ4jg2l6kpVGlFpTlWk212khh5RFkEhlkowoAm95g9kNVHD8xO19VDVe1ThqoSA9oxnJoANI0JihgiVkWuBUWGV0W/j4AsWrVcWpT8Xm0wBCWQKgQSXygsNyWe1KXpDsXagRodg6Wm0d4UgmXiWIhSX2Xu0bkuXqWcW+W8XBXSthW+dan0d4mQIcEkm8AxnUm3MQcbw6nMmvbBmfavcRmKMjnzgTnUkIkHmuAoWp07ZYXlXEADQNwrAE8vswJqIggrngklmM9IwGIwc0nnBVAZcPb+nodjWi9g6S8hry9K8F9J869sz4WUpW8Rjfkxib1T8B8uph8gRR84hx8DhNi6DZDd64Z97F8e6wBV919zzt9NizJmIj8T9FR+9z9XhL9r83iHJ78Jin9s2gQoQOBXlP9ygcB6hhx/8NbGt2ycqwARDIDsyYDkX4CHl9iUC2XbBB7MC5rjTz7H0sCSDz7p7WiqCFjaDp826mC501D2DNDw7OAMSsT+CWrhDwDOAmiJD92/S305CxAFCd9rIVDoH1COC3lYjuSGV9DIiL6jG0jrC3IsizGsHCirHcGyi4jCHqiYOGUDDvSKMp0Yij7MLYPajSAEPUita0GUOmSpt0PLHDabGuKeT/68PyOCOtE4s4QGigQf2WjM2GDU0B7uiiqNtUqiNnzM3n8iCtRpi5iFiqhljViBP1jblNjyUqVHA9i/bDiQSgQTjF0hqLioSMAbiep4SBpniiSb9+2nh0Yvih6uWAS5AgSk1QTfjTPISriLOYSrOHibOkSIHblUSnhX3sSKhBC46+PNGfkSSmov1UgKSqSaTkHEPaPkPTHMHWTMOOTsP8PcO+SBSkvhSwBRT8PxSIA3HpS3qLpZCvGfHhWErVTG6UqDgflBPtTV3F39S6GCrxGAzTqdrrrxz2b5H7rtq3SRHCPXqjSFqTSHqzqIzRvZHoatqVqZuVH9rBuiDcyq6Cyvq/rZykaKzFzUbVyMbGzIh1vvL50vquzJ7eyp1dgHBTpByn3KOxyfy4aEa5zzvgbqy0a6z1z056LSK9yDzgQjzxvVZTzmKLyrywAby7yUgHyIKJKoKwcjRPyRL4e/yALD5kfUfQL0fwKnyse3yzdYKzx4K4exK2KnA0K2OGUeK+L8LCLgRJAIeYHGKKKqL6ztFBKjQjRefGLEft9KfYBJL2KWe4j2frAN6PFFxBLbxhLeemfULOLZLxzGLFK9mFBlLVKVp1L8atKmYia9KDKQqKa9vMTqbLKBbbLgB7LGbaaWaPKbqOaPf4brfgqG9QrOa3LZueO1HWukrOipP0rV3CZ12+vaH6GuAiqmYSqyrWrKqHJOqCr6r+lGq0BmqYu2qYAOqpqzf3rsztLBqsDRrxqHu4s/FKaD3FulrpvUyxuNrJuRvtu9rXqK+2GW/TqwzVurq7uu/ludrnrdv+/hrPqBknzDvfqib/rAaUbgeruwerTbuBHJvYavrpyV/kaLv1/0bN+sa3lhak/zf+qdL/eya7eZ/xHHfff6azJ3eBbWad+F3g+ppubebA/+azNSKtjVioi0x46KcWgJjTj+BpagSUgHLUMY0dla+AVWurSVBZcMiOtdInrXJQG1rGxtU2nNXNpRNBMtTSQK5iFwEUHaQCVNoG2jA4Js8rEd2n0zwCch/A9lPACkxqYutyBarf0O62jagtasVqfWLSnCSYgw20ccPHaCdB0Cr4DA12kwMNYDNC8vtRcv7U4CB1FuE9HsmHS4KR1rY0dMILHXjpgAMAidZOjRnTqZ0XwOdNZGmzwBF03kJdObmXRNSIE8yNdPjvXWvS9ktAoDVuiJxnRwFO67gx5LWz7pcAl6Q9NICPXEDj19UPZaeqBjnqzYF6tyaIWy1XprBroQkRNmxkrbz4D6WjE4F/VPrn0MuWAK+vNFvqocH6T9eaC/W0Bv15oH9UoecG/q/0qigDYBv4Jbq7ZKMM9W5FA0XywN6QujbxvowqGIDUG2XVDrlwsY4MCutjcYfY3pDkNnGrjahitH65X8+G2lFhmIyILsNGGXDHhtXiCRj9v+ijZRp6VcFHD/SLfKRrw0YZXC7qNw0Prt3iorRNGYwghuQwMYK0kOmAnLoxzy4sc8GdjDjsQ3WGONNhWgKIHiw8aNdyGvjMWm9ECYKEcUoTcJnaBIGvZo4DTS+K/GaacCFqmeBQV003DKCo2heM3q03ATMxCmbMUSIIl8jwJby5TZBDZFQSORnWJOWzJQMAiasiEgiCkSG1qbhsWBbuWkYwlNYI5eWYgCZo7GmbaIVmXzXxIs1ObLNPm5STURsySRp5rWOzPUfs2qS+srWZzW1uaItZoAbmfuY0ec0eYhxnmeSa0Y7A+ZzNDePzCWH8zBYAsuwQLZpGACEHgswAkLJZI61WQOCW8SLMVjuy7QUs94MrRUfywygKslSWoIlnGJRYSskxmLGQDy1pbpiNUBLLMcy0Ay5i9UHLKVsmMLE0s5WArUsQyxFY5jxW1YyVhiypb1jZWq6JsTaiFaMt+RrrPgbU2oHas5BAYSkXq1DbAgaRBeOUcMwVG+t7RRoq0SZjtaRiVk6cfkaoCsyNMTQ1AlcYaLuYBsAc8giUaBF6Y/xvAbAqgBwL0BcDomugVQKr1HGWBsmIAIQTy02YpIxB8gCQe9mkEyDM88mRgTeGoT8ZcwsAD8G/nFBMjZQ8ofbMqEjIvQ4YCMUkGwGRgbZ4Jf2RCZDBQnqhmAx2HPgWDATaVvwrMTyKyLARcwVo1ofsKBhZRaoYAAHVIPdDzBPtRBwY8EJiQUB8d+4VwLaH/n4A1AEGWQuGAymWgFwGRcIaTFrAFiuijMW2VkGdlBBwhVAl2YEF+TjgqwkcpsWgOjiNCY5scuOfHITmJyk5ycqgSnNTlpz05GczOVnOzk5zc5c4qubUeEmTjB4dcwEvyQ6Hcm/j083sAyX7H8nhTgQwcVwAXAeESMVQ34kQR8UTjiDEAl2WSWMzUjuRGGlo9xAXAW6LUEpe0IKQfRSlpS2RGUrKQkhPEpJ1cBcfwMvFEBIBQAgQACctFYEIBXArgIAA==="}
import { Hooks } from 'wagmi/tempo'
import { parseUnits } from 'viem'

const burnSync = Hooks.amm.useBurnSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
burnSync.mutate({
  liquidity: parseUnits('10.5', 18),
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  userToken: '0x20c0000000000000000000000000000000000000',
  validatorToken: '0x20c0000000000000000000000000000000000001',
})

console.log('Received user tokens:', burnSync.data?.amountUserToken)
// @log: Received user tokens: 5250000000000000000n
console.log('Received validator tokens:', burnSync.data?.amountValidatorToken)
// @log: Received validator tokens: 5250000000000000000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `amm.burn` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/amm.useBurn.md","from":10373,"to":11081}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { parseUnits } from 'viem'
import { useWaitForTransactionReceipt } from 'wagmi'

const burn = Hooks.amm.useBurn()
const { data: receipt } = useWaitForTransactionReceipt({ hash: burn.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
burn.mutate({
  liquidity: parseUnits('10.5', 18),
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  userToken: '0x20c0000000000000000000000000000000000000',
  validatorToken: '0x20c0000000000000000000000000000000000001',
})

if (receipt) {
  const { args: { amountUserToken, amountValidatorToken } } 
    = Actions.amm.burn.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `amm.burn` Return Type](/tempo/actions/amm.burn#return-type)

### mutate/mutateAsync

See [Wagmi Action `amm.burn` Parameters](/tempo/actions/amm.burn#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`amm.burn`](/tempo/actions/amm.burn)

---

---
url: /tempo/hooks/amm.useLiquidityBalance.md
---
# `amm.useLiquidityBalance`

Gets the liquidity balance for an address in a specific pool.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/amm.useLiquidityBalance.md","from":145,"to":5353}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"8ac7e459f30e286677d1cb839aa57883a14653c6b8b3bf03624ebf676bd6cacc","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUWKQQOBwYAJScUKJiiJwARowKplwAPpwArmCwAGamMFD+UBDWCHoAKvgwnDKiIpxwOdbW8HAFOTIyGJyk8BAyJFBxCaKcBeycyvUAjjlkGAB0ADpgGxu19Y3Nre2d3b39g3DDo+NiUzNznIvL65vPOw1NXAcdcF09fQNDIxKV0m01Iszq9yWpFWWxeEL2HzaXx+J3+50BY3i11B4IWUJhz228PeLSRR1+pwBlyxINuEIe0JW/hE4l0ABZ1MZ5EoVIg2RpxNogjT/CYzEgAEw2OykBxOJAADncnhweEIJHIGkCeGsEDAzWSokaYA6SVS6TAWVy+RgRTMpSo5UqeFeCNJh2+xz+ZwuQJpNzBdwZq2Zml0qgAjLJucokAB2AVaHR4Q3Gjqi4qS6X2Rx+RARtnK6heNW+TUBehMVjsLgGQSh1lIABsAGZo4pY4hOZohXg60YxeYpSBbDn5YgJU2i5hVXp1X4tZW9Cw2BxOKJmMwGxJEE3pFyO7y29RBcm9But7JMxPs7Lc84WxLpyW52X/DQlyBuia0Iw9bk4BgAAZRhFkYKBGEwAAhI1RBNGAAB4AGE9SKBQKBSNIMgAPlCexmB0Mg4AAfiSfsVgvFYckAkCwIg6DYPglYAAV8MI0g4GQ1C0gw80cOiMi+EECjNyomjQJycDIIwGC0xgFYACUdByUgwAANSNJYEL4y1sI2MAN3gLAHHqajgIkqSGLksoKiqfQhIDTghV/RRcU4IDmNmAR5BSRiOkcuD13aCA8i4Ux1xaHBrEYIprE4NhhiZAUFCqZBkBAOgNywOR/AAA3ytA4FoDYVxrThgB4IS4E4VwpnCZhOAAcgAd1EBRmEYAB6Ghq0a2Fv0cP8wE4ABBLAsGCWJgA2ThOF1fUuAqmkkgSmQAEkxlqgBeSrDBE5gxJgZi+HWqBgmm4bZoAshqm8sAkkaixaBWF7GooGarqII1wISdhbv4eQHqel6Vjej7XGiWFZvm5olomDDGDgICIFECDXO23bhMoszaMk+iZL8mBzo+2bVo297Ltm1GoDOOAgdoCULGsEGLAsVRVDBy6IahzgYs4YJEeR1HTAUWJBjQFThoQiCiGwoW0YUEGEM6mW9Mu8XJc4aXGFljzOFkuDTXKmliJWNAIAAZTQUgRcm1xldVjZXA2fLcpAABdCh0uM2VLxAH3DKcaqAFpOFY332LgJlPfSjXVKMABFfE0R6Lhmsg/A3L182AeG1NDfkj3PZAFkdzjY85EPJAI33HszxAHGLPxg34IzcUbxHGU5TzFspw8YtZx8DV321PRQnCSJMFianadIzhcqegASYARBtxRXFyzhsjyQpigdEAnTskaoBpzovLmuprH4Xy5IDJKS7DKQEwPHl40TXtzxP2m2/MY9RzvccT5+4zm8POcsH4gjjwiGQKe11SD/XkHPBBYANoAHlSDH1Pt8Le1pd72hss6PQABVQCgY7r31LroCMqh+Qv07LXU8QQzLwLuj/JAtD/7d2cEAlUoC3yLkgWEaBURYhfRMFiP6d0kF3TQRgr+Z9t42jtCUAhdkNLiN+mQ3OFDH4TgjBXGMvICzv3rmIn65sWG5zYV2W8XDJTPkHmAken4DIETgMZfyMNhgwA2F9MEXi5BJBQvqbxqiXQQlygEmAm9mDQB6PUIRRBwLwAinAFccg4gwGSDkBQFoFBzT1OieoygEi82qmkjqjQyG4g2AAKVEF9C21gbZYC4FEzgBFRxgERg1RJySxjJH6M1LJKRwjNVIVHWErxYlQHiZwOgq5CqzGahASKMBoqxQKdWMwlo6awgAFSjXnsEopm9rB7GqunZQHSdCECgOUtomcmjzyiSsGQEAFCTVyhhSJhTvErDIOEUgXz1z5BeX8uQKxWqqRBSUtpgVkimUAmMc2nBmo2xoOfOC/QABy0B5IACtynWxgBuJ4hyRpOXeamcFIS5Cb1MCyeCBSwBoRUkCVF6LILFNWcgXKQjkQrBEOUHIaBcru2CPgNAaAsB006p1SAsAiUrHYAoFWtlOqNBoCIYORAJRshWLQTqogsBdQFZ0FYUrmAyAAMTmu+MKkKaBp75A2Hy+1UdhWAvFZK6VsrEDysVTAZVqr1WVE1QkeAaBdX6sNca01nUPWWrQNau14RkRetIKQaIKxOCvAUNSo0tLTlzQRUioEVzCCit5tWDgIs3K5SDYgKJMS4mQthAAfX2fsgA6uIbpihu0dqSPmwtMgWVFM4BAZIBL1loEatVAiyhoDVXEPUMwGcyATsRjQS0fQNhwAwCafA4RIDUQaIwAGblkhjNIaNZia1qpzEpIBZgyQ5AYUgGCNduJ+gwx3fINA+6DKHuPaekK1UTBXqNOOiAcwwR4tgCsIlLQSUbijpwC2MBikQj5ZATF/4PWcDWp1VBPqpUyrlQq/FIatBhrgBG7V0a9UGqNSas16aLVWttaIYO+GYDBz1MHD1wc/yxFBBsWJgxeasvYMwBIQ0ngbAAKK0Cyhk6i9a7gFunUW35dLomIFhK7IlGxXnvM+Y1OovRVkrNIDIKAjVogAG4NjyrDmvQqSRrPvLRewBzGFUWOtFWZiF8kLPBCszAGznAACkcA3pNTsw5pzrmwDueYp5umnAfO2f81AQLqzgtoFCwZgFWb2DBDMM1TgymKvAsaj2wgEQ4AYXOEu/A9bDRjDsONeQJQnMubc51DzGRqqApmG4uAbV6hwTGCyK+sw7w8tQ7ALNRn0sjdmnVoFSQmt8FlW1iAHWuuoxyyanA9phtXSplwZAMAxHuy7PmVQ12bulKaS0tAKxSB5DWmAWoiNgkQP5k2ogzB8yPnzAqSGm2bvri4Kgmdc6ft/YB51uAwPAig/xYgcHiAWwWEkATmHb2rqlKbRkMgBkZCJs498TqdB1miqGogOMcZ8ySDJ7dzg93HvB3RRdsgu4JwSm5wj+ZYjPuMFaTj2AiAqeqSNHTionRGe0GZ7+PUbOmy7gsLD9z72uCU8tNT5X8nTCM7ER21eIsJwtgJ7CGGxvDKcB2o1xgvROAKWnYyvUjU0uvOhWAYIuUAAicFtBgmXq4mArgACEnAI+KDIPH3KQ24eZbG0kZPUfOA9s9+On3qQQlgET7n1PhXVuApdvlWEqn1NIq0xEk53izkXI27X3KpmTSFK4E6t3TkdBW0GBuC2x2YCEGapNQPff5lZsH0KEfpLmDj4IlPmfpXmjMAwK3jJO1qsTv+XvomTqMKAoz5J3fYW3kfMi7lvz9nHMZ4y1l7z0XfPJYK+fJ1V+T+38swf3i0Sxany1S2uyz12Xfxiy/yr1/zAB33/wm2BUPx20q0a2a0OxaAn2UFOx6yF3tEGzS1f2z15zQNID20wNa2wJO1cm63Oz63tE9nPhr2eGd04Fj0Hw9y92Lz9zAADz/xv2D1Dwr2j2AFjwTyT0j1T3T2IJG0gK8ykJTzBALx4N91L3L2kNIHjyr1YNdnfDalSnSkAlwCoGQHOBUg6AlQo39XlXSGUByGSBWF1GYGoyVQYyDU6nfWnU6hYzjRMGSE6leSJWiCLmEF0QlDjH3ErlfjZxMSCCiWsQVFsXvCQAsAcT4WHgETwGCA62gFiH/wiymxmznmxQwhBgiC1xp3DnQySGxWQHdgEk4CIAgHAn5gAGoIwp0NR3lUZQjHRbI8AFCn1VlcpitN5K0OCYBmpBxc0ABZVOGXDJQUHIAiXZUtPOBJJoZFDCSYuYDYIoDiLgMyMYZ5O4MIFgcQfoYo7QUFU4r3amSCIaItE49cB5ZIEQSCFnPUXxTSFJCpT3cQc+d1TzAoYIFsaIcjP1ANTqeTMAOMFVOjMUHII1OE4TGbBjOElsOnDIAoFYFsZNa1WHYIO4FYtYpZH9GDeKbYjlXlXKFnGQFYUEeTNAL5awv1KjINWjNVQ+RjKNGNVjeNLqBkwk21Bk5khICU6NQUOAaIHNYzfKHvdg3UUKQfVQWfMrCLRqFUy0JIWLRzDCHU51OQ0bKAgpUKJIdQc+YrLff5LUo0xARLI0l/eQt/c03UzgK0oLNAEVErMAV2WELDeoPlEUqUtk31SjGErkqOUNXkrVfkvwtjBNEU7jG1cUuTSUjM6UrQWUxyKTeoUwKUxTAwlKJANKEuUwdMKgIgCwFYCMOs1mMIh+RsCcBUZ+GIzsY8OuIICzJIlI8cJUYBF8IeBcCsBIuffOeCM0LCS0HBHeW0PeMJGoYkfYMkT0CkNEX0TECYRyIMfEHRFslsfRdsWI5+bslMQmPszuMcHuQsIcweMQBQfwWPPAXs8Iw8iUYcDs3kKwMcvAXGSyfoSco2CMNmVmcCiCyC8CsAaxUC/svMdI4uXUWAKsRZcqTGaqWqAoeqJLNqDqbqGAXqJ3OfOGRIG+AuGqQfcibGcSOiaSFuDoYmS6GeToemOMNkCUKAFsVQJCawJsVsNkJCNmR8SQCUVQUQFsZIBUNkNkKCawSQGAOMVQSQVQAoCwZIZTZIZITmWaZhZBemRmawKC4yky0y4ynS5o76CRSxQGJqJ6Qysyxypy8CiMTmbmNgm/LUgC/GciqcxLYCmAWHfwJdUQJAUAQIeQNJPUPAQqEAVwVwIAA"}
import { Hooks } from 'wagmi/tempo'

const { data: balance } = Hooks.amm.useLiquidityBalance({
  address: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  userToken: '0x20c0000000000000000000000000000000000000',
  validatorToken: '0x20c0000000000000000000000000000000000001',
})

console.log('Liquidity balance:', balance)
// @log: Liquidity balance: 10500000000000000000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Return Type

See [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook return types.

### data

See [Wagmi Action `amm.getLiquidityBalance` Return Type](/tempo/actions/amm.getLiquidityBalance#return-type)

## Parameters

See [Wagmi Action `amm.getLiquidityBalance` Parameters](/tempo/actions/amm.getLiquidityBalance#parameters)

### query

See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook parameters.

## Action

* [`amm.getLiquidityBalance`](/tempo/actions/amm.getLiquidityBalance)

---

---
url: /tempo/hooks/amm.useMint.md
---
# `amm.useMint`

Mints liquidity tokens by providing a token pair. [Learn more about the Fee AMM](https://docs.tempo.xyz/protocol/fees/spec-fee-amm)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/amm.useMint.md","from":203,"to":7459}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"4fca6eaaab4d04b51aad961895f40c6a81566cafdac628c7923a2a2603d064ae","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUoiaicACUnABmAK5gjowQYJxY4nAwAKpgjGhwwURhcTCInCKkpgoUnLDWLGFwZWBxzABGZJFlbYwKpmgAOrms7FzppJk5eUZQENYIegCycTJojFgm8Jyi5WiVipykMFhHmWBiaymcEDHbnC3tZJxtGHd9JKl0bGbn17dtERgnAAjBZOMFQV8UvI0JEAHRDIYAWk4ABE5k1OPg0GgsE0APT4oiMGDMOFwfD42bzfFxNYmNbwfHjSa5fL+MQKBbIZAgOiiVhyfwsNgcTjANIZbJsuCcVyxUgQZicADkxNJKsRYBZ0umwRVABYAEwWFU1SSRIaEzjGix2+0OsAgAC6zuEml0BvUxnkShUiFBGnE2iCOqm7NkpnMwJsdlIDicUncnhweEIJHIGkCeGsKREnGY/QAyhhEmUDII4QKyXFMoti6XrHCAEo6OKkMAAFS8AB4AMIpGK9GoJfiQADuYAAfP4ROJdAB2BeyX3KJAADiDWh0eEL5xLiX8JjMSAAzLH7I4/IgAGzJ6heNO+TMBehMEZiitGOcSRDrzc+ooa6IN6mghngX5HlGZ4XvGV7OMCC73pgqZ6OmfhZm+egiqM2zMMws4elIBorkB/rntQwY7no1ZQSeiAUbYl6JogRqnshj5oc+HLZno8SJJcqS1jA9b7o2/aDsOnCjhO07BOMAo6GQcAAPzlnwlbVnCwmiWgB5NgACvYzBKRMElgEO1TSWAY4QJOU5dDwGlwFW+HaXWDaJC2bYdt2ODmZZI42bJU5DGAilwOk1hAjpnnWP41ILPoGmxOw2xQFAVScCYACOcSMJlmCcGgEB3GwEAyAiYBDAAchANBlJ2+CMLKLV3HAjb4IqkC1liKXKKIXDjqI0ypaQxX4ECeyiGAcAJsk1XnKVHScKY1gyHEsBQNcqQ7G0MhzPwzwwDE7BAkcaDtrkBw7Kc3yZHCHKiFySA8nytAChsuBUAABn9+S0EMOFihKX5ygqSqqsNCiFviNAjJqi38UkVwAIJYFgwTRMAQycJwuazVwErMHSg0wDULUGfImUHPKAC8TmGK5NYeWJiRY1qeMXVd4K43jnA9m0dIlYt/P8ykfYmNY/B08AWOcHToWpGL/MkxcMDBDjysq/zwmkJ2AjyKjGWnJiKoWLQJrWBYcK2x0J1mnzOt40UJhQIN7AG/wRsm/AZsW1bNt26IHSO9rzuuwVHv64bYCo8wEAJGgZSghYYAUE7zslWU5u0DEMAwFAttwvnsBh87cqWuHeOuJneOZXN+2F7LlPU1Utfh0rOvG9tAAyjB5QVeQYJnPb4kLOIpF3nBVx3f0/S6FC8gpBFUCvpmyiiRnxiZTguYvvLcx2RjLBcC2HPAKxoI9rruvOUgAXIZFIMCMaUduQSxWz8WRvRjFxgma8RokIeAfKhHwGYeJYRAATfMe49KNnUkzLSX8EFeVbJdXyvYBwWSkjJOy05CL3wDJIEigE/Qbi3OBPQ8D9J0XMDeWCgDnAWA4uA9CL4aDQPkoqHAHAMDRDVmTMohRxCMBDnITEtDGxwm3opPeAVehThqBALAglVJlFPmTAA8mohacAexazFmcWApAyg/QtgAEmABUduP0ADcmc9Ze3kOYqxNi9h2MceHSO7sSox29mANxtBrG2MUK4BxmcBSJ3OFkTIATXHPF6P0bxYtolJwAGphCjv4lxQSkl9HOKk/muV8qFQwN0ZJRTM5HGiusZOnBOzxlmvNFIrY6lqO8e4TgAAhQEABRUgip9ZeBqNIrycjd7KUUQoZR1lbL2U4AAH2srAIcZgoDREVpwIgEACoJQxHgJqQIhGCViAkFGqQMCJ3xjNW5MgZCcHHHkfAOyxESK2CVYqlQFDaHGsoE5pMzkzW2qowSYQZCvEIIYHa6VCoLTCPcmQAJpbXD0XmR6QYXooGXsZfwRRKgfM3o0yabzCVN1lBANoAArGAjhiqlXSHAWUXyAWcB+qchaAAxMAP0b5LxACvfwYL9FwhSEWOI1horMs4CiJqbVkZnOeQ82IjAjhPMmqkNlnKrhtTgJK6VcB4iPJBU8xgKqVpMsyNtbVQKFoqllKcK+/LcU72Fei2aYqwCDOGbKklCqLlKvNY8oc6rGC3FtWfK48hcxJ2UtsT4Qy0qmuVY8y1ERrUTSBGQYZLrBV4qoCKjF4qdBoDkNtOVzVZSKvPqm1V6rxyaqzQWO1urZQwBeU8fVUq/bGshbEHQthC7XHGjGmJe8E2cBzcmsA2103MuHR2gF/zSV+J2GladpA81HGYOIQQ/gUQAElbjXLiAWUQ3sW2rHWHIC+eV4D5BqD9cVBq/Y/TNSq0NQIUj9tEDEJwzaZBk3zNYCFnBT1qhOaIWAVUUSoxVWy0DDyUVHRrXmcEz6wASp7cyn6T6Ug+vYHh9lJacTlp+tEcQQJdkFXOQJfRNRTVsqPhst5G0gR1pWr0SARwi4ujdCAH8ugTQUSfhQ28VDqIgFOd9Yw0EJMwIAfBJMoCULeA4VAoIPDVFkEwNEbOnABggAtguY0UBTyqD7NYG8N5TwGj7BYVQp4jSSCNKoUQp42jrgNAaHp1hJAwAXKoSQqgYgWDaP0tobQjNEN/EaYEZCxPASNJJoIJV6FIGXIp5iQC2Hqe4phLTJwdP8OiM42OPdTZlCMwHCw1sHQNca015rjWYt3zizZ0i4ngSMPftQkA5XAmVb9hlv8TDlOsTy0+SBhW8Dab4XptjOTPYVd9sy6rxnLZ1Zazt3bjXgRtcE0RBizmuvJbfmBKTvjo55OG8y0b0hstwRYkaKbXEZuviK7w3TAilt+JW0NhOSdKmFIYO1z0FhROrn9CaVLeBru5Iq0D84o3AxPeYUgV7qnOIQIwp9ub2SIjRDDDKUR7GyhhKsnUBoMhMQPA6KQRyPRQdAw/GMKU4YZiHKWFfG9JJZQ7EpxfE48AYSDXPjcO49OngvDeIwD4U7aDfBhH8Z4gIQRgghBYKEPxYRVWRGiDEZRsS4gJESEkZIKRUgxLSekeR+fMg5zKJ62K3r8kFLJ4GRNJQTF1PkcGMRFTKjVBbxGQwSd6kNCaM0nALRWnxDaE0LWnS3yO8Q403okv+jR5d0MTvpio6sOjibRoDRvdx5w3i4AIpRSBLAiqMAhgEvxnmBvZQcFwAbwc+YRzSU/Xr3Id9CcoArCBMV4ksABflBFLe2AQtflZQH1NOwXA9UsHNeIBlWahgAClRBFCLNYSoaiW+zQbwWOldhchwGVOPgqw7ZfjhgG0Z4ipxzxJclqY5BZoCj8V6Kf3NAccUqSKOlcNRgawFvEYXXJoLUAAKk4FRnZQ7wb3fXWgzTNWUAv2UGgFlG7VeQiHZSXzhAOgUCxmI371bzkDhE3XIITW2koLP2oOGg7DoIGi4FA1SBWmEhtVKnHEqBoC3xmleDqhg2pTwL2BgAFCqgQKQIUAOgBEeUYM70H1WkJhmmilP0snbGHS+X4LyCmlKmQB+mK0NXJDQFmDpB+mdGCBNzxEQEJEgFgHELFS0GtxpCAxoBECRCIFLzhFoHxFECwEYGZEVDMOxGYBkAAGJTC/YRBLDYR6ChhjDYjmVzDTFSBrDbCcR7DHDoAYAXD2AFB3C4B8RPCH0fC/CAigiQjUiXIIjoi6j4ic14QSUgR5CqVEVlDUDbkuCYpM1nkcC6RVo2cso2UfonDSgl8h9f9qCtQAB9OAuAgAdXEGugUCWPmMalJQ6MUNPxUO/RpTpTQAdWwMICgAF3VTME7XGlgRahoHOEhSGA6kSC6hSETllBMEvTZTaDf3iUQIMkPRZUmleFOFJCbhqB422HVQBVeDuJEBhCePCheNsG6g+OykYEvTA3qkmnGlEJgDhHEN2COAFBck4CLALmbWMMgEEKuDqM4EPXxG0SyLsLN0mMKLcMSjKOAzQEqINH8MCOCNCLmD9jhAaKiNECRBpJgCRBSCRDqKRGSGiFOlICGATjDQsnYF3UEn129Q+g92kjgDGJ2IUK6OmMQC1HnnEKGGINIP1EmgeT4PYBkCgBVEiG8WtAMn2HyGNxgEdKeWdKgBqC+XiMTkGESCoIJLtJVAdIOk4AAFI4AY8VRgDSAXS3SPSE8vT+hMRYynS0ygyt9Qy6QbTIyaCk1SBggzBxxOBCNKyVRljoU8QahO9d5moDgARto7AMZ5BC43T3T49OBszzh20KyL9mVnogRTU5xUVppNCQyLCc0LSwBrQ8Y6yyhGy+BmzyglQdB2yFA1cuygicANlBy0kuBkAYBXZnQQIAxVAzz+ZBpySj96k4RSAEhD0uwq0cEuEuAqz8jEAiBmAAxnMAx1wq5VzHyuBtEjjHA3yPyvyWofzAhwRJjALgLTwLBJAGJwKHy8Yny0L+gyBwoZBhTDV8Q6A6U6QFpEAlwSE8LtgLyrywhnQkR+DjyyBbxWIjQGKnzmKZBD9j8/zCLzhiKwgyK/YKLaAqLBJaKbxbwLAIKE9zz7gAKiKOxxLd1TAKLXZ5jKdWJTwGItRYEuBwoTIFZVRljg1OBmwqVTBO8wAVRvFiCWCwBggfpUQZo/lOBrEzKYBXAABCNELysgAKijTMoc70zETyxQJ4KylVWynoM/MAIKmKv5AK4MkAxcoZIYeeLUfpfUr6Q040oEH6FA1Q9A9bS0v6a0iMwma4YYhmEMIsSQgUIsXcwgccLGZyvMLgHNCy5q1q5gdqkyTq7q0s+q5gDAcqoEBmas/YhvOEGa4IMMmoFo7xNU6ass6MvMgMgsjMwc4cn0rEP0uM1Ml0zKhq8MqamakgiAMgmM060qRM5M8610gclcrMqK30/0t6y6sMza262g+aus/UTc1ROAFs3c5QLKTsrEDijZfsiKo6zEZAdczgcG7c1svc2G6DeGnsjZN0LfHNYy3q+4RSCyhs6yxK+ylIJywGss1y9ytKp4XyxSQK4K2K0gMKj6z076zm7y+Kx5Gm5K1KkK7my6km3lP6F3bkXkTIWTZATvdsaKGw1khw/EPoZQOINoOEXMZgfEdk0oyY8eBQokKosoxgNofEYg8QyIfjcHJAL0N+LPTLOHPQJfVHf+HLFhcvDTWbPQYINs6AaIW6u0kyCc7QNSBNDAGoYuItEiyZTEYQ5AZ0RyGjbaYIAAamBGuAzAOmg3tqoESjwBRq3x+mLLQHfUGNeWrOPAJM4GWGvSKuDFaBhFlE4OOklAXULJru31wQmC4B4O2GBLH0qF3VIFeAjrmm0HoO2BVWg3hRSERWHsIP1TaBEDyGopSCb2KC2CNMLCA3+SMJMO9JiGCFPEiBZJyI1t3TAAXFcOKOPDiACLvvlMnNKLvtPFCP6BiDhFPDFLQEiKrmCDZVbpMhHOhKnJVStV0JPuosqhVO1PILVpyLZPyI5OKK5PKO8N8P5OqKFIQcAciKiIQaQcGnId5ODCiHhGqp+lqpMpbyTgstUB6qYKjPuv1FjXODKHjNdJqG4dhGRv5sEbKHUCLIsIBrqoOLuoetEZj0Ed5q+pzLKFEc4HEYXISNyr+i1ApKBGMKIcoZQeyNNw1qNsfpKO5K8N5LwYFJqNt3NWIeiLIa1Iodcaoa0CiDGh/w1MoYWkxUold3lrWlkyIBtmBDhFTgdrT1/C9Ee1doYnduMHuq9vGxYnXD9oK3xw9rJvGWsCQU0jclQX0m8kwS7GwUkisnwXsli09G8zO39AAlz13DilSeLxYlPHYmx3YSyd/Lm2KwW1+zXTKCMX5hMU4vZXcUpwiWKTxkG0SQsRCQ8X2AUBmczgRwBwWamc8XCUiXDnSViXiTyRBxSSiWRzQCyTdhu1jhOeqXDlKSHkwFubQFmYvg6QaSaRmjmkuXaQ7U6SGHlBWQSDWSjCgG7ySm/yA3zG7UNT7VBPgAqhIG2jXW8cjXFxSF1KGEhYiC4Bhd7RWH7VOEReHRRZVObR1TAExa/KBChdxdfWZThYvhUKRdqEGh2DJbRZ1K1CxdJVpfKHpaNQJfheZZJbZdRdJQpYCaEydskCh2fkQDIWab0DXTaaYme2vGNEyY+z6cDoGZ+2iAefKWeeWVWROlBdqZlfiehykCScNeHlVaUxYgNAye6e8E5H8D8rwFIItZAjRwSaLx1ZAH7kHnKQLCIqgBTmaydF/mjG9DVYx0sFcAE1zFgHfAAPFEZkEADyDyhmelhnhjYERi9wzYj393lED0hhDw1FJsmrigsq/GZnchEjig5kWmtD7DAw5SBRgHfVMCZfukMMNKeFaVSGCAJIUDhGeGFiuHWggP4BqCQf5baELGZQWirjybhBk01j5gM1zlMyNHM0s2s1s3s0c2c1c3c082818380C2C1C3C0izaHLiHYSTjjW39i23qz2x/Z2xfY2bfbu0/cDl/dA/23/eyX+0A/ObKFLYKBVFThjxvEiAzjAFcCrgmpkejODbKWHjDdEojZjw3bXRUhIIHlw70yGH8F3lECQFAECHkCNJSDwHZFcFcCAA=="}
import { Hooks } from 'wagmi/tempo'
import { parseUnits } from 'viem'

const mintSync = Hooks.amm.useMintSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
mintSync.mutate({
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  userTokenAddress: '0x20c0000000000000000000000000000000000000',
  validatorTokenAddress: '0x20c0000000000000000000000000000000000001',
  validatorTokenAmount: parseUnits('100', 6),
})

console.log('Liquidity minted:', mintSync.data?.liquidity)
// @log: Liquidity minted: 100000000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `amm.mint` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/amm.useMint.md","from":7795,"to":8498}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { parseUnits } from 'viem'
import { useWaitForTransactionReceipt } from 'wagmi'

const mint = Hooks.amm.useMint()
const { data: receipt } = useWaitForTransactionReceipt({ hash: mint.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
mint.mutate({
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  userTokenAddress: '0x20c0000000000000000000000000000000000000',
  validatorTokenAddress: '0x20c0000000000000000000000000000000000001',
  validatorTokenAmount: parseUnits('100', 6),
})

if (receipt) {
  const { args: { liquidity } } 
    = Actions.amm.mint.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `amm.mint` Return Type](/tempo/actions/amm.mint#return-type)

### mutate/mutateAsync

See [Wagmi Action `amm.mint` Parameters](/tempo/actions/amm.mint#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`amm.mint`](/tempo/actions/amm.mint)

---

---
url: /tempo/hooks/amm.usePool.md
---
# `amm.usePool`

Gets the reserves for a liquidity pool.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/amm.usePool.md","from":111,"to":9752}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"a5e2597c7cc0e903cdeee24bcbbc6a915a731be45436f6ef363478a4ecfdc54e","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUWKQQOBwYAJScUKJiiJzAADpgnBmcpPBkJACqcGQAKgLySQBGjAqmaADcaZlZOaQkAGqiJvFo7CX8ZZyV1WB1DZndYjIAygCuWFgyGBVVNfVgrpwAPpzTYLAAZqYwUP5QENYIekX4MJwyoiKccNPW1vBwe9MyC01wEDIkUDiCVEnD27E4yhuAEdpmQMAA6NJIsBXG53B5PF5vD5fDA/P4AoFiUHgyGcGFwxFgZGo273LiY15wd6fb7ZX7/I5EkFg0gQ67k2GkBHItK09EM55Mlm4/GcwFdHmkgUU4VUmkCiWPKXY1l49kErmKkl8smqhH+ETiXQAFnUxnkShUiBtGnE2iCiv8JjMSAATDY7KQHE4kAAOdyeHB4QgkcgaQJ4awQMAPNh/JKpdKZdm5GAFYqlMBLIYjbMZXMtGDtToJHpFksrUYZcYdGZzBaN4ardZbHb7Q7HKinc54cX07VY5k4tnwQ0K4Em/nQoUW4SaXSqACMskdyiQruo7p0eHTMm9h39gfsjj8iC3Nsj1C8Md88YC9CYrHYXAMgktG5IAAbFYDqKPuiD2poHp4H+Rg+uYAYgLYN6hogfoAMxPpg0Z6LGfgJp+egsGwHCcKIzDMAB1rAUBu7gc6GFuloJ56BRVGyJe6HXsGt7OH6bgeM+uE+HG/g0ERIAfGAjiMCm2yFAACnwMgADwAMIpgcCgUMkzY/HmBakL0/SDE25YGVWNaMF09Z9MWAzLN2+mtlMszzIsjmlj2AB8oT2MwOhkHAAD8SRwfC7HwtMSkqfCikBUFpBwBpWlVLpWaNJW+SFMZDZeeZWXNG0HQ2XWeX2V2ZaNK57YeVVvnROFfCCJFlHRbFfzwgASjo0ykGANawqpmU5sV+a5SZDlmc5FnZdWpW2RVplOdVYwQBMdWdgVs2uD5aRgBR8BYA4NwxTAyl/CcZwXPoLVLh6aCmAoy6WSQcBLiCJgwjZjCYJwZ7wuJogKBcyDICAdAUfMuBUAABgjaBwLQaQkT+yQ8C1H3rHs4TMJwADkADuIPMIwAD0NDfgTyLSbJ8kAIJzMEsSjcmqZcMA3K6YwcAADIQKIUDPZw6wALyY4YbXMB1F0qcEo0ZOdy0OQTFi0PCmsExQ+lEIt5VTUkasa1rOvZq40TIhkjB7JwwS8wLQvPbE2RoP16SqcLRA+Y7wuKJr8KqeTXv7dmrvu3b+me4w3v6RkRmcFNnC9blJCZoqIXwvNRlTfC3STGgpDPSzrhx5w1lLYnRbJ+N6fApn80VwbRZ5xABdF4oJdR8HMehxkltrGkCNwyAAC6FAQydwYcSAU9HU4H0ALScAl09JXAQPjxD4cDUYACKq4/J8XBE39+CvWeb3wJv48gFaEiIAA7KBcgMUgj/MTBejnZd56cb63FkJBhDHeDCWEhI4W8Phd8EkgihHCJETAsRlZTTClXeyABJKAAB5UgDMoBQHZB9PsuwYAHDMEOEAI5br4MIW8Tg4IMEABEGG2zJMrCELdqIPzDEhV+TopCf1YiAFBRYLwAKYkA1Cd4/TYRfHhN84lEx6HgREMgSDOB61rN0FWaCppYNwbQohmxtikPIUca6o49BGPoYwlhEA2ECi0WVHRnD7JA3XDRe8NodxgQEd4oRQRnFLSmuI8wh4UK8TQrIiB8jRIEQ/EEQ6gU4AnVeJwdmHIYBpD1nyTJfwYBJE0qmApljbq0jhvkuQcNODMGgJ8G4YRiA2XgORR4JE5BxBgOUaYCghgvSqTcZQCROC83aWTO4poIDLjSAAKVEHrSY1gi5YC4IM2pMAUJgF5vjJpRAWmAnKHiIm3SBjhCJrlDeGobh1KgA0zgdBSJIwhETaZqTNk20YNYDJEBvxmGGHARAyIABUnAGacDhsUrJNTrDog+qfZQGzlDQA+pic+9wIWDPhDICACgWZw10pUlMWT4RkHCKQfF5FdiYuJQU+EJMBqUuGWs0Q6RyhnUKICbonAiZFxoJwqleIABy0AYDwgAFaosLjACiVJQXgoUDi8oHQaUlOqaMjmrL0ns20v1Lk3LeV/SGdM5AcMmnSnhCIU40w0Bw1HsEfAaA0BYEBeTcmkBYCSvhOwBQwcbrkzuDQEQi8iB+htPCWg5NRBYApuat48JHXMBkAAYjjcyK1EAbWxFZVANIpq00bytWSu1DqnUusQG6j1MAvU+r9ecANCR4BoBDWGiNUaY3kwLQmtASbU3hGlEW0gpBojwkTgKRVEBlUyFVdCjJrKBgcq5AiwgNrRnfg4CLMkcMq2IEGTU25DT1RgAAPrAuBQAdXENsxQZ7j1JFpBOqdPy1U3EneKzZaACYfUCsiqAH1xA3DMGfMgz64C8xoMMBYaQ4AYBkvgcIkAYq3EYH0V65Rzm5TBYpDBH1IT6hyMwcochdKQD5AB5ceJMngfkGgKDh0YNwYQ5mj6JhUMdGnRta4fIRWwAlVK7IFEN6cEmDAIZApTWQH5fJAtnAMHk2wSWx1zrXXutFTWrQda4ANqDc20N4bI3Rtjf2+NiaU2iEXpJmAi8UyLwLYvOSsReRpDqdkDVvJmAJDkmAI9ABRWg0NOkxU3eOpVKqiUvrhkC6kYBh6SrSFinFeKCbXC+NM15pAZBQAJtEVYbqV4dyRkkFLOKeXsEy7pblGabXxdpXIbFuLgjJZgKlzgABSOA2tCbpcy9l3L5N8s1EBZwYraWytQAq28tA1q0A1ZfaSod7BghmCJpwHzC2KUE3PYQCIcBdK/B/fgEWyrAR2DmPII42WctpDy4pArH0yXghSXAEGNwc2PDENYfgEJeLGve7AIdUW8sZDW+SpIW2+Aur278nQh3FADCFsN6NOAKHXf640EZyAYBaNHpBe8qhUeNHIlwJZKy0BZx2BglEh24DFNgXbHdRBmD3gwn6e8YYB5A8yCM7B5R32OHJ2ASnVxea08CPT0ViBGeIAwhYSQ0v2cE/R1wHdNQyCHRkJ24zzJyZ0E2TarzT9H73kkIrrnXBMfY8XrypHZBEBAXQn6U3GQRlY7bMsxgqzxewEQKrgaHRNdnDeDr2geunopifvbkCHO0dm84Cr4Yav/cedMDrrRx6RAdwUOhDC0vkSZOV0dTgEtNuMC+MnSdphfhgAJqsLFDKwDBDhkw1l2g+QABJgDJJgK4AAhJwZvigyA97hldsAN27tJAH63zg57S/Tu6hXkpYA+9T6HxNv7ZKh4I2RH5gLHLgs3EhbVmAMK4VRa33DOLMliVcEzVwCWHp24yuYJMaHhAiYs1rzfh5Q6i+cEf9KhRK/oFO/p/rNg8MwBgFCgUn/stqBnStAXIMEHfrpGSqPs5lAcfvVkliNqVhlllqPuPoNkVs1iVt1uNgKnfhgYgWKolo1rge1p1sTGNr1gTrdsQcNqQaNvgevlQWAJATQfNuSktjACtiDotptttpDo8NDsoEdgjqdsjhdtEIQf1uwQCkkMgOIaQGDlIbtjIQdvISdjbhQuPAKpvtFvnnHoXsXrPmXgvpUEvjXtQVgfXo3qvu3p3kdL3v3i3kPiPn1gNhob4YPnyHYfPovlXivn4aQD3uvhYcPMDKDEgODHfKJv4MgL8P1K8PakpuWm6tUMoNMOUPCMmMwKpp6lplWuTERpOuTHpm2iYOUOTFipKtEGPLfPfLoH6BYB/H4hBH0dBMIoMmEu/DxCAs4BYHIiJNAkopJMEAdtALEIIXQU9i9mgqyhgLpAHBEGHurqvIJkkJscgKPE1JohADZHbAANRbgMJxg4pCztHDg3R4DqHPLcpwxVa2o8pnxx6iEISjoACyx8HunS7o0wgUAKc6bKjS9wnKuky6MyYABwyUXA50gIGKZIYQLA4geIax2gVKGJZeQswsexKq6J5EqKxRIgf0+uKYOSHQsIqKLApe4gAq+aBWewwQGE0QimZaFa5MHmYAj83qGmPo0wkaQptmL2WmQpGEmuNQew8IGE3aSaA8wQZI4JkJzy5G7GAMcJ+qJqcM+uMg8I7mCQ+KuRZaKmVa6mvq1C2mTaLa+m7aFMJpqpKaJp5paA3pi87ocAKhR6sWcA4Baymawwf+qgX+c2dBBMyYOwaASQrWWWuk8ZwwqhQRhWPyCZSQ6gAqXx4BdKsZaZiZnWJZGZbxQ2JZuZ6+BZMW2+0WImNwpq7p3plppaymAptpG8taDpgaTpDRBmHa7ppmyaXp7AHmPpE5CQfpWgAZS4LmNwpg3pXmHiR4yRKAEMYGMksMIARAFg8IW4h5FgFgHRniD8foW49o/CEEkiQxQQiWoxT84xfE4Y0xUCiihEQQVhZ4mY+k2ck0+UM0a0FY40TcOihsO0IFnCm07k20wFPYJi/YZCg4ZSY4moE4jIuosoBo8o3IS4Zoq4a5XR/oNofCe4zoh495p4KkT5fRkSExSAGEqg75r4YkX5eAqiiCMQV8OcQFq0SFZiqFzxViIAKceYrCCkIG3Q7i3C3RNoYY9E/iW4dER4LEQQAFhY9kdFL5aEPirFCi7FiSeAXeqSp08BcgDJeSx+RSx+aFlwAo4Ws6B6nSeyLS/64yMMXSPSfSIs6yzKoyzJEybJ3KkIcyCyogJOHuYZL6GyWyOyAM4Q+ysAhyxypy6GEAFywUR6tILlNwjyP4uGryjwOA1gny3yZRbA/yhWIKYKEKNBp+cJPxiKixf6k46KH0TlRZDWvJhKWKD2FKvJhJM6dKbhQ1AV1g867KUlXKaWfKv2mxnAPGYqkq72AmMsaQ8q/+oW06XV6qleYgO5z6uq2Qs1PK817JZqWuhaU2d+fJnZlaamPZGmfZjawag5rpAeFqo5BaXx2auweaV1gezIlqU2xaVpD1FR1az19p/q/Z71raQ5RmwNG8P111g6w6o6D6O1I16qk1MJM1zVK6XAaMG6cOW6O6e6tS9SdWyIp6F6V6z0t696IWk6Kq6yb6H6X6SKhAbV5GQGkI1lqY1GkGGA0GsGtgTGSGrGYmNwGVWVfIDM2GuG1w+GhQhGxGce4I5GeGoGIttGYt9GEt8GKYzGyGbGZenGIGy1fGa1z+QmTZr0EmG0r66QMmcmCmEN+RUNdpmmjpCNLphmX1JmPaZmFmLt1mYAtm119mEAjm7Azm7AS5yJ05exvm/mrAgW25L0ZIj6YWe65+9Zl+IZ1+MZDWTWLW5BrBY+ahE+nBldY2tZt11WpdJKsZDBHWukzB+B1dRBwRuB5BTd02hZdWA1IhYh62jW4OO2UOhhcOx2iOZ2FCl2gRlZP+5KGyzIL2w1Von2325llWYNAOpu2huhEO+h+2MORhi9ShuaNdhOGOruMgOOqgeOTuROwm7uqyAuQu1Oou9AXuhSUuW4LObO0eD9XAPOfOZOpAFOVOIuKYdOS2EuUuMucuGECu99SuWt3uvu6uwd2uuu1gdJxYj8RuW4JuWDseFuHQo8VuwYZ2Oh9ufojuVDzuXAT9UVnuyDuDCefuGuBaweoeBuj8keFg4D2D8eTg+DyeY+T96ehcz02euelh3+Xef+Je9hkRKYzhrdo1V67hMRnAHeXePhHhw+FZddHhM+c+5ejhURIRrecR+ZR9pAF+O+GdXlQW5NjlDVGSZ+yIwZoZDCq6D+OgT+QBb+mVYBrdHDv+YTaAETL+UTH+o+VhAhx+sBohFlYqNByBNqqBQ66B/BmBZdOBXBeBPWljHBA9jdlBLdGTZT9BFTjBXdVd1T/dFTg99TM2JTghY9cB2hU9ehs9V989ChJhyhHTWZWh62Z9M9BhYzL0C9ih52UAZh3KFhwT6jthtjDhleOjqwjTJKbhTeRjJj3h0RoRFjq9VjRj4RdjBzy+jja+5hQ6F+SRYMW56RVAmRmapAORHZ3thR+AxRpRvyPtVRoqNRSq9RiNAajAzRrRAZZ5d8gE6EQEqlN5zogxx435dl/85gilUiUSd4UxsSIkYgCg/gXeeAj5553RmLSlEEoEsCeACcMl8gV8SQW4J5fL/LArgrFgYAT5xLDFr5lgBl8SMCyiIQrVyxWBqxbw6xRxYAWxnAOxqyXmHQBxzAQ2xxpxSQRAFxgIwQNxdxZADxUATxVCLxega9HxXxNSiJy2AJnAwJMgT0XlWpNGH0+NC6+pzIRwCJvxYVyJjAqJhNmJAo2JHmwom9z2BJb2epJJf02r06FJGKTw5QNJbsexDJMgTJ4yrJUynAHJip3JvJXtApQpIpta4pkprK0p2gsprK8p2JwwSpKppm6pmpWgEJvr5ErmepJ0QbZ1LZT0ppbZVbQLNpT1opsN9a8Num8LQdI5odY5k73pvp/pgZgTCMV+VhJZkZ0Zbd5d1ZbWKZ2Z6ZtzHBF7eZh9w9ejdWxZ4ZpZqZb70zVZb7NZLjT7w8yIjtE7peZpqd7ZeRc7lRC7fty7zpbaa7k7Hpm7pe27qds5oM8dfIi5bmqdq5nzKRW5pgrw/g+5h5x5p5o8nR6Lfoj8h42LTFgSdLuKoruld4EYFLH5RlbLegP5Kkf5c040fFlUUFqwRUqcC02idkK03kLkG0bYcFnkCFaQvYpiA4FC9lIA44GIOo04eocohIxovIr05oxF6LMuWLFFB4jHegZ4LHJLjFLo5LUYnHCS3HIQTS3FLsYF+sEF/FpYglanFiIlt04lVYklwS5Ubi8gpnXiGEW45Fb86Evi1FegjcPnUnIrhL4YrHzgNoQEUrsxHFegplaSNwgyVlOTtlL6GnFSVNeViVzSsAHlYGmdNwsAPl/SOT/IIyYyLXJbAqYb8yiyX9MVWScVdg2ycAuySVByAwaV5QZymVlyOVAo9XBVHARVbypV5VPyfyvrhdW1R+EW/jTViJrVVJtglJuNtBPVBK13Qhi2Q1b2e1YqY1NSE1U1i6Z1hq/K3Ki1Ntq1Gez+cqdVedu1VNB1WqZXaUCgeq33F13KHJKNoN02913t3Z0Hr1OmcHSNBDqNG7v1zdaA/1d9SPFqGNaPkH0NmPcNb1K7gdHaXaaNKNGNI6Y6NwYP13MKn3hNy6d+a6TyB+EKlNx++6NNYqdNZ6l6A0TNwKd67P21bN06HNvOXN36MOKKQ7gGMAwGQtYGIgNGdGDGktpt0tKGsti3CtWGOGFGBkGtMAJG2trmutVGBvotaQ9wxtUtLG5v5EltgtS1oqttQPgmo6jtZIztUmbt11sm8mlPXZ87vZtP2PH1QdTPG75mlmkd0dKNsdmHidrmy5uHKY6de+CkQvnPL3kW+7xdI9N35TDdPdX7JBjf5Wf7fBCW5dHdTB7Tt7nTrfFBj7HfWBAz2TQzkh59ozch4zxhS9UzffzyA1Cb29b2u9X2hcB9k2/2OhJ9czM+Iziz0/yzEzc/d9nO7DZbT9L9b9bDH9XDMDcDwuNOiDYuPDQDTOIDrOW4mD5/H9UDH6P9eBs/wTwAM3+kuJnGg3lwSNY8UjRPAI2upCNiGexQ3MbnfqP1Lc1uRhnbgdxoCOGWie/oAx9x8N8GgjIhiQwjx25xGuAnBoUjwZJ5RAKeeRhniUaYQVG2zGwoTAeb7MnCp7fRoyjOahFjGXhQKGYxiI3M2CdzQQVwO0bPNzGQ9BIg2TSC75Wu5fHxofj8awo4ShdIJrExCb35/84TQAskxALRM0m3+MlH/gALrVgCMAUAmYI5i1JSmY3CWHASxR5MUC69Ypsc26oN8yCLBZvvXT8E8EemLhJphXRKytMus/ghfkNlqbBDuUfBbwaPUnqDNJ6E/BZpfSP7w5Z+t9FehII4KzNQc+/Sfof1hzH8chazDZtMi2a6CdmnAvZjIN0ZJDXuBjAQdPguYiCrmTjAIvkOCLWNpB9jFMF0NeabN3mRdfDpuTSK7k/m2RGAF7RUwgswWZRSFlDRhZ1EPqTRFolgTaKosSK0uZisyxxbWdkIBLYwFxGkD2cJWTnYSN4CpY0sjoTHalgyyYoHD+izoVlrK3Aqkhq480HlkK3+GCtMuZwgBBcPFZoRrhkCNiq51lYLENe1rTgCsQaz4kYAGxNVtsU1i7F02urfVmqxOJnFjWlxM1rcTfBWsbW1CV4ndgFSfEiezrX4q60OBAkQS3rfttqT9Y89R28JImkiRRIPBM2KtRpEXDjZ4llWSbalCmwIRpsUw5JTlFd2za5sSGBbItn10mSXUO2PpStmjxraso62YpUwBKUFJNsToLbA0WAHbacllSHpXtgKB9ZQldSZeDkYaTLbGlEO07ePo9Sg5J8l2dPHHp9XXa9pxypAScjuznJ7tosOgo9m+xPZ19sCjWC9smTLKfsYhSQe9kPWH5hDqyCYhMgEJTHt8W6AHRsqJidGtkwOM7CDgnw9EvVk+A5VdsOUQ6jkAxQYtDruwXJJ0cOgYzzCXwmGpFtyxHKgKRyPK8sKOVHWLjaEkT0dpcxw+lsCPMCgjgEErdjs5yhEytJIvHDMHpAE7ichO0nQqGNHE5fCVYDUWTrBQ7CKdVoiFEhIF0oTkiHKaITCjpxlCzgOQBnRcEZ0IqUg5KTFICHR0s4uhjhtnLLi4By7+hBIi4wytCPmIed1EPFWqApyqgBcUK6nYLmODk7TongJ4ySnzEUhRdUwMXB+BhGfiHCkAW4ZLnizwAwSTxT5WcdImcDMUpWdwqgLSz0BTi9hGDMcT+I+GSQSgEwbUCeL+EAj+JwrJ8sRKAmStb4yYWAF+CeQYw4IosUEHjC6ykwKYVMNgDTFUYOCuYioJIJfHFiSxWoUUH+PLFGiiJhOxsHotYAEkWTLJFgbWKMAi6+cTJ6sMyVZOclCstwNktYAPGjGxkOWPw2uJ1jPANxBOgFeyAPE75JZ9x2E7lv5JUiBS9x6XFWKFMVbl0uJKqNCfVGil/BM45EjyAPH8A/pRASAUAIEHkBgYUwZEhAK4FcBAA=="}
import { Hooks } from 'wagmi/tempo'

const { data: pool } = Hooks.amm.usePool({
  userToken: '0x20c0000000000000000000000000000000000000',
  validatorToken: '0x20c0000000000000000000000000000000000001',
})

console.log('User token reserve:', pool?.reserveUserToken)
// @log: User token reserve: 1000000000000000000000n
console.log('Validator token reserve:', pool?.reserveValidatorToken)
// @log: Validator token reserve: 1000000000000000000000n
console.log('Total supply:', pool?.totalSupply)
// @log: Total supply: 1000000000000000000000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Return Type

See [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook return types.

### data

See [Wagmi Action `amm.getPool` Return Type](/tempo/actions/amm.getPool#return-type)

## Parameters

See [Wagmi Action `amm.getPool` Parameters](/tempo/actions/amm.getPool#parameters)

### query

See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook parameters.

## Action

* [`amm.getPool`](/tempo/actions/amm.getPool)

---

---
url: /tempo/hooks/amm.useRebalanceSwap.md
---
# `amm.useRebalanceSwap`

Performs a rebalance swap between user and validator tokens. [Learn more about the Fee AMM](https://docs.tempo.xyz/protocol/fees/spec-fee-amm)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/amm.useRebalanceSwap.md","from":223,"to":7472}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"20c09f8cc1ff08a8faf46184bc97fb05274d872847ffff372666aabccf7c9bdd","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUoiaicACUnABmAK5gjowQYJxY4nAwAKpgjGhwwURhcTCInCKkpgoUnLDWLGFwZWBxzABGZJFlbYwKpmgAOrms7FzppJk5eUZQENYIegCycTJojFgm8Jyi5WiVipykMFhHmWBiaymcEDHbnC3tZJxtGHd9JKl0bGbn17dtERgnAAjBZOMFQV8UvI0JEAHRDIYAWk4ABE5k1OPg0GgsE0APT4oiMGDMOFwfD42bzfFxNYmNbwfHjSa5fL+MQKBbIZAgOiiVhyfwsNgcTjANIZbJsuCcVyxUgQZicADkxNJKsRYBZ0umwRVABYAEwWFU1SSRIaEzjGix2+0OsAgAC6zuEml0BvUxnkShUiFBGnE2iCOqm7NkpnMwJsdlIDicUncnhweEIJHIGkCeGsKREhxgAJkokSMAAygB3URYMsYRJlAyCOECslxTIAJULYRL1nLVZrdescM7aDipDAABUvAAeADCKRivRqCX4kArYAAfP4ROJdAB2PeyX3KJDAw/UYM6PBHIs9vvV2uJfwmMxIADMsfsjj8iAAbMnqC8NNfEzAJ6CYEYxUbIwdwkFxzzkRQT0Qb1NBDPBoOfKN30/eNv2cI1/w8QDUz0dM/CzcC9BFUZtmYZhtw9U8LA/H0kP9Vi0KvPQWyw19EFY2wv0TASjQAzBSJ8DMOWzPR4kSS5UjbGBO1vUtKwfQc5wXJdOBXNdN2CcYBR0Mg4AAfgbPgmxbOFlNU7t1P7R8hwABXsZhTImbSwEXao9LAVcIHXDcuh4ay4Gbei7I7LtiyczTEmHHQx0nGd5183T9OCzchjAEy4HSXs9NitTew0gcnyoakFn0azYnYNIyBidhmCqO4b0c4q4H7BUlU4IoTCgUQ0Ea0b+HkThRpKp5xvkBEwCGAA5CAaDKCd8EYWUtruOBB3wRVIDbLF6uUEbOCraYGtIKb8CBPYSzgBNkkW84IGeIFTGsGQ4lgKBrlSHY2hkOZ+A+lqjgLUdx3anZTm+TI4Q5UQuSQHk+VoAUNlwKgAAN8fyWghhosUJWguU+uVFUqwUNr8RoEZNVe+SkiuABBLAsGCaJgCGThOFzMB8wlZg6RGmAai21z5Cgdr5QAXnCwwotbUquvvSrrG5rV+aOaHUmCPn+c4ac2jpUbXuN42UlnExrH4eXgG5zh5Y3I2rf50WLhgYJedSD2reU0gJwEeQyhVCxaDhaOzXdgOBrCRhhtG4PQ7AcPI+juFY/9+O6IgBI0AAeTpMpQQsMAKDjgPRozqOY6r3OPdcS0m/51xq9qLbRGBmAoEdqWZaqDum7dtvOAc+LioquPp3xM2cRSMf+dbkf8dxl0KF5YyGKoHevNlFF3PjTynEizfeT11KjGWC4XoLOAVjQJHXXdXdmIQ49/RNIMtG4kB7JxTvBVFyfFzCCTjAmH8b4iIpm8ORUCNAqIgEFvmTqU8NYuSssrWygCyqYMHMlfWU4cA+T8suQKBktxvzgkaYERojzsVPOeLiQR0HAOcoOMBSBfy4Sgc4Cw4kgJkRAjJZBRlFQ4A4BgaIXtxZlEKOIRgPc5CYnYQlTWcJj4mTPmQ3oG4agQCwIpCyZRb7iyLsYl6cBpx+0DpkVOE106cFxpHAAJMACow9cYAG446DSTiNdgIcnFlFcbQDxXjFCuF8XHHq1YpFhPcZ4vY3i/FNwFAXc4ABJZxPQ+jnHSVbTJhcS5oG6L0foRTjZHF7OscpnAJzxiFs9FInY6nGPSe4TgAAhQEABRUgipg5eBqOo8qnCkraNPmZPRCgDEBSCiFTgAAfAKsBFxmCgNEV2A0IBJ38DVPAG0gRyMUrEBIrNUgYALgLEsdyZAyAunkfACdKgqK2NNVJChtA3WUKcsW5ySz/SMYpMIMhXiEEMADbYUBZZgqedYcFAJ7bXCsXmJGQZUYoG3h5fwRR3m90Po0u6bzlFEuuG0AAVjARwU13rpDgLKL5pLcZnJegAMTALjF+W8QA738KC6xcIUhljiNYXsTLOAog2jtFm5yKyMEebERgkMKx3VSP8zg7Krg7UfhK+AcB4hPOBc85VHRJRMr7rdAFd8UgqllKcJ+vLcUn0FeioWIqwCDOGdKklcrLkKqVU8xckNGC3C1Tqz4iQsln22J8IZjVTWKvNUCRlmR/parIMMl1/K8VUCFRi0VOg0ByH+jKzasp5X3xTSG1VQJ1WTUjYC++O0YAvKePqyVRqVgQtiDoWw1rGryFzIXMy8bODZqTWAf6Fr03Wvbf8v5pLk47GHYm0guajjMHEIIfwKJsm3BuXEbVogJraqfusOQBYACOJQRBwBqLjUV4ru24zNXWyGKQ+2iBiE4G1nBiw0HzEi5Vx61SnNELABaKI2bKq1aBmQKKwbVrzOCZ9YAxUGqZbjJ9KQfXsFwy44tOIy242iOIIERB9n/VQ0LGopqtVX3HNawaJQP0fU4L0SARwoAvzdCAWCugjRvisGxP0PDf7oT0GcnGxhsJ/j4fhU8AAOIRkkEFiKCBIoxZBMAUeYLGspFSCkMBocJg0MZxPIWkBeP+QQSnnDKdwxA54hJ4REmJYiEl4GiMotpxOERohhhlIon6pRdj7H8nUBoMhMQPA6KQMK+T+jE0gmMKU4YZgYjwMsVYV6SSyh2FEhQBYTjwBhCNe+Nw7gJaeC8N4jAPiTtoN8GEfxniAhBGCCEFgoQ/FhAtZEaIMRlGxLiAkRISRkgpFSDEtJ6R5EK8yTLMpkbYvRvyQUcmSZcAlCFq68oYiKipuqZgTMhgHfyPqW0ZpOAWitPiG0JoHSvadK/QTTFEBGlUAw6z/pAx2ek3miYuoIzyf4m5yBymAxvnU756S/m8A6akfp+lZQBggEjnuY0UA3yqFnNYX8v43wGlnBYVQb4jSSB+6IN8bQVMGgND06wkgYB7lUJIVQMQLBtH6W0NomPGLv2+weRhEnvtSf/qNFzKmlOefh8BRHYFtMnF09I6IQcQlh04JjyOJprCvaN8bk3pu7RC/M++an4ubNS6CFrtOLnbPuf4UgLzcClcURV8jtXqOZEJyGkExxOu9e0AN2biPkf7TAgt59kXb4VNy/+6eA0du8ABOTsEx3kZ+KA5dzD93JEEde6QUEfKnlCoOCBKgiAcghgEoFnmWvEWMpwGb4cnLegTkuJr3Id9hmoArDTYqYksAivlBFNe2AZsfntV7/dOwXA9UsCVeIelNqhgAClRBFDLNYSoxjG9C2b9q2ldhchwGVGr0f1qGsVkLM8RUFYHGRS1N3gfQ+WuinyFNCs71Cq0rhqMDWCN4jADZNBagABUnAbMLireze7630EQsoiqygp+yg0Aso+qryEQPeTecgcIIMCg3MRGuM8+cIU6pAJB8a/0ZB+BMAcIVY441BZ0XASKqQFqykma70FYlQNA6+JYrwK00GVKWBewMAAoC00BsBCgIMRYeBx+feXGQsYgpYR+fkY41q00vBeQ9070yAuMau3a5IaAswdIuMzowQ42eIiAhIkAsAohIqWgc2NIQG8AaASIRARoBocItA+I1YjAzIioxh2IzAMgAAxEYYaiIGYbCDQUMAYVEUyiYbAEMhYVYTiDYXYdADAI4ewAoC4XAPiG4SIJ4d4b4f4VgIEUkZFKERETUTEdmvCCSkCLIRAPIXQYoTAIgfcpwRms8hgXSFxulu1FqrjPYaUPPv3tAEPkNmAAAPqQGQEADq4guQigSx8x60pKbR8h8+lKNKjgDq6BhAUARWkMZgHaN0qCW0NA5wEKQwe0iQB0KQBcsoJg56WqbQT+DiMBrk2SzKd0rwpwpIvcNQPG2wkM/yrwNxIgMIDx+UTxtgh0bxgGjA564K1wS6nAwhDBohkWEhzAkUnAZYMAC+QIBhkA/BVwNRnA2S+IRc6R1hk2ExeRzhNUxR4spRXhPhfhARQRcwhqcIdR4RogSIVJMASIKQSINRSIyQ0QEMQwhmYavkrUVWKQcx/SmM22JUoxOxchYQChbefeiAWo68ohQw5BRB+od0jyPB7AMgUAKokQ6S1ork+w+QY2MAdpF0DpUANQ00MRBcgwMaXRhBEAxBKotpIMnAAApHAHdtTH6c6a6U9u6f0JiNGfaaQI6QGf/qYcGZafQRQRusEGYBWJwARlQSqMsVCniDUG3qfJtAcACP9HYJzPIH3M6S6Y9pwOmecLKJQafkyijECKajuKig9MVIGaYdmqaWANaPzFWWULWXwPWeUEqDoM2aVq2ViAkp2VAL2cUlwMgDAINM6ChAGKoEecbOdHvgfs/KQAkLkrKnABlKXuCBMYgEQMwLDkaAGCpq3IubeVwEXNSrSo+c+ZOJWu+YEJ+Tkd+b+aJpIAJIBTefzOdF+f0GQPlDIAKd2viHQLSnSC9K5nuAGJIOhdsCeWeWEM6EiLwfuaQH+N9kaFRedLRTIPefUvBbAIgNheOGEPhYaoRbQMRYpK5r+H+BYEBU9sefcAhQJbhfiDuqYIRYNPMSVt9m+AJFqKglwOXkCIrDWcGhPO0aYG3mACqOkuQUwWAMELjKiCWL8pwB4oZa4AAIRojOVkAeXkapl9kemYhOWKBPDLGmXtjmXH5gBeUhW/IeV5m7CpGkBDDrxahalYzXpth6lAi4zwFKFIFMrzmpX4wWmhn5jBkuycAhhljiEChlibmEAVjcw2V5hcDZpVU1V1XMANWeRNUtVFkqHaoYD5VGX3AwAVnkGjXBDBk1BNHpJKkjXFnWlRnekxl/45lOk9kLlplBVek+kbW5nr6FlgDMBLVhkrVZlxkJk1BJmbUpm9n9melYhrXZlHXTQnVnWjUlnDJlkTWVmlk1l1mPoblNntS7ntk4BbLdkBVPWYjIDLmcCrlGIg2Nlbng1QZ7kdlbJujr7Zp6VtX3AmRVUmXKqRU9DRXWWLXfV2UOVxVPBuUmSeXeWhWkB+XbVul7Us0uXhVk1RWWWxU+Vs2JX43cr4zrbci8iZBybIBt5ji9iWHMm2H4h9DKBxBtBwi5jMD4islFETHzxyFEjlF+EmBtD4jkGiGRAugCZCZIBeip7J6uZp56Dz4ubAgQLCQ/iCLebCJSQl6yQhBNnQDRDfXWkV5PTaCWTxoYA1BZyFq4XTKYiCHIDOhhTUZJzggADUwI1wGYIMUGVt1UneIAcN6+uMQZ5hAxry5ZL4DBnAeWaw2MkJCgrQMIso7BnG86/pVdG+mUEwXAXB2wgJw+DQpArw4do5NB2wyqUG8KL0hpg9uBj8bQIgeQJFKQ9exQWwcAK+xYfy+hhhHpMQwQb4kQTJmRytO6YAe4ThBRL4cQfhV9Mpo5RRV9b4QR/QMQcIb4wpaAYRrcwQWqwYrdA5kJY5yqXd6+BhJFMgcIEMO6aAJBitmRLJORbJBRHJJRHhPJFR/JMDv9YR4RMD8DI0JDHhwYUQ8IZppVcAg1IGsaVVqgrVF1EZ+oo65wZQsZTpNQ7DsIsNXNvDZQ6g6+FdIZVprDKogjd2vDHNu1GZZQgjnAwjM5sRJVuMWopJFJuM+DZDSDGRE2ytutt9hRnJwG2DxtlRgR+DIpxDapaAZDSIFDCpjUypn0qppACDL0mKF4G2UtX0cmRAFgcIwIwTdo1tluiABov4f2iEEunEl4QQRBbtHtHmP4amPtGmfm3uLthN4yBC9YSsNk0UeC6sIChCI4qUJCMAcyFCSym4wucEBoKmYmsTyEZ4ztIAeTZTVUEO0YKTru32sCRenuiCAdKOem/uq6ZQdixsDuoSLiySJWMS1S/MGeQe2uzi4SkSqS0SsSTc8SHZzFCzESKSUWyzccjmaAuSJmVSFzhmpSpczwlShScctS7axi60zST0Vy7S7zaAXSqy6yMAmyfcHe8wxypKxY+YXahqxqfapwteJA/0q610AGUacxQw3eULXAMLTKcLwJ8AiL1qKLEMaLLaGpWomLkLEQOLr6sLvaBLxpSLtQI0OwpLzadqYAGL0FQI2L5QdLeLDLD8RLyLrLqLHL6pXLDTnokgSerT/oDtrCeAq6yT8uP4TOiuIiyupePukiEzBmsa1zTzpmgLCQGyUYUA0ragFgDt8rSASeSrPE9zOSToOefTarzgqg3tHuegnI/ghleASTETqgwItrX8SAYmOregoIv4FO9orrvTp43o+eIkgiAmuYsAEE3+4ohTsoR2J2qoNMdMDMbATMu2ObV2eblMqoZ2F25VXAXTkyIBis0EKsMUKkQCGiLk2sr01os4mJbKgK3RyhD8CMehM0N0rSBsDBCgcIzw5sVw30wB/ANQ8D/LbQbUTKL0rcjbiUQ4smvsRslzxmkooOWW+ooIcIqgd2v4kQjc/Mtcqo2OuO+OhOxOpO5OlO1OtO9OjOzOrO7OnO3OvO/ObQOc/MczOuEcYeFghuUe8Hpu4HAegSKcGzdc4eCHmHDowIOcLcBNLDkZbMzrS+6cd2u7miq65kUUhrYArc/gp8ogSAoAgQ8gO9KQeA7IrgrgQAA="}
import { Hooks } from 'wagmi/tempo'
import { parseUnits } from 'viem'

const rebalanceSwapSync = Hooks.amm.useRebalanceSwapSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
rebalanceSwapSync.mutate({
  amountOut: parseUnits('10.5', 6),
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  userToken: '0x20c0000000000000000000000000000000000000',
  validatorToken: '0x20c0000000000000000000000000000000000001',
})

console.log('Amount in:', rebalanceSwapSync.data?.amountIn)
// @log: 10605000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `amm.rebalanceSwap` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/amm.useRebalanceSwap.md","from":7817,"to":8540}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { parseUnits } from 'viem'
import { useWaitForTransactionReceipt } from 'wagmi'

const rebalanceSwap = Hooks.amm.useRebalanceSwap()
const { data: receipt } = useWaitForTransactionReceipt({ hash: rebalanceSwap.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
rebalanceSwap.mutate({
  amountOut: parseUnits('10.5', 6),
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  userToken: '0x20c0000000000000000000000000000000000000',
  validatorToken: '0x20c0000000000000000000000000000000000001',
})

if (receipt) {
  const { args: { amountIn } } 
    = Actions.amm.rebalanceSwap.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `amm.rebalanceSwap` Return Type](/tempo/actions/amm.rebalanceSwap#return-type)

### mutate/mutateAsync

See [Wagmi Action `amm.rebalanceSwap` Parameters](/tempo/actions/amm.rebalanceSwap#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`amm.rebalanceSwap`](/tempo/actions/amm.rebalanceSwap)

---

---
url: /tempo/hooks/amm.useWatchBurn.md
---
# `amm.useWatchBurn`

Watches for liquidity burn events on the Fee AMM.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/amm.useWatchBurn.md","from":128,"to":4832}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"1eb67ad9a75d59810fdaf0024451c348d0f712105fb6fc09eb9c9df760ca27f0","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXKLMzFGaugAssUmKykj9GVo6eO2deWZIRSC29o5+iABsVdRetb4NAfR4AGYArmCOjBBgnIdwMADqomi2AEKHpGAAPADC5/uMCgB8AAosPZmDoyHAAPyITjAAA6F04iIWpgAklAoZwwIdmAAjMicAA+lzAsB+ZigAG54YjEZlIdC4QiaTTriSyBiAAYWWgAEmAIlIpgUrg5hM4XN5/LQgsUIuQAF0xViZDIxcdSflKdTmTSrmQACoCeSc7l8gVCkViiVm6UWjkKpWHFVqtlkmBapk6oiiExQe7sQ38Y3Q61SmXC0VE0Pm2X2xVE5WqonqmBuj3M1wujXkqme/akCDMR4yCDWfgYnG/UxcZOuzW55nnACipALpAxAIBZDb0JbbYAlJwALx/ThECCMKCD2vZ91Z1P17WItgqjHSw4wedpreLz0rkyKFFgJzemQYrG4/Ezhfknc5pecc7PV4dgF06EAd3uTxeYAAdAAglocAUJwJYKJ+374M+/4ADIQAog4jmOE5Tne7oNrq1ykIGwacLhYBogA8qQAFQFApDwHA6HpjSp6Tv6OFGmAGIEcRpHkZRcDUdeaaYUi3y/BiXxgD8Cg0fxnDyKIOJyOi0I4nwciiBcvGahJ8KuP20LjpO8JgO08DAtYm56ncDzQb+/hQKWCB6DknD7OwnBfhZQpgYwACOhyTowmCcDiv5SSQx5wH+/hiAodnIMgIB0O0WByP4HIpWgcC0PCIStDC4SGJwmb5oWnAAORfgozCMAA9DQLTFfC8JHCcaBnBcAFYFgAKDoyiI5GFkx/mZUEwQC3U0k+v5vsBXUPgJYBwBAch/uBALFbBXk+VAfkYJwlHML4UCIMVoF0v2D7uNqWn1QilFoEFbybUQfzmbY7lOaQHneb5/m7cQPphX+f5vJVD1/Jp8IpRyIDyhQsXAqUUwgHDhlONRAC0nAAAogmCpBhVD0MgNEEiID0iTGMkQyIAAjHMmhZHgg0WTB/gHoUxSLOU1OVB4Gw1HodR+I0ex6ECBY4BwGCDuNL7Qp274uUNv6AcBoHgZBTNK/BiHDqOuloWp5LWbZeAfD6Mg4g4/CcGgECcKY45Bi5+DyB9G1bXb1E/SQUDhcI3RICsPQDCkAcaJk4x6NLYAs/kwzs6USzOAU6yYHzPj1BFTQi0joJOIO8ujYirKwKQIammGdqSXqTFBmAZeSjGEaSfRfo2zX8j1za4YipJ7QQMcaAAKrYQRClVsevd7QPABqPoMW3o8BePaCSSYn2bZgY8KNWkk253FexrmrhdDESDxCMciDKkQejPTeh0jHMyICMCwJ5zVNUynmz89smfCyAQJsZ5zAghdWP5Xh/i1ifYm8RpDkyvnHW+EdjAIUfuYF+JQyjLCpvEL+acBY7BoP/AyoI4DGU3NYc4805Dwm9O9Shc0FowGhCJahuAqA2WsHZEA+pnbigYWw0Ue0oBOk3FgAsRBJzwE4KITgcAQhyE4LAQKCht6KE4AIph1s7BcEYNReRFUZDiGtrbZQMB4QAClRDegAMrWEFFgLgmjFGggWGAPRzBODiOIFIqAAVtofhgDiAKBYPzYTCldXhm5hGiKkrQUIaVrYfltmQmA1hGA/GsBowsbAzChUQFdAAVJwAC4pWFMNFNYIx3EXJ+XwJwXOhAoD6MOLYGR1EOTOJgEtBCnUOSgU6VQphf5uzsD6TIkk/ChmLS/K8cZyh7gaJUgFUy1w/E2xcoKGgJiJnbQAHLQG6QAK30dKGA7Q/zwmKaUhQJYLaqkGYwuQopTDRBOBQwSCgXhzg2R+LZm4NnIA5N4ky3E/wiBsocNAHJ5QAnwGgNAWA4CIEqpVSAsATl/nYAoYGtlKpGJoCIVGRACg9D/LQSqogsBVRBVRP88LmAyAAMS0u4hC/uaB84knhEC1lYUIXdhhXChFSKUVosOZi7FuKuH4vuPANAxLSXkspdSyqfL6VoEZSygsoLuJoBLqQfsf58J8NuRAe5UynkwEqcsvElw1m1OUByu2LQODuTMeKdFzCulCOgKIy5YB4QAH1CmFLuK8IUoag3QiiZwM1FqumPhxEctJaBirUUadAai4hNxmDqfiAReiaDHhkBgeEcAMAnHwAWSAVwPKOw9TiUJ2ESkYxRNRMx20uIwFxHIUCkB3o5u0TAbahaRDyDQKW+EogK1Vprf3aiJhHZm0fGY96BzYB/hOXIs57QwqcBsTAAFfCgWQG2ecLxOqqKcBRJVIiQr4WIuRair1kqtDSrgLKwlCqSVkopVSmlV6wUMuZaIVGZ6YCo3OKjPlqMziDjevCPalE7aiXYMwe4LUA3wibLQBKiirjutNXcn0lrBEFMDWACGJz4RdJ6QoFazsVS22SaQGQUBir9lzKizGMo0rQiYyWFy7B2OgQ2eyqFtHpndOWsVQTtsACkcAjolVY+xzj3HKq8erMizg8nhNsagGJlJ+qOVSatSM1sYyzAfk4H2MZxUbiEAgEi0C81GnuQtn4uw7V5Duk41x+EPGMZ8eoqM96pC4CiG0BMvx0QyzWwTgCkzBqKM8cRPZ0unAnN8Fc3IwsOh8CedEN5qlOByRBa08yRZyAYCnnlGkamqhKs6kWXYhxaA/ykGOEeXheiRJEK4ACL1iAiDMGprEAo1MAAcp0wDpZpIsoiybU1dZ62APrcABuBE4MNw5o3xuxAsJIZ+s2WvVa4CN6sZADIyDVUBz9dA0lQpaogeI8RqaSHO4trgtX6uoz+WVsgqxEAFAKN92kXA6s+na4wRxu2rvHhuz6e7pYqKVSe9YF75w3srFWBYObC3IeYn29d14KOMOmAx6eINjdQexGfldARl3DLDhKjcRgzoABK5rXnnGKrmOjsywAAg5AAERUtod6fISEwFcAAQk4BLxQZB5cckC/NrTIWdPQmV1L7LnPVQ88rIwsAiu9eq+Mzug14MUpXVw/h1ZRHNwcnKc8jR1TkVXWo3AczIhHxQrZ1kGxu7mA2IK4QD8nVBdUKh62IPOgQ+UXaOH0Ekfo9+64MwDAbvNxDkxDAWzdHc8Ag5aBbsGukM5+k/RxjMBmMGfUxr4LoWBP16E2pozOyzNgGz7n2vcn2+KeU6BUqImOPN6163vTQ/G9d42T3vvNfwvDcL3ZqzpAVo5ZcyBfLHn1Feb00D8kAXNPafyZwZAmXoTb7y+5wrxXSu+fJNDHZ3Ymex8xKz/PjnDecGN3zmAALlXv3sLqLhbtLsALLgrkrpLqrurmftrhfhAQbtzrzqbubnAaQPLlbu/lRilBFNFtFLFNcOwiAMgPNC8CZLCo+qKqitvMoIcDiH+JQswOKhip+l6pVLJOapVL+sqiYDiJVHRicv2PjH7KfC4BfBTKkGTHTMgl0mgkgDfK/Fgs4D0Hgt4AQn/EEACJmmhP3stJFtFjABiCpBgKBADFio4i1D6FjPDLpuYQqNpChJOLtgANRUyPj1AlglZiEcLGx6BIGJIbIcgSbQqOr1I2aszGoACyTozUiUm4mQ2IE61E1gtqYiM6ayoEH4dSw6DUjAuMXAeofiM6w6l6LA4g20xhMWKkZRzoJWG8thqopR7SciTBIgfk2OlGp4G4+iLAnOxigKwKfG+wAIsQ/YD6IqYqGGYA8QWK76B4hwFKcxMGJhn6cxsQ921Y+wf4sQGqjKc2AIHqKRoIoUMiKGK6wI3EPytsQKL2Mgf4b0GGaAfSNBIqz67BMAb6OKnCn6BK8qiqf6KqVUjxhxzKjxLx9w0JCqJ0Rq3uKUNGJwn+lCA8bOqgMeFmsmaJx40ICmHGoEuJnKiB0+xJ0I6gOy4RfuwyOJ/ceJKmxJk+5+/G2SA8FJVu1J+BHIV0h6m4DxzUTxsJ7xwqT6Yqr6YUUq/xX6QJ/B/6qq4JIGTKUJ6GMJqpcJU0jkzkyGm4pgsJWGhBUUSAMUhMpgJk/gRAFgf4VM1pFgFg4hhM/sXMVMwclMIw8hQQ4EShJM8cahSANMmhWwGcQsuhOcOM+cwEDID4xcwO4o5cjcPcD41ci80Ytoh8D4LcjEKZ8ZaZTcD4fcA8w8BozEW8O8+ZU8x4s8voWZJZS8aiK8D4a8bsm8dZZZnoe8cZDcuZiZYAx8EhxMH8N8l8IcPpSCQQD80w5gKhmCicswqgrgBMlCsAzQCSOUvU+UjkBYnipU0WFU1UPabAdUlGvUf4/UjM4CIuo0UcssdIqsCESEo4hc2S2JvSxU74KmJ0F0FAmk/hIAucogSAoAgQ8g8i5weAaUIArgrgQAA==="}
import { Hooks } from 'wagmi/tempo'

Hooks.amm.useWatchBurn({
  onBurn: (args, log) => {
    console.log('args:', args)
  },
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `amm.watchBurn` Parameters](/tempo/actions/amm.watchBurn#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`amm.burn`](/tempo/actions/amm.burn)
* [`amm.watchBurn`](/tempo/actions/amm.watchBurn)

---

---
url: /tempo/hooks/amm.useWatchMint.md
---
# `amm.useWatchMint`

Watches for liquidity mint events on the Fee AMM.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/amm.useWatchMint.md","from":128,"to":4640}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"dcfbe669423c1e67e1fd5bfc996004b53912d26ef3dcef6280d135f90c3df485","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXKLMzFGaugAssUmKykj9GVo6eO2deWZIRSC29o5+iABsVdRetb4NAfR4AGYArmCOjBBgnIdwMADqomi2ALKmaAA8AMLn+4wKAHwAFFh7MwdGQ4AB+RCcYAAHQunARC1MAEkoJDOGBDswAEZkTgAH0uYFg3zMUAA3HCEQjMhCobD4dTqddiWR0QADCy0AAkwBEpFMClc7IJnE5PL5aAFimFyAAuqLMTIZKLjiT8hSqUzqVcyAAVATyDlc3n8wXC0Xi01S83s+WKw7K1Ws0kwTWM7VEUQmKD3dgG/hGqFWyXSoUiwkhs0yu0KwlKlWEtUwV3upmuZ3qsmUj37UgQZgAIRkEGs/HR2J+L0zKY1OaZ5wAoqR86R0f9/mRW1Dm62AJScAC8v04RAgjCgA6TLo1NdT9epbGV6Klhxgc9n06zboXCKXJkUyLATi9MnRmJxeK3tbJG+zWoR52ex/b/1pUIA7vcni8AHQAQS0OAKE4EsFE/b98GfNBfwAGQgBQB2HUdx0nO8dwfTgWVgNsoQDeRUQAeVIf8oCgUh4DgdC0x1a5SHwsB0QYoiSLIii4Co6950w08Jz9ejDUYvDBJY0jyMo6jd04awvh+dFPjAb4FEkzD5FEbE5DRKFsT4ORRAuLjNyJbd3VcPsoTHCc4TAdp4CBax111O4Higl5/CgUsED0HJOH2dhOC/FzBVAxgAEdDgnRhME4ZhqxgEhjzgX9/DEBQvOQZAQDodosDkfx2QKtA4FoOEQlaaFwkMTgMzzAtOAAci/BRYoAehoFp6rhOEjhONAzguf8sCwf4BwZBEciSyZfycyDoP+MbqSfF43yA0bMMRc44AgORfzA/56tgsKIqgKKME4UQyLdRB6pA2k+0w9wtTMrr4QotBDlIC5XhOohfmc2xgr80gQvCyLoouk6+s238YdeFqft+OFXDhAr2RAOUKEyoFSimEBsdspwqIAWk4AAFYFQVIJL0YxkBogkRAekSYxkiGRAAEY5k0LI8BmlzoP8A9CmKRZyg5yoPA2Go9DqPxGj2PRAXzHAOAwAclpfKEO3fALZr/QC0pAsCIP5v94MQocR0stDDLJdzPLwd5vRkbEHH4Tg0AgThTDHQMAvweQQeO07vaoiG3WS4RuiQFYegGFIY40TJxj0DWGGmcwRgWUolmcAp1kwaWfHqFKmkV/GQScAcdcCn9jwAoCuhiJB4hGORBlSOPRh5vRaUF/JhhFnOxfZ9mC82GXtlLhWQEBCmq9AhCTbrmDzabhn4mkFmO8H7uU+MBD+5mRAs5KMplnZ+Jx6L2WdhoGebJBOB7PXGSwC2uQ4S9YG34/mAoQUn/e21gvIgD1AHMUv9towBFMwaAjp1xYHzEQCc8BzpYRCHITgsBsSHAUAoYKUCsHKHuKHDBsUZDiA9l7ZQMA4QAClRBegAMrWAFFgLgRD1wggWGARgcBmCcCQcQVBUBODYjOh+GA2JxH5g/HRJKL1wHcPgVgugoQioew/F7Z+MBrCMG+NYaSBY2BmESogF6AAqTg/4xSAOgSKawlCOIBSivgGKOhCBQConAQ4thzpUXZFw3aCERrshAkEza0DfxdnYGE86xJIFRJ2l+T68SSGcP0uIxy1wxGewCgKGg1CElnQAHLQBgL+AAVj4qUMB2i/jhNY2xCgSyuxVJE9+DjvbvzECcV+skFAfTdMUj8hT1z5OQOyYRDkOK/hEB5Q4aB2Ryn+PgNAaAsBwEQC1FqkBYA1N/OwBQ8NPItUoTQEQRMiAFB6L+WgLVRBYEYC1GZlFfzrOYDIAAxG8jiCyIBLOrsSOEUy/lJQWV2FZayNlbJ2XsiphzjmnJAec+48A0DXNufcx5zzXn5lmUlT5PzwWQpbH2X8nBlGcFaRAdpSSulyEcVk3ElxcmuOUICrgZUODBVoWKfZ/8uGwNUZUl6AB9Sxli7ifUFFK8VeEIG0vpVwzgdKql6LQPVKilcvFhwohiGAbi8S/34TQY8MgMBwjgBgE4+B8yQCuCFP2/LsRyLojY0myIqK0LOuxGAOI5AgUgMDcQEyA5nVNSIeQaBLVwlEDau1DrAVURMH7Z2araHA3KbAaptSKLtCSpwZhMBw3rimZAIp5whEEoksiFqhFoXrM2ds3ZgqkVaBRXANFlzMU3LuQ8p5LzwUfLQF875ogiaVpgETc4RNwVEzOAOIGcI4EGtMEDZg9x+qNLAHCRstAcpYKuHypVbTvQMr/uyCxe6wCoxqXCYJe16oB2VF7bRpAZBQHqn2HMuyybSiKlCV9JYArsC/SBfJAKlmPuSZU59IGvYAFI4A3Qah+r9P6/0tQAy8bZnBENgc/VASDOi0CLLQLBxllTYmkH+GYD8nBexxPqjcQgEAtkgS2rq4KrsxF2CGvIN0P7f1wn/aTQDVFaMeI4qIbQCSxHRDLB7HOEyyM4VIDe/9CJmOac4GxvgnGsIFk8bxi6BGnk4DJGJnDTJSHIHit6OUaQOaqBs9qUhrD2EwVIMcI84D+EKXvlwejFTEBEGYBzWIBQOYAA57pgG09SUhhFsQascL+XzYB/P4EC+cYLnBQuwHC5F2IFhJAn3i+5uzXBBWIBeGQGyMh8Wlkoi1Ogeiln9UQPEeIHNJDVeS1wBzp45REzGZZsgqxEAFAKINmkXBHMyC84wDhhW6sNc+t6FrhL2u0E61DMAPWVirAsAlpLC2MRhc201lqW7TDtdPOK6M4ECixBPi9X+tXbJDgajcRgToABKdLTBbTAPVHMwTUlgH+OyAAIvpbQwNeSPxgK4AAhJwBHigyDo/ZKJxLOGJN4ahNjpH+mAcqmB5WLpYBMdk9x6RrC5GuwowKi9A9R6cmnvXOyexTLpLOO2S9e9cAqMiDVUs37WRmF1PaMwkzhAPwjUh5tRbLZpc6FlwW5gCuQRK5V+LrgzAMD8/XIOQ1jHglm/+FykCXYCertN3BkJCh9qEYw9+gn4nJPAZgG+ojEHilcqd2b137v/egZQ2hxq4GvfYdw+Ygjkf31x6ZyHsAJuw+0fozARjun9oGY48BYzPHFDiPMwJqzwm+ze6J77zgyBdNQiL0Z7jpny98Ys4JskGNims9vV9jEP2Lescp5wanoPzgQ9Dy76HsOGfI+AKjjHWPEe4/xwn4nSfF8U6ByD2n9P1+kHR0zgfqMUpyfSpla4uAqDIC2h9Byqzm1wt2QQ5QhxsS/hkswBFBzu1BUWoNI6UWp+0cUTBsQWpgkak+waYo5m4XA25WZUhmZuZ94uEj5zAu5s5z5nAehr5vBb5p4gh/hdVoABww89on44A5MYB0R9IMAQIYYjkOF+pvRyYcZ8NGD5RzIUIJxCsABqdmNVeoEsC6OAqgDyEBPAbfTRfJdkaDZZDldxBjIWSlR4R0PqXKdcTILEGNKiawFlRBBNXJECD8NxD2AObqRgKmLgXUMRBNKwxBAULdUgM6GgughTc6J0CGKKdglUBwgJLCL/EQKKLrc4L+b0NcHxFgAHKhSZaZQDfYf4WIPsJtWFeFLdMAeII5TtA8Q4B5bI+dOg7tbI2IfFF4fYX8WIUdL5BLf4flPQkERKc6A1DNIEDiEZRIrrGQX8Tde4MJF/WFVtf/GADtE5aQ7tC5DFLFAdXFF5Xouon5XogYtANYomO6ClEXAqB9E4NXYxY4LgC3VQVXajcPeqGSI4qEJDb9ECK448OvRPIDQ448KEdQYpJQ8XaJZ9B4tAa6e4wFR4rfBvP494pnL4u9dnW9EtctdkJYtYoYmFFteFdtJKZFKYntWY8AwdPFJY4lb5VY9gLddY4k+4TY1aXyfyNddcDdMkw7SODINKJADKOmUwByfwIgCwX8dmHkiwCweAumaOcWdmeONmEYdAoIMCLApAHAs+XOJATmQgrYEueWUgiuSmauICZeVyeuA2IwemXQUeLuduBORmJOMYIIPuDOWUoePA2YVQVwWmGSWAZoDRCqCaaqXyfMQRRqOTVqdqNgTqW9CaX8KaPmFeeaLUNOLWWkI2BCJCEcBaDac459d8NDO6J6CgJGSQkASuUQJAUAQIeQOAfqPAIqEAVwVwIAA=="}
import { Hooks } from 'wagmi/tempo'

Hooks.amm.useWatchMint({
  onMint: (args, log) => {
    console.log('args:', args)
  },
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `amm.watchMint` Parameters](/tempo/actions/amm.watchMint#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`amm.mint`](/tempo/actions/amm.mint)
* [`amm.watchMint`](/tempo/actions/amm.watchMint)

---

---
url: /tempo/hooks/amm.useWatchRebalanceSwap.md
---
# `amm.useWatchRebalanceSwap`

Watches for rebalance swap events on the Fee AMM.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/amm.useWatchRebalanceSwap.md","from":137,"to":4883}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"a65363a61410810306bc28a64110f48e977141b2aff31cdee698fa19287f0ab5","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXKLMzFGaugAssUmKykj9GVo6eO2deWZIRSC29o5+iABsVdRetb4NAfR4AGYArmCOjBBgnIdwMADqomi2AEowAEaiMqInMADKAO6iWAAPABhc77RgKAB8AAosPZmDoyHAAPyITjAAA6F04OIWpgAklBUZwwIdmC8yJwAD6XMCwcFmKAAbixOJxmRRaMx2LZbKuZAAKgJ5MSAAYWWgAEmAIlIpgUrlF1M44qlMrQcsUiuQAF1laSZDJlcd6flmazeWyiO9GFB7uwhfwRWjVdLZfLFcrXerNQrRbr9YdDca6TAGTBzTzLXB/lgcKQxRK3RqPUqad73Vr/XqaQajTSTWGzSyo64Q6bGSXeftSBBmAAhGQQaz8YkvCGmLgF0PhyO884AUVItYTaOh0LII7RQ5HAEpOABeSGcIgQW3z7sViPlouVi04tiG4kaw4wHe98/F/ecQ8mRT4sBOa0yYmk8mUze77ef3tVtnnZ43g+L4/gBYlxw5NF/gefBAPeT5rB+WMADoAEEtDgChOCbBQoPuJ5XngkCUIAGQgBR5yXFc1ygDdaS3Ps+WuUhHWdThWLAQkAHlSFQqAoFIeA4EvPco2fW17RY4UwGJDjuN4/jBLgYSfyvKNrDBCFiVBMBwQUESIz/HF5FEF45CJNEXj4ORPgMqA7JLVxZzRVdbSxMB2ngOFEMua47hguDgMQ0CsH8KBmwQPQck4fZ2E4aDbHlThBKAhCzxjAFOBgEhHzgZD/DEBRIuQZAQDodosDkfxRRqtA4FoLEQladFwkMTgyxrOtOAAcn+BRmEYAB6GgWm6rEsSOE40DOC5ULjaF525HEcjyyZkP5fyCNS4iAWhJb/zAQK0pC6EOUW69cXOOAIDkZCcOhbqjq+TgMqwRBuqws7r3cC0nPG7FBLQQ5SAuQEoEYIhIU2/Akti0hksIoL0tjPLkOQwFBvByGsVcLEatFEAdQoUq4VKKYQFJzynGEgBaTgAAV4URUg8sJomQGiCREB6RJjGSIZEAKABGDRMnGPQNvw2DEeO2N/DvQpikWcpECFyoPA2Go9DqPxGj2PRYVreNMHnACZZ2rBwNOjC8IC83gpQ9CiqwnDba2oiHYBZCyIoxdl1c2i7LCiK8GBd4ZDeFtODQCBOFMVcnXi/B5E4UQEe2nzXs4ZtrGB1nhG6JB4hGORBlSIX0k0LI8DNjOkIBeX8mGJXSiWZwCnWTAtZ8eoCqaA3KYRJx50g9Fr35KSnTAF0kx9VMjJXG07Rjyf5BntVMz9BfXvjdfk19RUF/aCBjjQB9LI7R8j+YE/Hy4w40AvhRO0croYikEW+bLpAelFsYgg5I3GYiARgLFbirAo6tqjeB1jsGg+sQCwiZsPbC5E3bSzriFb25E35c0kLzUuKRm6jGrnoHCQDzCgJKGUZYBQ1gay7jA7YfcEEeQRHAbyZ4NJgGunILE1p4bcN4TANEOlhHB2sJFEAApk4qiETdGASob5QCDGeLAtYiC2ngKnF6IQ5CcFgC8Q4Chn6KE4PI/Ryh7hx2EnAFgjAPjwxjtHZOWIABSohrTfGsHKLAXALFngRAsMAjA4DMBvBorR9kXgYHiq8TgLxay/GYnlf6MjAnQFUVlWgoQ6rR1+LHDhMBrCMHBNYcxdY2BmFyogf6AAqTgqEVRiIUUqawHxlLxUYMoTgQ9CBQFsYcWwqdhKigCXdciC1RRYTGVdBRyFJzsCmanOkci5m3X+CDZZVj/G2QpL5bczjfhyhoNHWOnxYkADloAwGQgAK1sRqGA7RkJYgaU0hQTYgJrJ4a0uOPCxDPW4XpYGhzY7HO6WeZxyBRTqObEJZCIhwoP1FDqaE+A0BoCwHARAg1BqQFgA85C7AFCYwioND4NARA0yIAUHoyFaCDQBENOFiFlLIQxcwGQABiVlQkkUnzQCPOkWIYV8vZUiycqL0WYuxbi/FNyiUkrJZIil9x4BoBpXShlTKsAstrGyvKnKeXiuUmgWAw5ZzIXYrIz5EBvmzN+XINpeyzz8nsr8bphAH5xxaBwJKygzyigJSIgJSjMm3X+gAfTqXUu4IN5SxqjWidJnA7XfICdnF4dziloG6sJPp0BhLiDPGYL1lIhGhJoI+GQGAsRwAwCcfAtZIBXGwowROgaElJOYo0+m+JhKBtiUpGA5I5BYUgPDEtLiYCxMrSIeQaBa1YlEA2ptLaT7CRMIncO2dA3w2ubAe5jzBLtDypwb4MAoWyJhZAU55wInws6fiQaXFpUYqxTivFIalVaBVXANVVLNW0vpYy5lg1TUcrQFy7logaZ3pgDTc4NNTU0zOPOOGWIb6CX+XDZg9wZqvLAFiActAKr6KuAG21Xz3g/OEaKWpxGwD4weVicZ91urJ0NOC9gMgoDdVnCWPFDNNR1TRFxps8VeNQCws4gVD82PrNuRxiTscACkcAPo9QKaQPjAmhODRE52HFnBVNSd0zJs5L1zWCsU0625izSDQjML8TgM4lndRuIQCA2KsLXT6UlN49k7BxnkBGATgmsTCfpqJ4SjnelCVENoFZ9lohRw1A4KFhTzWTkY8JnE7nSBoi83wXzL06w6BhmYoLpmAQ4EZFFwzvJrHIGyu8HUaRVaqEa5aax3jfFoGQqQY4D4ZGhJ0vArgzmbmICIMwVWsQCiqwAByzh681rgXFs25qGyNsAY24ATcCJwabsBZvzdiBYSQIDVvrbZNYkNiBOxkA8jICDBqhKDToMUh+M1EDxHiKrSQd32RcFa8+HUNNjl1bIKsQWBQQepy4G1mQ/XGB+JO4957IN3jvafQB77udprnH+ysVYFg1tgHy/drgWPHwvdx/h0wX3nxRs3oLWIID/pCNp55RcPUbgOKNI8e1phrpgG6iWcZmywDQlFAAEU+NoeG0o2EwFcAAQk4IrxQZANeiki1TwzMXjNoh18rzggvgwi/bL8sAWvzd69k9li1pA8Y1X+qR8jbq7FmK7aKFpzrzEdJxf9FjcA7MiGzj6hcaadDfCee0b4FXCC/AWlLq6yPhz86yAn09zBk8IlT+nyPXBmAYED2eWPLmKn2eQpX6EgqsKTkN1hivSmJkKAemZnTenDfRdi+JmA3HzN8ed9HtAbfK+d+78PyTGmtO9Wk/pnrJuammbnzxiz4/bNgHL9PxzzmYCucKw9ErPnMLlYC9V0QwWYeMgiwZoz6/kCFeK95sr/nKuBdv7V0LjIiYrNJxudM8SQ+dY9PMhdOAbcxdzhJcp8O8Zc5dHcVdgA1dNdtclc9cDcn818xNMDdd4YrdhdRc7cHcsDSANdx9gDmMaoCoktipSprhcAqBkBrpgZEI0UP05U8Vn5lBDgXhkINJmAFVCUAMQ1BozJ7VBoQMdUTAXhBpxkHlZw2YC535VYhZP5CEBZeYq5xZ5glMKEf4W4aFnAehO5NhtZmE9YghoRC1A5p97p2E4AksYBiQLksI0ZiU/EZp3hGYyYTMLldRnJqJbQTsABqIWbOeoJsW/FQqgcKSRPAPAwdWOUUeTNAJUT1HpFzBWa1AAWSDGmkqjPEyDJEXWEmsFdRvFXWuEs2yPwBnQmkYBZi4HdRGRnQiRYHEFiWcNcJS1TmDFv3BmJ1ewOXslXRegEJEG6V+3OH4XeFPFsXsUcSszFVE32GhFiFnHfVlXlXwzAHiGJT/TvEOEZQOJQ1cIAwONiHe07H2GQliCgy5Up2hC7TKIRFylThw13ThGUjBU4BhV+xkGQjw3uCmS4NlS/VEJgF/VJUSIA0pQ1S1VA11SGmBOeJ5WBLBLQBxJpjOitTDxqlYxOFAI0lPn51UAzzrw43JMfDRDU34ywjpKFVwMHwqVPjRHUCswyMj3mVpNvkfi0xZP72N3ZJZK5PH15NoNFH+kvTPCBOmhBJxIhJlU/XlR/TymVQRMA2RNkLAz1UGgxONW5WxPYHw1xPNPuHxIwgwzimwzPFMBxMI3oKKiQBKg5lMEQn8CIAsGQiFn9IsAsFUI5kLg0OkC/iIRAT/lIWMBwWmHMF/nmGoTbiQCFg7gYUsJ7l1l2FsMHmZhHhtjHijAng4j3jnizAXnEmXgdGknLM3kPmvB3lhxVFngbNFGvkFPPgSUvjQE7NPnvkfh7NMT7JxlwV0CFkWwGCjKTL0IAQwiMO5hMNTMFlUFcHZg0lgGaFyRahWnahilrHCV6iSwGmGlHTYDGiYxWmQjWkljtkwVjD2gtFrg9nrjehOw5BdnIkomXH2kuhpMmW6kgi0y+mxB+jACcn8CHlECQFAECHkDsXODwDqhAFcFcCAA=="}
import { Hooks } from 'wagmi/tempo'

Hooks.amm.useWatchRebalanceSwap({
  onRebalanceSwap: (args, log) => {
    console.log('args:', args)
  },
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `amm.watchRebalanceSwap` Parameters](/tempo/actions/amm.watchRebalanceSwap#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`amm.rebalanceSwap`](/tempo/actions/amm.rebalanceSwap)
* [`amm.watchRebalanceSwap`](/tempo/actions/amm.watchRebalanceSwap)

---

---
url: /tempo/actions/amm.watchBurn.md
---
# `amm.watchBurn`

Watches for liquidity burn events on the Fee AMM.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.watchBurn.md","from":123,"to":5186}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"88643edeaab8a1c3858658b1397de9291730cd2a4ec09f2bcb6ee2f76ce6d305","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGccTMZj4ioyGqk+oMv5UgwisVgnqIRnM06sxAAJkqCMwXJ8s1KNH5IASa34uM4wPsACE7mAADxHLIAPiCHWSqRdyQonCwjmYejIcFSNOEADpFRGbfh7fcIwAFQPB0hwZ3FJSuiJ7A74I4nYYXRRoG5oB1PHC5MAi+AB3gwa15+NgUpQCC8BAGfYg+CcBLsTjmACOK0YUEYmE4ACMHZwYJc0HAI8bxEou8hkCA6CKsApSgADI9L3KCwrAaKkGBbGA+pR+/BoNBYTiufukCDMTgAcgAApslGYRgAHoYivb9T0xc9OBoTFX3fT8f3/NcgNA9gYFAhwLDgCC8igrgL3DOB4ISD8vz/ADULAjDYLYXDciWOJM04ABeS9rxoO8gmAXJOGiLDhFSZBaIgB54DQSw0AAXQoXiYKGYQCiXVIeLAPi+OEmBMQjccpNSR9nyCCJZLU18TNcCJcgY2JVg2PNWJ4S0TCjUUY2bB0PUzP1VL4oQW1SEIdDgP05AgJQohY11OB89SlggBQI1CpQgm/AAZRhR3HScME4K9mF8KBEG/P1WkiOT3FyCzciPA8QBkrcAyGJUmWYgBadJMxXeqQEakVSl6oMRmI9rkya1Nlzqigtyvct7lMbh+wtYw1LQCBbLgFZpzgXhSEYadG1IxDVEbBcSy6mSygJPprH6L4ZTGOUAQMWMWzpFU1UGYYXG1Qk9SRQ1URNQIQjCSIimEJjEi9DqoZyPClPBzpRCuxBejR+Q6h+JpHvaTM3shaENW+iFfo5fVvBRXkgbwIIsA/HAOAwKI/IdALStSF6HQjbggpCsKOfchNUrCiKoqICBxzbDsuxANJQjkacnAAaxgtaLHFpXG3WfBFCHDKxwnKdGGIvKCpXZGJVRrVGWlLHmmoVonpAFn7nxpBKkJr7Ri1P6DUp410QMWmUxGKJ2eiuS+LgRRYFIVID2sWgABJgDEXblFcA8AG5I9WaPSAeCBNbAePE5TtOLCUTOc9MviiFCcctnYQvi9L5PU5OSvq9zkUIDWNAAFV85bxRUmnZILDQGv1OFfL+4ANQbqAm4LovR5nCfjmn9SRwN7Kx83qfc9Wtvy87jPs8q8U3l6CFbDurGPYd/5AlKt3ECf9UvbcMn/v9+ZgYDVTFEJKAsQQtgjMLJQ199C33trbBojJKROySu/T+n1YR9AAKy+wpjyAOpoaxBjgPWRscUFC5HrqQcGcB4owG9CYOhUtOx4AeDrTgB5yEwAPJwfKUAVgKH9B+Ig44+ziE4HAfIgjYCziUEoSuNC6EwQcFwY2EiWCMDkJIVWyiYC5AAFLiHrgAZR2owLAkNaGCKDMyPIcAvx02IKIqAM4crrBgNOGcH51j52XFZR47C+ECJOrQJSxE0DrDWiQmAvBGBJF4EUTElhjihn8QAKh4Bwo4VjuHRC0XAYi6xJz4F4XoQgUBiIbXsMKYinDGEJSSkZA8fo6nCDoRGMgH5SBNOFGAFxrScluXuD01QWxojiDUvtPOMAXGrWtLtGgOiJk5QAHLQBgBGAAVpUk415mARlyBkhaShQqKzkBwrhPDsISDAA2RGyQ7gzJ0esBZjY5nIAPI4hsBSIxiHbCsNAB4pJBAMlgUMwFgKQFgNsiM7AlDAXbJ2YCWiaBiFakQHUEZaDAXEFgECXz4DLkfMwOQABiAlBS/l9zQGHPpuQPkUuXH8zpQKQVPjBYgCFUKYAwrhQi6WyKbxooxZULFOK8XAUZRGYlZLGXMtIKQCIEZOBsMbCciAZyLn1NybwCZM5GwrGji4opqhqWcDPAIZQuiOHcsQJc3h0BgkHLALkAA+mktJ+x7iVw9a61IqrODqs1VwzgGrNkxLQN+Yig1ynEUkI2SwxSyA0ONjQY4cgMC5DgBgW5+APyQENXrTW1rpzePzjwRMABJcJOscpXmjswacCg/SQGofG3ROUlippLBm3I4Qc32HzX3Yi5hi3y1DcdahazYBbJ2VeEUy5ODGJgG89hHzICLKEEIjshLOCVuAgAeVZaC8FkL1m8p0PypFKLxLosxdi3F+KPzfKJWgElpLxCtQ3TAVqQhWqMtaoIKIA5SC5Hylec1iR2DMC2LiZ1uQzi0F3IIw1CjjqBtOaELVbSFAHkQP4mq2zrI4Y2Y078Os5ChWtOwOQUBvwRBrhCzgiZ07KU4BRqjkTSC0b9HMqlALiODLIxxtaABSHCfpvxcdo/RxjwFmOsdDOxmAlG1rSagLxqJaB/loEE+0zp7AgiWHWJwM4CrDPfl2IQCAYK/S0JjQoxWLiHBYBwJYOjEQGO5CYyxyexEDPUOIXANcjYJkuPKLwFWhY7l8e050/DYAmN8TM10vY1nbMSM/GUxz4hnO4rczM7z8mZ5jOQAuUIeksGoywUVmewouCmN2hYiMpA1iVoCcbAsAROBGfWYgIgzBUYQi1KjQkllEvFfUmMg905w38Ba21jrcAuv0B67agbqprDSFVGN2rJWuC2snmQGschJXPsJcBOgMSAW4neOoVG0g9tTa4GV+ucgpKtReflsgTRtRaie3xMZ5W5CNfMVwXrsBEBHfuKEM7O6CmXdoNd5a7xGhNGsONpLz3OCHeOMd2HMGLCXbe66iuyhtQQlVP4xiOPawOUs5o85VwNXYSEN+GuXChlgCCAeAAIhM3Q1CU5EJgK4AAhJwfnygyBi4PF5ibCm/OpCl4LzguxGecGZ+PNpYAJcq5l5piRcWFXVSPP4xDyGDWSKtehg82S6E8N4Pk1JLqwCEbgIJrgZq2JtGMbskUxisuEHWEZDnNlOkOV9/75ggegzB9D573hGB7eCLYsZxRCUU8wCCNSv0nT5dgeT9qxKYUUoieo9xjzcnFcpP0ipzjNGNM6OpYXrPJfkrkfr2JiTP51Oydq752vynVMV5483gTYBmBF5Ix08z3T08pYs1ZiANngqZYc1apz7Hvvufo/LnzimhKL7jmr9La/7PZc37l7frnFAzJkjozp1ObIi/p+ryjmuWc6/Z634vmxhl84C7JrC61ji6S5AGkCy777yaD5sb67ULv5M5f60K67gHS6QGG5P5u5HirjrhICbhlArqlDIC0J3ANjAonqcrATyKqCbQRgxDMBnrQpwBMEYRNoarAQipirmDThoQz7bIRB1QXSvCwLVAYxki/DPzygtQkbvxYKeyYIfy4LTD4IAI0wxrQBRBt6NJBYhYAD8qQyyfoEYJhNmy0oQo0C6hhYAGAyAUkOYnA4s44PWAA1L0KGrMKFLloIVQIijLLAeEmtAePxoCtaMUjjjAOsN0BspwAALICICB7ihY6ArBBgpLjKTKNgBgFIzJ+gmolLHS5BJBphcCGpPLhDWp0wsCSA5S6G6C9IuLjq5aGy4hYZlGNGVKbRiCTg3ZCCUKhArB9iSJARaLULvKfKsYJBBAQgRDHrspUEwZgDqCwqXrdArDYqLH/ohYsGLEQhnaTwJARgQjSpvpyDjZBDoatCpElhxoQbjrZFGo6IfI3ZyARggYwZoBNIUHsqnrcoXrwp+GCqopoB3qioPoSovEnHvovHvFbCwkgmlSebwbYEHhEa3I2QxD9wORYJh4z5kaYnHCpCiZ0Z+gEk0rV4BGpBkmpDyE6IhF6YNKl7fjUnFRFD9zQE15sbUmcC0mxY6am4Hj+LLqNjPECCvHwlfFsrPi/HnrLh8qAk3rCr3riogSQkyqkownQZwlakIlBTAaDjgaNgWDwlwa4EbhbjW4NilBEDWARi9B2nWDWBCEWw3xYLyEPyII4x4CoLKhWDulfyKG9A+y/x+yqF8iAIhxkBhxBQqS5zRx9I/YcJlwdzpxVyXy1zTKrytxJntxk5pnbx1xLwrwjwlw5lnypndwZm9z9xDxkAlkHzyJbw9xzzHCLzmDLyrRZnrzjyNlHwZm7xZSYANmTwFmqynwpldzpmuAwJsiEjiH3RPzIKvxBRyEKGahag4Ihl4JGhqEGA05Ah5gBSiyOESxQAznajWBSiYzkhekGAHkgjvy9D3wBmajWCuAXQxCwAYgIyEROTCAkRkS94oQgQiS4QWrRT3JKAAWITfgRh8FZD0TokQy2SxgOREQuT7KczDKej3gRymQuzc6lR8zhR4Uzyc5kbsysmInlTmTja1apQ3ikB2arQvixiVy5D3n2BGSlCDTiBICgABCKCSJCB4BLggCuCuBAA"}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.amm.watchBurn(config, {
  onBurn(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Return Type

`() => void`

Returns a function to unsubscribe from the event.

## Parameters

### onBurn

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.watchBurn.md","from":5386,"to":5887}<fsm-vh3gqscxm4e>
declare function onBurn(args: Args, log: Log): void

type Args = {
  /** Amount of user token received */
  amountUserToken: bigint
  /** Amount of validator token received */
  amountValidatorToken: bigint
  /** Amount of LP tokens burned */
  liquidity: bigint
  /** Address that removed liquidity */
  sender: Address
  /** Address that received the tokens */
  to: Address
  /** Address of the user token */
  userToken: Address
  /** Address of the validator token */
  validatorToken: Address
}
```

Callback to invoke when liquidity is removed.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.watchBurn.md","from":5988,"to":6244}<fsm-vh3gqscxm4e>
type Args = {
  /** Filter by sender address */
  sender?: Address | Address[] | null
  /** Filter by user token address */
  userToken?: Address | Address[] | null
  /** Filter by validator token address */
  validatorToken?: Address | Address[] | null
}
```

Filter events by indexed parameters.

### userToken (optional)

* **Type:** `Address | bigint`

Address or ID of the user token to filter events.

### validatorToken (optional)

* **Type:** `Address | bigint`

Address or ID of the validator token to filter events.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.watchBurn.md","from":6649,"to":6694}<fsm-vh3gqscxm4e>
declare function onError(error: Error): void
```

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Enable polling mode.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`amm.watchBurn`](https://viem.sh/tempo/actions/amm.watchBurn)

---

---
url: /tempo/actions/amm.watchMint.md
---
# `amm.watchMint`

Watches for liquidity mint events on the Fee AMM.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.watchMint.md","from":126,"to":4909}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"3e678dc18ce9b1b0888b0e3f1b0a2e9e066a3d862bdcaf011c8c115c0b244c46","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGccTMZj4ioyGqk+oMv5UgwisVgnqIRnM06sxAAJkqCMwXJ8s1KNH5IASa34uM4wPsAFkLGgADxHLIAPiCHWSqRdyQonCwjmYejIcFSNOEADpFRGbfh7ccIwAFQPB0hwZ3FJSuiJ7A74I4nYYXRRoG5oO6PLy5MAi+AB3gwa15+MMKhQCC8BAGfYg+CcBLsTjmACOK0YUEYmE4zAdnBglzQcAjxvESi7yGQIDoIqwClKAAND4vcoLCsBoqQYFsYD6lH78Gg0FhOK5+6QIMxOAByAACmyUM4APQxJeX4npiZ6cDQmIvm+H7fn+q5ASBMDAQ4FhwGBeQQVw57hnAsEJO+n6/v+yHsKh0FsFhuRLHEmacAAvBeV40LeQTALknDROhwipMgVEQA88BoJYaAALoUFxUFDMIBSLqknFgNx3ECTAmIRuO4mpA+T5BBEUnKS+hmuBEuS0bEqwbHmTE8JaJhRqKMbNg6HqZn6SncUILapCEOhwH6cgQEoUSMa6nCeSpSwQAoEZBUoQRfgAMowo7jpOGDClAsBQIgX5+q0kTSe4uSmbkh77iAkmbgGQxKkyDEALTpJmy7VSAtUiqUnVBiMBHNcmdWpkuVUUJul7lvcpjcP2FrGMpaAQFZcArAARnAvCkIwq2NkR8GqI284lm1kllASfTWP0XwymMcoAgYsYtnSKpqoMwwuNqhJ6kihqoiagQhGEkRFMI9GJF6LXgzk2HySDnSiOdiC9Mj8h1D8TR3e0mbPZC0Iah9EJfRy+reCivL/XgQRYO+OAcBgUTeQ6vmFakj0OhG3D+YFwWsy5CZJcFoXhUQEDjqU7adngaShHIq1OAA1lBS0WCL8uNus+CKEOqVjhOU6MAR4jZTAUDLgjEpI1qjLSujzTUK090gIzxw40glR4+9oxat9Bpk8a6IGFTKYjFELNNiCLYc/54pvL0EK2Nd6Pu/b/yBIVruIMn6qe24xM/X78wAz1qZRPFvMR+zAtKDH+hx3bNsNIylKO/FGdZ29sJ9AArD7pM8v7po1kGcD1o20UKLkRCSCDcAxTA3omHP4sdl2IAPJrnD7uPMD7tO0ArAo/rvkQ459uInBwPkh+wKtKxKEoFhKDPc9QQ4XAGxfLCMHI0+La/MC5AAFLiCngAZU2owLAYNZ6HyDMyPIcBPzU2IKfKAnBVqZXWDAVa6D3zrDgCGCM5lHgb2YPvQ+dB5IETQOsJaI8YC8EYEkXgRRMSWGOKGYhAAqHgm8jgwJ3tEH+cACLrEnPgacehCBQAIitewwoCJb0XrFeK+l9x+iUcIOeEYyDvlIGo4UYA0GaIEc5e4BjVBbGiOIZSO1VgELQX/dYW0aBK0MZlAActAGAEYABWsiThXmYEQsAPCZpKCCnLOQm9t67wwhIMADY4bJDuCbNxzjJyNj/sgfcyCGwiIjGIdsKw0D7nEkEXSWBQyAUApAWA/iIzsCUIBCWcBAI/xoGIRqRAdQRloIBcQWBGCATyfAJcD5mByAAMSjJEUUiAJTQ5GNyDk2ZS4im6LKRUx8VTEA1LqTABpTSWkr3adeLpPTKh9IGUMkZ758njLQJMmZ9yxkbNIKQCIEZODr0bBEiAUSYnKMEbwGx6DGwrAcdacRCz344Ufv/TeBzECxL3lAA+PjiEAH0uFcP2PcR+uKsWpF+Zwf5gLt6cABb4hhaAvwEV6tIw2l5OCWHEWQGeBsaDHDkBgXIcAMCJPwO+SAkLtZq0RatPBBDSA8ETAASWoZrTKl4CHMFWgoP0kBZWSCycqzlYgSy8tyOEQV9gRULIIuYCVMsqUHVlV42AfiAmXhFEuTgoCYB6sbDkyArihBHw7GMzg8rAIAHktmVOqbU7xRydAnM7GczpaBum9P6YM4ZayIwTOmeIRqfqYCNSEI1NZjVBBRAHKQXIZCWUWErcwLYuIQm5DOLQHch9IUIoOmSyJoQgVaIUPuRAxCKr+IsgOnxqivyazkEFa07A5BQC/BEAA3LkGpnBExbQ4TpGAs6lq0NIIuv0f95klPHaYqdM650AFJMJ+i/Iexdy611gA3Vuh0oZODXoPQuqAJ66FoGKWgC92jdHsCCJYdYnAzgfIg1+XYhAIBVL9LPRlCK5ZoIcFgHAlgl0RFXeuwCm7t2LjnHB2Vw84CrkbDYtB5ReCK0LEk09QHdHDrfcR7isG9F7CQyhi+H4pEYaNt+wZuGTZEZUtxKxyB5yhG0l3JGXcpPSaseAraUCIykDWPKkhBsCwBE4JB7xiAiDMCRhCLUSNCRmU49J4UXAw2rRpfwbTun9NwEM/QYzyLzOqmsNIVUtnVMqSscih0ZAaxyDuUGkRgE6AMJKbid46gkbSFCzJrgcmp5yHEo1Zx4myBNG1FqTLjm5y5Y05ArgJnYCIEi/cUIsWHkJdoEl+a7xGhNGsHZjdamuAReOFF5rDaLAJdy1isQ26UhW1VMQuirLay2QQ9/aJVwAUYSEF+V928zFgCCPuAAIjY3QsqAAkwAh4wFcAAQk4Cd5QZBbv7kI/Zj9O6HunY5bsNbnANurS22Ae7j2zu3YAxfNjHzyqHmIa29tELL7KERfufhc9d68GEZwsAMP9xjsSZZWFtk2igMCSKUBQnCDrH0rtyyujid6FJ665gFOgxU5pxergzAMBo8PsxKDz9Yq85gEEWFfpdFverTz4FcVgqJR/fOo9+HX3vtI1+hXT7/1uNhVL4XsuErTr3be+935Ncvqkx9hS36je/qVxDnXYBud6/A/ogXPH4OIYgMhgKgn0PI8w2JnDigTbLre6rz9/F3ekD417gTaHhP+9E9hiTUBJJuN0Qtyy12Vu/dnf9zbWiwA7d1zLzY5jjvfYu1d2sd2vtPdIC9sPxHLdftBz9v7AOgcg8r+D9P0OwAVRXGuJAG4yhetKMgWedwGzlKjXswCD9VBrQjDEZgMb6ltIOYBDVALAKXOueYVawEZf+IiFVU6rxa7VFRmSX4Kd5QNQnRnLuHtO6Z17tMfuhdKaMugFEPXqiVGNGAA/KkDYhgH6BGFAchvNKEING6mAWABgMgOJDmJwCLOOMZgANS9BUqzBBRGxn5tgrx4At5uL7hnqlLQqqCsowDrDdA+KcC2gHwCC7i0Y6ArBBgcLWK2KNgBgiImx+hiI0EHS5BJBphcCQppLhCIrUwsCSCZRAG6CGJoK2pGx6y4h9pSGqGyJrRiCTjJZCCTyhArB9iXwzg/yyrZK5KkYJBBAQgRCRo7Lz4NpgDqCNLxrdArD9KuElo0ZtKuEQh3IOgJARgQjZpPJyB2ZBDdqtCcEljMq0Z578FQrWHJZyARj1pbBqKz47LRoHJxrNKtJJoiSppXLpq3LpERHPLpFZFoB1GNSFQEbNoD6Hj46LYxBrBcDMRdy04Tr66JSdHHCpA3pLp+hDFoBN4kYR5FBdGpAv5uKUGgYqJy5fgTF5TjELLHBTEt6pDrGcALGsbAa47EKeo+r7hVF1E5HbJPj5GxpLjHLFEdKlH74VHDJVE5pTK1HsANr1E/FbCNH+QVqDg1qNh1r/HzRmz2zD4oCbhI4NilBEDWARi9AonWDWDn7myxxdwv6JyNyYx4CtzKhWC4nZxv69Dex5y+xf58hFzBxkChz+Tlx2jsyczD5Ym1yNCEg343TJzNxpzRzElICkkdyahag9xUl9xGjf4GCLZAh5i+RCzoGixQA1xIBajWBShozkgEkGDykggZy9AJxkmajWCuCnQxCwAYiwx4T2TCCETESm5ITDKCRYSni4TJJPyvh7QkQRjH5Qw0QE6gxWSxi2T4SOTBJszHBuRQweTSTOxoB+RrjcwhQRTSTcR7ZTosz5TChAnFQmR2ZSZJTXikCoaLTPixiPy5D6n2D6SlC9TiBICgABCKCXxCB4CLggCuCuBAA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.amm.watchMint(config, {
  onMint(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.watchMint.md","from":4995,"to":5024}<fsm-vh3gqscxm4e>
type ReturnType = () => void
```

Returns a function to unsubscribe from the event.

## Parameters

### onMint

* **Type:**

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.watchMint.md","from":5126,"to":5651}<fsm-vh3gqscxm4e>
declare function onMint(args: Args, log: Log): void

type Args = {
  /** Amount of LP tokens minted */
  liquidity: bigint
  /** Address that added liquidity */
  sender: Address
  /** User token details */
  userToken: {
    /** Address of the user token */
    address: Address
    /** Amount of user token added */
    amount: bigint
  }
  /** Validator token details */
  validatorToken: {
    /** Address of the validator token */
    address: Address
    /** Amount of validator token added */
    amount: bigint
  }
}
```

Callback to invoke when liquidity is added.

### sender (optional)

* **Type:** `Address | bigint`

Address or ID of the sender to filter events.

### userToken (optional)

* **Type:** `Address | bigint`

Address or ID of the user token to filter events.

### validatorToken (optional)

* **Type:** `Address | bigint`

Address or ID of the validator token to filter events.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `(error: Error) => void`

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Enable polling mode for watching events.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`amm.watchMint`](https://viem.sh/tempo/actions/amm.watchMint)

---

---
url: /tempo/actions/amm.watchRebalanceSwap.md
---
# `amm.watchRebalanceSwap`

Watches for rebalance swap events on the Fee AMM.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.watchRebalanceSwap.md","from":133,"to":5190}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"91e718ca006a23e8682b0ebc2f91d672ae05dd36421745b488980a673c12e660","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGccTMZj4ioyGqk+oMv5UgwisVgnqIRnM06sxAAJkqCMwXJ8s1KNH5IASa34uM4wPsNwARqFxGBeDAAMqbLAAHiOWQAfEEOslUj7khROFhHMw9GQ4KkacIAHSKhM2/D2x3Ot0ehMABUj0dIcG9xSUvoiewO+COJ2GF0UaBuaDujy8uTAIvgEZd1sr6bkTpd7vEWFKUAgvAQBn2IPgnAS7E4pBgDv7mc4cA9nBglzQcATxvESknyGQIDoIqwClKAANb7vcoLCsBokutjAQ0ow/g0GgsJxXHOpAQMwnAAOQAAKbEozCMAA9DES6gQ+mJPpwNCYv+gHAWBkGHjB8HsDA8EOBYcBIXkKFcM+8ZwJhCRASBEFQfhCFEehbDkbkSxxCWnAALwvjAb4fkEwC5Jw0QkcIqTIOxEAPPAaCWGgAC6FDiWhQzCAUu6pGJYASRJskwJiCaMFAKmpN+v5BBE6kGf+9muBEuRcbEqwbJW/E8JaJhJqKKa9suGaDh6AYlmG+kSUIfYDlmw6pCEOhwGGcgQEoUR8b6nBRYZSwQAoCZpUoQSgbFa4bgloFhq0kQae4uTObkt7XiAamnhGQxKkyvEALTpCW+7tSAnUiqUo1RiMtH9XmXUFnubUUKeS5NvcpjcHOFrGAZaAQB5cArHacC8KQjB2jAWEgaoF3bvWQ1qWUBJ9NY/RfDKiC9IScoAgYqblaFw50iqaqDMMLjaoSepIoaqImoEIRhJERTCDxiRBgNaM5BROnI50ohPR9Wq2G9PxNN97QlkDkLQhq4PVFDBoorycN4EEWBATgHAYFEMXBauANYIltWpH9fNxUOWAJtwyWpelItBSu4vZgAMulmXZUQEDmaO46TiAaShHIDq8AA1mhe0WJrJsXes+CKMKi5ixVm7jrwdwLfjEofRCWryHUpO9AArOTeC84rmYS1TSCVDTYOjFqDPeEzxrogYbP5iMUTCzlGkSSscBkA8EDW2AqTXtYtAACTAGIp3KK414ANy55wRChOZWzsEXJdlxX1e1xYSgN83DkSZVWCc73Vc1ycg/Dy3IoQGsaAAJKl5wdrJBYaAj4ZwrMEvxwAPIrGgqSb0o28j644pvL0lRfSTDQx9QrQ/SAtVR4gL/qnHfSQxyfUSceQp1NOnOamdODFXliCf68VJaqyULffQQcX7SlJoySk79ipfx/qDWESAdSJ2mCA+YgR2xRjgF2C6+UFC5DbqQZGcACowGDCYFhOsJx4AeHbTg15aEwGvJwA+UAVgKHDEBIg5lZziHXPkcRsA7QrCUJfZQTCWFoQcFwRgtE4AsEYP2Rhu1NEwFyAAKXEG3V0J1GBYFRsw8RUZmR5DgCBdmxBpFQA3hga0y4N5AXWAXQsCZXKPF4SIsRN1aA6VomgdYe0qEwF4IwJIvAiiYksMcWMoSABUPA+FHAcYI6I/Y4C0XWIwVQwi9CECgLolY9hhS0X4ewwqxVbLXjDC04QLCExkCAqQDpwowBeO6UUwK9whmqC2NEJ0G8Lr5xgF44x6xTo0HNsMnxAA5aAMAEwACtdEnCEswEJYA8kbSUGlFcfCBFCNIhINcgYlB3CWRs1ZlSLrGOQNedxLoykJjEGOU+14VJBGslgWMsFYKQFgIchM7AlCwTHBOWC/YaBiF6kQHUCZaCwWHHBP58A9zfmYHIAAxESspQKl5oCziM3IPyqV7iBf00F4KfyQsQNC2FMB4WIuRbrNFb5MXYsqLi/FWBCVAX+SStAZLKUyuJay0gpAIgJk4Dwi6VyIA3LGSwoRvA5nnVWAXLxFTVC0s4I+AQajrp8N5YgO5wjoCRLObkAA+jknJ+x7iD29R61IWrOA6puQIzgur9lJLQKBWik1am0UkBdSwlS7aMKWDomgxw5AYFyHADAzp8BAUgPnKBjBrYmP8RAQJZAeA5hXrEu2PilwF2YHaBQYZICMKTSYnxGaxD1hzbkcIBb7DFqXrRcwFbDYRuuownZsADlHNfMwPcnBXQwC+bwn5kB1lCAkeOYlnAV6wSPuyiFUKYW7P5ToQVqL0WKSxTivFBLYLMoTKSil4heq7pgL1IQvVmW9UEFEecpBcgHyXNaxI7BmBbFxO6sAZxaAXnEfnQelbQ2hFua0wRiBQktUOW5HpbT0qlTtnINK1p2ByCgKBCII9oWcBzHXXSnAKNUfiaQWjYZjE0tPsR8Z7TQIcb2gAUjImGUCXHaP0cY7BZjrHYzsZgJRvaMmoC8YSWgYFaBBO9P6ewIIlh1icDOKqozoFdiEAgJCsMzD40YYdF4hwE9FBLPowx3ITGWPb1ooZxhlC4CHguk6Lx5RTaaScF87TsBVX4bAExiS5mBl7Bs3Z9cwEalOfEC54cOBLBQG8wpveMzkDblCJZQOH1A7Fb3sKLg1jTp2ITKQNYa8eE6OrAETgxndmICIMwb2WoPqEhcolkrhkZlHztFG/grX2thK60IOGvXHWDdVNYaQqoxt1dK1wR128yDtjkG+pVZTYJ0CSafXE7x1AfWkHtqbXByttzkCpXqqz8tkCaNqLUT2JIzIq3IJrtiuB9dgIgI79xQhncPRdq7bttrvEaE0aw42kvPc4Id44x3YdwYsJdt7HqB7KG1BCVUoTuLY47N5KzBi5CcCuLq0iQhQIjwERMsAQRrwABEnS6EYdXChMBXAAEJOD8+UGQMX14vMTcU351IUvBecF2AzpnLOelgAlyrmXWn1w6f6c1W8oTkOoYWXou1vDryFINSU8I2SwAm+vER507krUCTaK6Y5IpXRZcIOsWyHP3L9O8t733zB/dRkD8HwTXBmAYDt+IgSJn1GFWTzAIItKwz9PlxBpPuGipkZE6pzjNG6Py580pqyZf1MV4N7Sgvmfi8lVL2pzgEnqpgQ03Jurvmsm147xpxvAmwCJ5bwF4zMBTMpcs9ZiAtmUqZcc2o5z7HvuFc8/JxXg/ODIDn6QNLi+MsOey2v3LG+3OFbUhs43zv3coxp1GOn6vKOa83tr9nzei+bEmXzgXWtYXDscXSXQA0gWXKvBTAfNjPXRhN/RnZnT/ZhHXMA6XCAg3e/FqA8I8JAE8MoTdUoZAZhO4F0MFC9blWCS+VQQ6BMGIZgK9OFOARgoidtXVWCMVCVcwO0AiEjPZQ5CINqB6V4FBRoYOJ+X4V+f4CmPgr+cQ3+Ahb+YhbkI0MhVmeNaAKIFvdpILELAAflSCdAwDDATFMNs22lCFmhFGUyMOQBUnLFbi1i8SCAAGpegI1Zg0pctBCqAUU9YYDYk9prx+M0AhELV8BscZ9ug9lOAABZMRAQS8ULHQFYKMLJWZAyE1CMMpJZMMcIkxXIJIQsLgRZLxcIStdmFgSQHxXQ3QYZMo9/XLKASpXEbDUoppdcQ6MQSpG7IQehUIFYWcPRGCQxDZJlVjBIIICECIc9TlSguDMAdQBFW9boFYPFBYwDELZghYiEM7beBIBMCED9eVOQcbIIe1VoVI+sRNKDGdbIs1MY68G7OQBMMDODNADpcgzlS9XlG9JFPw4VDFNAJ9cVF9KVWCZ444hVZ4t4rYWE4E2qCIdVAjW8N3anGIZebyQOEPPg1vUqDE44VIMTOjMMAkulHfAI1IMk1IYODZEI/TUjNvak7vMkqA3fNjakzgWkvjHTJvMAFqUJDdC6H5SE+Ez4jlX8H469PcAVAEh9UVZ9SVOCSEz9clGE2DOEjUhE5KUDBcSDC6CweEhDHA48U8K3F0UoIgawBMXoG06wawIQz2O+dQRkdBBoTBN+QIHBZUKweQ/BTUXoBOQBaGZONQtOCaAsLOZKPSFuRZUgbuRQKefuWeeuJuFuN7DuXaeM4uRMvhPuGeOuIeNM0edcD0SePM6eUnIs3eKbA+ZeNec+LeY4GswHOs4+U+Rs1RHeRqZBf+ZoCQ7+EOBUZKOQ2ORQrUQOZQmGZmVOHqJ/IESsRKdWRw7WJ0/QLUCcv2MkSQrBQIBckEL+XoYmBQzUawVwB6GIWADEHGaiXyYQOiBiHvPCOCOSciG1HKXGZIB87CUCBMXgrITiR/ZYfcxpASGifyU5UWcOAWcKTGSKDSMOEKeBJKI8WWDKHOEsznYTYWbvRE+qJycbOrZWN8UgezXaP8VMQeXIEC/AWyUoSacQJAUAAIRQPRIQPAXcEAVwVwIAA"}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.amm.watchRebalanceSwap(config, {
  onRebalanceSwap(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.watchRebalanceSwap.md","from":5276,"to":5305}<fsm-vh3gqscxm4e>
type ReturnType = () => void
```

Returns a function to unsubscribe from the event.

## Parameters

### onRebalanceSwap

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.watchRebalanceSwap.md","from":5427,"to":5802}<fsm-vh3gqscxm4e>
declare function onRebalanceSwap(args: Args, log: Log): void

type Args = {
  /** Address of the user token */
  userToken: Address
  /** Address of the validator token */
  validatorToken: Address
  /** Address of the swapper */
  swapper: Address
  /** Amount of validator token swapped in */
  amountIn: bigint
  /** Amount of user token received */
  amountOut: bigint
}
```

Callback to invoke when a rebalance swap occurs.

### userToken (optional)

* **Type:** `Address | bigint`

Address or ID of the user token to filter events.

### validatorToken (optional)

* **Type:** `Address | bigint`

Address or ID of the validator token to filter events.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.watchRebalanceSwap.md","from":6134,"to":6392}<fsm-vh3gqscxm4e>
type Args = {
  /** Filter by user token address */
  userToken?: Address | Address[] | null
  /** Filter by validator token address */
  validatorToken?: Address | Address[] | null
  /** Filter by swapper address */
  swapper?: Address | Address[] | null
}
```

Filter parameters for the event.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/amm.watchRebalanceSwap.md","from":6565,"to":6610}<fsm-vh3gqscxm4e>
declare function onError(error: Error): void
```

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Whether to use polling.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`amm.watchRebalanceSwap`](https://viem.sh/tempo/actions/amm.watchRebalanceSwap)

---

---
url: /tempo/connectors/dangerous_secp256k1.md
---
# `dangerous_secp256k1`

Connector for a Secp256k1 EOA.

:::warning
NOT RECOMMENDED FOR PRODUCTION USAGE. This connector stores private keys in clear text, and are bound to the session length of the storage used. Instead, use this connector for testing workflows, like end-to-end tests.
:::

## Install

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/connectors/dangerous_secp256k1.md","from":727,"to":776}<fsm-vh3gqscxm4e>
pnpm add accounts@{{connectorDependencyVersion}}
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/connectors/dangerous_secp256k1.md","from":799,"to":851}<fsm-vh3gqscxm4e>
npm install accounts@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/connectors/dangerous_secp256k1.md","from":875,"to":924}<fsm-vh3gqscxm4e>
yarn add accounts@{{connectorDependencyVersion}}
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/connectors/dangerous_secp256k1.md","from":947,"to":995}<fsm-vh3gqscxm4e>
bun add accounts@{{connectorDependencyVersion}}
```

:::

## Usage

```ts [wagmi.config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/connectors/dangerous_secp256k1.md","from":1038,"to":1387}<fsm-vh3gqscxm4e>
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { dangerous_secp256k1 } from 'wagmi/tempo' // [!code focus]

export const config = createConfig({
  connectors: [dangerous_secp256k1()], // [!code focus]
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})
```

`dangerous_secp256k1` is a thin wagmi wrapper around the root `accounts` package.

## Parameters

### privateKey

* **Type:** `Hex`

Optional fixed private key to expose through the connector. If omitted, the connector generates and persists one for you.

---

---
url: /tempo/actions/dex.buy.md
---
# `dex.buy`

Buys a specific amount of tokens from the Stablecoin DEX orderbook.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.buy.md","from":138,"to":6276}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"514f8188da5f3aadb6f821b1369361f48b3a9b8e33f46d5689339bc21bc9aed7","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScAGYArmD8gmCcWJJwMACqYIxocEFEobEwiJxipBZKFJywvCyhcCVgscwARmQRJS2MShZoADrZrOxcqaTpWTmmUBC8CAYAsrFyAljm8JzipWjlypykMFj76WASxskQ0RucTa1knC0YVz0kyXRsliecF/fhMJwAjNZOEFAW8hIo0BEAHQDAYAWk4ABEZg1OPg0GgsA0APTYoiMGDMKFwfDY6azbGxATmATwbGjcbZXKUajiJRzZDIEB0cSsBQslhsDicYApNKZJlwTiuGKkCDMTgAcnxhMVsLADIlkyCioALAAmayKqrSCIDXGcA3Wa0221gEAAXQdom0+l1mjMihUakQgK0kl0gU1E2Z8gsVn+dgcpCcNHIiGk7k8ODwhBI5H89DwITCkU4vBMXALYGi3RKAGEhKWlANBcN81XuiyxJJ9AAOSOe5SqJAANn9Oj0eGL1ZZ5ksSH1UccznjiY81C8qd8GeoAWHhb2MF4MEYWDQJQAKjHhLGkgAlbe7/cs8lzEDH8SnxJCLc7vdoKHN11If7/ACs8hej2iAetogZ4Ps743mGE6ILq04xrOSBtkmi4pgYaZ+GuWYGHWwpGEkpgtlIvoAMxkUB3Y+mBAZDgYhEmGO4ZIAhID2DOcaTr2aGYBhPjpiyNC4SA+FcLAtDfq2v66p2CjUUglGsoOgQScxcFsRxSFcYgZG6rxS6YSuQnrgYcQJGc9yxBgADKGAJAAPJWJbdAAfEEI5lpwznVlUoy8noZCooxwhQhJUItNZdkJFCAAKjjMIFYxOY2SiuR0nCxXKzCMOkDnAAMnBFW+14Hpwj7Pmcl7QWgADcAyuK5AxgAFcCpDuVm2fZvC3iieAAELWVKmxtdujClrwGzMBA8RcN8aAQAA1oocAwmAAwAHIQDQR74LlnD7SN3X4HKkCxMNL7JKo4hcAA7uIkwxOwnCqH82xPnAZ6vgtAxtAdCRyLEsBQF8ySbC0cgzIt9wwNE7B/PsaCxKQ2S7JsRzvOkX7+uySCctytC8qsuBUAABuTuS1kMwqirw+w3TAPndFU6KYtKsrykqAAC91KDl2IFvsaqDEKXCijQQzs9E2Xc7z/OCzAAsOBYcDC2JIo8JdUoytLnOKjzbLy/D2IS2wwsDMWYgNi5SicAAvPm9M0EzShBAVyT5srwglMgpsQIe8BoJYaDOoVL0nm1wyou7xWcL7hJsFCjBQA6JSs1gQQRBQYfuA1ZrrQkm5HEsXAO+I905JrZyreFkVdQkHmpVUMcvUtigAJJgCUirWLQhq8FCg9/saYcLctYAAPJUt3vf94PUKGiPHu8jNJxT2VwaSjqgJGlUvZZ2HzDiLQ3DTbNnclJv2qKoC/7Gpw+/Z2Arj5+TpOOhQXL+cwLKebbCIuy/M6L+CUWTfySlKBE8UYyJTjKtD+XJEbI2ECyQ8+A3oRy+skKCpUgHOhACRfQ/xdSAS7N6DQA4IIGDrtFHqsErCaWjLGFwulUILj4t4LCq5hKBBzIwcIURLZFlShWVKVNRbW1HC6aSvp/xKXkuQxA/ZlJUPYqldSDDELMPjLqHi7DDICWwjw7MhwIA4A4BgKIK9Zrr06N0XoUlSL/F7KQhRIFZAqPoiAaxa8qQaKQKQrS2jJwGX4lwkyIk+ECLFGMLUuR8iFGKFsHYlRqhjSPnIVENw2ikAyl0HoJxxH1ivqGEAd48CLGWHuNYw1kkVC3IceAEIbpJC+JcTY2S7gPCeIwF4nAwQfDmpcFovwARAhBNYAZEJoTqgRMiWYacMRYkQLiFURISRkhRJSakOQCRwHpOKEMpgJC4xQFyHkfISaiWpmLGJjJHo6xlsqAkzBzYakOVvPUi8TT5wtFaW0AL7ROmkU49Qyi3E+j9J4oMHzJj+MQIEphyFyKhM4cZTMvDTHmMwFEI+J8z4nAvvcexJxHH6ENLYMhIE/yUK8Xi0+q80Cd3hcooJyL9SouXIJDF2ZQj8LzCUvIBRAZJLKBUKoNQ6iZMaM0HJeSSX9BFsU2FpTykLBLtUvZVwxW7H2I044pxWnfA6bKrpjxNjPEUP02g7wIRtJ+OkMZwJQQ2vBCcGZBc5kokWZiHEeIXnElJHebZjAaR7IObEo5Qk2QcnOYTS5Aobka0FVLJ5ay3mCp1Fae+ppzTYktBSgFNogX4MIZOf48jgKQspeBLxgqWVaORQBTlRluU4UxXKbFljW7jyJX0EAs9rC8CLSO0dY6i3/H7WSycZEPQQoodCvAY8O72noQutlOkOX6LCei9tJjO1kBxT2xQtjOD9sHcO8dV7r3Wn1FOkF5LpBsXnYgNstLAjLsnn4tdr7G2bpbYY7hplwCtXan8S2EAFADAKKQa2cBINJOcvB/kVA1UPnQZwUmEGFCk04NNKASw/imPxLAWpcBBQKDSZFJQBTbbYbeg4Lg+1yM5TkJIVuL10EDAAFLiAKDZOmH44MIbw9uBw2Q4AKmI8nGAINum3RgC0e4cpbrpDGGtAYaC/j4cI9a0WUo0C3QgKUHAtQJoNiGIMho6oABUPBMNIYQ7h3gbG4BSlujkfAonVDQClHAWI9gNhSiwyYBDUJIauwiKTKoIXhBhbIHKUgmdcNPhBrF5DMAoT3RRslzjN18xPhhpwc6smOO3XKDQDjT5HhbVgFCAAVn57YMBeRrTs9wTgShIYjLkJh+juGVYSASOB1KyNSsLU4OVnIb1jPIFJqYncbniRoGmFSUmDogjpz9ZAWAjWoTsCUJsikbGaBiDhEQfUuooS0GxOILAjB6RykW6tdEzA5AAGIFvwDcytmakINhgCgAMObX2ltiFgKQUg63NtLO29AGAe2DtHf2SdwO53LvXdu/dx7MxvtQlex90HP2Ie5KhOVDDXWIA9b66FnDBXkh/RKyDDzPmqQHRufU16mGdvFH63h6AhGNNgAAPo2ZswAdUkKjJQYvhe7T+JT6n9GvgtHq9uNAiopSwMIFAYa+xri7lerBy2uUaAnDkBgAYcBjqnRmlKcwy1ON/BaCptTPBYrtwM+gx4RxCQQxgFUSAsHJAMZgI8E3YgIQW4GOEG3Qg7ecAd38UIvXtroNg7VzLjXkkteYKtTgNkYCh7jqTSAlXXxE84O3bEE9odbZWdiHniOdDI+xKjs7F2rs3buw9on+O0Bvfe+IOEZeYBwiEHCIncJBBRDhqQAY019cWDn0fM4QuACi8bibFfI7sLnivQg07izhxA6o36NYtrTzLEWdToLkJDSb7A5BQEVBEeqYALRZV6KiO/D+jOkGfyqAm3Bz+0v2P2vwgFdkVF/2MwAFJVYqhFR/9n9X939P8dhcg04YB79jNkCoAgDjMQCqQwCMsoQEt2AghLBbpOB19IcKDFRxdCAzE4Aqh4Ntd6kRkQYHAsAcBLAX8Ig3881MoMCpRyDYNEo3M2Rk9ActgnBoZ3oOpgCVsEtT8P980ipaDEsShGCIBmDWD5Q9A9pdhOC0Q7teDZMhDY58tkAYBhVU5/xZFLDip8sBNyh9woRSB4hO40FcpnIeFgQedEAiBmByJ9RfQ2xfl1DnCuAJ5Vd1cPCvCwAfC4A/CAgAj4cgiQiyJrBpBWFIjY4NguBAjegyAWo5AcdntsQ6BtwqQkhQJ1BfRpAnCiprDbDQgHQ4RyszCyAlFEB9Q701CCj8s2i5BXChNKCMiSiUZQgKjvsqjaAaizhQJewlFrB8irCijJiThSiZij4LAqjhVhcdUlA+iyJdJ1QhFrgAp7YlRxdQ1etzwqcVYhBFR396MsspcghSZEQnxdBYMAASYAFqRKVwAAQiRF+LIFBNJkEMGK/xOFRB+OUDuDuPv04EeK6DizAHBKRL+NBIIK2BJwGDfnVE3yJko3Ok5ww1Jkczpxc3CGswLnPzgBILmjZwdkDBsma15BsgMMIFukzjeM3ASxuM5O5OYF5MSn5MFNZLwwwFpL+AdioOEwUChAVKCD+yqAS1hIX3lKv3C0gNv2wL/yf34LQPzXhMwLRGNNwNNIJNALAGYD1PAINKgJgM4HgPviQNNNQKEMtJ/xtMfwAPwI4wdKdIVLILoKS2VM0PoJ0L0NKAMNUA4PEC4O6L4Nf1hPQO/x9ljNIG0KYKxH0PYOMNTNMJ4MUFk2dA4wSwuM3GBMVNuPuPRKeKxNeN1IjOyzAC+NxLuEBIbLBIhORNIGhKzItJEJKF7Ng1RIeNbPg2xKHLxIJNrLADfmjVOXxnSCuWQHg2Rh3A23r1xB6FUFiBaChALGYEb3h0ayvNgGxAhipzxAxxu3MBaAFn1MawiEdFLR/F0n/GfSrQXVrUCHo3hRpXYiRR0msAA3CR5QMCCG12gCiAjJvwkM+l0AAH4Shqsqh54zEzhQhoFeRURqtkAHQMoiAIBk5gQABqf4L4dMSGVMr81DPqAwf0jjUmIgtAXDFnLzKg8cTLTgSpFYSjAMZoCEKUXgQrP6VINzWTKoPip3AYUsMYLgJnILJ3FIcoI+UgR4NCqQgHEGFPDYKAKAXZIQQ/DS8IUoU8sQHIWooQaDRJPzFgUNdjCbEHDA6IIIMiKLA8pZBvI+MAdQfbFvccWIG7YKyfKQ/ZYKsiR7XoaIKEMifvN7fOIILncSxKBEjYfXEyuS9IEGTy0mWouQKEFfG6ZLAK31BvJvVaJHYNdvNAdHLvLHB7MqtKj7MqyqtAXquEAMSID1Yk8mC/QuYQYRWaG4/8IUl0m/RUAsWaEoWAl/KoRa91c04QnMhsJazgQCDjbikgsLea9ag8e+U6scrahEkoU6kofapQ1bRVEkguQvP4ObTq3q6qmHWq3EeqsKw7JqhmDvZ89qkNcqgnd7Hq9gVffqwa2fZ6RfP4ZfaGlpIQbGVkDcrkXfHcFkIgawKEf4Am60b8h9RSXsKcKlH0JSYCvACLMCzsDdFhNhZMNFNtYxAwS4nBD8I8TBS6aqUqXqWYPACqT6S6EqD8dGstVhOdQC0Cd9SCK8D8emv9FhCiGC3ddm4ILFQ9btd6SqJIAACXCHwBKFJl7kBOONcHflYqFoMCNpJHtWTIM15rOGnV0mkFcVloAnloMD1tFrOHtrUB/XAsZp0X+FcHwQLFgCYCTVFBCm1g5gVCQMNgez9jVljruTiQTt1iTvTSKRpkkW6FTT1ihHfJtjeUuNFC5v3HZjLgri4HjrCjoAiiim6kbhtmbjDh8TQFPUzRvmtHvkfkPmPgZXPi7kzqOW3msDvj3gPg9k/SJR7j7iHRvVXrHX+CXiKk/VPSXv7jXv3oBX1CXhfjrLmsNMVBFqwVMJJEQHvmrs/D9qwUDpYpAFgXECQFAACBWiSCXQQFcFcCAA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { config } from './config'

const { receipt } = await Actions.dex.buySync(config, {
  amountOut: parseUnits('100', 6),
  maxAmountIn: parseUnits('105', 6),
  tokenIn: '0x20c0000000000000000000000000000000000001',
  tokenOut: '0x20c0000000000000000000000000000000000002',
})

console.log('Transaction hash:', receipt.transactionHash)
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `dex.buy` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.buy.md","from":6613,"to":7045}<fsm-vh3gqscxm4e>
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'
import { parseUnits } from 'viem'

const hash = await Actions.dex.buy(config, {
  amountOut: parseUnits('100', 6),
  maxAmountIn: parseUnits('105', 6),
  tokenIn: '0x20c0000000000000000000000000000000000001',
  tokenOut: '0x20c0000000000000000000000000000000000002',
})
const receipt = await waitForTransactionReceipt(config, { hash })
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.buy.md","from":7072,"to":7153}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Transaction receipt */
  receipt: TransactionReceipt
}
```

## Parameters

### amountOut

* **Type:** `bigint`

Amount of tokenOut to buy.

### maxAmountIn

* **Type:** `bigint`

Maximum amount of tokenIn to spend.

### tokenIn

* **Type:** `Address`

Address of the token to spend.

### tokenOut

* **Type:** `Address`

Address of the token to buy.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`dex.buy`](https://viem.sh/tempo/actions/dex.buy)

---

---
url: /tempo/actions/dex.cancel.md
---
# `dex.cancel`

Cancels an order from the Stablecoin DEX orderbook.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.cancel.md","from":125,"to":4919}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"8e63dbc2614d60dc2105888794c30ac7532f2a92ed7af97887d3f5dd42573f7c","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinOywpACSUKkARskWDKLa+gAc/bXKqhotOnp4q2SbXRZWAMwDjs6jxxPUXtO+c2oAUWsU4pBgvBgjCwaFSABUhsJhoIwAAlCFQmGlKAQXgIAwI8RI/gosEY6FoAB0pXKUjGtnO9Su1FatwM4MhFKePUQbxA9g+Iz66h+mCmBhmfiBCwM+XYXCMKNMtP0vWsx3kdUuiBq2jaeEVJm5r3eQ0+SBeAFZRX8JQDSjQZSA5YVYLQaUc+r1moztXy9WyQG7jRbTcMXIhKi8beKfLMHcCDAkAK5gElCaJEyFyADKGDTAB4MolkgA+IIdZKpYtZCicLCOZh6MhwVKG4SUt2U3hZmC5/O8SkABUbzdIcCLxSUpYiqSHpAgzEYcBgBeAuU4m5WpDWmx2ezAaAA3ButxzMbDOITicY0eSYSewK5S7kwOIm3AG5DM2m+3m09iuL4iAaS9nIcCcES25rJwCQLswnCqDA0FkNsEAQAA1pSuS5AAchANDwvgy6cCR4icHAA74AukDJhByIZqo4hcAA7uIjBoBBCTsIh+DIWgiJwAxYCIRAuTbMhFi8HIyawFAKwieR2xyLiGGcBJ3HgmSaDJqQeTKJBZKfiYMDUi0Sj4sgyAgHQ75YAopQAAbOZxuQulwwDROCzEwDWyR1vgaBoFgnCuLB8GcAA5AAAmxShLgA9DE4KRW5rDypwnk0OloXhYuUWxeI8WMEl7AwElDgWHAqV5OlhSee2EFhXB+UxXFiXJeV2VsDVuRLHEU6cAAvF5MA+X5ShBOuInRJVwipMg3UQHC8BoJYaAALoUKeAlEsZHCtplp6botMDpZSjBQBtqSBcFQQRNtM3uLkrgRDhaaguCcDJnIXAjeIbEcTw6Ydl2Pa/v2aYVlOdbTZu9wbFsnC9AATC8YCPa9uTOY5IBbdZDZDMwpSVkonAALTpFO1L4yAhPvqU9NNiMEGUyORNjnANMUNZ4I6XpphwnxiGCcJZKcjCkFgPJMAkIenBQMx4g01tZSeogqMMgoFwNGq1z6gY4PZv+vAhryYbmpGIoeL8saSoCjqBCEYSREUwgDSWKRU57aUFB7nSHBUfQvGc2tMk0+uBqTZt8gKZpCoglrfDbYrePbCZOkEWALjgHAYFECN7upB4HGrQca1Gmo68yAaBIXUBm5UFsJyjMZp/a8yBG+H5fshSwQAouREJIbtwAPMDViY4+AXieBC8hjn9wojmcMw0A/ch2fEJd8CGXA+QKArMDbMmShKBYZNL/xDhcCR+9LnII9oBAvEwLkABS4jDzmvCkBSo/j1XhCBweQ4AIS3kQHe8ltgYE4CxY+6kFwsRXOObCYBcjz1XuvQ+dA/YQTQCxF+n4ISMCSLwIo6VLCHlbO9AAVDwTgjlixj2XtER+cAIIsQ4vgIBqhoAQW+vYSCEFF5TwUJSFSk0IiOTrKI4Q49KRkAXKQe6K8iTyTkSw0ybE9KqN4sxH86lkJ0RgPJZ+cC/40FElLWB+FYCUgAFYCIEmNZgaD6HcE4EoFS2xQiMKvivKqEhfxuyyLpUx1iWKWP4i/ZAjkt6Qg4ZSMQOJkxoEchtIIt0sCtgSglSAsAnGUnYEoBKOI8QJUfjQMQ5MiAo0qJSWgCVxBYBKgk+AXNArMDkAAYnaRwlJEA0lRHUbkOJ/SuYpKURkrJQUcmIDyQUmARSSllKApUnyNS6kNKaS0tpC5EmdLQN0vpByOlTNIKQCIlIrzC28RAXxch/FiJgCvcGRjOAmPklwvhaTSJ1QEAZJCjClmIACVgqAG80G5AAPq0NoQAdUkPpJQ8KYVEWQvcx5ADD4PIcRCNAkUILM0IFAeiWlLDcLIKPZcNBDxyAwLkSiaZqJCCGRBcwGFr7IW2EglBPAhzrHwXxWBX0zrKRgHWSApBIJaSQrApYtLFBoAZbkcIVEaLss4Jy5CoQnkET4jKuxpknEURce+LmnAcwwG5ZwOJkArEZgmZwdYCUADyMzsm5PydAZZXNVnlLgBs6paBan1Mac01pCUJmUi6b08Q5MHUwHJkIcmEzyaCCiJpXIa8tIWE0swZiKJoVgAAKK0DsofOiF9X5eJ8X4zR49HKIHejjJxfUXkSIgJNSKfE5AqTgewOQUBIoREfHkzg859iHT7QOwhpBh11nMYMtJHb5HiMkUEXtfYB0AFJqp1kivO4do7x0JUnX/ahN0d0v2PVAJdRC0CpLQGurRijLnsCCJYFinBS0fpUZFBFhAIA5LrGPElNbfHyQcFgHAlgR0RDHbkCdU7qGcCUTxD8QldBS3kuUXgaldrfmXU+pRLawATs3H+5RqQgPoVAxRRcehiIGSg5wGDcHTHIfPVuSCXBkCy1CNdS0GtLTcd43xq1v8KSUlIKmdYYAhbLmLI7TgX7fWICIMwDWLwUYa2OG9CjPGtwGLddsfF/BZPycU8ROAKmAhqdBVp3k1hpC8gM+J3jBjQX7DIG+OQ0azkcISnQCEaSUQ6nUBraQnmTP8cE3IDa5MoktNzk0RAKMUaxc3AYhLP8/6S3U7ARAvm9KhEC7iDpIXaBhdvDqRoTRrCGco3FzgPnDx+fK4WiwIXh5yBhWIS9KQ0a8nev1Nr75kIjUA4wftnBUQPKqkISKj4r6Uh0WAIIjkAAiRJdAyoACTAG7jAVwABCTgu3lBkDO45JDRmL3TtSFd/bnAEWzaeQt3Y8iwAXZezdh9Zq1ikGxs5d65bK3GP3kC4WTCXlvPYTQ9BYA21wFfVwIZf0vF6BzOa5gOYmOEBYvdVboIlHDWx2gXH3l8eE4gMT+743mAYGYYAka36cWmVZwoIImO6xKPuzmlnnbN3bv7beodCGz2Pavexm9g6F33usZjoX3PTKi9nS/fdkVD13tPeJ1DnFr3i4V4u5Xq6wDM7V++5RX6YA/uo5+wDwGGPgeY5B8Q0HUuKFMaO+7KHL1G7tY70gtGXdwDA0x1QHuvewZ91dQHSixughOxTmbc2vtLbACt1XnaNtbf+4d47k3zuXb2zdu70vDeHUL29j783Fs/b++X0gZ3E+XNB7jcyllrIrlwFQZAY9dKQkyV6hZCVz6qGTNsbsi4fWFKDUshKykHkJW2RG8w2xSrrpNZEPGqsVR9EaCjKu4ddSsnaC8s2NQ47hlGNYNu/x4ydzwEEEl0AojW83VhoqMAAD8qQRIGAdYlIoBIGt4oQ7MFqgBYAGAyAG0s4nARAEAl0amAA1L0CsLMCpJ7hEDPMBNXtYo5CuuknAtwm1vbt0KZJwAALI/QCD2S6o6DJhNhobvIST1jhArhK4/I8JIS5BJDjhcBfLCK1rZwsCSCwI/44bqKQRzae5QAcQoh+IiHhAUTT5iAcThZCBDyhDJi7z3yzZPyxLxKB4JBBAvDSKj5zLj6FpgDqDFI6CVIWDJhNJ2Fpq/5Bp2EvCBb7AJCUgvCxrHJyCGZBDAqtAsHKrkq6pzYNgcIRLmJxLhZyCUgFrMSqLWHBTepLIrJOGBrBqrRho7KRolTJFBEnLJFpFoBVHkytCRDXKtrOTtofTuxFCphY6Wik475do9oxDtGpC7ojp1h9GHj+7nrV6pAjGXiWiA4kGvoKKi5TGIA65tGjFV6B6HRLGcAzHWJzEo5g7I7WrIRJECApFVEZGzJZHj45H+p5HrJVKFHr67JRplFxo9KVHsCFrVGfHMS1E6CuyaRYJ5qJA/G3hmQsgWRIBWRlBST94gBEDWCUi9BInWDWD76Bx0i9DqBaxagND+gX54CSLX7NwRjJyTDtzP7SiX6tH1z7jnyHgejly9DSA1Bhzajn43B1w7gPANzyDPDMi36WxWiP4GASBKClAnaEndqMl0gozWA+hskNAMiOx4CgQQwKDyQIwurbapCozoxmyyD8iDB35IAP6qwxCwBMAAqZTAy3hNR5QIRHpFSJRLQ1TuQ2mky5QtSOmUjb5ZC9QtHLCeT1x1jnj/xhT/SAwKggxcxgxgQmzQyeywyni0nIxowYwvSGbzEbrdpbpqnZgakoQyrrA6krH1yGalDMziBICgABCKD7xCB4CcQgCuCuBAA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const { orderId, receipt } = await Actions.dex.cancelSync(config, {
  orderId: 123n,
})

console.log('Cancelled order ID:', orderId)
// @log: Cancelled order ID: 123n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `dex.cancel` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.cancel.md","from":5259,"to":5628}<fsm-vh3gqscxm4e>
import { Actions } from 'wagmi/tempo'
import { Actions as viem_Actions } from 'viem/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.dex.cancel(config, {
  orderId: 123n,
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args: { orderId } } 
  = viem_Actions.dex.cancel.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.cancel.md","from":5655,"to":5789}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** ID of the cancelled order */
  orderId: bigint
  /** Transaction receipt */
  receipt: TransactionReceipt
}
```

## Parameters

### orderId

* **Type:** `bigint`

ID of the order to cancel.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`dex.cancel`](https://viem.sh/tempo/actions/dex.cancel)

---

---
url: /tempo/actions/dex.createPair.md
---
# `dex.createPair`

Creates a new trading pair on the Stablecoin DEX.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.createPair.md","from":127,"to":8783}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"898ef8c60c928fbbc1b3ecd918cdf0c00d4ac080a78268a8148b45b02b060db9","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinADWMBipAAbWtAAkwGKkFkqum6XlUogAHP21yqpIAMwtOnp4axhdFlbPIPaOzlGVwm1C8018c2oAUWsU4ACNwjAtjt9odjqdztp9Fdmnd6khKi82ngEXBcPJvk8BgCRn1HiDMFMDDM/FCFgYllwAI4AVwgNGRewOaCOygxoixMgATPI6g9EABWIlvAy8/nksyUxC/f5DQF9cYeUFMnyzUo0dl/WGkGC8GCMLBoVIAFSGwmGgjAACVbfbHaUoBBeAgDK7xO7+J7ODa7Q60AA6TEVGSyPHymraYkGGN+hgUnra6l62mIKWNBlg5kQ83Qgz5dhcIye0wXfS9Xo1BT3BoZ1oqwyRkxfAs6wbDFyISqVCsmlmQi2BeuFWC0JOXXpSpVphq/TP9lfDn5F8ejBVSmfeOc1y0JHlgQdgaI28Q0AAK4kYpAAyhh7wAeDJEmSAA+IIOmSVJAKyChOCwRxmD0Mg4FSJsTHjFd414Z83w/b9f14eN3yGBCRjgADiiUYCIlSV9SAgZhGDJP9gFyTg2NWdZBVREV0U2ABuVj2NJJFOG2IU0TFfjBLYtUBVElFhVFE4pMfdiczjF03TgD0hB9WNHQEsBXGA3IwHEBC4Dgu0nxgF8YHfT8f3vAMgxDEA0mw+BOHEThLAAd04EVxCgY5YNwzghEC/AYE4AARABRAANeNclyAA5dUXXwRjOByny4Hw/A6MgHk4G8h8opfTg/I/NAyoSdgopioKI2MR80AgXI4RiixeDkHlYCgCLHx8uE5CDFZ4RgBqbWjPQeVIPJlG8ubLJMGBExaJQQ2QZAQDocysAUUpNlOurciXLhgBsuyoOSGD8DQNAsE4VxOASOjmE4AByAABGqlAYgB6GIbW+i7WAbThrpoSHXvez6fv+8RAcYEH2BgEGHAsOBwbySHCmu1DhHhj76KRgHgdBzHYbYPHck5IogKUTgAF4bpoO6lCCFjVP+HHUmQWmIGdeA0EsNAAF0KEElq1o4ZDoekzghZgSH40YKBJdSR7nqCCIZdU9xclcCJUvva14B5OQuHZ8QasYRsHzgdC6EwzyHLw+8wIomDebY4TUm+nYpWsAj43jdtvsN03clOs5pb2uDiNKcCWYAWnSCjE0TkBk/M0p85IpDOEzojzMQ0gXZAXObTQBbhFKZ1osCrSdMfdTHW8sAhpgEgwC4KAX3EHPpbKSVEA3VMu3xSfCWoPt2g93CnN4Q8qT+Md9UVcsjUZS9q3mQIQjCSImeWNPIIoiGCjiCi1zbKdZW7JBcT3dp7/zI9N5pCd1F6C84IzRHzwEELAdEcAcAwFEQOnBsggBDmHawyCUGoLQegjBmDejwIfn0BUuIZ7ynnu/EkiJ16TmPNvc8e9KymlZAuPAZkLJWRiksCAChchEEkOfdhIlAJwF4S5YMeBm4xU2GwhQmxODMGgNbGK4DiCay8vlfIChOCwDhDyJQShQoSOag4LgOU4AsEYHIbhHUmq5AAFLiC4V+LCcYeFqIQv8PIcAvoKKIEooacIMDVRgHCeEdE/JkirilMAuRRHSNkWougt8ypoD8hATgllbSMCSLwIokNLAD2QubAAVDwUS/DeFSL6uEMqflHb4GkXoQgUAypwB5PYbyZVxEmF4fGca3MIibBgu04QnSyB0VIPrKR4YhoDIEQoeMNVFpjMqnEcMU1OClRgENCxfkjg0ECsk8MfiMqwHjAAK0aSKWyzBwmFO4JwJQ40ERyFEnoqROMJD3lYRRBa6zdnVW2c1ZJyBNgKLtHAF2YhAw8jQJsSWQRdZYGQkDIGkBYCnPjOwJQQNAzBiBmYmgYh05EClJUeMtAgbiCwGjYF8AXaPWYHIAAxFS0F4KICQqiBM3IgKmVgrQLAUgpBoWwqevCxAiLkUwFReizFrkcV2XxYS4lpLyWUroiCmlaA6WMtVdS8FwyIjxk4FEu5EAHlPI6ZI6IyzuqrLJENKpqhWWGIJgIZaqgxHisQM86JUA5HhNyAAfXyfkgA6pIJaSgg3+qyjFY1pq9ERThMc20aBvplRIvUsqkgYqWGqWQc+jEaADzkBgXIBV7xFSEKysq5g1hNSCRAEJebuCvgAJIJOin4m0ZJmBjRgDBSApBvKzTdX4pYBbFBoGLbkcIhVipVs4DWmKoRHn8mioOw5G1TkpPOeZF2nAvwwH0TFQFkAdmRW5ZwFtQMADygq4UIqRdACVLspVYrgLKvFaACVEpJWSilQNuXxlpQy8Q6dT0wHTkIdO3L06CCiDNXIMjZoWBmswF8no/VgHirQQ6ajSqhTdbc+5oQzWDMkYgc28dTkM3NRtbpQRvrRTkONaq7A5BQG+hEQyiLOC0QsHVHWMBmPJKSaQdjMELEsshTRsjdGIDc0Y0JljABSXGMFvqifY5x7jQNeOigE5wJjLHNNQAk8kqTaAZPTI2sM9gQR/KcHivyuz31g2EAgPCmCAj02hQRENBwWAcCWA4xELjuQeN8dyZwWzg6LLaV0N3Ia5ReCTSCtZSTvLhkUbADxtiTmRmpDcxADzcAvP0Tqb54KhnyVBfWeF3T7FvJcGQH3UI2sFSTwVPVxrTX90OMdPGUgd4W1gGboxQCC5OD2afYgIgzBJ6PClJPK4ZscsNfYlVa9ibk2DeG6N7KcAJsBCmx6ub2prDSG1Ct7rjWqoev42QMycgAPatBUDOgtpIWekQOodQk9pA3Y2811rchJbpy2TVsgTRSxSkB2xKqIP7FHC7tN2AiAHuLVCC9oM1L3u0E+21H7jQmjWFW7loHvkZsY6e0DNDFh3tcLkP6iSKQpSPG1ObRmTCYrs1c6Yx5XoTU4yEN9QyejZlhqCJsWK4ZdCDv2Nz1wABCOKsuyBK82GFtben+OKxl8oPNwb+ecEF3CYXYAVf67l0rsz26+WkDjqdc22HcMxXw66lumwSkWvKaC7LjvNjUYtsILgjq2a3L0F+HdzAvzlcIH5fWYvYTDPD20KPz4Y9x4bYnqzXBmAYG9zz3yMAAri8L0ER1ME9WGUQwX2jXT5MMaMyJtjIWdM69yYJ4TrGxOmZ+Y62vheG8Keb5wVT0cfome091yLBnR8mdtwPsA+eh8xfsyXxzznRmufc55lJ5XVCVf85D4LnGtcRf04rZA+X2CFd36V/fPnlp+eq4FxQ6zpY/OGZz2E3Pw98+YxNyF0GTAFF0H3rzmTAClytzzQVwrmV1VwN1IA13P101nz1zV0HSN0ANN3N0t0wJty/35QD3NBRh2j2jJA1GQAEQWjtBhXvVFSBh0VUB5DhEwnokfRRXfXFSBjGhNSBgVV/XMDhHRlkxOUiBrjHlbCQClA3Gflnl7FeA/lk3IRqF1BPCQGsEASrGATZGPnTWgCiCH3ozixRhgAAH5Uh9kYII40VHRPRQhy5mBFZ9lkBJZqJOAiAIBNYpsABqXoCKWYcaYKCIIRNydAn5TYCzKRe1GpfyboDaTgAAWWtgECOiXR0B5AQii14CtXkQqXWRgliMsSAiri4DWSGnCDrXARYEkD8VMISwmW8kAOChCjahIwqNaRSVYLEEdi+yEE4VCB5C8mMQYjMUHQsS5X0wSCCEeF6XoOFUYLQzAHUDRR0BxQsB5FJWWOgzMPfWWMeBe34wSHjEeCAw1TkFWyCEI1aCyInUzVmmXTClBW+UmM2C+zkHjFQxfDGQWOegfXFUlXWLfQ/TFm/UVT/TRg+POM1Q+O+LQHhPTlaEiH1Uo1OiD0ZhiDvFtk4AVCTzEPo2+ixIHlSGUw4xgmJLQFQI7wM0pNSCVB+Qsys06UJLpIn0pOpPQNSDpNxNtyZLAHjnNgPWPXeIEE+PhN+KFX+MYMBJfWBJlVxTBMEKVX/WhOA3pThPYDQwRK1JfCRJ0DPhmmiWQ0SF1Lak2gXm2iQF2jKF6g1CIGsEjkjmQUkIlGTBh1sG3A3hIQMG6VUMoRLGBBoVnEPj0JhBDw4g2HknEh4kklwVLEeE7DlB3GVECA+H9J/mLAnE3G0LoXnFrHAArksicA+Vk0GMHT0SvhUKoDfREU9y9RkR9TUU8SUUzRSVURig0S0R0WWnjVUCqiMRMXGJ+TdWsVsXECR0cXjRcQcDcQ8Toi8UGnhD8T8gCXrUbTCXNiiUbLkWi1oHiUCiSRSRwF4HSUYEyRiGyXuP9zAGuWKVozKTMVBWqmqVqQdQaW6JaSqKmRZMb16X6XFzX16US1I2swl3mWAv7KWUfGtU6M2T+R+X2U4A3XEO3QzyuSKVjRIx/ItVeXDGsjTi+Q2REwQreMA2iL+JFTFSfSBIxRBMVPlR/RVJVRx1BRhIZW5Qs3ZR7k5SBVex5XtzvWFQBJorlLooVLlS/WVMhOxzVXYq1VYtBUy35X1UNRbiwseRwpgDKTyJtW+ViLD0ugI09w9QbJiQ2nNkDRDTDWOEjWjSIxNRI3jRNSTX4FTTfIzSHWzXtDdQrJMHHSLRLWEFnUrVKgXUYFrUIzhGCVCR4FbXbXWFWjVl7X7UaizSalHX8rEAnSnTMjLXsDnTCsXWaJXV8uQqfVQsOAuT3WFLrRPXVGGlgn4svRvSEulOoq4LWPEuxQYqkqYpksA3VNA3A0gzAGg34tgwgHg3YEQwxlylNNIG1Iw2dxw1YDw2MQ9xjWI00ueRvKozgGZJmUJPn1b2n21y5MMyUxb17z5N5SX3F2OqurHzU0n1Os5Mvy72M1b1uohUs2DzArXwcxv23yKxKzKyfxZhfwC1qxC3et12iy31qVBTMJAuS1Sz1H+Ttyy0B2Brv2Kz328wq2fyq2hvfygDh16xa0Z3a06wpqqknIGyGzABGzG0OyEEm1RyRDO16EW2WzJ3W3hy4C21coTCZpZoOyO3oBOxmzO0eAuyu35p6zuypwHkeyx25TxwJ2+1+3+zpuB2pvByGDf1IGhylFh211uy4ER36y4E5vR1Vsx2ew1o+14H6LACJxJ0VstspzR2pyxzpxyxB2Z1jNZ3Z0eB/wjL/152wIF2AIEVAPxLAsgOgMwM4DgIQgQJgOQM13bwuqzs4BjqALNxAPwKQMIIy3twDxWtdxtWMrEUL0fIqT2vRIOv+tD0hVT0j2j1jwQnjxzzboRsHXZjT27qzwTy10ZhX1o3DwczL1owr0hSrxUpr2XzrwJMb0U27ynzhs70uq3u+v72k1XuMI3tH3H3U23tzo+r3q+pusPr+qnrEMBo32BoY1BoJoP2ymJuPzf1P1Cyvt10FlxoLvv3BqJshpJpPw/1t2/wiQHqjp+kLtwJALAOPogMl2l1TvTpgEzoIJzpn2vvzqQbjqEFLutxgeIIFNOlIKtJQAoMPVKGoNZVIDoKlKoqYOqVYPYOYE4OfV4d4PuQEP6uENELAtOVCMlikIniJRlC9J+1TPDOs3ISuADInC0ODIPl0IYQMCCAMKgCMPrxMOpTMMsO7gwBsIjg83aLkCcJcLAAwDcI8K8J8KCH8MCLIGCP0bCLwAiIsSiLushRiNfPiO+ANRSJtgdDUVuOyLqktRgvyJeL72KNHNKOWE6KqMIxqLQ1IHqOMcaJ7hKu8igDaIcMeXScaR6IEHrjakGP6hGKHPMQBT4uONmPmLYaWPDFWKlW6C2Np3DF2N0H2PDEOJqIHhOLOOAyuJuMyJiYeKXUALgkSZ+UBWhIlLaYYI6ufS6ulR6skvBN/WVSBjVIuI1LFPhMRORNC0w32tzyKGxPDzxMOrkwUx5LJPZNZQHh3tpI+adF5MZICb+oeo3rZIpJ+a+cVh5IZIrqX0FLgdqpWbFK+LNMlI2d4dop2ffV6v2eYqOcRfVM1MWpfAuYNOmtizmpQzNIwxofINtPeVKAdKdN6BdMkbdMuE3E9MIRTIXiULwD9K/iQBUczI0OuFzKvBAQ5FhFgTEm4iUnFHHndLLGnmTIJAUYMGEmUdUdGClHUFFdDO0cLOYRLKcRgHLONarKUZrNcjrLETMqbPkQXNbJWlGPSPUQCW7N0WnqgtykaQaYmOSRSZsTsRtuNdqVcUYnnMUSXN8X8UCWiobVCRdi3Jbh3NiX3IbASSPNSVPIySyTYByQEwKSKS9wfOiCfMqVfL0Yqa/LaSBZ6T6VAqGS3wWSaK0vAqgMgoMTiZWTgpIsdkxqQpQq3SqvMgwpuQ0obdwpD3wtLKyCIp+S2T7eWb4sUvjAorYZEs6tfQks/WxYGv4vks4oBe4vJrACmJXd1X5TavYdlO2for2eksOcGpOcPft1UqNW2one0q7dgttRfIdQ7qMs2tElMpLZTYsrgastDUWlsvySjTUq2scseWcu2zcrTTqWgDmeL1zT8uEACsnSCvyorRKmrQiqPXXNiubTbQyqSp7QUFSsHXSpHXzWysCunUI8KpI9rSeNXTzUHbOQzxqsPTqs2HA0aovSvVvUoo3a2a3d2Z3Yff/Sfc1WGvVFGvGsUsmtJdmpNPhOWrgZdzWrdw2pZkI3Ha0s2GbsD1btrabyesvoIcAZvuuvE3+d+qeeH1s+73Ptet7zOov0c5OrvuhaPsAqbaBqbZ33xof0JsP2/tfxhrPwAaixiyRviyXQKbRtbiNYruxots3wKxAai7Adi4gZ/phr1pVhBxpt6C6zy8Fr62R1Fr21ZsltttO3mx5qW16Guzq962Fp2zFv23G3ZuOzttlvlseB6/J3q/uwdpp2dvx1dsJx1t6AB166qipra0NshxNuJzNoq+tsa+lt9rm/Vv4s1qW+1uJ0aFJwq9m5GBpwDoZ1CGDqUgTI5zga5wrn/2IeLvjtQfF2TswaQLTuAEVzIfV3wfOsIdTt+7wMQPIdc9gdhdyAM5dfdxM89wbtLabrRKs9ubD2Hq7ozx7pgD7onuT35U7rQHTwuVJ/J8TrzzXusxno3zntkwXrQCXtIC13APXpHzs7eqS7n0F6C+SSX0frAseq85eo0yF4c93sC5c4sQl+Z8bZGXXwClfsi7Bsf3AfhEgd/vWUS4V4M2vy3zxt15i6/tK/i7Js/wsVgduYQYANjr+5F0Mkl86SB/zuwdwbLqh/893qIeN2Qfjoh+QIoYdyobOC2hpcoMYZoJYZgCk8YOYPwC4cvLRe4KfQEf4OkpEfF3EddPlbZfUC3E5Y0FVatGrM1ALFTHUO3nUcmE0foQLN0fQ/0azn547+Rt0FMesM4FsKsdKdsasPsccdSGcaGlcYCIhE8dCMteEQMF8eSX8d+qCdUGLz8gSLCdSMiYyKUDuJyN0sWdtSKNfJSaSDKL0sqISqatqJydS5RqaKeNaMdlKdv66KaThF6Oqc9FqbDEfWYxRpirGaZjNWmV7DpisW2Y9Nti/TOCIMz6ZgARm0xU4uxSmYtxom9xLyoUzP6vEmmqzZFus2EoylRKt7bdkqX6qHNjmsJM5maWJbbQrmePDErCEpIPNE6v5F5j81JLkk7mnzYXhCx4F/NgugLQxsCx4HvNsS4LbksIKhbmYAWVdOFkJwRamIkWhLNACi1IGbN0Wd7eTtQNVJ4sTmBLbUowMNKNQkMPUBaktSEAWkJAtDG0htTtD0tHSvQZ0tYBL7SFSwVwX4JX0LDcsswZgeTOQgb5bxAyurLRgWUZiyQRI0rRSLxHjJy1fByrRUNXxiEhDNWMhYEGPBiCwAmAzqaGDwGdikxEYGmFGMDGFh4xLohQtOCUPJjfR4wohLIPTAHrXQPgMEYSDBBiEwRO4XAN6HbAdhOw2oLsDCFhFsg4RHI+EH2MzD9iCRYEwcWgKHF4CYIVhqwlYb0GjgmxVs7nQkp7EjKIAJ8HwVbDZ2+gAAhRELsjWDu0J8wkY4eIIUwABFPkDsg6hXCDhXQ54TAEX4gASI4gJAKAACCKBjEQgPAHVBACuBXAQAA"}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const { key, base, quote, receipt } = await Actions.dex.createPairSync(config, {
  base: '0x20c0000000000000000000000000000000000001',
})

console.log('Pair key:', key)
console.log('Base token:', base)
console.log('Quote token:', quote)
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `dex.createPair` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.createPair.md","from":9127,"to":9545}<fsm-vh3gqscxm4e>
import { Actions } from 'wagmi/tempo'
import { Actions as viem_Actions } from 'viem/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.dex.createPair(config, {
  base: '0x20c0000000000000000000000000000000000001',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args: { base, quote } } 
  = viem_Actions.dex.createPair.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.createPair.md","from":9572,"to":9801}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Key of the trading pair */
  key: Hex
  /** Address of the base token */
  base: Address
  /** Address of the quote token */
  quote: Address
  /** Transaction receipt */
  receipt: TransactionReceipt
}
```

## Parameters

### base

* **Type:** `Address`

Address of the base token for the pair. The quote token is determined by the base token's quote token.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`dex.createPair`](https://viem.sh/tempo/actions/dex.createPair)

---

---
url: /tempo/actions/dex.getBalance.md
---
# `dex.getBalance`

Gets a user's token balance on the Stablecoin DEX.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.getBalance.md","from":128,"to":5553}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"2cbcd8f2e4514b44f515cfd59cdc515095e16ac4e7309dcfa2a7dbd7df793943","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinABGoeJgvDCpK8kWDKLa+uqytcqqGi06enhrchtbXRZWAMwDjs6jjRPUXtO+c2oASYrHYXCMgmEpXKUjGAFZ5HULogato2ngISYnj1EG8QPYPiMkAAmYk/TBTAwzPxAhYGfJgziwWjQo59ax4hTnBp4tE3AzM7Gvd5DT5IF7Wcl/KkA0o0OkgBIAV02xjAnDaACF1psYAAeDKJZIAPiCHWSqUNWQonCwjmYejIcFSmOEADpmW6tTqtm6AAr2x2kOAG4pKY0RVJ+0gQZiMOD611wD10L16bX3XVugBKeiVpDAADVQkqYMbcmBxA64Hathr0z7cFQoBBeAgDABxPRwTjiThKhOkADkPbQEAA1opVo3OEJOKoYJwACIAUQAGm65eIlO3kMgQHQq1gFKUAAbntBwXIMwrAaKkGDiGhW5I2/BoNBYTiuTgJGPMTghwAAQAd23OMAHoYgfIdr1BW95xgUFv1/f9ANA8DGCg9gYCghwLDgWC8ngrg7yTFC/1jdCwKUSDoNwmhQSI3IljiMNOAAXnvR9nzDIJgFyThonw4RUmQRi2AAFXgNBLDQABdChBPnIZhAKS9UgE9UhM4cSkLYN1GCgeTUnfT8ggiJTtPcXJXAiXIWNiadMzrLjxDAxhwX4SFk09b0XJgM0wxtLShKcGIVTQVIh2sWg3XiocrKEsdJzAaLYuJaxeHit1el6RLbPssBz1PEBFP3O0hmYUpzSUTgAFp0jDTdypASqq1KdqHRGHtGoDKqg2TMqKH3B80HzKEqEk/BFwHMgR3nCcpzuB5FznBdl3XFrFLKNlEF6awai5ep2SudEDH81ahXFEVhhcXFKilSkfFmOVgQMEIwkiIphDYo0Uia/64PUn7OkOCo+l6AAORFuSQZpqFafl8TDa7cVusVEEqOEnu8alAXlQIgiwGMcA4DAonCiBItSU9YoAEmAMRSAsJRXFPTgAB9OH45ShN4cxFCi9JBbANA9Uk1SazBG00hErn+zAWAkksKAQr5nSwqgKAHzgZ0eG13W4AAbg1zXIF1ABZDZtzIAB+VIADkhC2a3K10UgFZVZXnigU3tM1oS4GSMAHZ54nAx6zSzcDoSHDgfBUgACXCfB/djoS7M441OGjWN431JO6AjL2lZgFWYCgUufdV9OM+DpQwG4JVVHYRgAC8n0hMOggjgao54FvCBZzu1VzABHUsxCiDic7zuMEz1ABlEPm9bkeu6EXNxoLSSvBL7nvfL33q+P2uY6DkPLfgOBbdSfjOGrW/dG/aOA4zoSn7vzgV8b8QVgUNfPWts66xyzrPXO/4C56iLrQY0oDA45U4JUR+OFOA5QQZrCk2xODZDMK2UIeCEE/m5gAKTgFvLAvA+ARTFqfCuUB4EayQaSVBD50HxQQRQ/MWww5HwYf7H8AAyTgdNaCM2ZqzdmURuZIMaGwxcSDuZBDERItALNlDs04CI0KOkMGFVKC2NsGJeC0K4E+CQ9hK6LXnDNaIoQ5A82YHAJQboExl1IBEN0DkwC5G4IbG+s4Ei2MXFTSKm5wawl6BKWGJ0URnWRmEsWaNKgYyJIgMkHhfjPXxm9BUxNSZkEwFEFKihaYMyZuoqRpVmytnbIYAJesgkhMWqlCJu0Ib7ShkdJEDQESI2uIEUpYA0b9IJKKdJmTJh41lPMQIlZqy1kXEsCAChchEEkD9ChChLQmFWU2EARj6nTUXKeFZCgObMGgEqBQtoYxECMvAXsnBg6sFubAFYSolBKFZls/ZtinycHjC8lgjB7iezHCE3IpDxAbKXrwFmWA/rbMXA6AkeQ4AARJsQR5VcVgYE4CBGAKxVgxhAoOZMPiTmoKgDcxcdB1KjhAhAF5OBeCMCSLwIooJLBi2dD4gAVDwURhoUUcwFuEHsIFPL4EfnoQgUAexwCVPYXsPYzl7IUG6OQEAlAWVPDaDVwh9lujIDGUg+rexK1EecmAbowIFktaoQFvANirFmgmKukKQIsxoDYjYBLnawDdAAKyVeox8zBvFgCFdwDUOq7g2s1TADmBEJC6lBskfM1jvW+sXJC5Ap5sVbD1m4tALYW6nnkkEMyWBnQQQgpAWAYa3TsCUBBI5EF7g0DEPVIgxJKhuloBBcQWAsLFpvm6d8zA5AAGIJ16zEBWtAlMla5ELQu5MS6zVVprR+OtiAG1NpgC2ttHa6ldqfDJPtA6h0jrHRBTdU60AzvnTGEtety1mq8ZwalSgE2hCTcai59j1QrA9dY6VrcW5ApIr8jap5j2IFtZc65WqfEAH0BUCoAOqSDyMobDGHUh/oA4421s4VghpgPwBa3UFU9kkIuSwMqyBbPjDQMWcgMC5DgBgTY+AYyQAHJwcwk4WkrDJYOHgfoACSo4ZoEt1khABMAbSQE9kxkJBKlgcaFtx3I4R+P2CE9THsYnQlyEcRABcnsg12rDS8iNVZkw/xgPmuxhbIB+rnJuzgsmIIAHld21vrY26AJ7kxns7d269/bB3DtHeO99k7p1zvEPVbzMB6pCHqpu+qggogJHYLkK57CLDFdIMwTeYBo25BXLQI8tyBzwbsf+iAiajVisQD4kqYbHLAbtTqvVQ4ZpWZZcy0gcgoBDgiP7BtkD9j6zGzqwl7Bps2khUu6maABsou1bqoIo2YDjc4AAUkIjaIck3puzfmxBRbfLTIndWzdtWNjtstz2yas17AgiWBApwFcpBzVHZw4QCAdabQUPo78tYVcHBYBwKrWbc3cgLejEtzgv3PZfxfhsKu5ReDjhUk4fNLLt0g562ABbQlgfmtSODiAkO4DQ9jPKuH4gEejuR5XdHD3NaAuQDADZcgTJwn2nCfngdAXwsRWgN0pAVSybANNeMhpCY8yQ0QZg+0XjEi6UVWnOlAWBaozRhXSuwAq7V3ADXAQtcRcQDr3E1hpC4ihkbgXJuuBIf2GQSschH0pb1hBOgNGW6QhROofa0hpeC64ML0X8l6o+p52QJoGTiTx599j0XcvGBIsd7ARA/uCyhGD62G+YfaAR7VCiRoTRrBe5l77p3ZfA8QWqxYMPouMOSOUBkl4uIfGsU4AsxcXEhw4bBY47MHWCJCCHP7W19r8MqKXBsD2nBGYT9cAAQmXFvsg+/Txo5pw9zHT2j/KDYzPqznB5+7GNWAQ/m/b+kH35tinX6Qe5BKj4g1k1h6q1qcqKvsuKvcHrNTv/ueP1psE5DtpxPWGgEvM5swEvOzoQCBBZCvk5GasgW0GgQ+FWJgQ6NgbgXtlwMwBgOAbclxADn8lqnQYFDtjaN+v7KVrQcmgdiNithNutjNufhjhohpJwPwWtlNu9pCjtlwSwbwUdhIRdolIBG9ndtLlfmIRIW9t/rOF9mADQfITjv9jAIDvTn9tPhDlDi8uzqoJztzkjooJXKjvdo9mIcgOYaQIzlYazjYbDsoNOA4bzsZLoWaqPk5BPsgdPrPo/gvi/svnITwQ6mABvsfp7LvlWDAAfjfh7KfsIZfqIfrO/tvvfnPnERQq/jkSfqEX/sVOeFuDuEgHuGUO5qUMgNwqQFsNWqFoehBD8qoEqCsG6DEMwOFs2nAGMbhAAh1hBPFneuYCsNhINqGpEGVDtDCPoAOqkmcHEqiEjO0MmmjDDPiIMHdKMJKFktgv8K9HMngEEPRtAFEPIcNvcTfLbGHAGjaDlJDmqKEP1C5qkAGsgPJJGJwEQBAEZDzAANS9CzizA6pc4RCGJ1J4CaGjgsqnifZoAcxQayoA7dB2qcCWw3ICDHihI6BKgOh8qgbuq2iSqVw2i4lQpGjBhcBzRVzhAtIkwsCSAEp46hLWoOK9jayeSQiAbslqovKDFiCeSR5CDrIlhPKvJgqbIFpFqiEJBBAvARAhb7q9HVZgDqCto6BdoWBKjDoGl5a2wTEGkvDB77AJBugvDPozpFRBAbStCUlCyMbsJCl2h6w5osqFqR5yBuiVbVZoD6rdH7phbHqnomkxZXq9pzGJYPohkulzohnhlPjZloD1StCRBeK9ZwFXgIG/RFCRTIFwh4HLEvFDhmKpBnYzY2hmL5FuH6wNmcAIgfblqyFln7Z1kNkqGtmuFompCdndlba9n6EAG+JgBLzua6Snjpm5lRl7qfixkRbxntqJk9p5kpn3pYTplpazpZnsARm5n5k6DfSVYKJAqJDnk1btISCNEoD7jBy6ilBEDWC5S5TWDWBrGRKbFwjEixLIi8j7F4DDZHFpL3RQy4zXE0iEyLBOQrS6g7B7DJJAUkjqCgU7HIh7GDK3CNgwUnGEj3TEjwWXHSiIxKClAT5QW6qsidKUX9D4UNC2C0iBCrhrjOSrSpAHT/lCVCUjLyDPCnRkUTL3SSg7QxCwAgggxkTeQmAURoTXaYQQQSQQBEQ3ikSZp1Q/iUQARDhuhLFZDMT9lcBoWuS9geReRqi+SpiXS6hBT/TqzaRJLCwxS0DqCVDEhQAvBwhpC8CNCNAvCVBpDWBwj67SDEhwjiAvArBQyVCVCai8DSAwDqBwjSBwgJDWArArgrArAFTaTDLpS0CZS8DCXVU1W1V1U1X5RWR2ThG1mHZDg8V8XoUqHWUwBFSlDdTiBICgABCKDBxCB4CXggCuCuBAA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const balance = await Actions.dex.getBalance(config, {
  account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000001',
})

console.log('DEX balance:', balance)
// @log: DEX balance: 1000000000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.getBalance.md","from":5639,"to":5664}<fsm-vh3gqscxm4e>
type ReturnType = bigint
```

## Parameters

### account

* **Type:** `Address`

Address of the account.

### token

* **Type:** `Address`

Address of the token.

## Viem

* [`dex.getBalance`](https://viem.sh/tempo/actions/dex.getBalance)

---

---
url: /tempo/actions/dex.getBuyQuote.md
---
# `dex.getBuyQuote`

Gets the quote for buying a specific amount of tokens.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.getBuyQuote.md","from":133,"to":5800}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"a420bc920b6563e021956e1161cf4176a0594ca6d74434e3e2fa2b7a9993a741","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScAGYArmD8gmCcWJJwMACqYIxocEFEobEwiJxipBZKFJywvCyhcCVgscwARmQRJS2MShZoADrZrOxcqaTpWTmmUBC8CAYAsrFyAljm8JzipWjlypykMFj76WASxskQ0RucTa1knC0YVz0kyXRsliecF/fhMJwAjNZOEFAW8hIo0BEAHQDAYAWk4ABEZg1OPg0GgsA0APTYoiMGDMKFwfDY6azbGxATmATwbGjcbZXKUajiJRzZDIEB0cSsBQslhsDicYApNKZJlwTiuGKkCDMTgAcnxhMVsLADIlkyCioALAAmayKqrSCIDXGcA3Wa0221gEAAXQdom0+l1mjMihUakQgK0kl0gU1E2Z8gsVn+dgcpCcNHIiGk7k8ODwhBI5H89DwITCkU4vBMXALYGi3RKAGEhKWlANBcN81XuiyxJJ9AAOSOe5SqJAANn9Oj0eGL1ZZ5ksSH1UccznjiY81C8qd8GeoAWHhY2zAg8TQAEkwJ1ur1m66kP9/gBmeRenuINsDwN4Xk7k4HsfhpC66cx2d9pOLimBhpn4a5ZgYdbCkYSSmC2Ui+pethdt6GiPkOBjQSYH4Tog34gPYM5xpOl4AZgQE+OmLI0OBICQVwsC0KerbnpeD7IXe16soOgQMdhVh4QRv5EYgl7/KRS7ASuVHrgYcQJGcnCBgAQrEGAAIqxBANAADyViW3QAHxBCOZacHp1ZVKMvJ6GQqKYcIUIMVCymqRpWkwFCAAKjjMDZYy6Y2SgGR0nCeXKzCMOk2n2XAjl0M5egqepmk0FCABKeixKQYAAGqFDABkDGA1lwKkvB/C5yXuSy5JzCAADiehSqofwAI4pX80TsPcqkVFcpUwLUpa8Fur5cN8aAQAA1oosVUWyHJcjyfK4FQAAGG25LWQzCqKvD7OINDmd0VTopi0qyvKSoAAIAO5shF2IFvsaqDEKXCijQQwXdE4U3fdSiPc9MBPQ4FhwK9dEijwiQmD9f2KndD2ME97Ag19bCvQMxZiA2+lKJwAC8+YHUdgVBMAAycPmYPCCUyAYxAAAq8BoJYaDOlTnDbOIwjvailPJNTnAM4SbBQowUAOiUZ1YEEEQUFz7gDK4ZpgNjm4vruB5Exs905DDZyxU5lVuTQxmBVUgvU1rJwAPJUiUwaSjqgJGlUvYK1zk0zWAB4lIq1i0IavBQmHF7Gt702KA7aAB0HIdh1ChqR2AqsDBta2OhQXJWcwLImQTCLHUoULZ7nPksnnflSgi3kxr5cZzc6XL7GgWXCCyTP4H8tvjZcPuKDrlgwLAUDcxAPWPC1pQ4ENBLj33sdl06LrMb6Bo3t2PoXmhgSmx1fFfj+sYuCJACs4nkSBq7UYEOaMOEUQ40WgUVoF23vXjo5r/B/zn3hBQ28+x7w3PjI+uET5/lwuoK+3gb7SRokEQ4EAcAcAwFEJejt7jHhODVFEeBuDbl3F8Ae0cwCxwnlPMuv99D/F7P2diPpZBcSfAYLBDAww4XPlA4S+o4HLkopme+oRH55mdtqAocgiglDKBUKoNQ6hyFRDcNopAQpdB6CcT+9YJGhhALVPAixliMFWASKUmw5G7H2IceAEJDpJFIVcVRdwHhPEYC8TgYIPj9x+OkAEQIQTWG8RCaE6oETIlmDLDEWJEC4hVESEkZIUSUmpDkcx9JxQhlMBIdkSBOTcloLyVYq1aI7Q+mKMYWpcjwyusqAkzAsYaiyS7PUKcTRqwtFaW0PT7SrxAHBOh6gPRAJQr6JC2g2EgD0aYccVgeH4WjKfeMV4BGSSEWBe+KC0GYCiIPP2h5OBrSDgAEmAFYpQrgs5UEMRhKAUAjhSgmj3CevsqEDTAFAGhAyzyIENJ2UZd4PSTPQtQch74uFWEYYJZZk41kUVAnfbM2yyC7NeTHbBxzaBnIuVc/BsxCH3MeU4me+yqEtFUt8wZk5z5sUBT6NiILAj7NjhAj0MLoH8IXGReBUlhF4GKr5UqTg/g4wgAoAYBRSB4zgOK4oZkTByvxXVbufw1pioUGtTg24oBLD+Cg/EsALGlEFAoaoMAKVKC0QTDVfxVCHU4JFE1EU5CSCoS1AYAApcQBQADK+1TGv2EHK7Vg0HDZDgAqA1ktR73EeLdC19w5S3XSGMGE6swCqu1dAPVXjaD825rdSeA154jQLEMHxDR1QACoeBHL0rKzV+ZXVwClLdHI+BQ2qGgFKOAsR7AbClOqxVCgoRyAgEoeWa0qjDuDaOsgcpSBTo2J8o5tqoT3Wysu+1RZeb3D+LEdI49JqcFuuUGgVDeaPAAHLQA8gAK17dsGAvJ021u4IpcdLRQhrpHTALV4MJAJFFYFLKsaT1npyHayeyA1ooPKq24kaBphUjWg6IIsscTYkgLAR9UJ2BKGSRSV1NAxBwiIPqXUUJaDYnEFgFG8H4CxXRMwOQABiRjraxAochCuqAAxYOcditxhdaGMMxKwzhmAeGCNEbgNiEjrNyOUeo7R+j9I5QIeY2gVjHHNNMZE6QdRUJOBZqUF+n9s7G3/vzHutonBD2xvbd2qkjryl9RnmtKTiBbVap1Xq9NAwAD61bq0AHVJDZGUKFoLJQzMWbkDKkNEAWj3sGmgRUUpG6ECgBY/Y1wYAdruDjSKNAThyAwAMOAGAEj4DlJAQ9nBzAzW5i8loybU08E8nuZqPdHhHEJC0BQVRIDSskHavrMrSsQgqwMcINX7D1Z3FKZrvc5CJa0j3aVt7YBQkfVsA6zBYqcF9TACbfxYOQAvUIFI+nW2cD3NiO2YnMNxOw3emTOg5MKcOkpijVGaN0YY3d7TunxBwiuzAOEQg4RCbhIIKIXVSADG3PliwSPmAOKEIFsAABRIpK0HNwA8y88zKXLO+cQOqTOj6NZzo8uOydioe7rcnkW0gcgoCKgiAAbnNNiUKOxcgyxgKz097BOdVBPdxnc/QEh/rHROnULPx2cAAKQQyqIqdnnPud87ABaMKvRUQq7ZxLqAUvi3Idl3T6zUIF3sCCJYW6nBcdGcd4qMLhBUFwCqLK7LfVv3jwcFgHAlgucRF5/zwXxuvHu+lUKuAbJe6rpbLwKa3NfzQa2LAIzVODcC+pm7xdJQvcQB937+Ueh8CB/EMHujYfR7R+FhsLgyAYBSOlufX059m/Cwdf68oWA0BQlIPEA83dIp6TvsCbzRBmAIX1L6NsnTC/964HbVL6XR/j8zTXuA0+Aiz7vYgefIlrDSBEivvvNsuDed6GQYqcgNMzCY9iOgg0qRJEQMM300gb+t4iwd6hAOhwhnoN5kCIC9h/L6gAEOrAFyCD6BrH6wCIAP7ZShAv5abv60Cf5nA/7QG9jWCr4t6AH34nCP6YGY4WDv5SJBYXJ/KXgiTqgvzXDWS6ye6MDracBpQpbgxCCKj67rqbpgBBBrSIi8y6DSpnKCowCuAACESIkhZA8ha0UeBeMeJwqIEhygdwYWXBiWvBXQwaYAihOhUh8hluOeC6GcG06o+OxSZqh6JOaqDacqWqvALaVaGaNOcAtu40rmxMgYvqz6vIvqVehAt08sQhm4C6uswRoRzA4RvkkR0R/h2qGAbhZqxMzuSWo6WRMAQQsuVQC66hKOmRCujOyuouquOuEe+uhuQuJuNRZuHOFuVCNuYAzAFR9OiuTOpu6umuSodReu0eRuWhIuYudRVhnR3RBR9u8eTuMALuxeHuZeFepQVeqgte9eoeigo83O6hjRxu9MqxpApe3uWIleAeuwQeaIEB4ezoVCNhGarBshHB+h3BRh/BYAgh5R8xIhYh5hdwMh1kChShuhpAqhRxAu4xwuEJUhnAnxhhfBJhZhyhUJVhLxmc80eSKAXI6QpSyAsqWU5U6Gr2uIPQqgsQLQUI5a72uG8mUm2IQ2KWeIKmNG5gLQqMvRj6EQjozoPy68okdKt4PowKAYoKtqECfoiyhEZ81g8KCC/KBgQQ2W0AUQ8xVRieyeAA/CUFelUEnKgmcKEPXLyKiFesgA6CFEQBAJLMCAANT/BfDpjjp178k3IEIGBwnNSTxrQy6oanodoFa3RzImbGIrBmoBjNAQhSi8B2b6rhBHpVDOadoer6RjBcCOaLy9b6rlCY6kCPA6m6B8YbDcF15QDpJCA/o5mDqlA0liA5Bf5CCSr5S9osBcFuonqCZC7RBBCXgRAvYxJvaY5gDqD4ZfbjixA0Zjmw7J7yZjmXgaa9DRBQiXhQgsZyBqxBAzwxm+RaEbD5ahCJapCtrgYwZrRf5yBQgY6HRTrkkSZvZSafaEa1Q/akZoDKYA5qYozXmbk6bsbXl3loAgVwgBiRBhI+EbS07y7CCvwkLEznwxG9FVGKgFi7glBq5c5VAYUnAwmaHwl4VxycA8LvLW5Ui25yp9E6jEWIDGgNi7gEW+klB0WkVWGBly6ZzqinYXZXnUi3nsCY5oAPniaYiSYfaxSybvmKZkb/aqZA6pJcEAW6bAVCWHRgUQWI7dSo5/Do7qVnDfK5KLQDIWDlQshEDWBQj/DWXWgCm0JICXj6iML0qOWgIGCM4ylIQcrCRthKl8qbJgK4x9z+w4JaKcJCnwSXi6iinAL3juUgAhX2iQrnjeVLLQKITwq5IsiyF4CeUOUXyxVjITIySGDEKfAjxjwlBuyIR2gylThylCQKmuCCkFiwBMDlLQwxS1IKja7IzYiMyQydWigzI9VKgJJDVfx7SBRjWKhQg8nVhNKsFJW6ziD6xcAxRxS0AJRoBJRmyFGFxWxcwcJOwtLaiKhuwMWeyKxCz7KhWBzBzWC8A9IvWvVvXvXWD/CpzUwsrYIPUhwfWA1A02j6ipzpyvGVFK6KhEJjQFajyjz0VVBJVqwsiNziBICgABCzRJB4DMiuCuBAA"}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { config } from './config'

const amountIn = await Actions.dex.getBuyQuote(config, {
  amountOut: parseUnits('100', 6),
  tokenIn: '0x20c0000000000000000000000000000000000001',
  tokenOut: '0x20c0000000000000000000000000000000000002',
})

console.log('Amount needed:', amountIn)
// @log: Amount needed: 100300000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.getBuyQuote.md","from":5886,"to":5911}<fsm-vh3gqscxm4e>
type ReturnType = bigint
```

Returns the amount of `tokenIn` needed to buy the specified `amountOut` of `tokenOut`.

## Parameters

### amountOut

* **Type:** `bigint`

Amount of tokenOut to buy.

### tokenIn

* **Type:** `Address`

Address of the token to spend.

### tokenOut

* **Type:** `Address`

Address of the token to buy.

## Viem

* [`dex.getBuyQuote`](https://viem.sh/tempo/actions/dex.getBuyQuote)

---

---
url: /tempo/actions/dex.getOrder.md
---
# `dex.getOrder`

Gets an order's details from the Stablecoin DEX orderbook.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.getOrder.md","from":134,"to":5091}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"1b4c194e1433ff47798203a8d893230e07a7bba99b163b51514c7b0d01dbdc5f","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinOywpKnAuZzbK6RrAJJQqQBGyRZoANxbO8ziANZkqQAG1rQAJMBipBZKrk9XYB2nGOEAgdwA0jAMM9Xh8vj8/gCgYw4AAhRhHYGghTiMBInYCXh3VJgACuzGOZHx23EzAgpLAaBOZ0Z1M4pBgtwsP2ZSnObKwHKIvP5122lnoItZYs4KIAYuYsCdsTBcWyEoqACqMIkk8mU0gA1ylcpSRDqWS1ZSqJAAVhaOj0eFWfjMFisAGYBo5nKNGhNqF5pr45tQAkxWOwuEZBMITdp9NIvVb6hoHW08DGTF13Uhk/YfSMkAAmawBzBTAwzV00BYGfJRziwWjxip9az9FM2xDJ7QZgzNnM9Hveoa+ksADnLQarIdKtcCCQZ/FjnDaAHk9mQADwZRLJAB8QQ6yVSe6yFE4WEczD0ZDgqSzwgAdM3nxut6RnwAFG930hwLuxRKAeESpN+pAQMwKIwNuT5wK+dDvnom5rM+ABKeikqQYAAGqhKSMAHrkYC0vA168DAa4oZ+pRQBAvAIAYADiehwJwuK7GsADk7GwBIjByOxCSQcwnCqFRLqkCCYLPvO4hKExyDICAdC0lgCilE82loHAuQNoUwDRBy4g0OeySXvgaBoFgnCuJwIlQZw3EAAIAO4KdBAD0MQctx+mRoZ4mcmwdkOaJznuZ5jA+ewMA+Q4FhwP5eSBVwRnwWFjlia5HlKN5vnxTQkYpbkSxxMBnAALzGaqZnAUEmyAtEiXCKkyDFWwmrwGglhoAAuhQ1xoEMwgFLpGwyh1IUQM+GL9akVk2UEERDc17i5K4ES5GVsRcWQ1UcR5jDRiuJiIbQyFoKhZDHsBl5NdsUmHKkvTFh6YBrVtuTaU8ICDSp15DMwpQnkonAALTpMBckAyAQO0qUCO3iM7FQ7+wP/gh/0UCpHJoNhcZUJq+CSZ+TZ6OIgnY/1g1lAm7b2l2DQTumToGB+axDp6o7DC4PbFtOlY+LM87hgYIRhJERTCBV+4pND8sBeNMudKIDOIL0vSVPIdTds01CtOzIBg9zea8+OiCVL0QveNWoYLngQSChAOAcBgUTPZipx8oydEMUxIA3aQnD7AAIuJECcAAjoRpAYHJ6ttprxYGwo1oNDUfbG17ZtWxbRaIILHiBsL9ti3W4BkXAFFUUsEAKLkRCSDLcANzAZ4mO3/uMXgJNUU89cKE8nB0lApIKFekFEBi8AcZwcD5JPsDHKSSi++DQ9Uaopmyuxi/QXILdoFHEm5AAUuIzcAMq8N8WBy23k+3gWeRwGJLsz7AUDAhgnBuTAY4wJIJuTgPeZ8O0wD91HtACeVE6DjXYmgNyUca4wF4IwJIvAiiRksIyB8kCABUPBOBPD3E/GAI9eBHzgOxNyJ18Cjz0IQKA+9ST2A4uxQeXcFDPjkBAJQK0niXm4cIduz4yCQVIEIjiYAf6iIoc+DyOEZE7ziJxSknBSRgJ/iff+3waCR1kX/AActAGAz4ABW+8RqqmYBAsAxDuBrn4ccUIpCt4jyShIMAlFVbJGwjAXRUc3IGO3lHZATwXaUVoc+MQ9FSRoCeP1IIS0sAPi8l5SAsBrHPnYEoLy9FGJeSPjQMQEMiDFkqM+WgXlxBYBitE+ACErLMDkAAYiabQ+J9I0BRFxFAXIkSukIXiZI5JqTrLpMQJk7JMBcn5MKQHEppkeoVKqTUupDSvIjOfK0jpIyxmkFIBEZ8nBoFKFce4hR7cqEaKotooJ/8GG9NlGlH44lSakLmYgTxMDx68MgQAfUIYQgA6pIPIyhQVAtSBcq5chW7txWMcSx6C0C8SYaoaA7FJBUUsAwg6SwUQ0EZHIDAuQ4AYF8fgSCkBtGcHMA8T5VFjggLASHbg359hINJn/DkYCKQKEvJAEOeKWV/2JWIRQaByW5HCNS+wdL6TsSZVRUIiKIASRDmY2AVibEmWYAhTg18YDby+ZEyAhihBTwYs00OXl1wTLSRkrJ5iFk6CWcU0pazKnVNqfUxpkEYktLQG09p4gIZWpgBDIQEMRkQ0EFEBI7Bch0g5LKRI7BbjGDAA43IABRWg6lJ7aI+RJFxEA3GIpucPRAkDfrWN2mI3h/DBHcVJnIfh/92ByCgNxCIAJMmcAgucB8nBO3dpQaQPtl49E9MSc2xRbaggdpgF2qOABSZKl5uLTr7QOodXkR3fHwYtddU7e1QDnagtACS0BLvEZI9gQRLBuU4AW45L7uJgsIK7OAl424o3wB8txP8HBYBwJYftERB25GHaO/BnBn0h1vLQhS6q5ELwkEScSY5wnYbWOseDx7tifqkakX9oJ0mAagsw0D4hwP1Kg0EkjQIOJcGQDAZucgFq2k1raNjQJd633vmgZ8pAGT7CgSBuAe4FycFfeYxARBmCaw9MWTWE5tpgGHcJrg65UXook1JmTKJ5MBEUz81TPZrDSB7NpoTOxd4/POGQUicgdnBuaV5Og6DEmxnNOoTW0gnM0k49x0I/UIahOY48RoRdixhY48hnjonGAPys8ptzOFQhebtbQ3ztB/O5vNAlxo1gdN6ec1wVzjJ3N5a5LpyLcggXwmUEXD0PZIHlU4KRW8h0f2CURehKtSUhDcQBFvJRkKghPDDriXQIcPj9ZgK4AAhJwBbygyDraeHB3Tx7EMTS24tg6YLhucFG6cMRYBNvbaW+tm9hHJE/W0pAotJaHmL2UCy0h5DbnRBoQQsAb2nhNt8XtV5NU2jX1sbSa+dHCBuRWlNvakjDqw/h8wRHt5keo6XVwZgGAAeTxqm+pFvDScwCCL0y8kiDtppJzwixK610bp7TOmDR6T1jvPRz/d16jG9KZ9TvhAjV2Tq3Tu5ygvD1seO+OqXnPZ3C8XWAYnYuUOvpgO+8j36qP/to8BhjTHIOKCCQOg7CHT0neQPr9YnBDc0YXnR1QpuJ1xeg4NIxr3QeQ9ln1sig2Ltdqu2N27k3Rcs5myo+bZ3lvAFWxt07O3SB7et0d2346Hvncu9d8bd3U+Pee37368lFJIGUmUM1pRkBt2wpRFJLqZleT5KoUkxxnwxGYG6nJcA+/xWOK4ryfrNnmGOLFFtFjrERH+nTU0+htZM3Tqmc0bN2gs7zjUAsY5C5lhLhWO2c55iBCCMB6AUQxcrrQ3ADDAB+VIuIMCXmfG/12ubQgY1pOO5/yB+pgScBEAQAYiKYADUvQKwsw/CjGc+VARSgciuRiTwC6SSzyqgfWuu3QFinAAAshPAIBpOqjoOSDKuxLwPcleOEDopePQhgWfPuABFwI8j/OEH9oKCwJIH/LfhhrIqwWHoxlACdLGO4iwZwgvJ3mICdAFkIE3ARHPAfIJMfBElErbgkEEB6BEM6lMq3rcGAOoHkp6t0KSLUnofGhhgPnoR6F5ucAkM+B6HsmGnIDpkEBWq0KQUhuKhqlQbQk8nopEgFnIM+CmqQDmkIs3lMq6nMh6gUggSsmUmgOsv6lsjFIEY4eGoESETmlkaZBDK0JEKcg2tpBDr1jEAyFwDVLaGjtPuLu2mUYyKkJuv2pePUX0jzorqkK0akPaEYqgY+q2hLtxF0dxC0fSIyJnrzmekUOUd0c9n0WAL9JAqalRAEQIEETkWgOEZMjZFEe6ghIsnET6uUmPgGtsmkfsu0pkdmqZBsXkToNLCETAhmhYBsbGInIbJXigCpD9pRKUEQNYM+L0ICdYNYPPknGaL0LaMmKvt2L2EbIEG2tvgXPzFOIfjOCLDWOLCbFDp+JNM1E9J+C9MCCyJcDKLcA8I7i8O8J8CNAiP8DKDJBCFCDCNSe1r8PSfiXvOiN7CqGqDKISMSH1vqFSDKLSGMUyMSb7KSZyRyE1jyJKaKJyYKNxlKNKUCBKBKT7IqciHAAqBlsqO3HyZyRqBltqLqEKRSCKWAMaOCUvuoCvnrA0EzNnIEFJEiSbIMHzKMB6AfpMN4BIEoKUKtngIibaX0BOMWLrBnEgLYGGJXMHBTAJEJBsBxHSDMZwL0CCVmVmZ9KPPcI8M5K8G/s+CMVyRiKkCNIRK/m/nZHnJaLvl6TGa4HTDELABGCrBlGdMIFlBFHutFF5J1BAClAZOlP4uDPZNlM5M+FPlkKVAHssFJIdOIMdKdLmghG+JzLdGDA9NcF7K9O9J9JtDpv0azoMQmfxFTMmaWVJDpqUCjOIEgKAAEIoIvEIHgLpCAK4K4EAA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const order = await Actions.dex.getOrder(config, {
  orderId: 123n,
})

console.log('Order details:', order)
// @log: Order details: { amount: 100000000n, maker: '0x...', isBid: true, ... }
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.getOrder.md","from":5177,"to":5947}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Original order amount */
  amount: bigint
  /** Orderbook key (identifies the trading pair) */
  bookKey: Hex
  /** Tick to flip to when fully filled (for flip orders). For bid flips: must be > tick. For ask flips: must be < tick */
  flipTick: number
  /** Whether this is a bid (true) or ask (false) order */
  isBid: boolean
  /** Whether this is a flip order */
  isFlip: boolean
  /** Address of the user who placed this order */
  maker: Address
  /** Next order ID in the doubly linked list (0 if tail) */
  next: bigint
  /** The order ID */
  orderId: bigint
  /** Previous order ID in the doubly linked list (0 if head) */
  prev: bigint
  /** Remaining amount to be filled */
  remaining: bigint
  /** Price tick */
  tick: number
}
```

Returns the complete order details including the maker's address, order amounts, price tick, linked list pointers, and flip order information.

## Parameters

### orderId

* **Type:** `bigint`

Order ID to query.

## Viem

* [`dex.getOrder`](https://viem.sh/tempo/actions/dex.getOrder)

---

---
url: /tempo/actions/dex.getSellQuote.md
---
# `dex.getSellQuote`

Gets the quote for selling a specific amount of tokens.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.getSellQuote.md","from":135,"to":5815}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"e72885ed736301b0d1aa5f428258ba248ff06fde799d2fc7fe974306d5b6b9c7","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScAGYArmD8gmCcWJJwMACqYIxocEFEobEwiJxipBZKFJywvCyhcCVgscwARmQRJS2MShZoADrZrOxcqaTpWTmmUBC8CAYAsrFyAljm8JzipWjlypykMFj76WASxskQ0RucTa1knC0YVz0kyXRsliecF/fhMJwAjNZOEFAW8hIo0BEAHQDAYAWk4ABEZg1OPg0GgsA0APTYoiMGDMKFwfDY6azbGxATmATwbGjcbZXKUajiJRzZDIEB0cSsBQslhsDicYApNKZJlwTiuGKkCDMTgAcnxhMVsLADIlkyCioALAAmayKqrSCIDXGcA3Wa0221gEAAXQdom0+l1mjMihUakQgK0kl0gU1E2Z8gsVn+dgcpCcNHIiGk7k8ODwhBI5H89DwITCkU4vBMXALYGi3RKAGEhKWlANBcN81XuiyxJJ9AAOSOe5SqJAANn9Oj0eGL1ZZ5ksSH1UccznjiY81C8qd8GeoAWHhY2zAg8TQAHkqZ1ur1m66kP9/gBmeRensJgeBvC8ncnA8MMMTxC66cx2d9pOLimBhpn4a5ZgYdbCkYSSmC2Ui+penYKN2Poetoj4GNBJhjuGSDfiA9gznGk66gBmBAT46YsjQ4EgJBXCwLQp6tuel6yF23pINerKDoEjE4Z++GEb+xGIJe+pkUuwErtR64GHECRnJwgYAMowHIcgAIqxBANAADyViW3QAHxBCOZacIZ1ZVKMvJ6GQqJYcIUKMVCqnqVpOk0FCAAKjjMPZYwGY2SjGR0nA+XKzCMOkelOXALl0G5ehqRp2m6TAUIAEp6LEpBgAAaoUMDGQMYB2XAqS8H87lpV5uBUOScwgAA4noUqqH8ACO9UxOwpQeRUVyVTAtSlrwW4vlw3xoBAADWigJdRbIclyPJ8g1IAAAY7bktZDMKoq8Ps4g0FZ3RVOimLSrK8pKgAAgA7my0XYgW+xqoMQpcKKNBDDd0RRQ9z1KK970wG9DgWHAn30SKPCJCYANA4qT0vYwb3sBDf1sJ9AzFmIDZGUonAALz5idZ0hUEwADJw+ZQ8IJTIDjEAACrwGglhoM6dOcNs4jCN9qK08k9OcCzhJsFCjBQA6JRXVgQQRBQfPuAMrhmmA+Obs+u5vmTGzPTkCNnAlrm1Z5GVmSFVSi/TesnAAkmAJTBpKOqAkaVS9irfOzQtYAuyUirWLQhq8FCUcXsa/vzYob4h2HEdR1Chqx2AmsDDtW2OhQXK2cwLLmSTCLnUoUJ5wX/ksoXgVSgifkxgFcZLc6XL7GgeXCCybP4H8jvTZcAcJ1SeyjTAjAkFAfWkANGlDZ1pQ4GNBIz4PLuV06Losb6urcchnG+lOPEYSAlvpTQAlWEJ0axi4Ym9pJFEgauNGBDmjDhFEBNFiFFYhX2t9Imo4d7wX+AAVn7BxO80D0JDgMCXa+eEfz33jLqecyZvCv1krRIIhwIA4A4BgKIG9Xb3GPCcFkTU8DcG3LuL4w945B2SLNeechK5gP0P8XsbYbwoSQHw0+CCQBkOQYgCBqC/yIAkguci2CZKZg/qEL+eZ3bagKHIIoJQygVCqDUOochUQ3DaKQcKXQegnCAfWdRoYQA0IWEsFYawpSbF0bsfYhx4AQlOkkRhVwTF3AeE8KeihOBgg+EPH46QARAhBNYCJEJoTqgRMiWYCsMRYkQLiFURISRkhRJSakOQCRwHpOKEMpgJDsiQJybktBeSrE2nDUUtipQykBndZUBJmB4w1BUj2ep04mi1haK0toJn2m3iAOC3D1BCMPneP0wigwDMmOIyRBE77SP+LIrBy4qJKOzAQohmAogjxYSULaYcAAkwB3FKFcLnRqKJaFQCgEcKUM1+782Yb89hnCZlnhkdYE+izUIPhERcl24joHCTQZOZ+CjDlgQ/icsgZzfmB0Tpwa5tA7kPKedQ15mF3mfP8UvC5/z9jVVCYC2Zk4IHsXBYIyFgQLlvnER6eF0i9mAWRaBd+eByoBUqk4P4BMIAKAGAUOekqFAAOEFKzaDiQB9z+FteVMAtqcG3FAJYfwCH4lgK40ogoFDVBgC0WIShLEky1fzBwXAYpmuinISQ/zOoDAAFLiAKCpY6jAsB/yVRagKhFshwAVEa2WMAZ7BMela+4cpHrpDGDCbWYB1W6ugAa8JtBhb80ehAZeo1GDjQbEMSJDR1QACoeC4sMnAZVOreDurgFKR6OR8C6r0IQKAUo4CxHsBsKUmqTDKqhHICAShlZbSqOO0NmUyBylIHOjYYAZ6LubQoKEz18rrtUKdfMgt7h/FiOkGebDHrlBoP8wWjwABy0BMoACtB3bBgLyDN9buDKWnS0UIuKtU6uhhIBIEqQp5Tjf8m9OQ/hsOQFtAh1UO3EjQNMKkW0HRBEVjibEkBYDvqhOwJQBSKTupoGIOERB9S6ihLQbE4gsAYxQ/ABK6JmByAAMRsY7WITDkIN1QAGEhvjCUBMruw7hzJ+HCMwGI6R8jZTKOcxo3RhjTGWP0jlKhjjaAuO8d0+xyTpAzFQk4NmpQAGgPbpbSe5IbROAXpg121QO5nUHQELsJeW15OIBAzm/Vu71QAH1a21oAOqSGyMoCLoWShWZs3IImO6/gQBaK+0aaBFRShbv21x+xriT06nKkwMUaAnDkBgAYcAMAJHwHKSAF7ODmAWo6v4LQU1pp4D5J2HV+6PCOISFoCgqiQDnpIBDg3UsVYhNVgY4R6v2CazuKUbWB4aS+KVzgz7YBQnfVsE6zAEqcDUtNv4SHIB3qECkYzHbOBO2xHuaTeHskEZfYpnQynsSqeo7R+jjHmOsfu/pwz4g4TXZgHCIQcJxNwkEFEaI7ABjbiKxYZHpBmC+KEBmgYABRBpG1nNwEXj86zGXbMgcQOqHO76dZLqnTOnU/cNIluLaQOQUBFQRAANzmmxBFHYuQFYeXZ+wLnVQ2ECY8wztLTPZ2KlZ9OzgABSGGVRFQc65zz/nYALSRV6KiZX4vOdQClyWmXVI5eTpXewIIlhHqcHx2Z+3ipIuEEIXAKozb8tDUAzPBwWAcCWG5xEPnAuhdG/Ca7ueoq4BsgHpurYTg5r81/Ahy3GGV00/14L+mLvV0lA9xAL3Pv5R9v9+IQPzGQ9xsj+LDYXBkAwE0fLCBvoIEN/FsegN5Rg1QlIPEF2fcYqGXfsCfzRBmAIX1L6Nsoz88964HuTL2XB/D6zfgMfQgJ8O5fYgafYlrDSDEgv7vDsuD+d6GQcqcgdMzHY9iOgo0qRJEQOodQvppAX6bxLVvoQDocIN6teZAiAvYMi+ov+x6ABcgfeQaXA++sAiAN++UoQD+emz+tAr+ZwH+EBvY1gi+jef+1+Jwt+6B2OFgz+mioWDyMil4Yk6ov81wdkhs7ujAW2WUGW0MQgioeuWqe6MWQQW0iIgsugc8dyIqMArgAAhEiGIWQDIVtBHnnlHicKiKIcoHcJFhwSllwV0EqmAHIZoeITIRblsLAGZtnDtOqITo0hahemThqk2vZm2uEDWpmnTnAHLtNGPOTKpJ+ryCpBXoQI9MrPwZuCuobAEcdsEQFKEeET4bqhgC4RauTI7qlpOqkTAEEB5lUCuioajikROrutOoribpwNrmHnrgbsLsbmLpURLubv8rLmAMwMUYzmUSzg0ersaEqFUbrpHobuoaLmzo0WbuYa0e0dkVCHbmuhkYXm7iXmXqUBXqoFXjXsHooHGjziobUUbszIsaQMXp7liOXn7rsAHmiKAaHs6P8iukwZuFIWwToZwdwYYXwUUTMfumAMISYXcJIXZLIfIVoaQEoXsYLsMSLiCeIZwK8Xoe8c2kYTCYoeYQ8WADnMtDUigFyOkJtMgM2nlNVDhm9riD0KoLEC0FCAWMwB9kRmUvJtiKNhlniBpoxuYC0JjIzu+hEI6M6ECrvIhMyreBCishuEuuIssjyqJNYEigcoKnJMEPltAFEDMV0fHongAPwlAPpVCpyEJnChBNy8iogPrIAOjhREAQCyzAgADU/wXw6Y061evJLysweAUJHUJaW0VuaAOqbmPaju44mUnAiwywQaFqAYzQEIUovAp6TmqQHacaVQAZHWAwpYYwXALm68A2hq5Q2OpAjwGpugwmGwW21eUAJSQgQG2Zo6pQlJYgOQb+QgMqxUg6LAHBHqiGyGwu0QQQl4EQr2mS722OYA6gJG3244sQjGo5cOieZSo5l4OmvQ0QUIl4UInGcgWsQQS8UZAU6hGwRWoQKWiZl6/ySGb+HCmO2OaAc6JJsm728mX2ZGTUv2p0amAOmmwORSHBG5BmPGl515p0QFaAcIAYkQySnhO09OCQm4BYDC5MECERnRzOio8FJwJQqu3OVQ6FkINRkJdRJQuFJQki/yvpNupRqFxFfRuFEJah0JxFnApF0uGGrROc6o52EsW0l5UIIFd5MmmIcmn2CUSmr5f2oFn5QO2mPFm53GgF7AN5IFYFOgeYmOOa6OJYClOOYAgK1Sq0MyFg1ULIRA1gUI/wZl1ofJXCXE+oHoLKYkbKeAZRkptgWyRED8bYcp0kKKQqiCus9Cr4h4FCli74Ap8El4ECSEIpMgjlBgg8nKH4EYrl0pD84kXlrISgLIUhTlM6zE4VvYYK0VNgRymEAVXANKk808JQ0g0g6gkykpJ8KV8Ysp/JBYsATAXm8M8UyMXSIMr0rMsMnVrSayuQPVCo3Sqo1ih0IC3QY1SoUIXJ1YfSzB8VfhRs4gJs8UiUtAyUaAqUVsNANsxMdsfMZCbsI1eQioXsfRvsqsYs0K5Coc4c1gvAEyb171H1n11g/wGc9MHKQVT1EcX1wNINNo+oGcWcmaAhXRiodCU048tKVVfRq1kIAwLILc4gSAoAAQi0SQeAzIrgrgQAA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { config } from './config'

const amountOut = await Actions.dex.getSellQuote(config, {
  amountIn: parseUnits('100', 6),
  tokenIn: '0x20c0000000000000000000000000000000000001',
  tokenOut: '0x20c0000000000000000000000000000000000002',
})

console.log('Amount received:', amountOut)
// @log: Amount received: 99700000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.getSellQuote.md","from":5901,"to":5926}<fsm-vh3gqscxm4e>
type ReturnType = bigint
```

Returns the amount of `tokenOut` received for selling the specified `amountIn` of `tokenIn`.

## Parameters

### amountIn

* **Type:** `bigint`

Amount of tokenIn to sell.

### tokenIn

* **Type:** `Address`

Address of the token to sell.

### tokenOut

* **Type:** `Address`

Address of the token to receive.

## Viem

* [`dex.getSellQuote`](https://viem.sh/tempo/actions/dex.getSellQuote)

---

---
url: /tempo/actions/dex.getTickLevel.md
---
# `dex.getTickLevel`

Gets the tick level information at a specific tick on the Stablecoin DEX orderbook.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.getTickLevel.md","from":163,"to":5884}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"3fba3acc82c4f344f1ecc51d048f896383905db7488d943734d6cdae1b8b032a","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogLGwcnAAqjLwA1pQgYpL6ACyaZooqaoiJWpK6gRHRseaWSACMdg6kTjTkiNLunjh4hCTk/vR4ABTi5uJwAJScvCZcQ2AAZoxKiJwAwkITSgA6YMHsI/OTsfFSiAAcZanKqkgAbNk6enijC4UWVgBM5Y7ONXUe1F5Nvq3UAVfDnAUJDk01y+SiABkYMCAHQAJT0AFdSGAAGrdRG4UTafQlEoAZnkaWOiAArOdcnggTA5LdipknpUXqd6h9GgZmn5fu0DKtQkZBMItjjSvcUgojhkUtpKQYBSY6VYsiB7M9qkh7tZWZh2T4WrEaDygqw1pxYLRhQlSvjyYd0khCdQcpcDObFUhlaqmerEPddtrPhzvga/gYxoiwPxBZwwZFIdCaQAeObjSYAPg610m0xTCwonCwjmYejIcGm8uEMPNMNj0ShsIACkWS6Q4MmNko031pg3SBBmIw4DBExW4FW6DW9OD6zT4UiUei5Ji08swOJi3BC7wYDGp3GZ7SqFAILwEAYAOJ6OCcVQ7rCkSI76lyTgWMbsZjiYxgThf3+cTcYF4RgJl4G84xhA1xCUM9kGQEA6HXLAFFiAADdC0DgZY+S4YBBlIGAvxgXNJnzfA0DQLBOFcTgxj7ZhOAAcgAAQAd2ggcAHohgIxjsJNUI8JoE1qNo+imLYjjGG49gYG4hwLDgPiVgE3CeCjEx83BUS6P7CT2KULieLk4S2GU5ZRjEQYO04ABefDCJoEilA6YBlk4QYFOEaZkFMiAwngNBLDQABdCh3JvSphBCTDpjcn8PM4XyYBNGFGCgELpnIyiOj6cKEvcZZXD6ZYLIBZ87N/djGC4Udx1oSc0GnBM5EzDt83ijyACNehgaZGOsWhNV4GFRrxRj8o8gRommcEYV05he0fDpGJKGFrGsEpGLyiLBwAIXS6Y0FITF8uK5Z0NQkAwvgwtKmYWIsyUTgAFpZg7SCbpAO711iH7i2qa83qbe6WzHa6KHggi0GRIUqDCfA7wfbdARa19xg/L9BU+sK4hFRACVkO0SRKR4nQuQJa3jYF3QZFUKiqFxEHxe4A11TkfkNQIuh6fprOEdZUymd6hf4mL+ZubErQJ0kyYle1EDOcnZRVDtac9BnmUyUk2e8DmQyNDp7wgHAOAwAYeqHaZUMGgASYAxAfZRXCuo8TzPQwoCgAi4GvCAxhvRHOEtnc0AgKJFEgqWdhKE5lXlkllRlF0QBD2nbS9RmalZ94dT14M2m543TcwAZpqiaYwERZguq5Y9TzwJaUfLm8IE4ABHTFSAwKO8el+4Sl2IlJQ9CkU/L2mlczrWc4afP9ULphVPCONLR2e57nj4kMiT508lX+Q7lORks6Qf1c8DPUuS5vBw0jb8xP7JuYCN5G+pX6J5vo5+YWf7sP6iF/J+b85wwxRGELwq51zwC3DuBaz9Yj1w9imFomF/z3kfABY6Fhnph3/OXGEpUwDIAAMoSC6goIYFhOAABEACiAANTgTccEhQ6NlLAZZOKcSQTCPyMJaAYAAF6cWNmHIYchOJ0FVMoOSgFeAAGII4YBeqMbcWBMJ9CgjBJAcEEK0CQihKgl1MJi1NHhbSNEFpMQgLQTiflzJgG4cwt+nB/acDWtYSqLdrBlQFuBaIJRKpzXgW/FanjtqcGcb4yMAJy73GCRBUJy1VrrQ2htSJ0SiHOOfm4gOnjNreLjB4jafirLl3xIkz+yTtzhLSVtAYziSilLAMsHJrj3HWBhNIHpRToivWaTEyyXBy6JCqYAmpL8BrdJ6ZkziAyWmXQhrdIsf1XFvQRkjTBvR/yOxwZwDoMAawwnzIsEABSShnNOSALpPTpBnL6J9SGIBoaw1MJsgJUROBEAxEc66uNtj6A3kTBOGQibJ0CJMyeJ8tYEl1l8Be3Ii59hLubV8cADpQGmF1CAEAFDiDAIg92eAADqiNbykFbh3LuGBA47i6ulAC6UdwdGOpiAY7BfxwC+XAZlByxjdCHI8teQLSQHFBUgW0EKmAYvSrTFI08fSzzZPPa+oZwDQM3E4Hclk8UwGWD8yluqFA5hMHqolDcDAfNQsamAqFODMGgIiBQBY+xEGZdecQTLWAutgF1RESglD7NtYHP8g5vWMDkJIKlt5lgAClxA/JIbwB8Gj+ZwD1Q6oCDgVhwAYsbd1sAoDB1paxGAXVg59lYkOVshDWlgA+Y6qAzqdx0BiteNArE27yJApEayJpLBgFikQgAVDwTgqEUwZoUPa3gUbfacFYjVfAWbVDQGvHARE9guUTttTCOQEAXJ9FQvmG1ZqFAwjIH2UguV7UEuLWe4QeqYTsRRLe0NIwCXBx3IiIcxa8GsQfDQKlBLaUADloBHIAFYbuOoRZgdax3cBjAenqL5H3TrtejeIkYdUdmRDAf9bdAM1VDm3ZAqFjbbl9jCMQx5ERoFQmwjhXDOKQFgDBmE7AlA8PdpxKNNAxAvSIJvARnFxBYGklR+AY5yLMDkAo6Tvs6MQAYwMe9ywKNKbHHRq9TH2EUU4Ygbh7GYCce47x08/GiJCZE4kMTEmpN9mo7JtA8nFPOZk7p0gpBHnhCDkoVD3Rd3nqw7wL9tdOC/sI4u5dqmuA4X2beCdpnEC2vtU2ltdblgAH0R0jpJZIFYyh8s5dmgFoLL4Q0QC6lBoCaBGLXgBoQKAnqCKcEsMusg6bBw0CHXIDAyw4AYEjPgPskBf2AkYBHOllaIDVu69wBsABJDtiNaU+xShQmA+ZICUskKHdbPWxCKDQAN5YvQRv2HG6p685gZvdBfBAClnAIOwBhDBrBBF1xjk4CQmAh2dwUcgMBoQrqTwyc4MtziAB5fTLHjNscg+ZnQlm4DWcE2gYTom7GOdEZ5mjcmFPiBeiDmAL0hAvW0y9QQAx3ykGWI69rb5Mbfmy2AOhBifU/t5coWbgWavBYw3q1CiAiGXRg2U59B6XKMURnIA9i72ByCgNtAA3G0+ZS0h1lk4PLxXXbSAq/zHglTDGpcXplytfXbcACkSl8yMUNyr9XmuXEWFinrmkBvldQBN92tA9G0AW6OVe9gHRLCsU4HQnz4fGJktxZw/MGbmv7J6sWhwWAcCWFV30PoGunFa6dmgsPlKNxwGgjue9WCnBfOOtqql3nSBi8L4lGP17pgJ5NnAZP/Y9D4DT+IDPEns+Ebd4lX8XBkDQm6JlUkMtx+JT/Mm1NaAYQnTAMthtA+4Api5gc1LRBmAExZgTXYJVW8T7/DD2r9X18Ri3wjQce+AgH8g4gI/zNrDSGZufxfHk/xUsPcyA1xJFtMpFaAgIGNBREB1B1ACZ7lL8l8p8Z85AQoXpAMR8yBFZfR7h/9J9OBUCV9GA00I939gCURuh8cIdfYICoDvxYCThFZrAL9nEr8uAgCh0QCqDPwLApEfk5Acs9llBfR8RmYiFhkOtoFKp49I0Xw4QatFIhBGIC891X0wAOhUIaECVdBKV7Y1xixXAABCWhHQsgIw1CfPN3bXT3bQ2RSlElOQzgBQhlJ9MAEwuw3Qow/3LBWAHzC6dCIhTnQxHnJLIOSdULWdedMscXdCSXWJfxeLSqXIMhb7ZgEhPvQgViXKVQgEK9ZIvQVI+DDI4sLInIspLgZgDAKdTNeySPdNZ9GohQDoeLfMK9Kw+tKopoo5K3OXb3YjX3V3VvGw3XG3JXI3P3KleLRnao0LfdQ9a3fozge3CaJiZ3XPAvdpD3UYpY9Ynw6YsALouY0vCPGAKPdvOPLvJPACPvVQQfYfLPRQQjbaDorYnXHyC45vTgK4nvG41PPndPPXLAnPMKKlK9CQgEAwnceyWQhXZwxQtwlQmY7ol9IrTQzw7rfQ6BYw0w+wiw14ovbY6YDEhwpwlwpQ9w3Erwnw8EsAJZbIHRFAeCIcLEEAZADNZEbcZjQzVjINVQRELqGEIYZgJHDjdHUzTiChGrTiOzMTcwLqGSJ9C9GDLREKAFfGe4E4IeYmKUMeQIW1WmZpGFH0LUC+dmAuJFToZraAAYFEq3cvSvAAfmmFA3zFGi4w0UFG6BBh+xdLAAwGQBCn/iIAgEZQ6AAGoglvgD0h8tE3ZLUQARiqVUIzdGNYtVAOsziigjlOAABZZ1AQZCKvHQauU7a8cLH8SLQsX2QjfMJdDM2NVMVsLgaLYtHZZLDBT8buLNX2SvX8MANsuEofKAGqL0l8VsndTdLqMQGqaAoQA1X5DdFgSNaNPBLTYvMYDofEY9bkyiRHT8MAdQLjVHIoREOxA8qnSvdHA8/EfHD3MYGEfEGEInC/VlIOHIUsnXX8drR7AsXoP9KlCjaAuQeaVnW9XcozEzZHMcCzJBDHQKbHezXHSTTiYC58tzBTYC+nT8NAbCr8F6HIfoR5WI1CeIyQoYCMLgeyUkXIpUnohYxiCiodaYW3VXfMJitAAk93d46ySi6YckRvQPA4vdXojixAVYjirikY6YMSzgAS03IS83OkwI+tf7IHVCNCvCtAcCgzSiVjUzFHHjOCgTBC2U5C6SNConBRLC1nLSginQPmenB1WSdGLS7GbRWCZkiwbcWIIgLpNaQZf5aOIFdQJWCVZmPUqkQ9Q02wemNUJmc+OeBFNVI0SQ58UEPcOsFqUBWGRcTEEVDUaQW0cKqVPeKkFqGK40pmMUeFAwCQJQWIKEqKhq4Kh0awOWbeJAWKm+K1YpdKzgPCRGIfaYEoMAE3cQSNfisa1uCQOQCERgTudKGqDAEa9JNajaH8VwQ0smRVJmLUXGIYWAJecWPCUcHScSJ3KSexFKMyMxQSABc6vSRid1FKa6k0ZSHCAaiWSYR6hiRiGERUhYRxNKtGeycQaqWqDSSsasKmA8NqIWDqCKEOfqQaYada9GjGzGrGzaCaCKcuWaJJb+MJVJDaBpSadFTFI6E6HbIqC/EPeY2XbSdK1Y58C/WIAGcQJAUAAIRQXlIQPATCEAVwVwIAA"}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { Tick } from 'viem/tempo'
import { config } from './config'

const level = await Actions.dex.getTickLevel(config, {
  base: '0x20c0000000000000000000000000000000000001',
  tick: Tick.fromPrice('1.001'),
  isBid: true,
})

console.log('Tick level:', level)
// @log: Tick level: { head: 1n, tail: 5n, totalLiquidity: 1000000000n }
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.getTickLevel.md","from":5970,"to":6226}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Order ID of the first order at this tick (0 if empty) */
  head: bigint
  /** Order ID of the last order at this tick (0 if empty) */
  tail: bigint
  /** Total liquidity available at this tick level */
  totalLiquidity: bigint
}
```

Returns the price level information including the order IDs for the head and tail of the FIFO queue at this price level, and the total liquidity available.

## Parameters

### base

* **Type:** `Address`

Address of the base token.

### isBid

* **Type:** `boolean`

Whether to query the bid side (`true`) or ask side (`false`).

### tick

* **Type:** `number`

Price tick to query. Can be created using `Tick.fromPrice()`.

## Viem

* [`dex.getTickLevel`](https://viem.sh/tempo/actions/dex.getTickLevel)

---

---
url: /tempo/actions/dex.place.md
---
# `dex.place`

Places a limit order on the Stablecoin DEX orderbook.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.place.md","from":126,"to":6672}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"ae78873af261e30e0a9ea1adc6baa89b8d91d755de180f0299788136db141068","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScAGYArmD8gmCcWJJwMACqYIxocEFEobEwiJxipBZKFJywvCyhcCVgscwARmQRJS2MShZoADrZrOxcqaTpWTmmUBC8CAYAsrFyAljm8JzipWjlypykMFj76WASxskQ0RucTa1knC0YVz0kyXRsliecF/fhMJwAjNZOEFAW8hIo0BEAHQDAYAWk4ABEZg1OPg0GgsA0APTYoiMGDMKFwfDY6azbGxATmATwbGjcbZXKUajiJRzZDIEB0cSsBQslhsDicYApNKZJlwTiuGKkCDMTgAcnxhMVsLADIlkyCioALAAmayKqrSCIDXGcA3Wa0221gEAAXQdom0+l1mjMihUakQgK0kl0gU1E2Z8gsVn+dgcpCcNHIiGk7k8ODwhBI5H89CYQ2FABVGLwANYssSSfQADkjnuUqiQuv9Oj0eHzRZZ5ksSH1UccznjiY81C8qd8GeoATwITCkU4vBMXFnYGi3RKAGEhEulANBcMZ+vuiXXUh/v8AKzyL21xAANgbgbwC43bfDSAAzN2Y723APMCmDGm/GOWYGAuYhfKQsCkAAklAnTdL0B5lkeuqyNW3oaLeTYGOwEHQU+HaIGeID2D2cZIOWSaDr+PjpiyNBAURc57DAvAwIwWBoCUuYxsIsZJAASsxrHsSy5JzCAXHiDxiRCExLFsWgUIIVIvonuW541j6HraHeBj7HJwlhvhhHER+pG+uoFE/t4/6jnRgTbsKRhJKYpbKf86g3qhl5aQGmGGNJwh4VYxnRrGLiIC+J6WUOf4jrR44GA5XCwLQSn6P85b1l5PpvqyjaBClQVICFJHhbqL7RVRNnxfRcQJGcKRyE4MAAMoYAkAA8a6Lt0AB8QQPsunDdRuVSjLyehkKiTkmFCKVQqszVtQkUIAAqOMwk1jF1e5KL1HScKtcrMIw6QdcAAycFdYE4TB9xwScADcl3Xcw4iFmQJQAAbWLQAAkwBlBUrhfc9yTXWgEAfWA32/QDQPKCDYPXRszAQPEHH3T0T0vVdp0AEKMHdLQQBACiScjEMFoWjTNG0pCU1delCZjElSWcAn6WgYOuL1AxgBNcCpCxjVLe1vAiSieCrU1LFSps5gnVw2F3DJqh/CrpAk1DMJgAMAByEA0Jx+CnZwZubHA4v4HKkCxPLAWcKo4hcAA7uIkwxOwTv4H82ySXAvFqxAAxtObCRyLEsBQF8ySbC0cgzIW9wwNE7B/PsaCxKQ2S7JsRzvOkin+uySCctytC8qsuBUF9de5FuOZcKKvD7C7MAjd0VTopi0qyvKSoAALu0oJ3YrO+xqoMQrN07hJsH30THUPI9jxPMDjw4FhwFPSUijwAVSjKS8D4qw9smv6fYjQQxTwMIHzrtnAALwzm3NCd0oQQXeDxHbyUyAb5sFzPANAlg0DOhev7YQM9UQ/xRoA+eEAoREwdCUHuWAggRAoC9dwAxXBmj1gkRiRwlhcFfuId2OQD5nDgHNOgC1ZatXFgNXaVR4Go3RicEowZJQ6kBEaKoV5sFQOppxamUIT7MCOgWGAOprBQmkNIRUIjwaQ2hiURUv1DS8ChHo48xooFeE0S0WIGBDFgAIQMOuX1HQUC5ONZgLJBpKE4AiT+ilnQOI2iyRxW0pQInWjGTacY6F2K5JnbOgUqC5l9k7bigdHbM3khsMAMcYAvGSi7cQnjnQgFculcsalsoyAwkGJhy0JaGWCu+MK8Z3SVWsnFTMgRJyMHCFEB+u4epKFXLtRuM9umPhdIhX00hikKA0kgTy2k/IuKKgRWpn4CIWW/DFaiAE7ITkOBAHAHAMBRF5FwzGXRsYMBGcpfUfoSnXjKXgI5GMFmeRMnUzsjThw0RaROUI7Tpy8O1AUSOxQtg7EqNUZidQ5CohuPTA6pzegDJ3P80MIBRJ4EWMsNiax5YgoqExQ48AIQuySF8S4mwYV3AeE8RgLxOBgg+MrS4LRfgAiBCCaw9KITQnVAiZEsx0EYixIgXEKoiQkjJCiSk1IcgEjgPScUIZTASFLigLkPI+Q1xAHvUUyKj79wVMqAkzA74agVXwvUhpjScFNOabElpDS2kdfaJ0Fz9BXImReH01zZlBjNZMJ5SyzKAnebFT5gFWk7L2ZgKIAgiy01uKOApnYDTqTQogLKPq8CxuLNU9CRFQrLP1CGjZtkEpaqbpwFsOb8mHkQPqXUHqpnpruQYKtCyPQvOWeRNZVVmnhrwHVR2UiZEsSCIcWR4iiySOOiOmAa1ygsQOlW6d8pZ1QgElnHOuYvD80FsLP4w6F2arRQYbq6ZchXHHSLBGrjIZXGzbrAYyAWoSATsxCAFgkQAFEAAah0F0VAdEEDBOIJWzChEA5BtAMAAC96RykhrOOQ2I6DEWUBvIWzEADEH0MBwgXCxdikRaJsg5GqyuGqWQ2IbtPHcooq2L2XoqCAtBr5IJNRaWdpKARQiBK/bNnBrD30Ytm/4L9K0SMPbI/hvGVGcAtEJ4hwguDZv1OJ5dUnR2Kn+Lx20cmFPqk40e7jOnrRif49TVlimunZpfOpyTM6j0ybM/pu1AjDN2q498BRSjpDiYE3CdzSnQLZt1PZqdmm5FaMUUo1zbigs2PCSARxvjjMIliX8K9fxwhXBvcCOdSgoRVD6CAUz1h/gleKyAHzSiSvQiS5EnOpgMtO0s4CoouTXWdhPLlSZaaUKZoMJF9tgbwr/Aqj2ppYatkGDHXKKNBynZQ0UCUEr2jrC8EdVt7bO3dvlZK2lTs6gsp9cvIRQb1Blv2lzYgYpnazJFsmx8zZZa5u7LINGp2xjOAldMRgA7XWIr6hQqdn0GbfKBCsgslC93wqPeTFNl79EBabSFs1bpcAyYwAGAUUgGOsd9OEFjyWsxmxxK+iBLHX1OBoygEsTLcp8SwBxXAQUChwWmKUNjVxlP2fOy4GbVnJ0mp47verAYAApcQBQWqtxSbzv4m00OnQVDspnMAY5UtdjAFo9w5Su3SGMR9YAWu0/p3S2gsCnauwgKUHAtQly8F3EMBlDR1QACoeCcC+t1THChqe8CanAKUrscj4Bp3oQgUApRwFiPYDYUoKcmCx1CROX8IhfSqEnonCgoRkDlKQLB1PJIx2z37ud7sc5F59i7GckkU6cHthrpbnBXblBoC3ySjxDawChAAKxj9sGAvJdae+4JwJQidmVyG9wr6n28JAJD+C47Oze71t5yH7W3yAvo7LlnQsQ0wqRfSAyB4V2JICwAH1CdgSgwNyqajQMQcIiD1qhKx8QWBGDwZmPAOh6JmA5AsM98/9D90ZIRUkoAn1d85R99iQ0AIJSAT9gNBVQNL8YBr9b979sRH9QEX838P8v8f84CACgCQDg9D989oRK04lJ8IBp9Z9k9/c69kgw4m8Y5Q9VBwDzYm48V1Zvd0DEA58adoB6djcAB9d3d3AAdUkFziUCkPEJNj+DoIYIVy+BaD72YjQEVClBCSj3ln2GuFYnVjxxAlOhoBODkH+2EGtltnRilHMA+h9j+BaH10Nx4FWkgilHVkeCOEJDfSqEgDx0kD9l9keHMLEAhGsIGHCDsKEAcM4CcOyzkBnyNl9jxx7znQHxBWH2YDoU4BahgDCL+B30gA7xknIKlEgmxAAHlkCz9cR0DMCdBsDcDn9X9dR39sRP9v8qioRSCsNxA4RyiYA4QhA4Qqi4RBAog05SABg0YjCLA5i3ozhjcv0KNq5G9Wddh+DVDQhGCc8YAvpEB1QbEB9hMjjU8IAv5FRfZUjbcbdSA5AoAVEwYjNehUR7jE5W92AXiqg70wCqRLjy9rjbjvjbcABSHeKoRUJ4l4t421f9T49BGAB43454qAAE23IE/oYLFPfPdgIISwV2TgL9UgAvHUaQwgXZOAKoTHfQvFZlGOBwLAHASwV4iICId4zzHYC9QkvHVHQOXQSArYJwZOf2EWQEhA/PU4sAC0K6ckgvEoak0mLEek+USPJk8QFkz/dkjXJElGWvZADJUINBE8FSQ066WvWXcodiKEUgeISCE3U2OAbqOyYEQQogZgX0F8fUX0csQhBU60rgWozQ7Qh0p0l006d0gIT06AYob0iKawaQCKQMq0q6WvQQ3oMgAWZDKolDWgZiKkJIRAdQdQMZDMjYLgE0wFB0OENvPUz6K8OtfUKs2vU0uQW0lJYkhMxAHMnOUIYgv/Qs4ss4Mslsq8awIMu1I0rgbMk4XMoct6CwFDQFcQm9OtF8CKdULpFHP4V+RUaQxgVIzgPieg7eIQRUMGBXKESvMAIIL6RESSXQPHAGfc1wAAQiRBfLIE/K+m5KRJkROFRGfPQzx2PNPPPK6CJzAG/LAtfM/OxK2EQOsTrnVA2KrnZ3tj4PJ19ypxnCDzdyIXOLgBBOVipHE0DBfTbmYBak1MIFdiwRvMYnzyor0BoryPos2kYuYvIppwwHwvZ1fhJPx1zyErkXAKqCoLBgWMEqYLnTTx1AhIxIRMAvlN5JRLRDRJ+PhKxJb3ALkokrBOUp0qhJhKVD0sRI0uRJAtRPRL0uQsMrAGYHkquIFOJJgFJKVKJKPJpPVNKE1NUG1N1LZMUA1xUXUo+Lss4GQB8tIBVP8rpMCsZN2GZLRCbI5OdBb3z13MYn3PEyPJPJn2gsvLAGvKMoUrvLkMfIQruHfImi/J/PAv/Kis0pirqoguKrPIvNgvgt/NICQpyopLQtsRLjI3yWKJZGQEx2zhYlP1QPPx6FUFiBaChFnGYAvwTIHy2tgGxATnoLxAIJwMYBaHHiqoHwiEdDySTQil1E8lBzzQuwVwWX+C7HzVKnjGsGLWqi+Vm30OgCiGMqUqFLZBgAAH4Sgu8qg9Eb92IkhQggleRUQu9kAHQDoiAP0Y4ggABqMTEcROHUq6qgE9EAYCi9O9L6XE6nTg8PEk9sOdTgDFFYdnAMZoCEKUXgevMOVIYPDXKoWmlwgYJcMYLgdghPFwlIcoN6UgR4UGkUkvDYU8nUqAGVIQA48WnLWPFoMQHIEsoQHHQodYIXE8yQFvHfcdE4aIIIF8DPBazEc/N6MAdQG/Vo9sWIVjJ2yYsGuVJ2l8eDXoaIKEF8AYtAQAwhIIfgtmzaECjYIw0IGfXm9IGOO9HfEsuQSRdgVYove2oVJo7auhLA0SHA9uDo463oqVE80OwArDdOlYl2eutAOEAMSIblEiuuC44LR+DGcTE8Fiq4pSxUWcDGEoSE14qoYek4Nq2y3IEoSezGM8FvXEkElPQe+exAK1ee6e8m1EdezgRe6Uo/PEmxdUIo0or6dOzO0gbOu2lAzENAgu12u/Yu9opuzo7oiuy+wYuurOhu3+pulu2Y72RYv4ZY/+pIYuVkFVcuHYliFkIgBRHTARa6wHSKE7T1V8FtMwG416962HeMbtBHZ7UteiLpTWaCWCM5Q7CKdQKsR6ssrB8hqAXB0beMfUKKJ7AwZVFkfcvANPahl8csWwG5YRmbEAWo8CO4SCREEoN6l8a7MwZ8X0LKfBpAb6vJWcWAbMQZUUGaYQRjU+Veb/SDXeCtHVP1C9Y+JjUVUxnRiTIsAxg1UVNjW+RFYUFuJ+Kx0+KEc6npE1LpUUJhqoZJdiPuChKhLgPRuheaRaFiSpVhHpdhF6B5bhMUMYLUXIfha0K1YRHBNRMRexwsFdaRJzaLWLVRK6dRFbJUdbTbPbephplzPJyp77RUP7CxKxIhW8weiRiCTgaRjeqoJhwhFkEJcQJAUAAIRQVnIQLNBAVwVwIAA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { Tick } from 'viem/tempo'
import { config } from './config'

const { orderId, receipt } = await Actions.dex.placeSync(config, {
  amount: parseUnits('100', 6),
  tick: Tick.fromPrice('0.99'),
  token: '0x20c0000000000000000000000000000000000001',
  type: 'buy',
})

console.log('Order ID:', orderId)
// @log: Order ID: 123n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `dex.place` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.place.md","from":7011,"to":7563}<fsm-vh3gqscxm4e>
import { Actions } from 'wagmi/tempo'
import { Actions as viem_Actions } from 'viem/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'
import { parseUnits } from 'viem'
import { Tick } from 'viem/tempo'

const hash = await Actions.dex.place(config, {
  amount: parseUnits('100', 6),
  tick: Tick.fromPrice('0.99'),
  token: '0x20c0000000000000000000000000000000000001',
  type: 'buy',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args: { orderId } } 
  = viem_Actions.dex.place.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.place.md","from":7590,"to":7985}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** ID of the placed order */
  orderId: bigint
  /** Address of the order maker */
  maker: Address
  /** Address of the base token */
  token: Address
  /** Amount of tokens in the order */
  amount: bigint
  /** Whether this is a buy order */
  isBid: boolean
  /** Price tick for the order */
  tick: number
  /** Transaction receipt */
  receipt: TransactionReceipt
}
```

## Parameters

### amount

* **Type:** `bigint`

Amount of tokens to place in the order.

### tick

* **Type:** `number`

Price tick for the order. Use `Tick.fromPrice()` to convert from a price string.

### token

* **Type:** `Address`

Address of the base token.

### type

* **Type:** `OrderType`

Order type - `'buy'` to buy the token, `'sell'` to sell it.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`dex.place`](https://viem.sh/tempo/actions/dex.place)

---

---
url: /tempo/actions/dex.placeFlip.md
---
# `dex.placeFlip`

Places a flip order that automatically flips to the opposite side when filled.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.placeFlip.md","from":155,"to":7335}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"e9b109959543a4af97fa80fd74ff57c367fad28063d8fae2ea79374624391edb","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScAGYArmD8gmCcWJJwMACqYIxocEFEobEwiJxipBZKFJywvCyhcCVgscwARmQRJS2MShZoADrZrOxcqaTpWTmmUBC8CAYAsrFyAljm8JzipWjlypykMFj76WASxskQ0RucTa1knC0YVz0kyXRsliecF/fhMJwAjNZOEFAW8hIo0BEAHQDAYAWk4ABEZg1OPg0GgsA0APTYoiMGDMKFwfDY6azbGxATmATwbGjcbZXKUajiJRzZDIEB0cSsBQslhsDicYApNKZJlwTiuGKkCDMTgAcnxhMVsLADIlkyCioALAAmayKqrSCIDXGcA3Wa0221gEAAXQdom0+l1mjMihUakQgK0kl0gU1E2Z8gsVn+dgcpCcNHIiGk7k8ODwhBI5H89CYQ2FABVGLwANYssSSfQADkjnuUqiQuv9Oj0eHzRZZ5ksSH1UccznjiY81C8qd8GeoATwITCkU4vBMXFnYGi3RKAGEhEulANBcMZ+vuiXXUh/v8AKzyL21xAANgbgbwC43bfDSAAzN2Y723APMCmDGm/GOWYGAuYhfKQsCkAAklAnTdL0B5lkeuqyNW3oaLeTYGOwEHQU+HaIGeID2D2cZIOWSaDr+PjpiyNBAURc57DAvAwIwWBoCUuYxsIsZJAASsxrHsSy5JzCAXHiDxiRCExLFsWgUIIVIvonuW541j6HraHeBj7HJwlhvhhHER+pG+uoFE/t4/6jnRgTbsKRhJKYpbKf86g3qhl5aQGmGGNJwh4VYxnRrGLiIC+J6WUOf4jrR44GA5XCwLQSn6P85b1l5PpvqyjaBClQVICFJHhbqL7RVRNnxfRcQJGcKRyE4MAAGLmFgADKGAJAAPGui7dAAfEED7Lpw/UblUoy8noZCok5JhQilUKrM1bVsV1CRQgACo4zCzWMfV7kog0dJw21yswjDpD1wADJwD1gThMH3HBJwANz3Y9zDiIWZAlAABtYtAACTAGUFSuADn3JI9aAQH9YCA8DYMQ8oUMw49GzMBA8Qca9PQfV9D3XQAQowL0tBAEAKJJmNwwWhaNM0bSkPTD3RO1LZM9cLNkOzslCfjElSWcAn6WgMOuINAxgDNcCpCxjVre1m28CJKJ4NtTUsVKmyc2xT13Ko4hcOIVLyqbBahHIjwG1inAAO74IoMSMHIChQDCYADAAchANCcfg12cCHmxwN19hypAsR6wFnAm1wjviJMMTsAnLsJ9xcC8TJ8MDG0ocJHIsSwFAXzJJsLRyDMhb3DA0TsH8+xoLEpDZLsmxHO86SKf67JIJy3K0Lyqy4FQAOT7kW45lwoq8PspswBN3RVOimLSrK8pKgAAsnShXdis77GqgxCnPCeEmwm/RJdu/74fx8wEfDgWHAp9JSKPABVKMq39vio95skfk3bENAhinwGCBecx1OAAF4ZyLxoCvJQQQ7qw2Im/EoyBwFsFzPANAlg0DOi+tsSSCthionQVjHBV8IBQgpg6Eo68sBBAiBQL67gBiuDND7BIjEjhLC4Ag8QyccjfzOHAJadAVo61aqrSOI1jpVGodjXGJwSjBklDqQERoqhXnYV9e23NOKMyhP/ZgF0CwwB0VCaw/xFSGNhgIIspiizmMulYliOprBQmkNIRxHDnEI0UCURUwNDS8ChNE48xpSFeDCS0WIGA4lgB4QMSeANHQUC5NNZgLJRpKE4AiFBilnS5L2iyPJB0pQIl2jGfacYpHZK5C3NugUqC5kzmQ0WSRBbyQ2GAcuMAXjJVNuIMpzoQCuXSuWNS2Ujy5W0n5VaLF1qdUjkVAi74wrxndJVaycVMyBEnIwcIURoG7gGkoVcx0Z7nyuY+F0iFECGi7As68GFAiFK2SVUy4Urz/AOcOGixyJyHAgDgDgGAoi8nUfjLohMGDPOUvqf4WUFAaSQJ5ZZgQ4V4y2Z5EyuzOzAtiqCwCJzQhnOnFo7UBQS7FC2DsSo1RmJ1DkKiG4rMzqIt6PcncdLQwgFEngRYyw2JrD1syioTFDjwAhFbGS3xNjcruA8J4jAXicDBB8Lg3wWi/ABECEE1hdUQmhOqBEyJZjMIxFiRAuIVREhJGSFElJqQ5AJHAek4oQymAkAPFAXIeR8nHiAT+oohW/y3gqZUBJmCQI1H67RepDTGk4Kac02JLSGltPm+0ToUX6H1KW9SaFfS2DyjpEA0bCU7M/JWsl1EAJ2XBXKKFmAojGMZszW4o4Zmdl1J5TFFb5m4rwD21shkrAemJY2/UzbqpgsSrPTg3M0qdhPCOi8PosoToMBumd6EiKhUbf8Rd34YottsglEAdV44WK8TYw41i3GFg8fKZ9O1ygsTOtzT9ljf0wChAJVu7dcxeFlvLRWfwn3AY1rMPA/V0y5CuK+pWaMinwyuC4j96pkAdQkNXZiEALBIgAKIAA1zq/oqA6IILCcRutmFCXB9DaAYAAF70jlPDWcchsR0GIsoZ+CtmIAGI/oYDhAuFi7FIi0TZByENI8w0skydPM+O5RTcxvnfRUEBaBgLoUmi0z6viXH+HY+BCdGacGsFAxieH/i2YA/B6xtijRRAtI5/hwguB4f1G5sxHnvGKms/mxxnBfPqnM8ByzAI7H2Ns3h41fnLl4ZfCF9xYWbEReSw4nzObdFxZzRZ74vj/HSFS/ZuEpX/OgTw7qHLH68s+L8f46LFp6vWgyZPFptbKlUAw38BEXS/ijY2NKrDwIQNKChFUPoIBIv2OW0tkAVX/HLehINtp7dTATbs0WTgDKiiTOLZ2QF5bLwoQPfezxCHj2IDnWesy7kl1HMpe2yFZAu3HZ5mqgdh5XnlneaOy8+7fKBDw1s+Z86zKXuTIcilbbV0PKPdMkH+o5k3b3V85sjM4cNrMuRK9VUvto/vfER9j3POjffYB79z7/2hbpyxUDeh2mQZwNB/aCtmqxufYhsSKG/vSqm7NnDmw8PewGIR4jChZzkcRNR2jBZ6OMftcx0SbG6FQk4zxiF/GaZCdoCJ3Q2JxO8CkzAGTcmDi5AiEpoNQ9Q1jw01POAArhS6fs3/AzRmTMQLK+rpW3xIu1ZOxl5zjNXMIPc+z/LkXus5pjwFgHwWE9s6/cBrztpU8OdDxVqzhWo91wa5lxm2Xs+5aT/norMWSt9b4fF6xiWts1YQWl3r6emuMxa7Xtr9fwmdYCcV4pDXMmDbyVUhL43M5TfCFcWbQR5uLc4Mt1b/x1ub822PnbZSckgH2x08S3T7NnZA46KZg7XnSFyhDn0d3oeTqT8T09pV4z/AquTlHra70ggIVO0YUE4QkkY98IlrBeB81YC4D4CEC1sQBN0Ip0U8dioCcDB4ZEYtkUIEdwokdKJ/9b16IgCO0/tQCrIShlskkMBlsUCXwrwUIn86xMCiCtk/RP9/l4xCCrIQUAD6I5Z+dYMrk4AaYYABgChSBRDxDblhBxCRdmxM4AYQJxCAZOAcYoAlhJs5R8RYAZtBQFA2UkklBCYilVCjDE5Q4pQ4AWB3ZJAwCM4JCwAAApcQAoDqBeAZCwv4faETa6BUCFPQmAcuDVR2GAFoe4OUR2dIMYOXMAI7TQ7QnVWgc+KUNAR2CAUoHAWoJcXgXcIYPVBodUAAKh4E4ABn6jEIUHUN4CajgClEdhyHwA0L0EICgBsNiHsGmwqJ8KhBrlQQiABiqBUJMHEKhDIDlFIDYXUMknLlGPkIUChGTnbhmIzlNhnEknrk4FjhCMcMdnKBoEcMkkeH9lgChAACsbDtgYBeRvYyjuBOAlAa5DU5Beixiaii5SwEg/hCk249icMDicg/gcNkAAYIVdYpExBpgqQAYGMmNHVsRIBYArioR2AlAWMfUmoaAxA4QiB9RdQDdsRxAsBGBeMZh4ApF0RmA5AJMITKToTcZIRBkoB5dwS5RITiQ0AIJSA4StdMRmNkSYBUT0TMTsRsSCE8SCSiSSSyT6SGioRqTaT5SGjuTJjoR11M5niIBXj3jFiYBaitjC5djy4mjVAmTQ5Z5ZVVA/gAYhTEAfD1Ckilj1QAB9EokogAdUkA7iUA9NdKDj+G1N1J8K+BaAuOYjQEVClEaXaL1n2GuFYhtOkJAmuhoBOFtgGAjgSHwGjlxilHMD+icKiIgBiLuG4G2kgnSJdkeCOEJBIyqEgGkMkBBJrNELTIhEzLlmzKjiEHzM4ELL+Bti+GTM4DOJAyuOZVuOYCkU4A6hgFbL+DBMgCOJkhVM4EgmxAAHk+SETcQhSRSdAxSJTcT8TCTjNZTyTOSlSJNxA4QVyYA4QhA4QVS4RBBu12ABgcYEyLBG5SAfozh4iKM1Mx4djbDdgbSniXjQg9TqiDTEB1RMkrinN9T+iIBUFFQXYPYsjMjSA5AoBHEYY28ThUQsKa4nZ2B8KqgcNGSqQUK4K0KMKyKsiABSd+KoRUXC/Cwi7NdXEi5hGAbCiivCqAairI2i/oRrcYyY9gIISwR2TgCjUgKYnUT0wgSFOAKoMQ2M2VQ1cuBwLAHASwAiiICIIi8rHYNDGS6Q/nHOXQFkrYJwOuMhJWGitU5ShCsAC0B6JSqYkoNS6mLELS+UNo3S8QfSkkoykI3irGDY5AEZUIJhE8FSGKx6DYzw8odiKEUgeISCBI4OOAfqOyYEe0ogZgX0F8fUX0csXhbytKrgLc8MyM7K3K/K66IqgIEq6AYoMqiKawaQCKGq1Kh6DY+03oMgOWQTFUs3ZiKkJIF7dQX0aQYajYLgeKhlB0OEA4yK/6K8V5fUFajYhKuQDKgZOS7qxAca9uUIK8ykma3gOaoQF7Paq8awWqnNWKrgMak4Cam6n6CwITBlV0rDV5F8CKdUS5IQv4BBRUT092N4viHUt+IQRUGGPolYsAIIAGRESSXQaQsGKG1wAAQiRFxrICJoBjMt4qsX4tJtE2kLho9k4ERq6HkLABJpxvpqJrEq2B5P6wBnVGAtHiMNjmtOUKqLUJnHqOKL4SQu90a31SpFs0DCI0XmYA6hCsIEdjYTRsYkmOVr0FVunI1v2i1p1voq4GYAwAlqMIQXkpkKWJtpsSZKqHVJhi/Oto+JAwGJ1GYuEu4qpq8ost6FIsEvIq4tEscKZI9qdsYt9rDtYvYqVAjp4qDr4tyAEqEojp5ujrACttjusrkpgAUt8tkthvUqCtKBCtUDCoisMsUBCMcUDuIozs4GQFLtIH8ors0qrp0t2D0rRB2uMudEcMmIhsYihts1hvhuZqRrZtRpjq9uWJ9Kxs5rxs4AJpmmJrprxopubuDtprXruEZoRrnrEPZp3vJp5rHrAGn37hU2mQXJZGQDELbhYnhO10RJ6FUFiBaChFnGYCRO6quKAdgGxGrh1LxGlOM3MBaCPiXquOdyLSxxeRfHLB3SxRezYJ8I4NynwPjGsE+1R0ANjOgCiFjp9tsrZBgAAH4SgTiqhok0T2IkhQh6leRUQTjkAHQzoiAyNy4ggABqVzEcGucK53KgUVAwGmtDHDAGCS9Qs0lo+S9sEDTgcVFYIwgMZoCEKUXgI0ybcIdISOpRpwgYJcMYLgE0noyC19H6UgR4Kh+yuYjYJm8KqAL1IQGC6x5fOAX+sQHIR6vhK/GwuwpqaQ0E9k3oaIIIF8IYj+zEREn6MAdQNEo89sWIYzZJl86hn1ZJl8XjaJqEF8RUtAGk3hIISC7R/aEijYBM4c1IBogErIsEuauQcxdgACmYhJh1fc4BqRUU0ScUpeU86B4k0kj1d2UpmkiTNpv8gC+Z02OEAMSIS1WWyeZChW3cPGWzE8XW1Cn2xUWcPGEoFigiqoY5k4fe9O1ES5/GM8RwiS+i8Yw5u5xADNO565mR25+FEoB5tymEySzJdUecpcgGNpjp/802bp/k3p0B4UgZo8oZk8tAKU888ZskiFm8uZzp02RZ1FlZj8mypuIufFpIPuVkV3LkcCliFkIgXxazXRG/S7CKaQDFXdV8NggY3BkncKMnZHfgkg75RibCMgaCWCJFFA3Uf4DBitHyfKPAUVqCKAHlrgklPq5tQNFkKGvAblllg0QiFgmwFdEAdZI2aQyCREEoXUbde0Z7U8Xlgh1wKZWcWAbMB5UUBaYQfTABB+Mk9jD+NdKNFNVOAPABZ1QNj19df3WNJUZ1YPNgSNnTR5boH1uNKEeB65JNS5UUJV6CKoPSIWTeERMRLgL1qRZaVZeRDaRRQpFRL6fFDRMUMYLUXIHRa0DNAxIJDmLmXtaNuvXPTzArexQJUhPtxPQd8LLbUd4JRGMJKAmAxApd5d60BxbthOBJJUWg1JdJPhPow5s1pVjcq1jNPNqAXhFkRpcQJAUAAIRQWwoQPAZkVwVwIAA=="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { Tick } from 'viem/tempo'
import { config } from './config'

const { orderId, receipt } = await Actions.dex.placeFlipSync(config, {
  amount: parseUnits('100', 6),
  flipTick: Tick.fromPrice('1.01'),
  tick: Tick.fromPrice('0.99'),
  token: '0x20c0000000000000000000000000000000000001',
  type: 'buy',
})

console.log('Flip order ID:', orderId)
// @log: Flip order ID: 456n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `dex.placeFlip` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.placeFlip.md","from":7678,"to":8274}<fsm-vh3gqscxm4e>
import { Actions } from 'wagmi/tempo'
import { Actions as viem_Actions } from 'viem/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'
import { parseUnits } from 'viem'
import { Tick } from 'viem/tempo'

const hash = await Actions.dex.placeFlip(config, {
  amount: parseUnits('100', 6),
  flipTick: Tick.fromPrice('1.01'),
  tick: Tick.fromPrice('0.99'),
  token: '0x20c0000000000000000000000000000000000001',
  type: 'buy',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args: { orderId } } 
  = viem_Actions.dex.placeFlip.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.placeFlip.md","from":8301,"to":8773}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** ID of the placed flip order */
  orderId: bigint
  /** Address of the order maker */
  maker: Address
  /** Address of the base token */
  token: Address
  /** Amount of tokens in the order */
  amount: bigint
  /** Whether this is a buy order */
  isBid: boolean
  /** Price tick for the order */
  tick: number
  /** Target tick to flip to when order is filled */
  flipTick: number
  /** Transaction receipt */
  receipt: TransactionReceipt
}
```

## Parameters

### amount

* **Type:** `bigint`

Amount of tokens to place in the order.

### flipTick

* **Type:** `number`

Target tick to flip to when order is filled. Must be greater than `tick` for buy orders, less than `tick` for sell orders.

### tick

* **Type:** `number`

Price tick for the order. Use `Tick.fromPrice()` to convert from a price string.

### token

* **Type:** `Address`

Address of the base token.

### type

* **Type:** `'buy' | 'sell'`

Order type - `'buy'` to buy the token, `'sell'` to sell it.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`dex.placeFlip`](https://viem.sh/tempo/actions/dex.placeFlip)

---

---
url: /tempo/actions/dex.sell.md
---
# `dex.sell`

Sells a specific amount of tokens on the Stablecoin DEX orderbook.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.sell.md","from":138,"to":6272}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"997af5c0532953dd4e2e196ac8b932f9108ab9fe48dbcca2fc81f6d18ce19b1e","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScAGYArmD8gmCcWJJwMACqYIxocEFEobEwiJxipBZKFJywvCyhcCVgscwARmQRJS2MShZoADrZrOxcqaTpWTmmUBC8CAYAsrFyAljm8JzipWjlypykMFj76WASxskQ0RucTa1knC0YVz0kyXRsliecF/fhMJwAjNZOEFAW8hIo0BEAHQDAYAWk4ABEZg1OPg0GgsA0APTYoiMGDMKFwfDY6azbGxATmATwbGjcbZXKUajiJRzZDIEB0cSsBQslhsDicYApNKZJlwTiuGKkCDMTgAcnxhMVsLADIlkyCioALAAmayKqrSCIDXGcA3Wa0221gEAAXQdom0+l1mjMihUakQgK0kl0gU1E2Z8gsVn+dgcpCcNHIiGk7k8ODwhBI5H89DwITCkU4vBMXALYGi3RKAGEhKWlANBcN81XuiyxJJ9AAOSOe5SqJAANn9Oj0eGL1ZZ5ksSH1UccznjiY81C8qd8GeoAWHhb2MF4MEYWDQJQAKjHhLGkgAlbe7/cs8lzEDH8SnxJCLc7vdoKHN11If7/ACs8hej2iAetogZ4Ps743mGE6ILq04xrOSBtkmi4pgYaZ+GuWYGHWwpGEkpgtlIvoAMxkUB3Y+mBAZDgYhEmGO4ZIAhID2DOcaTr2aGYBhPjpiyNC4SA+FcLAtDfq2v66p2CjUUglGsoOgQScxcFsRxSFcYgZG6rxS6YSuQnrgYcQJGcpQwHIcgAMoYAkAA8lYlt0AB8QQjmWnAudWVSjLyehkKijHCFCEnEtZdkObwUIAAqOMwQVjM5jZKG5HScHFcrMIw6SOcAAycMVb7XgenCPs+ZyXtBaAANwDK4bkDGAgVwKkO5WTZ9kJLeKJ4LZUVSps7Xbowpa8BszAQPEXDfGgEAANaKHAMJgAMAByEA0Ee+B5Zw+0jTF+BypAsTDS+ySqOIXAAO7iJMMTsJwqh/NsT5wGer4LQMbQHQkcixLAUBfMkmwtHIMyLfcMDROwfz7GgsSkNkuybEc7zpF+/rskgnLcrQvKrLgVAAAbk7ktZDMKoq8PsN0wL53RVOimLSrK8pKgAAvdSi5diBb7GqgxClwoo0EM7PRDl3O8/zgswALDgWHAwtiSKPCXVKMrS5zio82y8vw9iEtsMLAzFmIDauUonAALz5vTNBM0oQSFck+bK8IJTIKbECHvAaCWGgzpFS9J7tcMqLuyVnC+4SbBQowUAOiUrNYEEEQUGH7iNWa60JJuRxLFwDviPdOSa2cq0Rek3UxZ5aVVDHU0zScACSYAlMGko6oCRpVL2Wdh7lYDcNNs0APJUt34ohnkirSP+xqcEP2cewty1gJ3JSKtYtCGrFUJQn+xph5vijT+Ve8H9YR9QoaZ9gK4+fk6TjoUFyAXMCyXm2wiLsvzOi/olFk39kpSgRAlGMSU4yrQ/lyRGyNhAskPPgN6EcvrJCgmVIBzoQAkX0P8XUgEuzehQgOCCBg67RV6rBKwmloyxhcLpVCC4+LeCwquYSgQcyMHCFES2RY0oVjSlTUW1tRwumkr6f8bF5LkMQP2ZSVD2JpXUgwxCzD4zugMvxLhJkRJBEOBAHAHAMBRF5G3NAO97jdF6FJUi/xezKIUSBNslD6IgCsbNTuGikCkK0toycejOHGUzLw0I/C8w921AUQGxQtg7EqNUMazB6iNGaG0UgmUug9BOOI+ssTQwgDvHgRYyw9xrGGkkioW5DjwAhDdJIXxLibBuNk+4jxNjPEUJwMEHw5qXBaL8AEQIQTWAGRCaE6oETIlmGnDEWJEC4hVESEkZIUSUmpDkAkcB6Rz0lEJNkHIuQ8j5CTUS1MxZijGFqXIUsZbKgJMwc2GpDnaj1I/E0+cLRWltAC+0TppFOPUK44CPo/QqK8cU0w44rCBKYchX0+pQnLkEhE7MJizGYCiKPce1ir6dHsScRx+hDS2DISBf4U5oWBHxRPE4V9/FKK0ci1F7DDICWwjw7MUSBG3MZHEwoiSygVCqDUOochUQdPaMS/J/QRZFI+SUspCwS5VL2VcMVux9gNOOKcFp3x2lZLuA8J4jAXj9NoO8CErSfjpDGcCUENrwQnBmQXOZKJFmYhxHiF5xJSR3m2YwGkeyDl3Pnsc3GKAzmEwuQKa5GtYWPL1mst5sKdRWhXqac02JLQUoBTaIF+DCGTmIVRRRULwIwpVXClirL2JIp0s4tFRkMU4V4disguKXpLUULYvoIB96HyLWO8dE6i3/CHWSycZEPRuJop4wIF9t72noRoNlOkOXJjCR23lBhjFyhxRYvtW8iWcCHSOu+k7b13ptPqGdILyXSHkRCihdK8CruZRuxAHim2cRYTu9Ce6eWmXAG1DqfxLYQAUAMAopBrZwFg4klyyH+RUDVQ+dBnBSYwYUKTTg00oBLD+CY/EsAalwEFAoVJLRYhKHybbfDb0HBcH2tR3KchJB9peuggYAApcQBRbJ0w/EhlDRHtwOGyHABU5Hk4wBBua26MAWj3DlLddIYw1oDDQX8YjpHrWiylGgW6EBSg4FqBNBsQxBkNHVAAKh4LhtDKHCO8G43AKUt0cj4Ck6oaAUo4CxHsBsKUeGTAoahJDV2ERSZVEi8IaLZA5SkEzoRp8IMkvoZgFCe6KMMt8ZuvmJ8MNODnSU7x265QaC8afI8LasAoQACtgvbBgLyNaznuCcCUJDEZchcMscIyrCQCRoNpWRlVhanAas5DehZ5ApMTE7m88SNA0wqSkwdEEdOfrICwDa1CdgShNkUm4zQMQcIiD6l1FCWg2JxBYEYPSOUa3VromYHIAAxKt+A3nNszUhBsMAUABjLf++tsQsBSCkB23tpZB3oAwGO6d87+zLuBxu3dh7T2XtvZmADqEX3ftQ8B7DnJUIKo4f6xAQbw2osEdK8kP6lWQa+cC1SA61y6mvVw4d4oI2iPQFI7psAAB9RzjmADqkhUZKGlxL3afw6cM5Y18FoLXtxoEVFKWBhAoDDX2NcXcr1EOWzyjQE4cgMADDgMdU6M0pTmGWnxv4LRNPaZ4HFdupn0GPCOISCGMAqiQEQ5IVjMBHiW7EBCW3AxwiO6EM7zgru/ihCG9tdBiGmt5ba0kzrzBVqcEGlHuOpNIB1dfOTzg7dsSTwR/tlZ2JBdo50Bj7EWPru3fu4957r3yck7QN9n74g4RV5gHCIQcJydwkEFEOGpABjTRNxYJf6Szji4AKLxuJhV6jux+dq9CIz5LBHEDqjfm1i2TO8uxZ1OgmyFnzOkDkFARUEQGpgAtNlXoqIn9IY5t2B38qhZsYdgdb9z978IBXZFRACLMABSVWKoRUV/d/T/b/X/HYXINOKKF/EAqAMAizCAqkKA3LKEVLdgIISwW6TgbfOHagxUGXQgUxOAKoZDA3OpEZEGBwLAHASwD/CIL/PNLKHAqUKgxDJKbzNkDPMHLYJwaGd6TqcAzbVLS/H/fNYqBgtLEoFgiANgjg+UPQPaXYHgtEZ7AQpTUQ2OErZAGAeJVOf8WRGwkqErUTcofcKEUgeITuNBPKFyHhYEQXRAIgZgcifUX0NsX5LQtwrgSeLXHXbw3wsAfwuAQIgIYIlHUI8IsiawaQVhGI2ODYLgEI3oMgVqOQQnD7bEOgbcKkJIUCdQX0aQVw4qOwhw0IB0OEGrSwsgJRRAfUR9TQ4okrTouyMTfcLI2ARAcolGUIaogHWo2geos4UCXsJRawIo2w0o7IuYyo7EdJCwWo+JCXHVJQQYsiXSdUIRa4QKe2JUGXUNIbc8enFWIQRUb/FjfLeXIIUmREJ8XQRDAAEmAFaiSlcAAEIkRASyBITSYRCRi/8ThUQATlA7gnibJOBXiuhkswBoS0SgTITiCthKcBg351Rd8iZaNzo+ccNSY3NmdPNwgHMC5r84ByC5pucHZAxbIOteRbJjDCBbpM4vjNxUsHjeT+TmBBSkphTRTOSiMMBGS/gHZaCJMFAoQVSghgcqhUtESV9lS78YtYDH98DgC38hCsD81kTcC0RzT0CiDeNICwBmAjToCTS4CEDOBkCV40DCDMDRDbSACHTCCSSXS3SVTKDGD0t1SdCmD9DDDShjDVBuDxBeC+jBDP9ETsD/8fZ4zSA9DWCsQjCuCzD0yLD+DFAlNnReNUsbjNxwTVTHjnjsS3i8TPjDSoyCswA/jCS7hQSmyoSYT0TSB4ScybTxCSh+zENMSXj2zkN8SRyiSST6ywA35o1TkCEYBLlkBkNkYdxdtm9cQehVBYgWgoQCxmBW8Uc2sbzYBsQIZ6c8RcdHtzAWgBZjS2sIhHRS0fxdI5FK0QJaIVINxoCWU/wt0WFrA21uVuFwMggDdoAogoyH9pDPpdAAB+EoBrKoY+E7fcJIUIaBXkVEBrZAB0TKIgCAZOYEAAan+C+HTEhnTJ/Mw36gMGDN41JlILQEI05381oPhWpwqRWFowDGaAhClF4DKz+lSG8yUyqAEvdwGFLDGC4HZ3C3dxSHKHSVIEeHQtkNBxBkzw2CgCgF2SEFP00vCFKHPLEByAaKEHgxFWCxYFDR41m0hxwOiCCDIniyPKWRb3STAHUBOw73HFiEexCtn1kP2RCrIje16GiChDImH2+3ziCH5wkqShRI2BN1MvkvSBBi8tJgaLkChA3xugy0Ct9Rbzb1WnR2DW7zQBxz73x1e3KvSt+3KqqrQD6rhADEiA9XJPJhv0LmEGEVmgeP/DFI9If0VALFmhKEQI/yqCWvdWtLELzIbGWs4EAl414vIOiwWo2oPBXjOonO2pRJKDOpKAOtUK20VQpILjLwry6r6pqsRzqtxAavCrO2aoZh71fI6pDQqtJx+16vYE3wGqGsX2elXz+HX2huaSEGxlZBjXxkPx3BZCIGsBPhPmtF/OfUUl7FpUXUUmXTwFiwgs7CCWRTYV3XRTAxEluJwQ/CPEwUuhqjKj6lmDwEqk+kulKg/HRrLVYQXXfVAipoMHZpgjMAbUgoA20hYQolgoMUxUPW7XMSiHeiqiSAAAlwh8AShSZ95QTzjXB352L+aDAjaSR7VUzTMuazhZ1dIl4gLIVSEa0V0XbDbjbaaoKdF/hXB8ECxYAmAk1RRQptYOYFQ0DDZXs/Y1Yo7BV7lY7dZ4701CkaZJFuhU146oRPybY3lbjRQ5auAZQy4K4uAY7wo6BIp64EhG4bZm4w4fEO4u40754+5rQV414R4LACUp4Z5u7e5F5l5B5h4N5+011d5r1eB70l6J1/gn5ipv1R6b5R1l6d7bR9Qn4X4Gz5rTTFRBasELCSREAV4K6oQ9ahazh7b8A2KQBYFxAkBQAAgVokgv0EBXBXAgA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { config } from './config'

const { receipt } = await Actions.dex.sellSync(config, {
  amountIn: parseUnits('100', 6),
  minAmountOut: parseUnits('95', 6),
  tokenIn: '0x20c0000000000000000000000000000000000001',
  tokenOut: '0x20c0000000000000000000000000000000000002',
})

console.log('Transaction hash:', receipt.transactionHash)
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `dex.sell` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.sell.md","from":6610,"to":7042}<fsm-vh3gqscxm4e>
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'
import { parseUnits } from 'viem'

const hash = await Actions.dex.sell(config, {
  amountIn: parseUnits('100', 6),
  minAmountOut: parseUnits('95', 6),
  tokenIn: '0x20c0000000000000000000000000000000000001',
  tokenOut: '0x20c0000000000000000000000000000000000002',
})
const receipt = await waitForTransactionReceipt(config, { hash })
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.sell.md","from":7069,"to":7150}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Transaction receipt */
  receipt: TransactionReceipt
}
```

## Parameters

### amountIn

* **Type:** `bigint`

Amount of tokenIn to sell.

### minAmountOut

* **Type:** `bigint`

Minimum amount of tokenOut to receive.

### tokenIn

* **Type:** `Address`

Address of the token to sell.

### tokenOut

* **Type:** `Address`

Address of the token to receive.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`dex.sell`](https://viem.sh/tempo/actions/dex.sell)

---

---
url: /tempo/hooks/dex.useBalance.md
---
# `dex.useBalance`

Gets a user's token balance on the Stablecoin DEX.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.useBalance.md","from":125,"to":5462}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"86f30c8b6ecfcd05a596ac74359c0fbce656e58c96f45bc8cceeb1ce8f608b07","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUWKQQOBwYAJScUKJiiJwARowKplwAPpwArmCwAGamMFD+UBDWCHoAKvgwnDKiIpxwOdbW8HAFOTIyGJyk8BAyJFBxCaKcBeycyvUAjjlkGAB0ADpgGxu19Y3Nre2d3b39g3DDo+NiUzNznIvL65vPOw1NXAcdcF09fQNDIxKV0m01Iszq9yWpFWWxeEL2HzaXx+J3+50BY3i11B4IWUJhz228PeLSRR1+pwBlyxINuEIe0JW/hE4l0ABZ1MZ5EoVIg2RpxNogjT/CYzEgAEw2OykBxOJAADncnhweEIJHIGkCeGsEDAzWSokaYA6SVS6TAWVy+RgRTMpSo5UqeFeCNJh2+xz+ZwuQJpNzBdwZq2Zml0qgAjLJucokAB2AVaHR4Q3Gjqi4qS6X2Rx+RARtnK6heNW+TUBehMVjsLgGQSh1lIABsAGZo4pY4hOZohXg60YxeYpSBbDn5YgJU2i5hVXp1X4tZW9Cw2Bw4nQGxJEE3pFyO7y29RBcm9LBaBnxRPs7Lc84WxLpyW52X/DQlyBuia0Iw9bk4DAACEjVEE0YAAHgAYT1IoFAoFI0gyAA+UJ7GYHQyDgJJ+xWM8Vhyf8gLTGAVgABVQ9DSDgSDoLSODzSQ6IsL4QQcLoPCCOA0CVgAJR0HJSDAAA1I0ljA+jLUQjYwFENC4CwBx6nwwDOPTR0KiqfRmIDTghW/RROEmJTSAAcjgWYBHkFIVPqX87gAEQAUQADSZAUFCqZBkBAOgZKwOR/AAAyCtA4FoDYVxrThgB4ZizNcKZwmYThjIAd1EBRmEYAB6Ghq2M2FP0cH8wE4ABBLAsGCWJgA2ThOF1fUuGimk4MYOAABkIFEKBTAUTh4oAXhiwxWNodjlKI4IapKuqDPaCA8jQJJjIsMaVhWYyKFq2a0AssBltWiULGsdaVgjCNNu21xolhOrGAKThgjazrut62JBjQfiSrAnqiEQl6esUU6wKy37JJmj6vs4H7GD+wiQNNKKaVcEGwY2VwNiCgKQAAXQoLz5NlZh/EJmSKLMgBaTgyKJ8mmTxrzIYEowAEV8TRHouBSxhlFxP8yFM8z+Es1MEZskr7Oc+m8ZAFktzjQ85H3JAIysI8kyCJT4dAi8h2vOU8xbKcPGLWcfA1V9tT0UJwkiTBYgcXVFoAfiSALVoAEmAERSF61wAs4bIpu2urrBMeQls4CDw8tMDqllfVVzQOCILsUxA+tQpiigODptm/ODKgKAzkwsqi5LgBuEOC8gUCAFkQPSshXc4AA5PUOgb6TtDBbI8iz+0q5mguWjSMAW+CFDaacUu85Hgu7DgfAsKafAh/n/rYgGxDqcStrwO4OhENiPubTtIFT4Hkp1/nuAx9KnJlHYRgAC8EmKiep7Jmekgfp/fbft+PUvEHgiC3jvEie9/xgQAMr30foQAB79gF8QEtULwx8M791tNnLBZ9s43xHnfBQYA66dCbkkKanBZJwCbv1JIc8N51RoRQzgcCSGiGSHIMh3wm6EILtdTg29d4QEytAw+tBEL8PzqdTgbJqHsHqKdaRO0vBJDWMYCoRoNH8PitkAAUucMA3EsDWFKvNRaeCr5QCkdXWREoJQKMGJwZR1dzj8Q6C3bB58oBD3igAMk4O7WgXsfZ+wCifFx61OBxicUo6Jl8cH2jKOpPA5inaWgMmgMQtggS7T5tYI0MhHrMDgAoFY/4bSkGiE8WEpVy6dE4BAB6dxHYLUtK5WWYZFQKnbDyeMiZex6DaYtXWSBDyjhvOOB8JsZzeHnOWN8QQbYRDIPbIW8g3ae29mgX2ih/YpOdHoepxdGnNL5rtYWYBOly10AWTkSt+ldkGSeage0xl8n1reSUj4zYLMtu+aSsl5IdHqnqdEMANhEHEGC/UwwYBJCgnC/yakjkgFeAFBqEKA7MGgD0eoYRiCMFgGZSYd9WByHXMkHICgLR9SxfC8ECROBtVHplRogYIC4g2Po0Q0KYHWF9lgLgDLKVoVHGANqSVCVEGJUCZI/QUowGSCkcIKV/yUVqWAV4uKoD4s4HQJOZk0ApS5XJGA1h7qMGsGC6sZhLSYVhAAKjKkEpF2L6p7DMtzXmaEn5QDMgcfABkzKYvBfClYMgIAKCqgFOCYbkXETIOEUgsaDL5CCaK4iaUBJpuUMywpJVkiKX/GMfJKVfY0HMum/o7dYArAAFaBt2TAGSTwXWlR0lG1Mmbw1yADqYFkoFYUwX4nkrlFaeb1HycgAKhLkQVLQOUR+AUcbBHwNkrAmEspZUgLAJtKx2AKFBupLKjQaAiApkQCUbIVi0CyqILA2V52dBWBu5gMgADEL7vgiGXWgB2+QNizp/XARdsBSCkFXeuzd27d3QBgAeo9J7KhnoSPANAV6b13ofU+rKoG31oA/d+8IyI/3JpqZwV4Chu1Gl7YmgOhaUglqBD6wgj8WXVg4L1PmAU90IqzTivFcgtUAH0nVOoAOriElYoCTomkjUdo8UrNTTkgNotWgQWfrCABoMs4swPM6hgixW1Gglo+gbDgBgE0+BwiQHwg0Rgws+bJDVRqsqJEACSxq6iUn/MwLhMA4KQDBOIadfnYV3xEBHSz0lrO2fswtMyJgXNFKaXMMEdbiJNpaC2mSYG2EwAi/UWdkAq2/lA5wLzWUADy0GN1oC3YgHd/GkNaBQ3ANDF7MPXtvfex9z7SOvvfV+0QFNyswApnqCmoGKY/liKCDYuLnGmFBMwZB1zYQOVoL5Sl+EeN3BoxAHtCbsWIFhFjJtGws2RujcEYydRegTvYDIKAxlohDx3bvDIpcntRs4Ka0gb24L5L/QtNAN2+3ESjTGx7MBnucAAKRwE2slIHb2Ptfayj9h1SR/sveBznat4PH5Q8TSsZN7BghmBSpwBykHqfGUk4QCIcA4LnB0zxw0Yw7AVXkCUD7n2Njfcgb9g1jOwQsO0OmsYLJrD8FmDeadZql3Jou2Ab7dUGcpqSCzvgW6OeiJ0Pgbn3VOB85wPaEXOP87MuQDAaFMgcZdnzKoG3BdmUCqFWgFYpA8hee1abuASKlmPX44gIgzB8z3nzAqG6mvbezWZbV9Tmm/cB6D21UPgRw8Icj9HlsFhJCIBbPHj3duuAR4yGQaSMh8PDe+FlOgFrH7FUQHGOM+ZJAV+T1wB3TucYUwrY+yI24JwSl73VZljujTe8YMKvPsBEA14EkaBvFROjN9oK3oB+04xNm3BYBPWu++cGr5aWv6+NumGb070TYTFAThbKX2EWKq9kyEclSTjBeicG4idoOnqMZEPLdjmmAMEAFHZCBD3JwF7ECjAK4AAIScDQGKBkBIERLY644hRJBoGwE/5/4AGpBwpgAoH4EYGg6q4QakCYxBTba7YUolqHYQgBTurwqMZeoa50EBTXYmjgpcAQ5f5CgwL5bMAwLG6EApRVSgECES5ghDQiFiESFoRSEyHk7NDMAYDsGUpDS05RYRo6EwDBAQ5wQUZDzLbaHQ53Zw4E6A6vbvbC6J44F/YI4A4Y7E75IQ6WFGE2EPZ2Eo5o6pQOFY4e5i544W5uGE4g7VreFgBaG+FU6pr6E65M765s5G5c76Q84W6j4C6OFOGi57K4GcDICpGkB66s6G4tDG7KBm6855H2h4zVrJpv5yEIFf7M6/7FLEFAFgAgE+HWHgGQEUFgjwFkzIGoEwEYFYFhHFGlyjGcCEE9GAGkHkHTGkBIFUHyE8GvjpQeReT/i4BUDIDuKkAdBrqNbNY7rpDKA5DJArC6jMDwb7pdb8ZZRcInZZR9Y4YmDJBZS3ZNrRC4wyy3KSgWDDiPKdgJjqxDIjjQ4fIwmTIGzOAWC/LzIviLjLI6bQCxC+Gw7BDS4wAtwgQYBwSnQRB75Gg0wFZJCknIA4yMScBEAQDEqPQADUEYTSGoUa3UwJqKGk4RIU1aAUpOaAAcbG5+MAKUg4KwnAdcnMC+lKgoOQaEDq9UIEzGnA8k3wJQcEkpcwGwRQlEXASkYwTQfMYQLA4g/QRJsuBkf+3UPUVJxSZpIapIyQIgPMbeeoUKIk8AbKv+MKM6c6xRBQwQLY0QDWm6LWWUG2YAcYh6HWYoOQ968Zs2TcXW8ZLYDeGQBQKwLYhGH6CewQrSWgqpEcpKzi6WOppa1as6beMgKw62CQsalxsGsZbWYGyGToXW56GGWG/WuG2UjZRZX6jZLZaAk5FMgocA0QNSl2QUfB7+YKliQ0qgshFOBJxkGSkcSO72cEu5hROOQppcu5SQ6gJOS6cRt22555aOR52Bp5SQ55nAl5YO15ZOYAWMsIMCxWpRAUo5k5bZMGTWcGXZSZx6vZ3WA5PxA2eGo5o2n6E57AG2U5qFCQM5Wgc52kK29Qa2GFe+nSYg7kSAnksspgqkIARAFgZ0Z0FgFgIJwg3SE4qsfSnYh4PYrysOiJXy44SosyT45sC4FYQQK5osoEZoCEmSiSPihyGkroJInw5IqIPoGIwI2kQY+INyLFEoRe7FvIMJXFQQElVFg4AyI4MoKJkoAlKo3gJF/gCBeAPFzFjYz+u4UJvIasSyeAjkTkVkRESQqsDFIVIVYAHyu4yJ3ylgrgMsuosAVYScUUw0gg/UCUoi6O6UmUOUMAeUbRjUyVNIZo1kaVQ02EuEWs1kwcM0IyloB0tAcYbIEoUALYqgEE1gTYrYbIEEFgqg94kgEoqgogLYyQCobIbIAE1gkgMAcYqgkgqgBQFgyQDkyQyQl0M0lymyyUh0x0oVe1+1B1h1+1F0W0YA10+VEKfhxkflAVYsiAaOplMACe/gfqogSAoAgQ8gd8eoeAIUIArgrgQAA=="}
import { Hooks } from 'wagmi/tempo'

const { data: balance } = Hooks.dex.useBalance({
  account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000001',
})

console.log('DEX balance:', balance)
// @log: DEX balance: 1000000000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Return Type

See [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook return types.

### data

See [Wagmi Action `dex.getBalance` Return Type](/tempo/actions/dex.getBalance#return-type)

## Parameters

See [Wagmi Action `dex.getBalance` Parameters](/tempo/actions/dex.getBalance#parameters)

### query

See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook parameters.

## Action

* [`dex.getBalance`](/tempo/actions/dex.getBalance)

---

---
url: /tempo/hooks/dex.useBuy.md
---
# `dex.useBuy`

Buys a specific amount of tokens from the Stablecoin DEX orderbook.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.useBuy.md","from":138,"to":7274}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"19b864958a3edb268ed55df991f577eacfa8b004aba94539562aed8b4486c2ef","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUoiaicACUnABmAK5gjowQYJxY4nAwAKpgjGhwwURhcTCInCKkpgoUnLDWLGFwZWBxzABGZJFlbYwKpmgAOrms7FzppJk5eUZQENYIegCycTJojFgm8Jyi5WiVipykMFhHmWBiaymcEDHbnC3tZJxtGHd9JKl0bGbn17dtERgnAAjBZOMFQV8UvI0JEAHRDIYAWk4ABE5k1OPg0GgsE0APT4oiMGDMOFwfD42bzfFxNYmNbwfHjSa5fL+MQKBbIZAgOiiVhyfwsNgcTjANIZbJsuCcVyxUgQZicADkxNJKsRYBZ0umwRVABYAEwWFU1SSRIaEzjGix2+0OsAgAC6zuEml0BvUxnkShUiFBGnE2iCOqm7NkpnMwJsdlIDicUncnhweEIJHIGkCeGsKREzziGAAyhhEmUDII4bBaHC4pkAEKFkuJOEAJR0cVIYAAKl4ADwAYRSMV6NQS/EgAHcwAA+fwicS6ADsS9kvuUSFX1GDOjwbSbpes/hMZiQAGZY/ZHH5EAA2ZPULxp3yZgL0JgjMUVowLiSIAAcW5yIoG6IN6mghng37HlG56XvG17OMC94eI+qZ6OmfhZu+egiqMtR0POHpSBePogf6pEQbuejVjBp6IKRthXomiBGkaD6YOhPgZhy2Z6PEiSXKkdYwI2xaHoOw6jpw45TrOwTjAKOhkHAAD85Z8JW1a1g2B4tgACvYzDKRMklgCO1QyWAE4QNOM5dDwmlwFWdA6aJenWG2HZdr2OBmRZY7WXJM5DGASlwOk1hAiJYnNkeVDUgs+iabE7AFhgVR3BFMD1CO1jbMwEAJFwNycGgAjyM5WoAHIQDQZTdvgjCys1WWHvgiqQHWWIpcoohcJOojTKlpBlfgQJ7KIYBwAmyRgEM5XPECpjWDIcSwFA1ypDsbQyHM/BLTE7BAkcaCdrkBw7Kc3yZHCHKiFySA8nytAChsuBUAABt9+S0EMeFihK35ygqSqqoNCjMIw+I0CMmrzeZCRJFcACCWBYME0TAEMnCcLm01cBKzB0v1MA1M1+nyFAmXygAvI5hguTWMUeZjWq46d53gjjuOcH2+44ikPO81tA4mNY/C08AmOcLTM6cMTFwwME2OpCLvPlfw8gAJJgGUKoWLQJqeXCcLAsCZrC+rmvyAA8nS+uG8bptwialtq+rBVFec9toGUYYyvqoKmjUt6RBQVsi8woi0CjhXFbr/tSuGBQqqCqhmpwYcRx7vOuJEriR7UzWiLtMBQFLFNU1Uhe5yFue42JnDdhV01W32+IC+Vs485aYC199n0uhQvKKcw/hjyZsoooZ8bGU4znD7ynNdkYywXHNhzwCsaB3a67qLlIQHrv6gbblo1EgCz4mJHR5iMXGCY3kaKEpt4mGvjQOEgPj+b7jf1gNKM20tfOKXkzo+X7EOcy0lZK2VnERQ+AZJBGjXORTcQYL5BH/nFO+SBbzwSfs4CwHEnwYRfLxb+ClFQ4A4BgaIitSZlEKOIRgpc5CYhwYeOEs8lIL38r0GcNQIBYCEmpMo69Sa21EXNOAfZVYiyOFFdYftm7xmmrNFI7ZlGiIANxDHcJwesgIACipBFSkF8mTdKYDeHzxUgIhQQirI2TspwAAPlZWAI4zBQGiHLTgRAICMCgP4RKeBGpAkYUJWISMYkYCKnjKaSSZAyE4JOPI+BAmsPYVsRaexejaFGsoKJJMYlTU2iIoSYQZCvEIIYLa2woDU2qWk6wNSAQS2uDIvMd0gyPRQKPIy/giiVFydPZu41sljLLrKCAbQABWOUuCLXSHAWU+SpmfWiXNAAYmAT6e8R4gDHv4Kpsi4QpCLHEawUV1mcBRI1VqAlkapAyak2IjAjjpPGqkEpCsymb1anAG5dy4DxDSRU9JjAPkdElOs8uY1SkbxSCqWUpwd5HKGXPM5PTpqXLAGYixDzJnPLiZvd5aSRzfMYLcf5OyrjyFzMVFS2xPjmLSlCylS14WZE2v8sgFisUnOGVQc5vSrk6DQHITajymqyheTE7l1KgSTl+UigFKLUitRgJkp4ILbnwHBSsWpsQdC2ERWlJl3sF5ss4IKzlYBNpwrWXy+1erilTKgP1HYVqOWkGFUcaOpBBD+BRNrW4CS4gK1EFrAFqx1hyC3gARxKCIOANRPpXNBUaz60KPkqq2qa0QMQnAapkKTfM7SPlRrVFE0QsAERgBRCjD5/zq0yE6QdRVsjwRZrANcw16zPqZpSES9gI7OD9qLFKmVn1ojiCBEEkJsTBKyJqFC/5K9fHZLWqqmFaS4W9EgEcKAe83QgF/LoE0VgyJ+nwZgyCehokfWMLBO8hDEJIH/KQriH9KFBGoSIsgmAF3xx9g7Z4vR+iIL/Eac2aD70uEfZfAUNrfZ4MQFuJiCEWLsVQpxd+FDsKAbCGwqIkoJi6nyCwvdZQKhVBqHUBoMhMQPA6KQByPQ+jnH+p+MYycZRhIxHgZYCaNgkllDsBjBwjgnHgDCfqm9So7HY08F4bxGAfHtbQb4MI/jPEBCCMEEILBQh+LCJtyI0QYjKNiXEBIiQkjJBSKkGJaT0jyJJ5kgnpj3QGc9fkgpX0A0JpR1kw15QxEVMqNUzn4ZDADnqQ0btzR92tLaB0WWnT70vcRVibFEOgTPlRUMvmIxvvothx+X6Axnl/URniJG8BAdoaBmNsdwNoETlBnjDAD5wYNAQu9xWYznyfSAaOnWbW60w/+T9eGGvPia2+Uj4QKNJZo0UOjux9iWWY9HVjzRWgca49B3jwxRQCaoynYT8xRM70TZJrKBTZPHFOIpmJKn7gnfU68HY7x5A6b078UqAJMjGfBJCXT0Jzjwi1CidE8w7M4jxIgQk6oXOUkSh5mFXmmSbaMJybkvIgvvWFPx8U4XqOyiizF1UmOEvanK6nW0mcLRWnxDaG9WX7Q5YvVepARpVDSBG6fW9pW8CE7mwtm8wJVBLfIStr+gGTjAbodEG2YAesDBAE7Cw1hedG+Nyb3nwJdewevf+UiwEkNbkl3oLXs3Iz0VFzhohQvFfcSwqtlrau2v0LKq3X2ZRdf68N6byPUe7RGgtwN3QZ4DS3tt6Beb43L5a4wy76Mt73e1fw2/ZbPuVd4DCsZCKDggS/wgHIIYoy8Z5hr6UTg0C4BN7u0lSJU7q9yDzYVKAKwgRq+JLAKT5QRRJtgPuBQPGFAN+mk3sa/VODApYDC8QQekVDAAFKiCKEWawlRRHz7b0m4yTFchwGVMPkJiKNOThgG0Z4ipJyZAmFZnsUz++D+B6MDZk4IBygcBcpGB8pcwRgLMmgtQAAqTgFGKdVvJvPNVaCIWUDJZQBWHQQgKAWUA1LJCIbvRvOQOEPaBQTGSdT6HvGAOEB1UgcgtlTaSgog6gwaLsegvqLgdpVIOFESflQAycSoGgTfKaV4WqRtBZXAvYGAAUJtWA+AhQPaAENJJghfXvFfAmKaKKefCyTsRFRaAQvICaQA5AT6NXMFckNAWYOkT6Z0YIezNHQkSAWACQy5LQNzGkCtGgEQJEIgI0A0OEWgfEUQLAaGMwo1OEbEZgGQAAYjCPWRECsNhAYKGBMLiOcgSMFRsLsNR0cycJgBcPYAUHcLgHxE8PgDQB8L8ICKCJCOZEVHMMiJiLSIyPMXhEmSBAUPmTCEINUJgGQOSR4LdXQMIDpBX340yn+U+jyMQCoL72gEHw/wAH1oDoCAB1cQC6BQFYxYhqKZTopQk/RfeZJZRwNFTA5QaAKTb5MwD1E/ZqGgc4WpIYOAdqTqIqWUEwONf5NoF/N/OA/SbWDZcaV4D7doOQGoE9bYb5EpV4X+e4mEJ4sKF4xIDqFId4zgT4oEGpa4EpUaMQ6giQ3baQ5gZyTgGdCaKZEwyAIQq4NIzgbWfEW2LI+w3I6AfI5yQo4o0oytCo3w/wwI4I0I+o8Ixo6I0QJEakmAJEFIJENIpEZIaII6UgIYQqGlcydgaOISD/ExV6YLGSOACYvYxQ7olQ0/PoxALUQeCQoYKgkgiAMglUcaVJfg9gGQKAFUSIfRMAa0fSfYfIOzGAZ09JV0qAGoRaBIoqQYRIZgu0h0p0vaTgAAUjgEzhVAANIDdI9K9J9L9MxHjJdIzNDM3wjLpBtJjNoOCDMEnE4HHToJVFWPqTxBqDb3niagOABE2jsHRnkHLg9M9M504F9P6FlFoMwPWQeixKdV2AcAOkmi0PDMsMFQtO9K51xlrLKAbL4CbPKCVCwMyg7KxGCJwF8QHJFmX2QBgG22dDAgDFUFPN5mXwPyP13lIASF1ieTgGgRV3BGmKIGYDqyNADH/HS1XIfK4FtkWWWThFfO10/2ai/MCB/LZMQD/IYgsEkAYmAvvNxmX2mP6DIDChkDqLmCNXxDoByjpDmiwyXGQWwu2C4AvKvKRAEKPLIDvAKzouX0vLCCfJUSQtgEQHwq7DCGIrBTItoAoqEiw1vDvAsBAvVlwuQqEsIvxGjlMDIu20WJkwUFYjPAYi1F/i4DLyBHpnrIPU4FbHmVMDbzABVC9NtNYLAGCE+lRCmiKU4AABJgBjLXAABCNENysgXy+dbMrnIc84TEVyxQJ4VY8yyynoBfMAfyqKopXysMwAlo5Ug5b6LUHUt6JNOsQ0oET6RAtQlA9ZZcoYK0uAMsgma4UY+mEMIsKQgUIsXcwgScTGeyvMLgQVWWTgJqlq5gNq4yDqrq2q/MZgDAUqky+4GAas20ma4ISMmoQVfshGKama2M/UfM4MwsrMgc8K/0rEQMhM9Mt09K+qqMzamM0gna06wA5M1M86909anM4cgMoMl6y6yMlU6a8s/1Ss+amswG+sxsjNHc1s/chtQ87s3xPs0Kwc3MsoZAdczgTckRCGlsvc9smGrs488uN0TfQVAynq+4JSfqsyj5eK6y1FL0m63ouERy5ylKp4Lyny5KwK0gYKt6sK5GgK6K0aWK6mqyxKzmwWtK4m8xKq76fzEnS9GAV9ZANvTsKKWwlk9HfEPoZQOINoOEcA/EPIiQw2tkzuRQokKowIkwNofEW0iQyIF0AXfLJPZPE+DBdPIIKgzDYEB+ZiG8EhAjMhb3T+PiEIVs6AaILau68vGabQdSNlDAGoF2cVQiuxTEEQ5AZ0ByZdTaYIAAamBGuAzD2gbQdoShEz0COo2UAM+hLLQDzWGLmsnBPGoM4DEzWHeihIUFaBhFlC4J5VdXLhqEbpKSGGpXzF4O2CBKH0qGDVeBjonIYO2A+QbRaTmm6MnoIJBTaBEDyEoqFjAG2zTXHyhgrWKWMNML9JiGCDPEiGZNR01ujjACXFcKKJPDiECKftlInJKKfrPDqP6BiDhDPAiLQCiL7mCH+WDB7oiqhKxI+UHr4M4BMMopkDhCVM1PIPVpyM1qNo5LcJxzKO8L5OqMFNxzQdFNQYwf6moYqODCiHhwRmqoms4JtX6tUG6sZrupVGZXODKETPdJqF4dhERqrrKGEbKHUGLMsN+ujK4ftP1AkczmEd5qRo+ob2Kkkcurrpls+i1HJOQc+lQfQY1P6iweyIc1wbZIKIIfcyId5MtpqOhmMcofpFodoaRHocVLSlVOWnVNIE1Lmj6W3AC15ANMSFfSIAsDNjNjtEdvjyQCTzTxTwohQyCFIO9t9twxvB/UDr/WI19z0EMpsUPCAS0lclAW4XbAgR7CgSkksjgTskt0SbPBtzdqwzSb3A8kydl2cFaa93/Waz0FaxA0D29TEDKAUV5iUV1VEQanURmleW0VmbQC9PlE8QSG8SjFCXLvuz0C7wrXzANTBQhVNVOBrxIE2nGZ2CVI1QZTAA/yGAOYiC4GOaNVOZBPgAucRWuZGjucBRSEec/yBEOdeZzXWQ+a3lP0udqB9T+fpQBYea1CeamVBfKHBeNVSU+ehZ+bhduYRa1WCcF0QANANDGxScSc6Zoh9R6Z/hqxYjJYGYKZL2Gf91GeiBmZUXmamkWaEmWZUQ7wiQWc0VSE5dESJedoNGPnQQ6Y9rwDFf60q2jCyY9xJaXCZeV1DpGY1zKmFdeW4AiHwDKE+kNi8u0tcDzQ2adRgB8XLkFb0ANYpAM2UFakmg0VeWaZJdUG9ApdvKpeoD1aEkdZUGzyQB9t6bUAVwvVzFgA/Cuyp2BjpzBjTIeihhhlJDYHhlCyp0JxBmi2TcZ1Jrqq4USH6u/CZjclikPDZgRmtAHGxO2TKT6PUKhZuiMP1KeBFfBGoIUDhALEFlSFWlAP4BqAwfRbaChnWTmj7hLc8hfRVh5jQ2KhD2pxTiDjtEzmzh5imzjhmz1lXcDjTgsAzlDnDh5id33YNiNgN2j1vZNwthzlxkz0gyveNjvffayyNHdnziLbNO2pVG7EDc3jsApEQEzlnarB9VUmgpyhWbhDdd5bmmDbLsmx0FECQFAECEqjmjwHZFcFcCAA==="}
import { Hooks } from 'wagmi/tempo'
import { parseUnits } from 'viem'

const buySync = Hooks.dex.useBuySync()

// Call `mutate` in response to user action (e.g. button click, form submission)
buySync.mutate({
  amountOut: parseUnits('100', 6),
  maxAmountIn: parseUnits('105', 6),
  tokenIn: '0x20c0000000000000000000000000000000000001',
  tokenOut: '0x20c0000000000000000000000000000000000002',
})

console.log('Transaction hash:', buySync.data?.receipt.transactionHash)
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `dex.buy` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.useBuy.md","from":7609,"to":8124}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { useWaitForTransactionReceipt } from 'wagmi'

const buy = Hooks.dex.useBuy()
const { data: receipt } = useWaitForTransactionReceipt({ hash: buy.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
buy.mutate({
  amountOut: parseUnits('100', 6),
  maxAmountIn: parseUnits('105', 6),
  tokenIn: '0x20c0000000000000000000000000000000000001',
  tokenOut: '0x20c0000000000000000000000000000000000002',
})
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `dex.buy` Return Type](/tempo/actions/dex.buy#return-type)

### mutate/mutateAsync

See [Wagmi Action `dex.buy` Parameters](/tempo/actions/dex.buy#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`dex.buy`](/tempo/actions/dex.buy)

---

---
url: /tempo/hooks/dex.useBuyQuote.md
---
# `dex.useBuyQuote`

Gets the quote for buying a specific amount of tokens.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.useBuyQuote.md","from":130,"to":5743}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"cb4e5f5fb447a1a65ef7af20e203bda1f35f12b1e876616083f30b47831f53fb","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUoiaicACUnABmAK5gjowQYJxY4nAwAKpgjGhwwURhcTCInCKkpgoUnLDWLGFwZWBxzABGZJFlbYwKpmgAOrms7FzppJk5eUZQENYIegCycTJojFgm8Jyi5WiVipykMFhHmWBiaymcEDHbnC3tZJxtGHd9JKl0bGbn17dtERgnAAjBZOMFQV8UvI0JEAHRDIYAWk4ABE5k1OPg0GgsE0APT4oiMGDMOFwfD42bzfFxNYmNbwfHjSa5fL+MQKBbIZAgOiiVhyfwsNgcTjANIZbJsuCcVyxUgQZicADkxNJKsRYBZ0umwRVABYAEwWFU1SSRIaEzjGix2+0OsAgAC6zuEml0BvUxnkShUiFBGnE2iCOqm7NkpnMwJsdlIDicUncnhweEIJHIGkCeGCJwgOA4GGiUFEYm6vX6nAAPpwErAYlGoP5qQsQAAVfBAmQRLhwOLWazwODxGQyV6nCAyEhQWqlnYxdicZRAgCOJVIGARYC1Ha7PfK/cHcGHKzHh3gk+ns7EsUXy84a7Im61Q13nG7IgPA6HI7PE6nMAziWN4LqQS6dg+67PtuMFvh+vaHj+p7jheAFAXOt5gfej4bluO4QfBX5Hieo4oXAl6Ade853hBOGbv4IjiLoADs0g+ooyhIAaQZaDoeDAaI/gmGYSAAMyxvYjh+IgAAcybUF4aa+JmAT0Hg1gpJ+a4QDQ5Z9L8NZ1jADZmE2VAtngcH7n237Hr+ZEUehIE0auUFwgxHpIDJ3pyBx/repoIZ4NpNBCVGYkSfGUnOMCBryZgqZ6OmfhZmpegiqMPB8IIHlMVIPm+pxiABcGfF6AYOWRiJiDiSAtiSYmiBGnFHgKYlPgZhy2bpSMYqwLQuUSAGFgxuxfoRdQpVBP1YXVbV9VRY1okWPFilJcpXVpSA8SJJcqRxJkABCcQYAAinEOkwAAPAAwikDbVM8FbnAAfLm9jMDoZCYhVcBwv1cIHTAx1nRdNBwgACh9X0TLd929DUPT6WgL1dFlhj/XQgNHSd52XXCABKOhxKQYAAGrFNdSP9C9QxgAK8DpIOtY46Dl3NhieAVZhnAhmsBzYWDQKgc8J1VHccA4PUDbWNszAQAkXA3EuAjyH9HKiFySA8nytAChsuBUAABib+S0EMGVihKv1ygqSqqgA7przCMPiNAjJqME7UkVwAIJYFgwTRMAQycJwGlgJ+EoCTUjBwAAMhAohQOL8oALzo4ImO0NjwO40LwQh6kYdywr5wAPJ0mUYYyvqoKmjUABskQUKHJdoKrYAAJJgGUKoWLQJrWHCI/AsCZpt2HHf8PIldoH3A9DyPcImhPxeuJaMFh4wtzBHHifJ1U0RHGgJOpFdKdEC9B8p4oy9XVSjBX23J9n5wF9Py9RNrowRwzj3WAq7igEq4B+l9aZgFcEME2RsXQUF5OMAU/hEGfScLKFEUN4yoO+u5N0vJX6kyMOdJ854+yrE4A7PI+BwJAgFGXJWtxp7yB7vcGAgFAK4LdCARiQ1QQFT8kgMePEgp6CBiDPGoUqrmHmnGBM0lRItRTN4ZKKkaBbVzIqAsmBoh0MVnPPS/QObzDwL7eWis/gqxnmAOeKtRb0XdHlAMRpRq+XGi4YRZUQC6IrnSWa5huJ1VkdFJARpVrtRUZtIIoRwhRElBMXU+RCiUzKBUKoNQ6gNBkJiB4HRSBo2pucC2vUxhSnDDMTmSwVhrA2CSWUOxUkHCOCceAMJSzJFSMrHYOSngvDeE/eQnAoQ/AYc8QEIIwQQgsEMmE8ItQonRPMMo2JcQEiJCSMkFIqQYlpPSPItTmSlJlBrLWKBeT8kFIbEAlsuAShrtMW2MRFTKjVOsz2Qw7mJMNKvc0m9rS2gdACp0roHG8NEkaWQhV/SBkmrxUMhzph+K4pFORMVRJhOURtVKUS8xaKLJY5hvdOBGwHgAEmAA0hQrhYHmQqSAX2UAoCnFlMre8TDUgd3KDgMAUB3Igt0MCVQjcIUCMQMxDxQQ2U90RcVZFwSmroqUp1LFOYcVkG0fi6xQDiW0DJRSqlRjWz0sZUOCxrLO62LaCdXl3DPJNWBLVVxRUZLirwGyue0qhWBIatJUJrUEoYqVapII9NPqSwcECCO5E5BDCKGBSNk5SicDupHBNBrLIQSNvGuQRtODyygCsIEeZiSwDqeUEUchagwEtQofSChw6aQTeBUsnA45lpdt2LCEAaFDAAFKiCKAAZWsJULAXAs1Ak+vVXIcBlRFsYLAGcvSHZVueIqB2mQJh4TAG+PNBbBm0FFPkJcDsu2SxgNLRgssNIjGGU0LUAAqTgvsiXJqjTAHN1gPyykocoXNOhCBQFlDZahEQiXjrhDICACgg5GxqJmhtcg4RkEVKQGD2xuVgYQzAOETtSZoeUM26wohUgdBZpRDlDtKg0FscR14AA5aA2GABWQG9gwAFFuR9z6FCQYBDITDKbs0tsjmIRIEb4YKBJuRrtlG8hAg5cgI2eZiLkjQLMOkRtnTBGWXiRAhJICwBY3CdgCgtk0m7DQEQSIiDNThLQfEogsCu2U0OOE2JmAyAAMQuePCIdTsJ0NQCGIpnzf0/PIc09pnEun9OMaMyZszcB8QWfgGgaztn7OOec4qFT7mvOhfC6QPJcJOBvh4xAPjAm30fuI88IEQMZw/sIHSFtxTxb3iNgZ0o46c27sQ1qAA+ve+9AB1cQuRFDDYG2UMrvGwj1sE0CCrTHz1oBVLKVBAG6lHFYVQp4ka440HOGOIYcAMCJHwIqSAB13yMBnjQ1dEB11PF9hDLusplxkVJG0OQNRIBgXEPJzsrwDsiBhCd+mZ2LtXYVrKEw92wj8Z0p2MCDHYBwhY7sI4Ao/qcAHWwh7inIDUauKFzgXd8Tl0izp1ZXX4taES8l0sqX0sGjsw5pzzIcuuby550QSJicwCRCkJEoWkTJGiKBIY8sdumFAswNpKQt0AFE9YXJZu1iC5XKvwcW0bRAWoYEsaGOByD0GVSdlHDJ9gMgoAqkiAAbitPiTgEN9j5CWTAK3FCbdQBqByvzCtBiJCwxBqD+pLeQc4AAUjgGaR2vv7dO7ANaN3/RMSR+t6QW3/vT1qaDyb0PyH2DBDMA7Tgyuisl5VCNwg+Y4A1HIpt8WAIZx2ADvIQC9vHfO9d+72UxewKhrgJrWhGHGLWH4EuKK8m8+wCKwblPLuw6V5Q2UWvfA8SN6VP+lvycsSOa5YBXvJdthcGQDAIoMhnTFQDKoE/Jdm1DpHWgOEpAEg9w7HHZNaiuCl8Y4gEQMwAGGCgGDJL8svo/lwOXG0Cto4G/h/tuvgN/ikL/uCF1oAcActJIDVOAQ/mHM2hgf0GQPTDIFznMEOPiHQOenSO0qKsxAGJIPgWfpwBflfs6EiJRofmQIgI3E1EaMwc2pfmEM/usH/kQecCQWEOQcRFQbQDQXtKKnwY3BYBAafiwRIU4KQfiArqYFQVfgNhSk1KJDVFqJGlwCGkCBnDXowKOJwATBVqYORGACqMnuBrhmAMEEbKiMRtoGBGSpYa4AAIRoi+FkBBFGw95L597p5lA+GKBPAja2H8YOE9AppgAhHxF+FBG567Dz6kDQImxaiq76wVoHSa5AhGyvoJofpfqL6FFGzG4h4ibXAtYZwhgDpsYCgDo76EAOxBxuGaRcDIacDtE6CdHY7MA9GfR9EDGF4tHMAYDVEVoZxl4LZvpwjLEwDBBB41DIZRHS5LGh5m4R5e5R4nrZ525RGp796e7e4XE562IF5gCLFbFh7m6Z4x5x41AqgPFXHJ43GxFYhnFZ6PEcrPGvFF5V6oZrGr7V4b717b7N4HCt4H4d6mTd4Aku5p7nCYjIBwmkDr515b7lA77KB75t7cGmRui2LIZmFDH3AMyjGqhJF2GpFOEpCuGHFvEeFeFZFPABEMzBGhEJGkARHXHYm3Eil+GcCskpGOHpGZFhFim5F0lgAwLHLci8iZCXLIDkQkyDhaY056b4h9DKBxBtBwjXr4h05JZdb4g/YVZEgZbJaMBtD4jgYsaRAuhcI8K6BGjMQOqQpIBiowoiJ1RYbSpsQLQopIArR+prQdQpRBo5ibbQDRBvEnHD6j4AD8ZQtGNQy8+Ye0YQmCOO+ZYAGAyAzoaMRAEA864IAA1MCNcBmJBsnN6TSsYnoDiUehykbIHhphQlQqwg7MJNhpwMsKsOsBWsGK0DCLKERiRoWhEJkH7sOb+suEMA2BMFwA1tsB9hBCcA0BuH+seKPoFtsHYcnCnCWfxvuaBn2G0CIHkLQSkDGpTEBiwLYeILYiFu7jEMEKJJENTtFiaQrmAMxMZgzsJHEPZhBaLqPklhBaJFzv0DEHCKJG5mgB5pvMEPeHOZ9LidsDtojpKMeNJqwUbLQTIHCPLqWDBkadFrTnFn9Ali2EzpZmljZmzplpzjRdhR5p5jRfRWgKJUiMGFELMjBEbnAPMZ+BpOYhnKoIMYtu8fqIpecGUNHnbjUJpbCFiTEbiWUPpWUOoLYoOcHqbuHiqKZfHvpRKUZR7vWorGZbkZZQ0VqPjkCIpgJaJYxVFisiabadBaZhxSllZjxezlljsrYYJV5iJewArmJUlaWBJVoLEiLDLkCHLqlXtNapyFqdwqYIOP4EQBYHCMCJVXaD6XyiEjJC4sGTVC6noGblGbKo1HJAmeEpiimXoOYZBJdAYgZLWNysZI2GmnoFZJ+DZMRPZKQo5FRDzILE+Nan6WJBYEGSKiVLCsFELO1V6otPIvGUoq6prP4JYXgG1XVTVNCo6v6FYH1XSmYr8GYOwlAGUPXMtI6NKkIodbGZYK4FwhpLAEwMUuKJnLKPKI8vbL8c7K7O7GwJ7NchDR8lDXbM8uqMwG8s0VHFRGUCFECOnJDdnLnOIgXEXAQS9WgPonEqyHqCqPXPHs3K3MXJKoSv3IPBYNYACrzXzfzQLSNGvFPJ3LTZzUPILZLVLfaEaGvBvPSWpScSqKYvQqwu9YgPHoTZvP4KgoJIgKAIEGrO0q6ggK4K4EAA=="}
import { Hooks } from 'wagmi/tempo'
import { parseUnits } from 'viem'

const { data: quote } = Hooks.dex.useBuyQuote({
  amountOut: parseUnits('100', 6),
  tokenIn: '0x20c0000000000000000000000000000000000001',
  tokenOut: '0x20c0000000000000000000000000000000000002',
})

console.log('Amount needed:', quote)
// @log: Amount needed: 100300000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Return Type

See [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook return types.

### data

See [Wagmi Action `dex.getBuyQuote` Return Type](/tempo/actions/dex.getBuyQuote#return-type)

## Parameters

See [Wagmi Action `dex.getBuyQuote` Parameters](/tempo/actions/dex.getBuyQuote#parameters)

### query

See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook parameters.

## Action

* [`dex.getBuyQuote`](/tempo/actions/dex.getBuyQuote)

---

---
url: /tempo/hooks/dex.useCancel.md
---
# `dex.useCancel`

Cancels an order from the Stablecoin DEX orderbook.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.useCancel.md","from":125,"to":5873}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"d99005d358f82f6b8da0b324b8d268d476741fc0146d122b7f8fb1d35c61bdc0","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6INYQYCKc1qJg1jAyAMoY0Yg8fIIAdLC0aQCucDAAwlEx8YnWaQBKOtmkYAAqXgA8+aEAZowKFJzZYPyQAO5gAHz+IuK6ACwAzLLySiqIAIxW1OLaQZHRsQnR/iZmSABMNnakDk5IAGzunjh4hCTkGoFMrOxcBoIjmrqqFzOKyjUGlWOjwHyMe3MR2CJzOfkWbg81C8d18jwC9BebA4nEyXzGl2hcgB82mKy0oL0eNkpihx3sjnhB1U12Rtz09z8T0xeha3UcjFCXTyhU2JWiTVa7U63V6EAGgwAFFh7MwdGQ4AB+ZLgjJ0HIiopbUppAAKqvVpDgkrAbQ6XR6/SGAEodak4HqsrkCkbxWVKmhqnVGs1bdKHXKFQAdMBgURquAqmLCn1i7bWfxQCDWBB6D6cFrsCK+0wKThRTjsWCkAukCDMTjKGCV0jVgBGqTSMZjADkIDRkrV8Iw4JwR+XOHBSvg65BcpxCAJG3YuH1RIw0KPCzWm43TmEzoKwDG0BBOG3m6ZrDJsrAoJWwBO2zJs/xzzBt83SFUaqWJ9/E1CPI0n8MQFFzZBkBAOh4ywOR/AAAyQzdaBjFhsS4YAUkMThXFretOAAcjXBRmEYAB6GhXkI7tbX5NAj04ABBLAsEVZ1OGAGNOAiIDMM4ZhsjEGhOhHU15CgP88IAXmw9JMgNVNinTdjaJ479AxqThFW4njOAaNshNPY9Hz0njQnyExrH4aTgHYzhpMGAShNEGhFSwqsyAASSgZIFgOSZH1cZ1XF0szJLgURnxgKBbLEiTS1C0yeMGMK9NFYpOAAeVbMg0oacjDLQYzUtM50YySpCEJAABdCgoJVU5mH8Rr40tUcAFpOHNJr2pAuqoI0oMjAAWRchihQA7IZDQfq6pAUYJEQC4/mMWZAUWMlNDWPBvQy40dhpfZEGhWwGXOE7ERubxOXRGgeWCPjizTUo3UMT1FP2v0Kh/YMcBtO0ZUdeUhnxJaFgucZ/jmJAlmBCl1l9dNdlpIEYXO+ELFZTB2R8B5QOePRlTrHAOAwDjBOEmBkkVIhxEYKK5DgZINmUk0erapxrVDO1Bk6CAsAmsJtU4MaqaywWj2tLjkpbasfOSNt2lMNAAG40u/GJGEFwd90igVQkqLXBfVsB3E4AAhUQ8gAUVIOtSHqHBOlZg6yg5tUuYB9o+YjJ0nIAHwdWA2jMKAOMczgiAgRgoEzbNcxAIdm0p1zGL5aIhc4DAIGyZ7ixkGROD6Dd8Cj+nGfgRszzQUh2m0Hd8BT8bGKie8BaF0RC4wBd3QfcsoEkzui8iQu2wcN8O6lkDgXApBIJAVrmqoOm68rzrOGT8u1+i0cIDbAArGBHGrzgVTgUdT2XZsENToWADEwAQ/r6sX1V/CnoC0lCOJsmsGIL6cC6kOccGcDaPhLoXAsjBvzFybo+Xcd9GLjjgH/ABcA+RFzbsXRgUCLxn2tnke8iCW6hEIqOKaM0X4NXflQT+YRv5gDtg7IBm9hxbnooxSBRc2iwMYC0a+zlhKMXkCEboXNyyPjICw7B3D3wEIvjFQR0j2DULfk1D+ksv4/x0GgOQ95gHsILJwoUcjeHNj6PAwRSChTjhgKXMgk40HwAwdNGQPcWg6FsEoosojc5gAkRWFRNZsH4PPkQzg9imyN2bFAVyogWyRPtqo2qr9vzMHEJ8KgXUvICJznnDJ/Bm4zW1nITg34ACO2R4Cbk6AhH+ziL4IRwVA8xD53HlhaE4QRMhXI1ILkXfJhESACVELALsYAupMSgbuUeMhx7WWMZnKW2l6lgF/v/FxCE6mhGYewbZnA1lxF0fohCHFxDNmjrHJZ4C4CdGwbuIaNQlF0xvBY3BRd8HtEgN+KAc1hDfFhgAdnUGtEklx4Y7T0HfXAR1zCgrOqcRkzgFgLGxiiDkaICYPWJgLMgmAOKeVIArc8ysAlg10AsAAHKtYkMNEBAshZSEARKfIo2OqtRFcJnAHHRbjW62KghxgTEmZsIQwgQDkDGVevEJVyGSKGOAkrYUgCzDmPAW8ELiqVXIZpzBoDTWbFgOsRBY5VwSXAdCZTYCGQUAoP82rlXLlcmOUclqyK9J3DXJuMYABSog6ZxGsHXQWsqdUp2PnYMAI4GzGuIGa+8bYe59BgG2c8dY+h5CtBMmMW99VQENZE2gGFL59DPImY+/DGDWF4q8MwATma0QAFTMUOYq5VzTryEJwcoASOhCBQDdX/Mu1tDmOrkGkF8Ch2IHK1UBZVaRgkzskfeOdcqYBpDXDUZdygXUbHkd6YhZ4+h1xoKfKIPc+zjIPm62uMB4wTJbUxTgCgXzjyLmu8NzTTCjE2LKu01QlFXxPRuZsV9kAITjegtIIgsxCQQjVRU+BipYGZuRcikBYA3u/lociaq4DkV6TQEQHUiAHHGGkWg5FRBYAolBlxaRkPMBkAAYnoxfWDuc0DnLAFAGMEH2Melg9IhDSGUNoYw9AGA2H2AKDwwnQjfSSNkYo1RmjdG6zQaY6xwTwn7bOjSGw5sr795dzHfO3V+d8GHp7YQISY5XgcD/LuBCmHqbjpgHqg1E7aIAH0m1NoAOriGjYoALvnBxNxfW+szHnKyH2PmgchfblDQFHBczgZgHE1m1SOGgAT3ExinNEGcoRc6jhMEUwRbYM1ZuYqaLyl8m49wAjAZg0VOg/PLLApsPdcsiHkHojAMZrbTlnOVzglXmxdyLv2JuNYr0bpvZOO98YPScGOWBqLEHIBnqFIJzgXlyJZVE8htAqHEDobczJ3D+HFPEbQKR8jlHqO0fIoJxjaBmMsdEB1XbMAOqhA6oJjqgoOLbhjPqvhtp2AZKFjmphtBYJlNyM5qLJn33mfXQhRAtEqo3pjB5ydEBp2ESboXY97AZBQEIs6U26Hup1wbckcnL5i5U6gJ0K+nGhKE4sxuqdioyexDZwAUjgIRToxEOe0/p+RRnKtmYLhF5T0g1OuflrQHBtAfP12LuSaQRUZg+icD2YbwigXFyoc6Eqz2w5FDnjGQuGjOAw607pzGBnpomebiSSwhMkVtArpWxPPcDgwOa+rKQXHYAGc8TN8kS3fBreTnrP2v8497x2FYvIGKnv5dmRdcgGAryaqIFUIsVQ+ezLli4EGkNs1SDdC8nUdhoZ7pcCN1JxARBmCbQOIsKl5VY8F70i6rKCXHBpCb2AFvIC4Dt8CNpNzPe++TAsJIRAkwh/V8L1wFfKsyBxhkO9zTLjyJ0GPkJI8DKgUIl32PrgxfS8dRPS7sgy0ToHAfzxF1Jeu717ayd4H4BJH5dyn7Zjn6X7WDX6hAMoXDLQWDD5x6P6Zbd6H41DgEZKmAX6vK+YiBM4KAnSTBb60Tar75tQORESBYfKcDlD7w/pkKmxE5bpgCKgIQAAiUQDcnAAAJMAMKjAK4AAIScBcGKBkDCFnJy4K7M5iHcGOI0FQL0FKwSpgCiHiENzCEa4rZR4xhVS0Q2xI6sAo6WoO4ubtqWZdoXwx76FIQE7RBPRcZUFrBxCrbMBxBp6EB9DsTMFPTSIuE6BuHfjxieFqjeG+G67hDMAYCWHNiyTG5hoLpxGKhcadDSIe4mQxFxHE6k6s6q7U6y7V7e6K4s4q7s5q6c6nxcaQ6xH865FC75GcDi6S5ERlqVFFEj6yGbhlEU4VHq7VG85gDZH1FLqJFm5C5J4Cx3Kp524Z5O7Z6u4xTu4yElFyHIAJ6cBTEp627p4O6Z7O455hx1SnzSJkFPSCFUEW60EqGMFgCESmwjF66sHsGaGOL8GCEiHyESGkBSGZFe4+5K5vE1hKFFy3FqEaEKG/E6FnFPxISgSiBzwoBQR5AqrIBKrVAxCIZnYXbob2rKDZBthpAhDMCSZYYEZuaFRvrkQqYvYmBtjkRE43rOi1TzSLS6AHAWCgp0obSMrkhQqPTrrsrmDSDoxIoXRYxIg4w3RYrchBCKh27QAcQ5GC4B6IkwAiwXqdBpA6n0JdwexK4XrIA1SuhRwxz3iKgADUCwlYDwL4YyLJVA+GeAaxvuV8CEPOaAzSJcvaxukIhmY0JScE02Wg2QaoDaVmRqhCMUnQPpZcTYMYvC4QNmo6u4xqLA4gPcapQe2CM2A8Q8R4ZmKZQ6bYIgG4sBJkry1SbqLAuC4gp8AmPuLQiokwzop2KGl25EGSYAQKOGcmew2QVG3ZwO6pBG3Zkwp+KsLQaQkwn2zGw+iou4qwYZg26WsCeZ4SQGZ4EG1+MgaQ24cOM62J4mnZ12Hosm8mOY92NST2qmr2FEu5c5rGu5B5rkr5j2qwcAzoBmeO9hcAURXAYiASVBqgfheuguhEQFaAyQouNOLs/i3GqxgJLMCFyQ6gp8npURC6EFUFiArRUF/x8urpSuuFnA6F3OWuNRcJCEtEm2nAO5DEe575R5Ym52EmZ5fZl5BGRGN5tJamb2j52mLGL5sOb5olH5WgX5BYRYUOl4MOpAcOR4M8KwSJC8ZhMQ/gRAFgaQCwOlFgFgrJAKBIJ0CwZIPJpITKQQU6wpUg9I4p8IVKfKMp+McpeA5Bz0bMSQckHoCke0SMJoAYQYTsMA3s9oso/sFKhw4wyw5lsMyw20zKrsfoNlLgdl3KSAkwLIUpGKeMXIGI8pcapMBKuI8SyQMsZkrKvkpK9qASpsZkms9iOsm8esh4hsx8jVasFUnAQc3QIctIccTpCcGqUWvS4QqCmyF8mCHSAEkqJA94cSYg0lMSQiacoQCOuaI11sXA416CU1LW8As1SiC1CS241ipCYA61rezYo121jSri3c5SB1Mgc1JVi1p1JCwia1tEG111W1TiE19101T1L1x1S1Z1n1F1kVJ0qgCw0MG0UM/JzKx1KVopXKyKSA4wVw2V/Ksp+VeAuKRV5Mcs3kVVSsNVXAPVvGH4/VUNzIfJsVDKlleAlVKNaV6N5evK2N3gYE/ggheA1lRlS0BwK0cN8w8VhMIAX0+ixNNYXkHBfkAUYAKVqKbNEprg80IQsAWIbwnE3luE+EDYxEiJZElEbWbANEJk7lSV6YVBuovlhoL00QqkJkDOhQUCt840nmY4j4AEbAYQEeKYIS4C2kG6CghmRUxkEQVk/AnQB5TibYZEF8R4w+1tJoMK7kuklVCtgUFAFUw+WFE6EFUtPiuUst8t+F/l0QGQ8SmoOG8s4cMY/gnsogSAoAgQ8glqoQeAm4IArgrgQAA==="}
import { Hooks } from 'wagmi/tempo'

const cancelSync = Hooks.dex.useCancelSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
cancelSync.mutate({
  orderId: 123n,
})

console.log('Cancelled order ID:', cancelSync.data?.orderId)
// @log: Cancelled order ID: 123n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `dex.cancel` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.useCancel.md","from":6211,"to":6670}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const cancel = Hooks.dex.useCancel()
const { data: receipt } = useWaitForTransactionReceipt({ hash: cancel.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
cancel.mutate({
  orderId: 123n,
})

if (receipt) {
  const { args: { orderId } } 
    = Actions.dex.cancel.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `dex.cancel` Return Type](/tempo/actions/dex.cancel#return-type)

### mutate/mutateAsync

See [Wagmi Action `dex.cancel` Parameters](/tempo/actions/dex.cancel#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`dex.cancel`](/tempo/actions/dex.cancel)

---

---
url: /tempo/hooks/dex.useCreatePair.md
---
# `dex.useCreatePair`

Creates a new trading pair on the Stablecoin DEX.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.useCreatePair.md","from":127,"to":8287}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"30ad47475bf43802763bb99c5cf8fdf2fdf294d49b87a8e6428158f4753de2e3","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6INYQYCKc1qQwojQACqKMpADKGGDWiDx8ggB0sLTZAK5wMADCUTEw8YkpadkASjoFpGAAKl4APCWhAGaMChScBWD8kADuYAB8/iLiugAsAMyy8koqiACMcxri2kGR0XEJyanW/iZmSABMNnakDk5IAGzunjh4hCTkGoFMrOxcBkE000ukeVmMK2Uam2Wh0eEBRnO5muwVu9z8iEuCxe1C8718XwC9F+bA4nDywNmT0ey0UUMQS2oOzhegpslMyJu9kcGMubg8uLeeg+fm+xL03SGjkYoUGxTKB0qRxq1k6PT6AyGIwg4wmAAosPZmDoyHAAPwZBG5OiFeXlQ7VE7ZeJ3Y1OOBqsC9fqDYZjSYASktWTg1vyRVK9qVjtqDTQTVaHS6Xo1vu1uoAOmAwKJjXBDdYYHLI4qqsc0v4oBBrAg9IDON12BF7aYFJxRJwzKNOGg7lBW5xDYlOLLlEWACIAUQAGtks1mAHIQGgZFr4RhwTgb9ucOAnfCkUIQIqcQgCHt2LijBJoTeN0gXou90Rhe4ysBZtAQTgAIyLpmsGQClgKARzAHcfxkat+F/GB7yLKJ42aAcOyifNQmKbJ/DEBRa2QZAQDoXMsDkfwAAMKNvWgsxYUkuGATJDE4VwG0PZhOAAcmvBRmEYAB6Gg/g4+cvSlNB304ABBLAsD1ANOGALNOAiDD6M4ZgCjEGgBg3WJ5H7RRmM4ABeRicjyW0SwqMsVTkkTlMQhNOD1JTlM4dof00r8P3AtzlNCEoTGsfhjOAOSTImdTNIqPUGJ/URigyDiLFoS4LGsbJMvWdYOOYgNXFcvz+zgURIJgKBQt0/TWwK3zlImQq3IVCpODLRr2j4zy0G8hrfIDLNaoosiQAAXQoAjDVdfxJtzE1SE3ABaVqjTm0NRvGkBHOaIwAFlovE2U0IKGQ0CwkaxpAGYJEQAB2cE5DpNZ1humFdjwCNmodctTnZC5MS5O4eWcBZsQFTAhR8T5sJ+PQQjCLh9ms5UTmDQww0sz7o2++pGmaNocE9b1NT9HVJkpa7npRB7ViQTZXpZYIoxsk4zg5aFUW5B5LBxcHvBFQkaHFEADUPHAOAweSNK0mAMj1IhxEYUq5DgDJEa+lVnRW91Cb6CYBggLADrCC1OD26WAHlDffD1FLqzh+BgDAMjIlKABJgBEUgarIgBuRr4sSzgXdod3Pe9v27YARwKZcZaDt2Pd7cPGqiQtGEN1c7lfaVQgaNPDYj9xOAAIQSmBJ1IQ9SHxmABjVrGNZdWbteTb09bTf1IoAH19WBejMKB5OMyKiAgRgoErataxANciylmIJMlNIjc4DBjwiF8N5kGROFGRhlE4eWvaV+Ae2/JOFG0B8xyirSJJfUCDaN0Rt4wU8QzA9soH7Z+d+sF+ZDxWCiOK2GEsLbFwkgfCIAZrMH8EfRWZVFqcFnofBWJ9NwQB/AAKxgI4M+g4Eqbi/I+IO88jYADEwBkTOhtWB/gn7W2yKEJIBRrCFjgMgtc24l453AnvbeDZEhFlGPgeQpDyESW3HANhHC4CSh3g/XejBBF/kIZw8qEj9rvg4puI6J1aETSNAw0BYRmFgArlXTgS1uF3jEhJARO9ehRC3N0LRd9ZTyBCEMd07ZwJkCsUoxxsF1HFFAjfAJ7BDEwOMVQRhYCWE6DQHIUCNj1x2OXg4lRTjhG7zEeBG+kjZTbhgPvMRD4ZHsPgPI46Mg37dB0LYTRTYvHHjAL4zekSHxKLUYaDRoFSljmvmI8kMQOwtMrlE9aBEojMHEECKgS0ACSbi14FHUqIB2UUTrpzkJwKI0d4C3gGGRFhsjqlkWUYI5xRZQh1PbN0JwpCZAVHCP/QRayOIkA2bAOcYAlqSUETfd5gCHAwV4UbTcepTlgFYVUzhZETmhEsewRFQdEndRSWReS4giyj3Hg2exGEBhKJvltAeaCgIiOySEvokAohQDOhdK6uh1gAA4XoQkek8emQRyG4F+uYdQHNAZc3WKoHmeJhQEmhkLEWBsyCYHkgHOOGYQApTStYCw2qdW6r1fqg1hr1hqvJqyyQbLaQ00QFsJksIggqtZn9GkIr0TOEuJKiG/NZVBBzHmAsRY4ZwAgHILMR8VJhGDXHZMQbSJUCrDWPAqCyKBsjZc5g0BjpFiwIeIg49T4djgLRPZsBPKXwHCmvZygYhbk3IW3iLzr7nzEVmAAUqIeWSRIjpwRhhSN6k8F2DABudi2biB5tAj+N+owYA/l/IeUYxR5p/KzKg9NUBM2cDoHRYhoxvz5jwYwXo1gVJ/DMO0lWIkABUUkg7RtTREF5nDlEHzdIQKAta2H4HbJuZNva5DZCggoOSaLf0Rv/V04DfjQKgZjTAbI15miQarQjTeaiIzhO/KML2NACEvjfkuX52Da29miMwP517JKcAUFBeKO8YP3tMDMNIAb1QKCaJokhWH95Pm/MgMio65HZBEFWTSZERp6nwN1LAKs+J8UgLAIjzCtB8XjXAPiLyaAiAWkQS4cxsi0D4qILA/EBPVOyJJ5gMgADEpnOHCePGgHFYAoBZj47Z0MwmAliYk1JmTcnoAwEU+wBQKmp7qdeWgbTun9OGeM3xdz5m0CWZs4eORnnK4BmyCgkZ1GsEvyDhWmAlz/7gTQ2E59hBNJbj+BwAcN8yLyZloVtNGb/0iQAPqXsvQAdXEEOxQXX2urhyzR/LhWRw4LwWgXR/blDQE3LizsgzynhsLSIeQySMBZj3GkA8R4TwmC2TfH887F1SViEs4hYi35oRgMwMqAx6XthcWON+gaNw0HaXUrMCV9yHkgAdxgWyAEjiGZwAjcGiO7hI7mUMnAkgwCfCMvjkAcOync5wJZfFzbeck2gaTiBZONaC8p1T4XNORZ03pgzRmTOpbMxZ6zogFqo5gAtUIC13MLRlPJe8WZ00uNMPeOZRtl0WNoMRPZRQ6sjby3R5riARJDSI1mQrAGIBAY4mI7emH2AyCgBxAMEdZOtS9uejI2uoK7z11AAYJD7OaVV3+uDgG9Ra5gDrzgABSOAHEBhcRt4b43fFTemFvBbj3Vvd2kH13bvdaARNoCd2BuDEGuycBRaQN33WzzSYGEG19A54qgTsDJeQ5VDdG6zCb2IZvbybsmQ+PMJVtBQeh2CnsgMePQ9gJXRXYATfKUzxkHPfA8+7ggIXwyxfTxGZwAPavIe/LVuQDAeWMgRqIFUBsVQi+/Lti4J2r2htsikCGEs1o6TkyCy4HqRriAiDMA2AsS4Gw2X9QH0vty1bzaTccKf8/S/Dca/QIZye/R/BkCwSQBkd/PfZfLge/MPMgHMGQeLenThPiOgPBTSd8W6G6DYSQOA7/LgVfdfEaBaLDOfMgRAR4TES4Ig5SatNfF+I/btMAgLRAJA5oF+NA6sapTA2gbAo2W6WgsED/QfYgzsDgrglAviOZUwTA9fdrMORQTEBYBkESQNBA2aEyTibrGlOoLBRjUIDiCONXBDMAaFccF8K+Tgd2X1GAVwAAQk4GsMUDICcOxWD1D3N1cJsLIE4H0MEUMJ/GMLABcLcKvicLjx7wCSzCGhEknAl1YCl0LUMnqzvTkGK0fQvR8mVzgGT3CAc10N2CSBh2YCSEnxgEIFGDkjMNUgbwfFMlKPKMqONBqLqMKK4GYAwEyKLFMnTzVz6L1AcwGACSrx8h6L6PV010t11xjwNwmJrzrxVlPEj3mNjwIQc3516OdxmLdzmO919392j31yDz31rzD1WMONONty2MdzACmL2LTxgG7Ez2z1zzgHzyqOUCL1EBLyoIHkr28MuN8OQGH0CM+O+KnzbBn1L3n3KjGgITiJ8i0M7B0NMg4iCJ3hCLCNMJ2OmIsKsP8IfHsNmmcL8PcNIE8KWJD1BPD0pNsOxM4FxIjXCMZI8JiJRKGmwlEEgRQAImKAFRAGQCDSaELHEzxwJ1kwUDKQKB/GyBCGYH8wUzU0a06hoz4ipxixMB/D4jVyIwDFGmZRBCuFUBtWpnpE5U0Delhmd0dXMGkBdSBiQAsA9T5hlTFCCD1FfWgHkmmNd2bz5JgBNjwwGEymYVMRfibmYFWLw2QBGiDEPjHlAj1AAGp1gRxPgoJ/ijS40p48B6TiFvwyIHc0BLk94D4uwkQss9odkSIiwdgChjRz0N5Sss0iFyoBhKyv0xwsxnFwh0Nv1SFs0WBxA34gzW8lEQd/if53x8shyEpdx5SRB94cDQhQ0X4ChT460VFxACE3M69ug9QFgAxccpNCc5CXwbolMQtzgCgDM5l/lDRtA1MnyFg0Cw9uhsgFhEtLMP89Qb4myWz69FsQc+lysSE+McCZBshhcYhgNJTfNLzidQxgtQsaxycjkotqdYt+IYK/zrMYL4K0ASKFodg4AAxMslcKIVc0gGjvF2ldDVB6iU99iOJGK0AMgvcDc642lHMQSVjVZ+KMh1ACEyzCjI12LOLEA/cVIfFaSfCGSZLOAxL7cE9tjqEKIRIEcixoLxJYKSLEKfN8c/NULbyMK1MNNsLtSac4sCLGcrNiL2ARcyKKLecmwBd/wvQXKF5QhwEmR+ToE0jCx4ELBsh1gIrtVjThBTTMRHgqZIQ1hGQbSGZAMHSpAAZXUkA2V3T8QoYvS8A0T65mY0hUZzIbQPomZkZYxcZEwCZW5UwtRO5TUrg2V1hLV6Q6ZbVbTGZSwaqfpjA2YXAsqXTMQbo8rpUCqiRvTR0xYlVRkxAMhbY/IHYnZ44Q5E4zcFBXBfZ/Yy5nYE4VCdq9qo4Y4VwNrQ4k5FBdqI4/JU5SkM4UEs4So+E85Hq0BC5OAe4hg+4OQJ58yE09BUFH0uBKk5EFF7k0Jg0SBQIoAxkGwmxCltF/KRIV0RlQblz4UalX59l4AYbNF4axBEbhk54UawAxd0aixMbwbqlIabt8aZBYbFqOx7x3E/KKa0bL9qaEowbzlOF6a8aY1maibWakaRkikKbWrMRJBnVLS1gbVUqghRaMqRrnSuY5h3UwYpVIZRQZq8B5V5qJZfwDrLqtrvZvre44J/rpaFgLBEruVrVeU8AHVBVMr1aMQ5hcrtbPVPT9a9AHD8wHAWMU9NyHxCsMg+jJ4gaZ4Rl6Msj1JWss0c080Ftdwi0iwS0Cgy1DJxtkMa107619ySE+ywA20O0u1DZVs+1jRbAXxh1BwU6QJfwp0Z050dRF1QwRJV0k7N1aBt0exd1dwcBrBD1GBj0lS2Az1w8r0b0yI+jsiiEKtZs30P1bBhz46XcNdgMTk1cIMzy29N74M+skNLw2yQkhzONsNu88NwcAtsgodPZSNyMb1ctaMCtndLlGMxBmNw1vR2MMNd5r6Dz+N0CPMNLRMkLTKUKAsScQsydrKtNbK8LeDBNHL3MyynMXMwBDy+DOEhME8vMoHpSVTAs0LScwtEHKdos7K6c8HQx0GwH0tSBMtssiw378tN7itUMiwhyezijaJ/gZciwGsODmtE7102sfJOses+tWxBtht2HRs/5ncJtcFHAZtfT31nsiwzAykAj3t1svstswg/t9tNxDskciwTsO6AjJILsrtHYha7sHspDukXtrtVsPsNtvscwdtbB/tjwLGgdGzBFlwVsIcH7iNyhYystdLSEUdY5P4McsccdiGzLYHyH4HKGIscKYtadUGGcksmcWdY52dnywHucIAPLSB+d2BvKSL3wxckjJdeG0i2wb4OH5dP7+94jaKCj6K2LXd3dPdbjzjP8lLrj1jrcFiYiJLBnYN2LDifc5KA8FjxnliriI9Rmbc5mIGk8FmpKXi3jG8Pix8viJ8YSTaASy8gSqLBKrjGjPLqlgy28ZhgFnxCxxLCG+8iCITR8DYLmC8dB1xp9/jZ9bnyoGCD9OBSCX5N9t9xVoXq1WCT8z8wAL9bEQD6B2DYAH8n91gX839xCv9GCuBf91HTp0XMWr9Qgb9cWZYIC7boCFhYCJn4CpC8WZCeD3MBChDcCbp8D1hCD2XJC4WN8KC7gy9SAaC6DkWuBmCZBUXb9ED2lkCeWwG+XrB1ywARCaCLASX99q1VWnBZD5CB9FXlDrqFA1CNDUSGiHDdCsSDCjC2T8TDn/0iSyJIiAiyTjQKSfXqSvCLihKOSHxmTWSg12TA3ojvne9amtKyJEjkiGy5RhHb1P6H0iFenE26K0TijmidAyiYm2jqidROiFmFXK4Sii3WiqiOiJi0SniU9dDBi9jhjRjGiJiCS9jhmbjA9FKiztmo9dn7iDnm3Fm+3pmVmTiB2HnfD+3Zmx2e22LjmM9TmsSoTLmQW/ibmETFjB3Q3wTG8R8t3gXfiwW93y8oAkSSEUSuj0TjQnWI3XWo33WJ2pKvXA27DgAHCA2SSaT52GTv2X3Qi2SIiAOuTK4+nhoIE8JBTEd/BRTjxSAJSTKSHZTlB5TFTJ9SGiNSGNSsEtSaH1NGA9SDTKKYrLo4q7aLUuUrVrTmQ9h7S3aNhwQ67RUMQ3SfaPTpqb8DatH/Te3t7JyQyMgwzOAIz4kUCYy4ywAMAEykz8VUyMysyyAczB5o7p4iyCFSz9mKyykltRgazTZjpxJU3gKNtNwSsQkIKuzl7S6ByuBFzHHG6xzSAJyXmpznN2xBFZz955yd4XPlyfxVz4wjZNyqVa0WA9zG1YXQGvyTyzziHLynybz0L7zHyXxOdgy3yXwPzRz2lvzfzGcAKgKtBmyrOdHfOd47PAH9KVE4LfK0BjKpSMnVSLKEHcnkGCmHLimnKDKSK3KtBKLqK8j+mH3OLmLWLJ3t6OKRLvdeL5L2lD2tnluuLVK9nE9JL/1hmZK5LOLVvfCVK1L49tvE2dLEd4uCKjLkv0P2uyHOucmKc8naG+I+vktnLSBXLmvyKRuanE7BcfLvuOaAqcJ4PLoAJhSiBwrIr1horzpYqqQGR1g5akqkAUqmO8B0rWP4fRquZvbXheO9b+O7T4Zmx+qYx0gzJQwLIqrKfsY4wEwa4dYfRmrSYpgkfroQY0fHbuqlairqqqfVa8ePa3VCfBRieBYYZhY5rFVjbRblrGo1rDrNrjrbr9rA5g4rrtqNezrY5Vedfk47YHru1M4XxXqjZ3ru0vqfrnNraB4tPE0MbeasaIbakGbhbCaEa2bkaPFOafIqbOAab+acaobGaRaffxayb/fKbubg/XfaaBaPehaCa4ao/Sbb5QeuaQbE/Q/BboambvfibfeJbyaAqWUMfVAOr6P6RFasfWQxkRf2O0QxrFhJrdbpe5U5fxZ5Jo4Dezb1fLk7e/rHeufdAFhVBOV5b2YBe9B++aBm/8fPa3ALoQhYASR/gFIaejJug2JOJuJeIBI7s2BhJ7XyeSqBrdCrQ6e7QGfbIP898SgQcyJ+Uv7wI0Ip7igCEIxuk+FnI4MCgLLF1G8gPpx6/AAYMLhC68ROE74D/Jfyp7ZB+UsUVyCqiSgap0ohqLAdgKwE5QKAA0R/h6y3qa5S43/L8A7F1YHche2MUWmaGyAqp4BwnTXAAEVzqPGCgbJTrjUCNYtA7IAvxgB5kQAboUQEgFACBB5AhaUIHgFvAgBXArgIAA=="}
import { Hooks } from 'wagmi/tempo'

const createPairSync = Hooks.dex.useCreatePairSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
createPairSync.mutate({
  base: '0x20c0000000000000000000000000000000000001',
})

console.log('Base token:', createPairSync.data?.base)
console.log('Quote token:', createPairSync.data?.quote)
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `dex.createPair` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.useCreatePair.md","from":8629,"to":9149}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const createPair = Hooks.dex.useCreatePair()
const { data: receipt } = useWaitForTransactionReceipt({ hash: createPair.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
createPair.mutate({
  base: '0x20c0000000000000000000000000000000000001',
})

if (receipt) {
  const { args: { base, quote } } 
    = Actions.dex.createPair.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `dex.createPair` Return Type](/tempo/actions/dex.createPair#return-type)

### mutate/mutateAsync

See [Wagmi Action `dex.createPair` Parameters](/tempo/actions/dex.createPair#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`dex.createPair`](/tempo/actions/dex.createPair)

---

---
url: /tempo/hooks/dex.useOrder.md
---
# `dex.useOrder`

Gets an order's details from the Stablecoin DEX orderbook.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.useOrder.md","from":131,"to":5440}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"1815c3299836587ecb4ba2019dc58a529df6920eadae785fd12d0d622fd85358","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUWKQQOBwYAJScUKJiiJzAADpgnBmc7LCkAJJQSQBGjAqmaADcaZmczKL8ZEkABha0ACTAIqSmCq6NlemZhXz8ANIwGE0t7Z3dvf3VjHAAQowFnEMQcqJg85lojNb8SWAArsyFZLsZoswQJ2BoRSVlV5ykMLWm3U+lD69hMCIPxeVUyZnowL+oIyiwAYiYsEU+FsdtDOAAzBEAFQOR04p3OlzSrk4AB9OPdYOjTDAoP4oBBrAg9Fj8DBODJRCJOHATtZrPA4OiTjIZBg3vBNiQoHEEqIMexOMp2QBHE5kDAAOjSOrArPZnO5vP5guFovF7zgUtpsrECtISrZnDVGu1YF1+o5XK4xoFcCFIrFEqtMmltvl6MVyud6tIWt1aU9hp9fL9AfNwetMvidsjDujLrjbo9TuTPNTpsDFsloZtOYjUadha1/hE4l0ABZ1MZ5EoVIgOxpxNogvX/CYzEgAEw2OykBxOJAADncnhweEIJHIGkCeGsEDA3OyDWSaOPeTWxV+FTRtXqpEmbQ6aC6ijmaI2o3Gj+mL9mfTRRYVkvZEYG2V59kOY4zguUhXhuO4HkhG8Bgyd5PjAb51meKFUM4AEgWw69XnBR4iJBPC4QRJFNjA1E8MxRgsBxKD8RgokwBJclKRgakzDpKgGSZPAk29csTX9M0g0tLNw3tR1VVjFthE0XRVAARlkXtlDUIctB0PBz3HGlp1nexHD8RB1I7VdqC8DdfG3AJ6CYVh2C4AxBFbVSkAANk0ntFB0xBu00Ec8E8owJ3MGcQFsczF0QKcbI8Oz1z0Tc/B3Fy9BYNgODiOhvPbPyAHYtKC/sAGY9PCvRYFoYzJySsz5ws5wqosWzMHSnwt38GgcpAYUwEcRgDwpOAYAAeVIHIAB4AGED2pBQKFPPDz3yZDXjvE9mifGY3wAvDPzGCZOAO39Xx6E6FmWVYaJRCDcWgwk4LRBD7jIq8KOqdDRC+RQdrRAiQbw0jwfu+EmKeujXkY5jXrY97+lcAA+UJ7GYHQyDgJJIs1BrNROKbZpyTUAAVsdx0g4CWlaSnW1JNrmshtvI3Dqj2h9LqmZ8bvfU7hnOn8Bf/V4gMe9ZQPAtFILxAlYPg25vqhzIAaBhR1YyMHOZQ6pIf1yW4BhxEZdouWGOxZGlY4jHogJ4Y4CJugSbJtnSE1AAlHQTlIMAADVRBkdV5pZ6otsvHCDcyHmxaO27XjO78+cOv9jpN4C4at6oFbe5XPtVpDjbRTXMOB0u8L136ubBQIdc4KjYYt560URljFfYj7OPRtIwBueAsAcdlSZmz36UZZl9GGeSR32RROG2LJPYAcjgQqxEYGQN/RcJmAUleck/TUBtEBRmWQZAQDoG4sDkfxGiftA4FoNI8vc5IeGdzgST3iAD6rwAO7n2YIwAA9DQNyq9dQjTGhNAAglgLAwRYgR04PuQ8XBgDhnWosAAMhAUQUBui/04AAXm/oYV2tB3bjxyMEdBGQo5JHUlOKqYAKCglcNEXUMJ0ScGCAQohJDFCxHeGgf26R5okKIOjQhxDuiamUfNcBsi+4DAkVIzgMjGByPJieYAAApAAytNAAcpqROjB0QYGCPWaIrhVHqOJGkJ+jQQAAF0KDX2HvOZg/g/GDycBvAAtJwam/jaYuy8T4kAWiA5GAAIpKWDCKLgQDGDKEPueTegMd6n08d4kAbYJCIFKgFOQlVly1QMnoMeBinLRVMnFOcC5LJVRSmubwmUnKDSCKEcIkRMCxBYfrSewk9CNM4LkAAIkqCAMZXTFTKUuQcgU+xIHKtQYcdSQBRyauYGqrSEqWSnN1eyGVHIDV3HoAeOM4DDwFBgg8IYYBpCIOIF5h5aJJGWj8h+gkp4iSdI0TBbzGg1GgCKdkYRiCrHgEvHkeU5CFUKCcBQvwFDfLeY6BITcN5wBYNvL5aBFnKjSEY0QnyTHWC6FgLg4LaI1BgPFTCcAD5wqIAimUhRxRAJgIUdY4QgFTTpsWPUTpbhQBhZwOg+UX5KiAYsx5rKbEHBeW5MwDx8a6gAFScAQZdf5EKMGGg3pk7JONlDQEJXyfAS8N5gtebRTUMgIAKFQY0dazqAUwE1GQcIpAvVLzADKX1bzNQgIDiG5Q+LrDLwuJNG0ZLOBAK6DQBZobxTmOgP6gAVoSl8YFmBugNUahQ7rCgh0ukyuQkLTBtlGuyTBq1/YpsWemrJ7JU3IEaHCtMVi0AMhOGgRonjgj4DQGgLA+NwHgMgLAQtmp2AKDUVPcBnIaAiFCUQZKmpaDgNEFgCBA7BSaincwGQABiM9/oRAjrQLEbYUA0h9rvS7B9gbx2TunbOxA87F0wGXau9dTJN0JHgGgXd+7D3HtPeEQdl6b0fq/aQUg0RNScE9JWiA1aZC1pdfWjBibR5TRlJawgo6m5uQ4KQ6MjQgOIDrTASF0qYUSoAPp6r1QAdXEBXBQPHONJBw1WmtLGsiFHzaytA68WU2qgBvcQ7IzBZLZA6cFiwaAPDFGkOAGBRr4HCJAUmHJGD1EPoUEVYrDWU1yBvZU1YprnDkOtSADoVMKXFFpkQ8g0B6YHgZozJm7gbxMJZkOBGIDKgdLm2AmpC08mLTcF2nATEwB7U6PtkBM0TQ/TM8B00f1TpnXOhdeaQNaDA3ACD27oN7o7Aeo9J7wEfovWgK917RChNyzAUJB5QkftCeNWIeY0i3HeE3MAeZaj7APBKgAorQO+qLSb0adLh/DhG/WNEQLqdxha0gsbdR64Iq82Sik7ewGQUBV7RH6POiJr4X5JEu+6tNN2oDrVTQ+u4aBjtEf9e6z1F2YBXc4AAUjgKvdawCvv3ce+A57ZR8acHe9d0gt2fsquHf9wHfqA3ofYMEMwQDOCLeJ8G1evHCARDgOtK01r8CkOrTKOwyD5C0nuw9tIT3KYvY3oGxUDy4Dn3ZC+5LDh+BKjaj23HOQHx8+RxkSnQaki074LOxnACdAs8Xmz9Hx6cD8WV9UJeXBkCAhDp4kKVlVBm+qPi2l9K0CalIPcXIkrFj/P6YIpjRBmBWSqlOKyS5eFgCe07rg01pOyfd5773cBfeBH93mxAgfECdUkFn8PjvMj4qY2UMgA8ZBtcQ4KcBdBWWjvGmAcppUrKSHz9cS31uZCeNCem43DRfJJSnC3i3crPkyBd0xLgpP0/F4DiHcvjJK/V+sLXg85S+++QsBHqPBeuBF4eCX2fGEq8j844nJKVUs+6nBTvweFDOA0+3gR72eHG0HlXv0E70awDBEaLM7Y2gHTtD3IwCuAACEnAv+igZAIBjQvOkeyOAuqOSQEB/+nAvGD+nAT+xQPyYAYByBUBOOyWiubiT8uoy2q2ZGG27IjQJqtEkK1g5q+27oYAh2cABOR41GlCI4JiKWzAJiuuhAQCqC7+ryXAgat+XBPBfBOMAhQhbBXAzAGANBqKlCZOOKrqShMAwQ/260gasBE2ihQOp2oOGOn2WOd2sB/Ogub24OH2yqZhBB+OYAChGhRh52Jh0OsOd+dht2iOZuCBOq1hEO3h32WajhzhhhwuwaqhauJONOdO2uPIuuygrOxCRunO/EPOSOKOARnAyAMRvMmu9OOuzOKR7OPe/E3iWagal+Ih+IN+lC9+ooGBz+2Bb++hLhn+3+eBABwAQBoB4Bf+UBMBWR/hr2AxkBDoaBTRmBL+OB4x/+IBBB1RzBT8Z8F8SAV8JSmW/gyAVo/sAoE6pW/686pQygJwhQmo+4zAFWS6tWQG4ChQVa4CjWzWJghQ4CJ2ha0QXixSpSug6kFgxyVSmy5StSQQLGhyfkrU7SzgXUqUPUPS1y2UAyzO0AsQLhIOwQou4uAA/EkNsBgOtMoiugynXiHJEqlviWABgMgJ4o7JwEQBAKsIIgANTqRZBbjurELfFAqTIgCjGOaLKNB/ajqQqUb4gwBALRRYYACy6STEqKw4Zw/mG8Ca6QSaw8/otI604pFKM2jAdMXAY8MoXIh8YQLA4g4o2J2goaJpTRxCJC82peyaJpdqhQIgWSy+TBI+6ohKxKnI+Yiy76L26IwQVU0QJWf6AG4CtQYApUK61WE4Jwh6sZQ24utWsZVU5eZQ6ImoVUHWV6EewQ0YSpOMOqS8U2UW+EXI5GWafateMgmos2CQXqhxf65WQGVWa6QktWW6UGMGTWcGrWDZBZN6DZzZaAE5oSw4cA0QmGB2T8R2o0tR+430t+qgwhhOmJq8q5JckOd260u5T6IxVhLyasnA6gWaIpAOy5W5Z2O5iEjwnhR5Fh8Bp5R5SQl5v2eOo6xBjQuoGW7I9Z+wjZE5rZv6ZW0ZnZLsoGPZdW/ZLxQ5ECI5yG16457Ac2U5M5Y2Iu7A7IpgE5dep8Q46xKA18RKza/gRAFgmo6ktFFgFgPxKkJUVk6klS2k1UYJeAIOkJiAvk0J7Uy4FyvUvSNyQ0V+R8hiZ4nsHMtcscGQ8cac10EsH4IsqcV04smcgED0IEls9Eects3cKsj5jc5cWEcl/w7whEFlaIRsNllEps1Erc8M7cNsrEdsPcXEFIYavENIAkIAPZIKBoYkvolYGYMktY2Yco8kBYSkxFJSPkweQJHFukOy+kQQRksgJkfFAliUnUwl3gYgCg/gQB3FHqKy/xHYVgGywU1V/SeA0ysAW8O8SQOCX0JcAJDFXVDFnCNQdQJ4q8LQxJnhUsawL46oRJyiv8vFS4uVlkXUxS+4sArkCqX8kUZC/8gCICCgYCkCHwbAMCTBElOC9YSQuSJIlChMxMDSnsjCoIYybCHCXCnEEebBrq25jVOg+S+Mnh54Ee/g1qogSAoAgQ8gRKB4eAL8IArgrgQAA==="}
import { Hooks } from 'wagmi/tempo'

const { data: order } = Hooks.dex.useOrder({
  orderId: 123n,
})

console.log('Order details:', order)
// @log: Order details: { amount: 100000000n, maker: '0x...', isBid: true, ... }
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Return Type

See [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook return types.

### data

See [Wagmi Action `dex.getOrder` Return Type](/tempo/actions/dex.getOrder#return-type)

## Parameters

See [Wagmi Action `dex.getOrder` Parameters](/tempo/actions/dex.getOrder#parameters)

### query

See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook parameters.

## Action

* [`dex.getOrder`](/tempo/actions/dex.getOrder)

---

---
url: /tempo/hooks/dex.usePlace.md
---
# `dex.usePlace`

Places a limit order on the Stablecoin DEX orderbook.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.usePlace.md","from":126,"to":7655}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"dc89ef7c90b6e3e69c1c36d86e7178af7ac3a72d19bcb225b4b1bdc2a7afa924","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUoiaicACUnABmAK5gjowQYJxY4nAwAKpgjGhwwURhcTCInCKkpgoUnLDWLGFwZWBxzABGZJFlbYwKpmgAOrms7FzppJk5eUZQENYIegCycTJojFgm8Jyi5WiVipykMFhHmWBiaymcEDHbnC3tZJxtGHd9JKl0bGbn17dtERgnAAjBZOMFQV8UvI0JEAHRDIYAWk4ABE5k1OPg0GgsE0APT4oiMGDMOFwfD42bzfFxNYmNbwfHjSa5fL+MQKBbIZAgOiiVhyfwsNgcTjANIZbJsuCcVyxUgQZicADkxNJKsRYBZ0umwRVABYAEwWFU1SSRIaEzjGix2+0OsAgAC6zuEml0BvUxnkShUiFBGnE2iCOqm7NkpnMwJsdlIDicUncnhweEIJHIGkCTBGYoAKoxrPx/CJxLoAOzSH2KZRIA1BrQ6PAFov+ExmJBG2P2Rx+FzJ6heNO+TMBeh4awpERpGQOGAAZQwiTKBkEcNgtDhcUyAAVZ9YF0vrHCAEo6OKkMB5rwAHgAwikYr0agl+JAAO5gAB8JY9SGBAGyL6tYuA2IZ4Bsc6LokbZRnW3bxr2zgAGwDpgqZ6OmfhZuOegiqMPB8IIv5lv+RoAMxATW/repo4F6KuRjtuY9YgLYPaJgGAAcaFDphI4ctmeG5lwG4kRIAZGlWcjUUglHUMGTZ6GJkYdogrHsYhnFGgavEYT4GaCbhIDxIklypNuMB7lBR73o+z6cK+H7fsE4wCjoZBwAA/CuRFwOudBbru+6HokcI7vYzAeRMdlgE+1SOWAb4QJ+X5dIRhgBZulnWQe0HHmeaAXlet4PnFDlOSl35DGA7lwOkB6OcFNkwVQ1ILPoRGxOwM4OFUdwmMweTXKQsCkNcqTKEC7BjW0REImAQwAHIQDQZR5vgjCyltdxwEe+CKpA25Yl1yiiFw76iNM3XjVNnB7KIYBwAmySLecEDPECpjWDIcSwFAE13G0MhzPwn0xOwQJHEVl79TspzfJkcIcqIXJIDyfK0AKGy4FQAAGBP5LQQz4WKEqMXKCpKqql0KEN+I0CMmpvaZSRXAAglgWDBNEwBDJwnCTk9XASswdLnTANRbTu8hQP18oALwZWuG5BVZIX5TzWoC9DxXgvzAucDebR0mgKQG4bE13iYRYK8APOcArX6cGLFwwMEfOpJbhsChACRoGUYYyvqoKmjUyGRBQFve2sRbrYW/BwjEirMDulQHvqFhwpIkgqpH0eW2b/DyGUKoWLQJrHnCcIAWaBeG+hpSqibGB117luuJErj13Lz3AzAUB29LstVN37ecF+9e5UCADyo1kNHN74ibOIpJPXuWmAY8E3jLoULybnMP4h/RbKKIRfGUVOP5e+8rrl5GMsFyvYc8ArGgyOuu6pEBuR8kyX6MiYElIgByhrI8sE1IaTjAmPsRoeIeEHPpLCo4aDGSFtOSCeUjy+UyqrMBLUCrnkvNeHAsV4oviSs5H838JIUSsNWQBoEFKNlDOA1qxg4KIHLAhWBzgLB6W8CgoyQRXKKhwBwDA0RXYSzKIUcQjBRD90xFg0Kx4L7uWvuQ3oX4agQCwOZbyZQn4SxngY16cAbye0tjNMgABJKA3Rej9AANzR2YKIYupAyh43LgAEmABUUeeM3HjyLiXTgvjaABKCYoVwITo6+39k4vo5xQmWy2gAIUYI454fA5CPXSQ3BOzRWgdFIEUnWMADzrADpwPM8YnovRSGeGpBjQnuE4JkwEABRUgipSCkMlr1bBYUNFX08tohQujErJVSpwAAPolWAT4zBQGiE7TgRAIA5P8O1Zs+AgQyPMrEBIbNUgYD9oLR61yZAyE4O+PI+AtkKKUXIWUZt7qVAUNoW6hyXbixOY9AG+jzJhBkK8QghhAaiCgHLMF9zrDgoBEWa45ipzIyDGjFAB9Ir+CKJUN5WwUQbSBASxRyjrhtAAFbVK4J89IcAPkfTunjY5r0ABiYA8af33iAQ+/hQUWLhCkeccRrAHiZZwElm1ZSsxOY8u5sRGBHAeYcya/z2VXB2nAcVkq4DxHucCh5jAlUdElEyge91NWAteiqWUpx368txZfQV6KnoirAH0gZ0r6mytOWZF+ir7lPlVYwW4d0tWfESH7c4nltifH6T1Y1wbPoWsyADO6ZABnOv5XiqgQqMWip0GgOQAMZU7XlUG01IaVVAnfOq61RzbXatlDAJ5TxdUSvgAalYELYg6FsFanq8hJz+3jTc7NyawAA3NYyjNnB21TT+UCKA50dgjqTaQXNRwPGkGIlQFEdjbiXLiC7TxzbVjrDkK/AAjiUEQcAah41FXqnteMTVKtDdNMA/bRAxCcE2zgs4aDTiRUq09aojmwpgAtFE7MlV3XAzIFFYMq1TnBC+sAYru1Mrxs+lI3r2D4cicWnEZa8bRHEGSnZAN0NPRqMau6981kvN+vWmtabeiQCOFAT+boQCljoQaBhACQLIWAUEY5uNOFqR4WxGBSF/wCMQY3YchkcKiJOPosgmAqPMFjXUnoqSGC0N0EaVQMZGHick3gJJ5xIHmC4rwpTiAjSCPU9hMcoiwiKKiJKCYup8jyPY2UWJCU6gNBkJiB45T0rGf6CTESAXWTTD2RiPAywr0bBJLKHY4XX4nHgDCc6L8bh3Fi08F4bxGAfEXbQb4MI/jPEBCCMEEILBQh+LCBayI0QYjKNiXEBIiQkjJBSKkGJaT0jyLl5kUpwxGE5NyXk/JBQydJiLFLQXZTymTtTNUY3mZDCDnqQ0JozScAtFafENoTQOge06L+gm/xudUNJYC/pAwsPonmwLi3HNIGcwpjifZQQef4hp7zeAxE6ckdEWO/BSmPFHEJ8zXF/6ffgj9kBiPAfMM0nwzsEODJebQUETb9SE7iXRx92S6lbN6BbMWVS5gqyE9cwglMQiBKabwPRqmqd07uxOIWJuzOk4pzTmL8Kwv0oS/20LmXhVipDJqnVBqQJFfS4POl+YeAyoZnyHcUXjUCufJ2Ij3rYBkDzjEP3Scpg0Q9IABqcB11UZ0wQht4kQISdqcJGZsDhLQDAAAvZkiozaThkPiOg7FFAwHxPVapABiYuGAkRCwPAYqIKNsUYzWzjfwO98hJdFFt5nlNFeqggLQBmpI2DHbANaHX01bjAjhGCJWiPOAWCGBg+lCdgSOyp0WSXSo28hy73nTg1p+8xuFvdBORpR8K6l8L6fD3Z/z61K34XzXO92hHz3hObWF+D+X0Wcia+E4T6VxnFUR+LDAh37d0Oe/btt+a1nHOkhR+95Igf6L7TiI4Gi37j7a6b5lzZw5xv7SrAE7y3x/YCjHwH4ypAim5AgRC7R7D9TBCwYKBwg1ADAgDP7AikEkEgC/45ykHwjIEsZGCkpX5gxFDsb8ZmadiSCsRib+hVh0QgJQFi747s6KacTAjkQk7CJ856Cw4SJ6b3QCARKkHlyVwPbqEaGaFaEv6kE05yTAjei8FqCM7UBKFOis7KYubaRSG87Q6yHabyFSL3ReBlCkEty6GcGIDkTliiZY4M445BBqYWEBhWYc7WGqZ8Sk6oJCTgAa5ziCxTgQByBDAEoJFPRJFNxlRwAZF64dTMF4wYIZEfoGZQArCYGKjEiwB5blAig3qwAmw/L9SFE3pnRcA6osCmriCKFNpDAABSogRQ841glQBiaR2RN6UUCeW0yo2mlRVq1W74MAbQzwio74mQEw1uzBJRZR9WFeHy74H0Ke9QT41gCRIw3WTQWoAAVJwOzJElkUUYLLOFKo8soC7DoIQFALKF2s8jgQUYkXIHCCDAoDzCRv8ekYCVOqQKCQmgDOCeMbBpdJeDCa0dcqkOapZJmh9O+JUDQN0Y9K8CtLAHCNSt8XsDAAKAtDcXcQoCDACPcvCY8aYKWIkECELPFBeFap8jiXkECJ8sgHjNpvquSGgLMHSHjF7j7iNpALAKSSKloJNjSCBvAGgEiEQDpCHviKIFgIwJHnMD2nCNiMwDIKnkKT2iIGKbCLCUMAKWaUyiKWNKQBKd7jiL7oSDKTAHKewAoIqXAPiMqSIGqRqfXtqbqXaf5EaSaeGRadmvCH6kCLSRAPSZEs0TAB+kiuiUCJiSasoH7G0SJP1Kyh6YgKmcUdAGUdbgAPpXFXEADq4guQigNZlZ60/yiZyZqZVKtKjg9q7xuZXx2wqqZgHa40GCW0NA5wEKQwe0iQB0KQfssoJgxcQGbQqx6xtxO4diHyhyrwpwpI/cNQPGg5fJO5Yx45MIU5tUM5tgh0C5wGjAy54K1wy6nARJsGpJuwRwAo/knA84MAJ5QIApkAeJVw4ZnAdi+IM8zpUpfu+IHpXpCp7U/pEsgZ6pBompoZepwpkZqeogSIwFMASIKQSI4ZSIyQ0QEMpAQwBmYacU7AHi5k1uPSWM62TUhZbZdJYQKZAJaZiAWoO8pJA+PFQJEAIJKohydy2J7AMgUAecoS++/QmIElIMDy0lUANQnyFpeZQlEJsGwJ+oylH0AApHAJdiqAcaQDJXJTdu7vsPkINjAJJapZZepd0VpXSDpQiXCFCcEGYO+JwERtCSqLWVCniDUNkVfJtAcACADHYFzPIAPHnJEPJV/nZW2luu8UyqjNgTOrsA4GDA9I1JpaKdmnxS3rdgLIFWUCFXwGFeUEqB8f1DFViNqTgGsjZZbOdJwMgDAGwc6IgKoAGKoB1T7FwEMSMR/KQAkHYleLKmVOTuCMWUQMwL/EaNxJvNaJ1VwDPDSnSnCFNWADNRtFtPNYEItdAKUMtV4RYJIF4VxBtRVaNfcBdYgP0GQLVLHuGXHrQNUnSK9NwuWAGJICNQLF1T1X1UiDia1WQIgMhG5kaCDdsFwL1WEONbUudbAK9XGpeGEFhT2t9b9eZNwnDchBYA9d7F1cWW9TjbHh4qYHHmwZWeFm5uRF4VqJfrVFFKPsFZxieEmcySkCqKEqmXCEiWAMEHjKiI9L8pwAEpzTAK4AAIRojS1kCK2UYpW2WKVlBS2J7jS1m8383pFgDK262/KK0aWHElX9JDA7xajMXYw3rbjsVAh4wPFyDpnPGXFvQCVwCeVcB5mj4hh25fnMDzgNWEDvg8zC1TjI39JB06Ah0Ulh0R0pTR3+0uwYDu1AhKx+VjEZFwjZ3BB5k1CxmhLUVZ3CX6XiWOUqUWVWXJU2XS7nBKW11SUuWW3XAeVgDMCV26UiViWGWcAmVmX12yWN3lVa0t0OVOVj2d3aU9191eU+V52BX6g1X6JPr1WRVNWwotXxVrJJWa3N32XdVVWcAb11URWNXRV71xVtUDxujdHZrs2x33DuTc0G1Kp809DG1C0V3Z2i0NkS1m1PBy3uRK0q163q0T0KXT1QMy1f33I/0C0m0INq2d0v3coEz54raCb/n+DIDZEXgHiSmukjZ9DKBxBtBwiTjMBwUXWkkMOwDLx0lEjBn+mMBtD4gi2kmRAugCZo5yRcTyZGHcImGpn47AjQKg78I2FQ7k4w6RXQDRCAP6VRRZXaA+QJoYA1DVwiruphDjKYgEnIDOjpTbI5LggADUI+I4IMsK/DbUGWegJ9zKkS7laAH6rxzyflzEcInAWWawOMg5CgrQMIsoGZaa86A8NQPjPR5UEwXA2ZOBd0oue6rwGjz02gsJ2wSqsK8Kr0XFKT3x1DIgeQf15sYAbBD6NRQ0s4t0H0tpdlMQwQ5EkQ0FrpsFHiYA5Y8pPp7YcQ9ePTJF2VfpPT5Eke/QMQcI5EhpaAxpm8wQd0wY4TLdx5eT9yMTWJ3VeMf1MgSc9F50oJZDw2sF8F/k3pvpyFoGqpaFGFOp02pq8zxpqe+zlFDFHz50SIwYUQ8I/FBMglIBXAY6vwSsqgMd/d1doLdSRlslNQMLsDqV2tCRySnA6gblopC9It0LhmiAl2iLx9aVZQMLZQGLxVlpttBMWof5gFez9IhzpADFJzLpZz7pjDlziFU2AZdzHDmF+zLzJp7zRzaAXzqpvzFFPUNFX0dFTLpWKQmKCkBevIcA30MmRAWcneocAjnh5Ekghhfh8kAhQQwJUjMjWkfYXOSCPOCjMRl+qi+UuCKsgUBCoyRCMMJUZCZUFCsy1Ceh6kwIXY1mfBJhDrECwR0jVhcCqg8jZOMRchumTha6YgZQ1ihstipADiKSri7iF63ikS/igSeBcSCSYSZhPihb4W8SlS2wBmaLCWaS0cWSOS3Q+SFJYANbiOyO5SNbRwbSdSDSj0z05yrS7a7SQw8oSyCQKyUYUAuRByQIzxXAXa+qhq/apwSRJAAMybOwlFQGUa1uQwzBS75Qb6TKa7u58Am7VqO7N0+7LaYAh7s1i7EQy7Z7vadyl74xW7tQ66d7kaD7T7x7r7p7uGH767V7MgP7t7e7AHz8Cr/rxoQbYjrExreAO7ZrUbzg5EMbERyCthij9h4iib0QGbWbzwzivwU7M6MAqyA8iH8CVETC8maHegZHc7Eb5rROAbJOnI/g8teAprnhBo3hTHIEDChHIAc8Y04FqIZQgb5E5hsm0YEmIOFrcjAmk4sAOYFe4oysu2guNMqM9MQeEAzMlOEop2xue2Kcqo6ozA5nyWEoVeNnB29nDeTMr9S+YbiQo+jEWUas08msm8Nld4T5bKgKaZnATuCMU4fJH0lk40zSqQBBcIRBzwpsVwP0CcNQHzp7bQQ0TKr0m8Pnx40mHsBs9mdSVnBQT+dol2EcUcXsXbY+icQhj+NBecTXAs4SYApcqhFg1g2hw3I39or+3XzhOApcLcbcncXnXl1d0nTwdicnl2pX6466Xk8pY0Dim8/gV8ogSAoAgQ8gqrKQeA7IrgrgQAA=="}
import { Hooks } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { Tick } from 'viem/tempo'

const placeSync = Hooks.dex.usePlaceSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
placeSync.mutate({
  amount: parseUnits('100', 6),
  tick: Tick.fromPrice('0.99'),
  token: '0x20c0000000000000000000000000000000000001',
  type: 'buy',
})

console.log('Order ID:', placeSync.data?.orderId)
// @log: Order ID: 123n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `dex.place` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.usePlace.md","from":7992,"to":8631}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { parseUnits } from 'viem'
import { Tick } from 'viem/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const place = Hooks.dex.usePlace()
const { data: receipt } = useWaitForTransactionReceipt({ hash: place.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
place.mutate({
  amount: parseUnits('100', 6),
  tick: Tick.fromPrice('0.99'),
  token: '0x20c0000000000000000000000000000000000001',
  type: 'buy',
})

if (receipt) {
  const { args: { orderId } } 
    = Actions.dex.place.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `dex.place` Return Type](/tempo/actions/dex.place#return-type)

### mutate/mutateAsync

See [Wagmi Action `dex.place` Parameters](/tempo/actions/dex.place#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`dex.place`](/tempo/actions/dex.place)

---

---
url: /tempo/hooks/dex.usePlaceFlip.md
---
# `dex.usePlaceFlip`

Places a flip order that automatically flips to the opposite side when filled.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.usePlaceFlip.md","from":155,"to":8394}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"0b032ce2f26b3ba60b7d704cf92957c90fd7feb051b6dc255273d25ecb860c75","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUoiaicACUnABmAK5gjowQYJxY4nAwAKpgjGhwwURhcTCInCKkpgoUnLDWLGFwZWBxzABGZJFlbYwKpmgAOrms7FzppJk5eUZQENYIegCycTJojFgm8Jyi5WiVipykMFhHmWBiaymcEDHbnC3tZJxtGHd9JKl0bGbn17dtERgnAAjBZOMFQV8UvI0JEAHRDIYAWk4ABE5k1OPg0GgsE0APT4oiMGDMOFwfD42bzfFxNYmNbwfHjSa5fL+MQKBbIZAgOiiVhyfwsNgcTjANIZbJsuCcVyxUgQZicADkxNJKsRYBZ0umwRVABYAEwWFU1SSRIaEzjGix2+0OsAgAC6zuEml0BvUxnkShUiFBGnE2iCOqm7NkpnMwJsdlIDicUncnhweEIJHIGkCTBGYoAKoxrPx/CJxLoAOzSH2KZRIA1BrQ6PAFov+ExmJBG2P2Rx+FzJ6heNO+TMBeh4awpERpGQOGAAMRMWAAyhhEmUDII4bBaHC4pkAAqz6wLperxJwgBKOjipDAea8AB4AMIpGK9GoJfiQADuYAAfCWHpIMCoGyL6tYBgAzA2IZ4Bsc6Lus57WG2UZ1t28a9s4ABsA6YKmejpn4WbjnoIqjDwfCCEBZYgUa5bgTW/repocF6JuRjtuY9YgLYPaJogRpGvhQ5ESOHLZuRuZcDutESNBMHVn6SBKWxTZ6HJkYdogvH8VhglGgAHKJhE+BmklkSA8SJJcqT7jAR6IWea7WC+b4fpwX6/gBwTjAKOhkHAAD8G7UXA250Huh7HqeyGuXCB72MwgUTO5YDvtUXlgN+EB/v+XRUYYkW7g5TknkhK4JdeaC3veT6vhlnneXlAFDGAAVwOkJ5eTFznxYk/jUgs+jUbE7Azg4VR3DES7XKQsCkJwyiiFwoh0kqq2FmEMivLN6yyj++DyLEjAyHIUAImAQwAHIQDQZR5vgjCyi9dxwK5+CKpA+5YmNK1cD+ojTONS3KECeyiGAcAJsk13nBAzxAqY1gyHEsBQNcqQ7G0MhzPwSMxOwQJHLVd7TTspzfJkcIcqIXJIDyfK0AKGy4FQAAGXP5LQQwUWKEqcXKCpKqqQMKMwjD4jQIyavDNlJFcACCWBYME0TAEMnCcJO0NcBKzB0qtMA1C9B7yFA03ygAvEVW47tFjmxZVKHq1q2uk3V4Ja9rnCPm0dJoCkPu+1jz4mEW1vAOrnDW/+nCGxcMDBJrqSh77AoQAkaBlGGMr6qCpo1DhkQUCH6f7VgLb8I9hb8HCMSKswB6VCeBdwhYwIqqX5eh2sRa10WDdNy3hbJyqFhwpIkjd2Xafp8tAjyGUE+0Ca1hwpvoFmr3vsEaUqoBxgO/z77riRK4u+WzDuMwFAUdmxbVSX6f/67+VQKVZwADyC1kOXj58QBxxCkN+adLRgBflzDmLoKC8n8swfwCDUqyhREleMKUnARVgbyT2d4jDLAuHDQ48AVhoFpq6d0dFoKMWUpBYEOFYIaRAGVZ2LlBraR4phBMfYoIiQ8IOMyxFRw0CsrracCEKrsOsGFYqDtWH9SqheGqdUHw4HSplT8OUfKASoQpI0UEjJMRUtBJhoY2EDVQpwpAtD9I8OcBYUy3hhGWSCH5RUOAOAYGiInY2ZRCjiEYKIW+mJJFxSURvdBAUsEaN6P+GoEAsB2RCmUQhxtv5JLhnAR8qdQ7sEWgASSgN0Xo/QADc5dmCiH4GQMoHMLC0AACTAAqM/DmFTT5BxqWAOpDTmmtMUK4dp5dM7ZxKX0c4HTQ4vQAEKMGKc8PgcgoZTL3nXZorQOikFWdrSu1cNmPG2eXI4J51g504HmeM0NYYpGvKcpJHT3CcBmYCAAoqQRUpA1Em0mlIyxiVkooNiQoeJ2Vcr5U4AAH2yrAd8ZgoDRDjpwIgEB5lDQxM2Y6CcjZ2ViAkRWqQMBZx1lDEl51OA/jyPgZFgTglyFlEHZalQFDaDBli3xuKoaY0SXZHarxCCGCxtsKAlteUyDJTIAERZriZKnLTIMDMUDwOSv4IolQ6VbBRE9IEaqgkhOuG0AAVjARwi9JRwAZYjcGnAOYcrhvOMAHMKFwJAAg/wPKslwhSMuOI1gTwWs4Fq56soFa4speS98RwKXHVSNau1Vw3pwF9f6uA8RxVcopWdcVHRzWZExnGnFcMVSylOGQ51yqMHutldDL1YB3mfMDRc4NeLbLEPDeKyNyNbgFqIVceQk5s5BW2J8D5E0M3tqRrmu+y0sVkE+eW11KqqAerld6nQaALqNqem9UNbas2nSjUdE6PatoJtlDAKlTwk1+vgKmlYu1Yg6FsNOia/as7nCHaSudY6wCYxzekC106L3gzZUCKAq0divtHaQBdRwqmkBolQFEBTbhEriAnapQJDarHWHIEhABHEoIg4A1A5t65Nt6OaZojYwKNKQH2iBiE4GdQJZw0GnNYHanA0Nqiw6IWAV0URK3Jdazj50pUE13VOcEZGwA+pvRajmpGUj1vYEpm1a6cQXQ5tEcQOrUWYyk9DGoGbrV4PhTStGQIJ05t6JAI4l0XRuhAKWfRqgux0P9Iw6gwZmEcvZsYdCiBbFxnsSBA0TjhwWVIm4k4iSyCYF08wd95yegTIYHo3QRocJKTkMxJA3n1JBFGecNCOkjF8VC9hTskXxLRbHG4sIQSoiSgmLqfIASrNlAGVlOoDQZCYgeFswqaX+h8xkq11k0x0XzDwMsHDGwSSyh2D1khJx4AwlPakG4dwhtPBeG8RgHxOBQh+FwHbAJMggjBBCCwp2YTwi1CidE8wyjYlxASIkJIyQUipBiWk9I8hLeZFKcMRhOTcl5PyQUAX+b60m+12U8pG6izVN9uWQw856kNCaM0nALRWnxDaE0DpSdOkoS54CQlywxk8yBKwPnGyhlBzKMr5gKt2OqwGRxAj95RZIg1vA7j4teOiHs9Z9xNkC9c1lyQ3o8smIq0VvA4vWzWJcNwrn/CUzOIkjFnMoouDV3kroKCFh5cQX9LxZXehjfq6rJzwSwJteCN1/V0RQQjMi2bq3ZOJwx6D3rijn3Y9Eq+8KtXYeSpR4nivDeO83z2qdW6kCYPMeAvDTwI1DM+Q7j+56qtxlOx+71y1MgZcYhb6TlMGiV5AANTgMeqjOmCO9vEiBCTDThDLNgcJaAYAAF7MkVEHScMh8R0H4ooGA+IuomoAMQ1IwEiXWJ4klRDpoqpm0O2b+GgfkcbhvxQXLrsLYPqoIC0GlqSNgGOwDWnT38EEHdY7LVPxYIY4iuAl+BK/yPaffd25TRohrQP9Egpxv864jQ/864o8Q824VRgQO4HRu5OBQCtQH9fcn8kC7Rf9bYS9rswCv838iwoIYCh4ACx4gDO5UDrRC4MCidH8dtJ5p5JBX8CCkR6DwC9YSD+ADRyCg8R5ACJ4p5p5aCidOC7QhhoEcFF1K0qB88gQg0gRFDthltdh9gFBwQYA4QFA4QagBgQAcDO5DCDCQAWDp5DD4RZDzMjBtVeDLMSgKFnMZdVJAw6cNdGd2JrIhCx42cpBNcndyxatzIBcPchc4tPFEteCDktkTdVIoJacFdIJrdfMggS9/DudAi+wXc+c6swipIQA4cT81dKdqEoIoJaFkirczFmw65Mj3DHc+wTJecxJQiRFCivdKC25FDA84D08w8x4I9YDuidCVEE8vAk8Uouo5xvd08ZsRps8Et1DVDC9EZi9YCy8K8NVq9UhUR69G9W5m9W8cR29O8MRu8b8IA+9B9h97o5gIBx9J87Bp9Z8cBrBF8YBl9V9jh8hIhN9IdmZWYhROZuY4BD9KIJRq4z8m4L8r8e8IA79MCx5sCX98D39P8IDeC8CSjBDo9hCcDxDOAiCsSS9oDbZ/9fCEDjD7QiSwDCdDiUSdtjCcSCCuDiCS8yCKSRiqTx4WSiSuCGSmDbgLC2D0TpVJCSSeCS9+DuSKDeT9RRSiTJTpCuZZC3UFCsDlC0gsCIh3o9hppggdC9CzCWTTDOBDDRSrDYN49oZ/B7CCCigrNnDMtVJjRjFIIqwbcfD8S/D1dGiqsncoIQiXF9c9BhcojvFF5ukyhLS14LBrBSckzkyUzUyTCQB4jEAoIcsPSWJai9Aul5AGjacmjnBci2jQzBdwzIiEsoz95YyQAj5DDMyDRgQKtqiMIvDmE+d/SPNSyatWihE9cqzwBk9ZjxFHiYAhg1UdYpxJyyhGo4BJyFjMUgQOYJy5AqNksoAVgVDFRiRYB1C4ARQ8NYAA4WVpoNyIY7AuBE0WAzpxAzVwYhgAApUQIoZcawSoJJWc6GSchOE1F4l6ZUOLA86dA7H8GANoZ4RUH8TICYK6IYew7c3ck7WgQ3BlH8RGOfeod8awWckYM7JoLUAAKk4CVhtUXMnKo1RgiEOipQAuUGgFlGvWpT1PXLnLkDhDxgUHVnUw4r/K4u/VID4uHUxgEqXK4qBjvFEoBhJVSBzQcnzURh/EqBoDNShleDugE0NRYr2BgAFCujIoooUDxgBHFQkuos4FMFLESCBF1kylvGnUZVUryAhkRmQA5jixTXJDQFmDpA5hbzb0+0gFgF0q9S0D+xpDY3gDQCRCICNAND73xFECwClm8tvThGxGYBkHnwyotREH8thDEqGE8vyoikKrnUCpOI+w73xFCpgHCvYAUCirgHxBipEHisSuStSvSsVB8uytyvKsqo+XhCbSBFMogHMptSvJotJUUrzUzSYrpGspkmmmtQ5gasQFmoTmgF3MQrAAAH0SKSKAB1cQXIRQE6w6x6LFSa6aq8g1Y1RwYtRiwgKAZbKNMwS9JacRF6Ggc4XaIYD6RIL6FILOWUEwGpFjGCvKeC8ig8ApBlY6V4U4UkW+GoezbYKNcGV4P6kQGEIGjqEG2wb6CGzgKGoELje6Y6JabSnQ3SjQgy5gCKTgZcGAa8oETyyAdSq4cqzgApfEb+aq4KuqhqpqyK4adq42TqhKpKq/Xqu4gatAHK+fUQJEHmmAJEFIJEcqpEZIMXdgIYZLKNUwImUgKpOyA615FmGHXqdau6sysIGazimADmRALUaBXSzEwSnQni/UY6c6FS9gGQKAbuDpZE84TEQOvGClEOqAGoRlQqrOQYbgySv2iAXilUGOxGAAUjgDxxVCwtIFDvDqFP2HyDexgCDrjpLoTrNWTrpB9vTrhGEuCDMB/E4FUxEpVFOoFTxBqCXMwWegOABExjsFVnkDvm7kiAjsYIrvPWgwAotXpipt/V2AcAJkhh6iTr8rnQ9vvyJ21m7rKD7r4AHvKCVB0BHq0LHqxFSpwHhQZNDlWk4GQBgCdOdEQFUADFUGfozi4E/O/PIVIASAKXvGDUag93BC2qIGYGgiNADCMggWtBfq4G/iNRNRAbAYgZeigcCBgegFKDgazIsEkCzOQf/u1lfq2v6DIA6nH3Kon1oBNTpDhmC3LADEkCoe2C4Hfs/qRFUoftqRwiEiNB4dfo/rCCAbOUIdgEQDobvDCCVtvWYdYbsmC1EZwgsBQaPoAfuCIYUY/SUfHyqVMAnydMOp6yEigizK1GII6hSlf17v3UvCmpspSBVA6SvLhGkrAGCA5lRChlZU4GaUcZgFcAAEI0RgmyBImdM57GSo6yggnp8lpTrXH3G/ywBonUnWVInE7sK96PlVSOYtQbbgSgR9wHa1yqLNydZZwLUD7Snva07zsVrbYQwK8jgBRlwr7CAfx1ZvGsS51X8un9Len+m8ohnm6uBmAMA6mgRbYO7fyW7FnggU6ag51Z6tR5nFnuLM6A7q7Y7i7S6dnD6knK6sRjng667Cnrgm6wA9nXaDms6c7OB87C7Tmw7znI6rn3nvn7mU7jaFmXm26Vnu79Qz7EkSNL7h7po76J7H7p7Ihfn57+hMRkAT7OBoWL6h7r6EX+N77J74U3QzU517GsTwnnGMnyU3GehsmvGQX9m/GAm8mngwmAoomYm0n4m0XLnMR2X0nMmGWlycmeX8n7mKXHU1SFVATMgAtkAlzbwTwgrTjPs+hlA4g2g4RJxmB6qiHdKDXYAgEzKiRuqr8TA2h8QfHdL/iKdXDdIoILd8tgt8y+JXaGjvR+zLAQzhzwjwzh7oBoh9n/bpiYZtBQph0MAahN4vVq0wgokWayhNLkBnRCoUV5lwQABqX/EcPGfjf4qgTPPQUeKOs1DmRutAKjSlZQe4GAH8biOETgebNYNmbGhQVoGEWUTjBSlQuiu+GoWt6lZ8pqCYLgJStQmG/3eDV4cN1esS7YclfjUVOGZ2ydvUpNNoEQPINh4OMAJ0ojcoe82cMGDyryiumIYIKCSIEW04uqqpMAcsCKlq9sOIK/R93W1etqx9qCYffoGIOEKCLKlWmQCBYIa1YMLt8tvTJd8VADRaxlTythmQBudgS2vitV2qwkcWiKZq1q6W9jOKuWnqtKgHM6ED1WlD82y2mj1aJEYMKIR7eGL28Etp2c7OV/VQYZ3215/UAdc4MoXOsOmoAT2ERJstq5sTsodQBuvy4FtOycvjlUaTvHMT/lyTzEaTzgWT3eoq0prUdmrmjmFDtDi21aTDmqs441xqvDyW/7Dq4ji1lKsj0zwa+faj9D1aOjuKxjw2paE25GDKLzq2gExmXkY8uy1VSeJAwuJzV03SA0XLS3VSd1nir17I5wFonXfnDosRLEsJF2VyWRe2KKBRP5CJOPMmeqdRRqTRMFHRFsnCF1kxYENSNI+CCxCJDLyrASXhHnHL/IvL2LDxWs6IcDMQMoXJX2fJMgIpcZcpSpTDUgXpJpFpA0wZYZTpJeHpG1PpdbzQoZHZbYZLMZZ4UpSZcuWZeZboJZAysAY7kvWIsgY71XGuSXQ5Y7k5C9JJR6K5GGAlO5H7tAR5KFGFGAOFO+Fc23LFRprga9FNNNB9U4R4kgTGCbnYc2mG+NMAA6pC2HiIeHijC1JH1G+AVH6dDH0GbHwtFIPHiB1jQn8oYnu9c6MnyStH2oCDank9K2rUfHxn6cBH29UnkhDnyn7nrH3nuGeVMohSA0SsXMzs70jHnrn1g0CLQct3AoqyCMsb+aQpBZUbX4aFBIWFKMKAFsoyFryCWhb02b0gIpNXwMvsVQAb13PATkfwcJvAdLhLg0SQXiDsywMMkAL+B3gW1EMoL0HCJ0f0kLPrhxVwZzScWAA3SEu2JHb3MWemSWa/WWCEgWBHMHGE1HdUZgOWYoqE0/ZHWEtHUkfP2/Slngwr6RV/TiEqR2D+IrxIN2eGa0Z8LjW1HFN26y1IKmKcdy3qJ4G5VII03Q5t4BIOVIVGOuGoGj5ntoSWC1OGCBVv/5fzFOH2Erc5LHDrRAu0PHEuOeXZJcfZXE/ogkjuLuHuNOJ7h/0YxU0Q2eH2Qs3b1edeGmSAHAD7QXcG/stC8Arwj4J8c+M3xbr+0VQ4fP+EtAKRR88c+/Srhj2CgRVDeECfwJglEBIBQAgQeQMeRSCe8EArgVwEAA==="}
import { Hooks } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { Tick } from 'viem/tempo'

const placeFlipSync = Hooks.dex.usePlaceFlipSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
placeFlipSync.mutate({
  amount: parseUnits('100', 6),
  flipTick: Tick.fromPrice('1.01'),
  tick: Tick.fromPrice('0.99'),
  token: '0x20c0000000000000000000000000000000000001',
  type: 'buy',
})

console.log('Flip order ID:', placeFlipSync.data?.orderId)
// @log: Flip order ID: 456n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `dex.placeFlip` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.usePlaceFlip.md","from":8735,"to":9430}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { parseUnits } from 'viem'
import { Tick } from 'viem/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const placeFlip = Hooks.dex.usePlaceFlip()
const { data: receipt } = useWaitForTransactionReceipt({ hash: placeFlip.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
placeFlip.mutate({
  amount: parseUnits('100', 6),
  flipTick: Tick.fromPrice('1.01'),
  tick: Tick.fromPrice('0.99'),
  token: '0x20c0000000000000000000000000000000000001',
  type: 'buy',
})

if (receipt) {
  const { args: { orderId } } 
    = Actions.dex.placeFlip.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `dex.placeFlip` Return Type](/tempo/actions/dex.placeFlip#return-type)

### mutate/mutateAsync

See [Wagmi Action `dex.placeFlip` Parameters](/tempo/actions/dex.placeFlip#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`dex.placeFlip`](/tempo/actions/dex.placeFlip)

---

---
url: /tempo/hooks/dex.useSell.md
---
# `dex.useSell`

Sells a specific amount of tokens on the Stablecoin DEX orderbook.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.useSell.md","from":138,"to":7269}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"ae5fe3560e82c82e12f7f413d98649d47715c71ac035ce263b44bcd061feddc4","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUoiaicACUnABmAK5gjowQYJxY4nAwAKpgjGhwwURhcTCInCKkpgoUnLDWLGFwZWBxzABGZJFlbYwKpmgAOrms7FzppJk5eUZQENYIegCycTJojFgm8Jyi5WiVipykMFhHmWBiaymcEDHbnC3tZJxtGHd9JKl0bGbn17dtERgnAAjBZOMFQV8UvI0JEAHRDIYAWk4ABE5k1OPg0GgsE0APT4oiMGDMOFwfD42bzfFxNYmNbwfHjSa5fL+MQKBbIZAgOiiVhyfwsNgcTjANIZbJsuCcVyxUgQZicADkxNJKsRYBZ0umwRVABYAEwWFU1SSRIaEzjGix2+0OsAgAC6zuEml0BvUxnkShUiFBGnE2iCOqm7NkpnMwJsdlIDicUncnhweEIJHIGkCeGsKRE5RgMhkAGUMIkygZBHDYLQ4XFMsXCyWy9Y4QAlHRxUhgAAqXgAPABhFIxXo1BL8SAAdzAAD5/CJxLoAOzL2S+5RIAAcQa0OjwmSLpcS/hMZiQAGZY/ZHH5EAA2ZPULxp3yZgL0JgjMWVoyLiSIFuO4+oom6IN6mghngv6nlGl7XvGt7OMCy5PpgqZ6OmfhZp+egiqMtR0AuHpSAa66gf6V7UMG+56DWsHnogVG2DeiaIEaF5oS+mFvhy2Z6PEiSXKk9YwI2R4tkOI5jpwE7TnOwTjAKOhkHAAD8FZ8FWNZ1g2TbHq2AAK9jMCpExSWAo7VLJYCThAM6zl0PBaXA1Z0LpYn6S27adt2fY4BZVnjrZ8mzkMYDKXA6TWEConic2J5UNSCz6FpsTsAWRZVHcUUwPUo7WNszAQAkXA3JwaACPIrlagAchANBlD2+CMLKrU5S2+CKpA9ZYmlyiiFwU6iNM6WkBV+BAnsohgHACbJGAQyVc8QKmNYMhxLAUDXKkOxtDIcz8CtMTsECRxoF2uQHDspzfJkcIcqIXJIDyfK0AKGy4FQAAGv35LQQz4WKEq/nKCpKqqw0KMwjD4jQIyaotlkJEkVwAIJYFgwTRMAQycJwuazVwErMHSg0wDUrWGfIUDZfKAC8zmGG5tZxV5iTY1q+PnZd4J4/jnD9m0dKVUjAsCykg4mNY/D08A2OcPTs6cKTFwwMEuOpOLAsCiV5wAJJgGUYYyvqoKmjU96RBQ/Payrpho8VpUAPJ0sbUrhgUKqSKoZqcFbNta3blX8PIhtlCqFi0CarZwnCwLAmatvayH8iu2gEdRzHcdwiaSdBwLriRK4yf47Tc37TAUBy1TNNVCXBdhQX+PxZwPZVbNyf9viws4ikTf45aYAN7930uhQvJKcw/hT2ZsoosZ8amU4rnj7yPPdkYywXAthzwCsaAPa67pLlIwFyBRSAJ7uUF6GzEmJcYcFMQhCZ3kaqEeM+GE+BmfG4SAQm+ZDwJWsJpZmOl76gJ8hdPyA5hyWRknJeyc5iKnwDJIMiIE/TbhvrREAICDIMXMPeV+SEkAWC4j/LC74aAAMUoqHAHAMDRFVuTMohRxCMFEJXTEhDvKL2UivQKvRZw1AgFgYS6kyjb3Js7SRC04D9k1uLI4MV1gZzbvGWa80UgdnUZIgA3EMdwnAABCgIACipBFSkH8hTTK0DBHL1UiIhQYibJ2QcpwAAPjZWAo4zBQGiErTgRAICMCgP4ZKeBmpAjYcJWIKNEkYBKgTGa6SiycCnHkfAYSuE8LkLKZaexejaHGsoeJZNEkzW2hI4SYQZCvEIIYHa2woC0waTITJMgAQy2uAovMD0gzPRQJPEy/giiVEKVsFEcT8nTN4dcNoAArPKXBlrpDgMUiAE0gTfQSQtAAYmAb6R8J4gCnv4epii4QpGLHEawMVtmcDmS1WUglUapByVk0cRxsmTVSJUlW1Td7tTgI855cB4jdNqdkxgWSOiSm2VXPZIKd4pBVLKU4B9znjKXtcwZs07lgGsbY15bd3lJKErvH53S/mrVuMCw5Vx5C5lKqpbYnwbEZThXSlayLMjbWBWQWxeLLkTKoDcoZ9ydBoDkNtN57VPmJP5QygF8g0UstSO1GAuSngQqefAaFKwmmxB0LYVFGU2V6xXlyzgoreVgG2kirZQqHX6oqZNWog0djWp5aQcVRxmDiEEP4FE+tbipLiCrUQocQWrHWHIPeABHEoIg4A1G+vcyFxrvrwt+Ywf5KQzWiBiE4NFMhyb5msI0zg0a1TxNELABEYAURoyycC2tRY+lHRVYo8E2awAPKNds76WaUhkvYOOzgQ7Gw4gVd9aI4ggThMidSr5mauXCu9RvIJ+SNpAn5Ui3okAjhQCPm6AhJF2IWCohfHBD48FBASV9J+jFSGALjG/Zwbgv7oW8DQ/+QQGESLIJgZdTsDZG2eL0foaCAJGmBFgh9YFgKQXwbrUqhtiFIDXF+1i78qGAd4jhEDYRuFRElBMXU+ROGHrKBUKoNQ6gNBkJiB4HRSBOR6H0c4gNvxjA9jKaJGI8DLETRsEksodhMYOEcE48AYSDV3uVHYnGngvDeIwD4DraDfBhH8Z4gIQRgghBYKEPxYStuRGiDEZRsS4gJESEkZIKRUgxLSekeRpPMmE9MR6ozXr8kFG+oGxNqOslGvKGIiplRqlc4jIYJs9SGjzuaIe1pbQOhy06Y+170FGiNChjc/pAzUT3KGfzEZ33mHwyxRCbFgRGmI6+P+ZG8CgaYRB+2YBHa2vTt0OD5wEO6GK+fUrV8jTPrwDDPrUG0Dp1w4BMhbEWv/u4r/bCH5yPhCoylujRQGO7H2NZVjIb2PNFaFxnjw3BjDFFEJmjntRPzHEwfJN0mcqlPk8cU4ynElqfuNdzTrwdjvE1ZZwz5UASZFM+CSE+noTnHhFqFE6J5gOZxHiRAhJ1RucpMlLzCKfNMgO0YTk3JeQhc+sKQT4pIu0dlDFuLqp8dJe1NVr2to/YWitPiG0JocuOhdFe/8Y37zTewWBcrGGqvPZE5GRiwEGs/qvo+Db1DSM7c6ycMDzDoipzAOHTgAwQBZwsNYYX1ube2+F8CM3o2kBGi3N6VD/p8Ny7wEbnDSvzDSAI41ojmuSPtZ13oLr4GWEVQ7oN035vo6W7t8nlP9ojSO5PgBC8xpyKPvQzRIIRult+6vlYQPav2KtZ4mHuhQQIqmSig4IEQCIByCGFMgmeZW+lE4AguA3fXspXmd9Fvch83FSgCsIEeviSwBk+UEUybYDCwUHxhQnfZrd4moNTg4KWAIvEDHvZQwABSogijFmsJUSRG/+/JtMixXIcBlQz8iairTU4YBtGeIqKcmQJg2a9jeoT5T56aPbFJTi7K5T5SMCFS5gjBWZNBagABUnAaMs6fe3e+a60EQsoOSygKsOghAUAsohqeSEQs6o+MAcIB0Cg2MM6I+XecgcIjqpA9B26lBTB1Bw03Y7BA0XAtaqQSKokwquyU4lQNAR+M0rw9ULaKypBewMAAoraqB6BCgB0AI3SjBm+Y+u+RMM0MUG+VkXYqKy04heQU0uyyA30euUK5IaAswdI30zowQjmOOhIkAsA8hdyWgHmNIVaNAIgSIRAxWcItA+IogWAsMthxqcI2IzAMgAAxDEdsiII4bCNukMNYSka5GkaKs4a4djs5p4TAN4ewAoH4XAPiAEfAGgMEaEeEZEdEYqHYfEUkTkXkTYvCJSkCOoRAJoZwToTANgRksIe6vgYQHSLvoJtlMCt9CUYgFQePtAFPoAQAPrIHIEADq4gV0CgmxaxTU3qfRAxVByyayjgWKhByg0AMm/yZgnqt+rUNA5wTSQwcAnU3UJUsoJg8awKbQv+/+aBhk+sxSk0rw/27QcgNQZ62w/ylSrwQCzxMIbxEUHxiQXUKQ3xnAvxQIdaDUk040sh1B8hJ2ShzArknAjYU03q1hkAkhVwORnA+s+IzsBRbhxR0ApRrk5RlR1R1adRIRBoYRERURzILRsRbRiRogSI9JMASIKQSIORSIyQ0QJ0pAQwxU/ypg6pIawkgBli70oWskcAsxxxGhYQgxd+wxiAWoo88hQwVBNBEAdBKok0RYYh7AMgUAKokQxiYA1ohk+w+QDmTYnppA3pNQy0aRJU92TptB+o7pB0nAAApHAH7CqJARGT6X6fzpwEGf0JiEmeGZGUfjGXSI6VwSwQGsEGYFOJwFOmwSqFsS0niDUP3svC1AcACNtHYJjPIFXL6bmQGQLgWecLKKwYQdsk9Hic6rsA4EdNNIYdGQ4aKraSOQLI2WUC2XwG2eUEqEQdlD2ViJETgEEnmeLDvsgDAEds6OBAGKoBeTrFwJftfofKQAkIbM1K1AgrXuCAsUQMwAGBeEaAGFuJlgLpeVwM7KsusnCB+cbkAT+SkH+bWVyYgIBUxBYJIExOBU+fjDvgsf0GQBFDIOKXMMaviHQHlHSAtIgKuBgvhdsFwNebeUiOIaeWQA+OxOnhuVBQ6kdq+Rov+ehcRd2GEORVClRbQDRcJPRfeA+BYBBdrIRaJecCRRJSGqYFRUdmsXJgoOxBeExFqEAlwPXkCIzM2Qit0m2P0aYP3mACqP6U6TwWAMEN9KiDNOUpwAACTADmWuAACEaIXlZAgVS6/pgZwZmInligTwWx1lnAtlPQm+YAwVsV5SgVUZUBq5NiQwo8WohpH0ya9YZp+ymBuhOB2y65+Vv0DpiQeYZUUxjMIYxYihAoxYB5hAU42MzljVDqNiisnArV7VzAnVpk3VvVlZRMKsGAFVFl9wMA9ZTp81wQsZNQoqw5mpc1VZCZbpYZ2SXpOZkVo50VoZHph12Z2V1wFZYAzAO1QxzprpxZqZ6ZNQmZR1vpJ1+ZZ1WIB1WZpZy0sZ21811ZtitZS1DZNZzZrZW6HZh53ZzaJ5/ZQSQ531Y5IZnAyAW5nAO5EicNB5ygR5SNfZZ5VcboR+oqJl/V5lQ1VlWSyV9lmK/p91oNrl7lGVTwflAV6VoVpA4Vw5UVhZZQnN40CVDNdlqVvNcV/N11VNpyv0gWVOBCMAb6yA/eXYMULhHJuO+IfQygcQbQcI8B+IJR8hptXJPcGhRIDR1RjAbQ+ITp8hkQoumenoFgUu7ueGM2egVBy2wIzE365ClgVeW2tC/EIQnZ0A0QoNCZDec02gGkXKGANQOc0qpFzimI0hyAzoTka620wQAA1MCNcBmAdM2i7UlGJnoBjTsrOuWWgPmhMYtVOGeNQZwBJmsJ9HCQoK0DCLKIIQKm6lXDUM3ZUkMH8vmCIdsGCdPpUCGqQK8PHTORwXWs2p0gtJadPRQRCm0CIHkLRSkO3sUFsKaTDFWhUlYTYcGTEMEBeJEOydjrrSGmAMuD4RUWeHEOES/UqTOVUS/ReOKf0DEHCBeHEWgAkUPMEMCsGH3eOXCXiVksPaIVjd9LRTIHCLqYNPQdrUUbrWbTyb4UTjUUEUKSKU0cThg1Keg1g2gLQ0iMGFEKjkjPaXANNTWrakNaoH1Y9XteyucGUCmT6TUPw7COjb9aI2UOoGWQ4cDQ1bwy6fqJI37KI4LadcLZ3qVFI9dQ3bVd9FqNSag+g5g+wHqTg4UU5vg1yWUUQ55iQ4KbbRQ8Y9Q/SLQ/Q4w2qRlFqatJZKYypikMMtREFryKaYkG+kQBYPHPHHaK7QVgBAaOVl7S/BVrfMYC6f7YHYRs4FuKHUBh1r7f1fwuWEzNpO5FAgZDApdPYm4sFF4qgm7UgAaBeG7pNitik/gkU9YBk6tneBeJxCHm1ttrXrrowlHtEFAL6mUCogLGonqpIk1NonNF8vonM2gP6fKH4gkAElGFElXW9noPMlWsArmtsjCmaqcK3iQNtBM2IGNFqqCgE1qEMIcxEFwIalCmcxCfAJc6ijczsOqfcximAIAc896kc28ycyakWF83flcz6rcwC8yg88C080AUCOC+UJC583vLC7876nc0i0C4E+Lo0waCVpfIgFgl7nRL6t0+XsHcaLk9rsMxHnrt1tHrMxogszNEs8JCsxooPrEos7oqkJy5IsSzel6GXkk57gXngGKwwCXsBT084AaDkwM9XkMxHZHgbhVMK18twBEPgGUN9FHH5fpa4Pmps86jAIElXIK3oIaxSEZkTcUvq8JE7pS6oBNhS8CBBHK3oNNDoga0a3S6rsHaoI+FermLAF+I9gzqDCzhDJmU9DDHDKSGwIjOFgzuTmDLFsm+ztTTNZ00Nb+CzB5PFAZJzEjNaIOHWgctUsMXoTi3dJYSaU8CK+CNQQoHCM8CLFcOtLAfwDULqZi20DDNsgtEPJ03CK+hrPzFhtBu7ArqlubH7AHPzHNv1i7G7Izp7PqD7Ou9bPzD7jBpHInlbqnlezbonIHPjEXru+ezHNey+zlkaPnEXEW9aU9fqD2O67vHYBSIgH7DO382pPBXlKs3CEG7ywtE6/gJXSAMvKIEgKAIENVAtN7ggK4K4EAA="}
import { Hooks } from 'wagmi/tempo'
import { parseUnits } from 'viem'

const sellSync = Hooks.dex.useSellSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
sellSync.mutate({
  amountIn: parseUnits('100', 6),
  minAmountOut: parseUnits('95', 6),
  tokenIn: '0x20c0000000000000000000000000000000000001',
  tokenOut: '0x20c0000000000000000000000000000000000002',
})

console.log('Transaction hash:', sellSync.data?.receipt.transactionHash)
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `dex.sell` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.useSell.md","from":7605,"to":8123}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { useWaitForTransactionReceipt } from 'wagmi'

const sell = Hooks.dex.useSell()
const { data: receipt } = useWaitForTransactionReceipt({ hash: sell.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
sell.mutate({
  amountIn: parseUnits('100', 6),
  minAmountOut: parseUnits('95', 6),
  tokenIn: '0x20c0000000000000000000000000000000000001',
  tokenOut: '0x20c0000000000000000000000000000000000002',
})
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `dex.sell` Return Type](/tempo/actions/dex.sell#return-type)

### mutate/mutateAsync

See [Wagmi Action `dex.sell` Parameters](/tempo/actions/dex.sell#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`dex.sell`](/tempo/actions/dex.sell)

---

---
url: /tempo/hooks/dex.useSellQuote.md
---
# `dex.useSellQuote`

Gets the quote for selling a specific amount of tokens.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.useSellQuote.md","from":132,"to":5744}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"e032bbb5ac251a0290eacf6fd15a7b454e27c2398bf4e185fb4d8d10e5253e5b","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUoiaicACUnABmAK5gjowQYJxY4nAwAKpgjGhwwURhcTCInCKkpgoUnLDWLGFwZWBxzABGZJFlbYwKpmgAOrms7FzppJk5eUZQENYIegCycTJojFgm8Jyi5WiVipykMFhHmWBiaymcEDHbnC3tZJxtGHd9JKl0bGbn17dtERgnAAjBZOMFQV8UvI0JEAHRDIYAWk4ABE5k1OPg0GgsE0APT4oiMGDMOFwfD42bzfFxNYmNbwfHjSa5fL+MQKBbIZAgOiiVhyfwsNgcTjANIZbJsuCcVyxUgQZicADkxNJKsRYBZ0umwRVABYAEwWFU1SSRIaEzjGix2+0OsAgAC6zuEml0BvUxnkShUiFBGnE2iCOqm7NkpnMwJsdlIDicUncnhweEIJHIGkCeGCJwgOA4GGiUFEYm6vX6nAAPpwErAYlGoP5qQsQAAVfBAmQRLhwOLWazwODxGQyV6nCAyEhQWqlnYxdicZRAgCOJVIGARYC1Ha7PfK/cHcGHKzHh3gk+ns7EsUXy84a7Im61Q13nG7IgPA6HI7PE6nMAziWN4LqQS6dg+67PtuMFvh+vaHj+p7jheAFAXOt5gfej4bluO4QfBX5Hieo4oXAl6Ade853hBOGbv4IjiLoADs0g+ooyhIAaQZaDoeDAaI/gmGYSAAMyxvYjh+IgAAcybUF4aa+JmAT0Hg1gpJ+a4QDQ5Z9L8NZ1jADZmE2VAtngcH7n237Hr+ZEUehIE0auUFwgxHpIDJ3pyBx/repoIZ4NpNBCVGYkSfGUnOMCBryZgqZ6OmfhZmpegiqMPB8IIHlMVIPm+pxiABcGfF6AYOWRiJiDiSAtiSYmiBGnFHgKYlPgZhy2bpSMYqwLQuUSAGFgxuxfoRdQpVBP1YXVbV9VRY1okWPFilJcpXVpSA8SJJcqRxJkADKMCjgAinEOkwAAPAAwikDbVM8FbnAAfLm9jMDoZCYhVcBwv1cIHTAx1nRdNBwgACh9X0TLd929DUPT6WgL1dFlhj/XQgNHSdMjnZdcIAEo6HEpBgAAasU11I/0L1DGAArwOkg61jjoOXc2GJ4BVmGcCGawHNhYNAqB5S41UdxwDg9QNtY2zMBACRcDcS4CPIf0cqIXJIDyfK0AKGy4FQAAGpv5LQQwZWKEq/XKCpKqqADuWvMIw+I0CMmowTtSRXAAglgWDBNEwBDJwnAaWAn4SgJNSMHAAAyECiFAEvygAvOjgiY7Q2PA7j+M0MEoepOH8uK+cACSYBlGGMr6qCpo1AAbJEFBh2XaBq2A1dlCqFi0Ca1hwiPwLAmaHfh13/DyAA8nSfcD0PI9wiaE+l64loweHjC3ME8dJynVTREcaCk6kV2p0QL2H6nigr1dVKMNfHen+fnCX8/L0AKK0NLNAznnriBe4oBKuEflfOmYBXBDFNsbF0FBeTjAFP4ZBn0nCyhRFDeM6DvruTdLyN+ZMjDnSfOePsqxOCOzyPgcCQIBQV2Vrcaec86TnkHM/QC+C3QgEYkNUEBU/JIGBEaHiQU9BAxBnjYWs1zDzTjAmaSokWopm8MlFSNAtq5kVAWTA0QGFK17k9ZGnN5h4D9grJWfxVYzx7qkLuYtRzuXdHlAMRpRFjSKjJMRZUQAGKrk6Kq5huJ1QUdFJARpVrtXUZtIIoRwhRElBMXU+RChUzKBUKoNQ6gNBkJiB4HRSBoxpucS2vUxhSnDDMLmSwVhrA2CSWUOxMkHCOCceAMJSzJFSCrHYBSngvDeJwz4f9oS/BVgCTIIIwQQgsFCH4sI8JgBROieYZRsS4gJESEkZIKRUgxLSekeRGnMkqTKTW2sUC8n5IKI2IArZcAlHXaYdsYiKmVGqHZXshjPNSYaNe5ot7WltA6UFTpXQuP4aJDxvlxrDR8aGM50xZFcUioomKkTWoJTURtVKcS8y6KLDY+QRjjYDwACTABaQoVw8DzI1JAH7KAUBTiyhVveFh9iICOJkM43hnkAyqGbrIQq/pmIIrwJy6uKLipovCU1KJOLOp4pzASsgejiVgCAWUMltBKXUtpaY1sTKWVDmsRy7uqt2EwE4XyvhugjTAlqrCrxEq9CcqATK4VoSGrSUxaopSyrVJBAZp9KWDggSR3InIIYRQwJRsnKUTgd0o6JqNZZCCxsE1yGNpwBWUAVhAjzMSWATTygijkLUGAbQ4gKH0goCOmlE3gVLJweO5bXbdiwty5cQwABSogiiHWsJULAXBs1Ak+vVXIcBlTFsYLAGcgzHbVueIqR2mQJhLLfPmwtnAoQcFlGgR23KpYwBlowOWGkRgLKaFqAAVJwP2nBjYpujTAXN1gPyymocoPNOhCBQFlDZWhEQX0TrhDICAChg7GxqFmptcg4RkEVKQWD2wwAzgQ6mpDzsyboeUK26wohUgdFZpRBxjtKg0CtSR14AA5aAMA4QACtgN7BgAKLcj7n0KCgwCGQ4HEMfrbVHMQiRI3wwUKTCj3KqN5CBA45Axs8zEXJGgWYdJjbOmCBsvEiBCSQFgGxuE7AFD7JpN2GgIgkREGanCWg+JRBYDdqpoccJsTMBkAAYjc8eEQmnYQYagEMZTfm/oBZQ9p3TOJ9OGaYyZszFm4D4is/ANAtn7OOec65xUanPM+fC5F0gRS4ScDfHxiAAmhM4ZE8R0jQIgYzl/YQNhDyJb3mNkZ0oE7c27qQ1qAA+ve+9AB1cQuRFAjcG2UCr/GwiNtq9cNoLHz1oBVLKdBgGmlHHuDa5c8bNLxxoOcMcQw4AYESPgRUkADrvkYDPOha6IAbqeH7CGlcj2djIqSNocgaiQDAuIRT33FtwGOzCM7DMLtXZu4rWUJhHthEEzpTsYFGOwFY+xo4Ao/qcGOiDoEynIA0auOFzgld8Sz2i3prZ3XEtaGS6l0s6XMsGgc05lzzI8vuYK950QSIScwCRCkJE4WkTJGiKBIYCtdumFAswLpKQlm/wNpWg6HWIKVeq9h99xtEBajgWxoYEGoMwZVJ2Uccn2AyCgCqSIABuK0+JOAQ32PkdZuNrekFtzUBxAXFaDESMJyD0H9SW6g5wAApHAM0Tsbd28d87137vMQR+977q1Ae6Qm5Dyh9gwQzCO04N/ErBeVSjcIPmOANRyJbYlgCGcdhA7yEAvbpPYBrRu/6LKfPYEw1wC1vQzDuwHD8CXFFRTp6NMoYN53l34dS+obKJXvgeJa9KgAw3lOWJnM4FMsnsu2wuDIBgEUGQzpiqCsP2XVtw7R1oDhKQBI1cOzxxTZorghemOICIMwAM0KAYMkQKC+t+XAs8K2a2T+L+YAb+cAH+gQ4I3Wv+/+y0kgNUwBN+4crayB/QZADMMg3OcwQ4+IdA56dI3SiAzEzEAYkgWBx+nAp+5+zoSIVGe+ZAiAzcTURo9BraZ+YQ9+6wX+uB5w+BYQRBxEpBtA5Be0VBXBzcFgIBR+DBIhTgBB+IiupgpB5+g21KTUokNUWoUaXAoaQImcFejAo4nAhMVWpg5EYAKoTuwetWcIeGYAwQxsqIJG2gYElKphrgAAhGiN4WQAEcbB3l3qnmUF4YoE8KNpYYJjYT0KmmAEETET4QEX7tPrACVrAqbFqKrrcqzJrkCK+sJp+t+nPnkcbMbs4Z+IHpwJnCGIdBxgKIdJvoQI7MHE4cYfuiVo0XzDoC0TjswO0Z9J0d0bnmJnmhgG+s2pnEXmDomnCHMXIMEIHjUChh3jLrMSHmbuHl7lQgnvbk4ZET3p7lbkcT7lAFkdcDnmAMwLsS4fsRbocTHnHiqCetcSccnt3ucGnocV8Zng4oHjsascxn3oXjAMXkvuXqvtXhvvXgcI3rvi3qZO3qcS7n8R7owbCaQCvlXuvuUJvsoNvk3uwaZG6FaihkYZpCYYzAMRYVYUkXYSkI4WCSHm4R4ekU8H4YzIEcEbEaQGEREViVEYKT4ZwPEcybYSkWkSEcKbcTSWAHAhctyLyJkHcsgORKTIODprTgZviH0MoHEG0HCNeviPTilt1viH9lVkSFlqlowG0PiBBmxpEC6DwvahEsxM6qKkgOKpNLxEEBOjKmxAtOikgCtFimtB1ClMGjmFttANEOCaHjBgPkPgAPxlB0Y1Arz5h7RhDYK445lgAYDIDOhoxEAQALrggADUwI1wGYUGKcHp9KZieg2JR63Kxs2eaAuaLWe2jswkzGnAywqw6wlawYrQMIso9WzwRaEQmQNxVCNCdCQwDYEwXATW2wX2RalQiuG4/6x4Q+wW2wVhKcqchZgmO5YGfYbQIgeQFBKQsaVMwGLAlh4gVqYW7uMQwQokkQNOsWhpiuYAzEpmjOwkcQjmoFYuQ+KWoFok3O/QMQcIokHmaAXmW8wQ9405n0/x2wu2yOkox4smjBxsFBvKCupYsG+psWdOCWf0SWLYzO1mGWdm7O2WXOlFGFXm3mlF1FaAglSIwYUQ8IhupstRvRGkVimcqgPRexYeKoMl5wZQUeduNQKlsImJKe5xjaSsZQ6gWeGmoJdRyxLxWliAceWlopul/xZQllnARl/uJl9xcCWoBO5FPFgltFMWmyhpVpEF5mLFaWNmHFHOOWhylhvFPmAl7AiuQl8VpYIlWgiSossuQI8uSVe0fKnI6pvCpgg4/gRAFgcIwIZVdonpkKDqMko0Lq/otUgUviZuYZcqjUckMZ0SuKCZegvRIUSaJSXAhkmGxkjY6aegVkn4NkxE9k5CjkVEvMQsT4dqAqy0gicKJUwZwUMiQSUgbVSi/qbU3gnI/gpheALV1VYkIiIqQilgKqegFijC1qnCUAZQkgkgzEYKMqY8+1zgK0PCGksATA5S4oWcso8obyDsnxLsbsHsbAXsDyoNvy4N9sHy6ozA3ydRjyVEZQ/Vdsmcv0OcecUihcMAxcHc/iaARiyNDcdocerc7cpcUqNcqoS8Fg1goKnNXN3NPNI068U83c2qrNg87NvNYt4t9oRo68m8tJzxSlj1ViRwHC04VlNQ/VW8/g6CgkiAoAgQ6s3SkqCArgrgQAA==="}
import { Hooks } from 'wagmi/tempo'
import { parseUnits } from 'viem'

const { data: quote } = Hooks.dex.useSellQuote({
  amountIn: parseUnits('100', 6),
  tokenIn: '0x20c0000000000000000000000000000000000001',
  tokenOut: '0x20c0000000000000000000000000000000000002',
})

console.log('Amount received:', quote)
// @log: Amount received: 99700000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Return Type

See [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook return types.

### data

See [Wagmi Action `dex.getSellQuote` Return Type](/tempo/actions/dex.getSellQuote#return-type)

## Parameters

See [Wagmi Action `dex.getSellQuote` Parameters](/tempo/actions/dex.getSellQuote#parameters)

### query

See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook parameters.

## Action

* [`dex.getSellQuote`](/tempo/actions/dex.getSellQuote)

---

---
url: /tempo/hooks/dex.useTickLevel.md
---
# `dex.useTickLevel`

Gets the tick level information at a specific tick on the Stablecoin DEX orderbook.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.useTickLevel.md","from":160,"to":5909}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"57b65b077fbeb672f0d0226a0c174adf10d17a4561575135f580ae6d087d726d","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHJwAKozW/P4i4roALOrG8koqiAka4tpBkdH+JmZIAIw2dqQOTlLunjh4hCTkGoF4ABRYpBA4HBgAlJxQomKInDl5/AAyMCQyAHQASjoArqRgAGqiMkswnAA+nEtgsABmpjBQ/lAQ1gh64fg7MqIinHBL1tbwcMdLMjIYnFI8AgMhIUAGQ1EnGO7E4yh2AEdtqQMLMADpgDEY+6PZ5cN4fL4/P4AoFwEFgiFiaGw+GcJFkVFYzFgHGcJ4vAmfODfX7/QHA0HnKlQmGkOEPenIpks7GSjn497c3kkgXkoXgwbUsUSxHS9Gy1nyvGvJVEvmkwWUrWi2mShko2axTS6ADs0hSimUSEy1GyOjwNoKZyQAGYyvZHH5EAAOGrULz1XxNAL0PDWCBgF5yGYjMZRSbTGBzRZoFbrTbbPYHI4wU5mC5UK43PBshWmwk84n8skU4U2mniukO1HO+JIGPJORe9LJTQ5PA54vBoqIcMgWyRqqIYoJeOYOp6Bp+ZppvQhdhcAyCMcSFxT1LexBz/1Ba9GQrmdebipR5wAJj3DwE0PHxGn8Ggz2CVhLwGOhb10YoLFKT00jDLItADPRYFoFcvwjX9t1DCx90TI9kwglo9B+MBHEYTMDjgGBximGYAB4AGFM1OBQKFGHQWKLEtllWDYthgAA+dp7GYHQyDgEZ31mHDZiWJjBJmWYAAUZLk0g4E47jGF4/i0A04sFhEitxIk3pFL4QRlLoVT1ILViLNLcsxO2Nj82idzhLLUTK0kjEwFEWS4CwBwdjU5i3KEy5rlufQHMHUy0FMBRdThAt2SEzhTDFZghnosBOCGCrXhwaxGFOaxcuiJ0sgUW5kGQEA6AirA5H8AADAa0DgWgMQvMJgB4By4E4VxoU6ZhOAAcgAd1EBRmEYAB6GgYMW0aYPGiI8tm455qWohGBgZhtqutg9pZGi6IYgBBLAsFafpgAxThOAzLMuAmm0+MYOAJggUQoCymbOAAXkmwwnNoFz4v8oTWi+8qfs4AAjZ4YBGRaLFof8LGsWZyeKYpFoob6scy6IRnGWZTogZgtNIKIYFaRbilmCxkMW3oacxn6QYAIUYKARjQUhtmFn7XF6ZlReOThWhBsGIay/ogSC8q2MhogJM1yHFHJ2Y2M2w2JNp3Xy04A3GCN8ZOACkZgAAKQAZQAeQAOVmEQOcUOqMFaG1elcS3rYxVwMQGvqQAAXQoDrooqZh/HTiK9OmgBaTgdIz3OnRTjq7dWIwAEVpTVX4uGWxhlBy+n+HymZCrAYrSszUuU5AOI7yQh8ZxKf8MIXPQ4vMmQ8PQjdykqaNQyA2pvGPFNIKCdpOm6TB+lxpiRj6omABJgCDrLXETptkrwZ6oCgMlpogVW6UPnY0AEeRmoHl0x/HqhJ8vp5xYRAB/OeGQCJLwAqRUCG9KJQR3l0Mg+9Gr8BGGAJYzBsYnhAM2FK7NOboLhBAKUjJf6D0Qq6AAbLIR86QQGvjwK3SByQfwwKQP+OB68KKniCGNLg4wEIlBjIA6caEoF+kwrkAsbDoF/gnDwpM4F+F4EeplBiLM2Yc0+DvTmjMCzM3mkQz42ldEwDskdJq2jTEwEsnrcIXgwo5yijFOarM7FJRbHoLiYBGhDSqh0Yhl9FCkKqq3A0GJkBezENjOQGZTCcAACIAFEAAahddFZSTq0fAaA0BYAUptK2yVZg7TYLMWgGAABem0OgQC/hmGQm06CbkUDATaUUYDWAAMT8BgBgPOf1PhYCGr0CCa02odS6qwXqVAE5DX2qEAG1i24nTOotCAtAbq7WZCUrJxDX6cF5hYWGJCLAYj+i8VuxRzlM1sRY7mpzBacAOZc2imYbkFn/PcoxjzObPL5vzfmrz3n7M2ocz4nBjmnOQuc1uJz+ZXK+VwVuoY/k2JMU8nmwKqb9AOUhD5GIDl2JharCwsxJDUoRXlPORKUX/XQQkTF/BjGeJxZS6lkgwWQvpcisACdk6pxANnTOVBgnQoLmySVOxnhVVCdlVo9iFCzD4miEAcLigavVSALl1KNW9FLiKiuWZ/BskRUQEKfdhD/x3DGV09DR4uAnmAgFnx5ELy3NGYooZlHkVUambeDS959EKnACWUscZ8DkKIMA3iUoAHUHjwiHGQkcOVsaS1eJLHYrQZbbH6LCZ4bc4C5rVscTYTEjUiMQCTD0EinwvhkUwCNktIF0K9YRaM3DgIHl4YGreeBwqRWitC65IIYAYiteKCdcgRh+PVLgW+PiQBsj6nOmAfVODMGgL8HYDSLqwGmlCMtcydiwGxksBQCgoabolJVEGOaNpPDTbqDEHtRBWq9tYDmYzfpfMnTunpdgwAgwWoe3N4JsYAmWjAbGONOjLSYvpKJRodi7qgPuzgdAVnTTQMtMh3Tar1QAzBMwYAhqIGZAAKk4M9TgfVF2Tu3dYDk01G7N1ksoaA00CT4AqtNDdgG5CzBkBABQH0+p8WE1mSdswyCdFIFJiqRxGObtmKtVYKnlCVWsHGnGsUmLgi/pwZaHMaDhLjQCP20B7EACs+MyxgBFA0dGGMKHE7jGQ6mRNbs7nEWiOw/o8RWMKUz5mm6fzIcgPqDTlSBzQFcJYaA+q5PyYU4pm1ICwEc7MdgChSk3E2k8GgIg85EEAlUzaogsBbXi18WY+TmAyF6Q1nkIhktoH6HGqA0S4udAS51xTaW8kFKKYgEpOWYB5YK0VuAJWhjwDQBVqrOzav1cG415rrX2s8iS4po1ERJSeYgN53zcm5CsYM7gxiwpOOEBS4VA6mUwl0j6tNxAm7t2Yf3WhgA+jRmjibxBgcUED/7jMTtec2ABy7Owzv2Z6WgRa01uOECgCeoEnAzBNweLOr5IMaCUf+BiOAGBaL4E6JANS7JGADMzUhlD9GtIAEl8MPEtExHBcg+KQHFOIT+nO4dlpEPINApPwrk8p9TiAtOTAM82D5xp+POC2dgLMRzrxnMRTgLMTgXsYBC52LFyAlmGJ7c4KzzaPtRsZYm1Nuzs2tDzcW2VlblWEjVY2/UrbPImtoBa700QeczcwDzpmPOe2870X6GKDEu7sdFXYCVTRYA0OpNoN1OQjEoZ0lO+d2TS6+rUZZAnRzjKl1iYk9zB4fwyGEdIDIKAgsADcJLIVEMowpTgdfxNmfYM3vipnOty7QJX+T4nJOLT72QgApHAamS1G/N7bx3w53eRiz4H03qAw+iNJbHxP0Tin2CtDMMtTgqTSBKe5smvgRS+LknR1DXG4I7BvXkOcQWvR29gFJcHIEqfuKJFHAGtHKmpnENEHCL+NFtrrADfqXgcj9NfkpiMPfl0HAE/qzDoPgK/hDL3rVjgA2OvljBVFwMgNMJsEnM+DuKoKQVjJVD+n+mgLMLLGAKzkaCDH4lvGrJ9kQMwDuKGP+PakrP/pCmQZVD7NjEjo4GwYcJwfcNwZmLwefnZogAIWuBYJIGuDGGIcgYwVwJ9qYE4OFC0ntq0rQD0ilmVIgK6K6DuJIAwT9JVJQVajIEnHnOZkQWQIgDQnWv+M4eQThu4cwYwP+mobAIgCYWQGYb7tcF8JYdYWnnYf4TQhYPoRIYYTjuoTEasJsJtCVKYK0u4f9oqnWqGGuMyNckYTnOcotImowH8JwPMGdqYOSGAItH/hplpmAK0H1MknGtoOKOfCOjAK4AAIQpJDFkATF9S/7r5d5UbTEdLiiNHNGtFZpyZgBTGDGrETH77wGKbxwDTMiZ7Z5GZ56ShMZ+asbsal4nF9QV6fJMpj7nI5CxJAgRRew4GEDLQfTdGoo4Y37vE6CfEubMA/GyR/EAmV5cDMAYDMY55wwX4i7yZIlcxj58SHZ/4J6Il+bV7T7b4r4t4LHiEb7LHEmD577hJH5gAIkYmEm17Fj94L5L4rTUlr7klLE95Um76HF0kMkEnAHn4wCX6oFn4NGECYHYEv5hJv6EGf4Ng/5/4AEmE97IASmkDoHSmP6vA4HKD4Hv4+ENgpzhLHEsg1E451FwwNFNE+abHtGZhdF4mMm9H9F7HDGcCjE5yTErHDFzFklqmb7+lkCcDrEOltHbG7EzGkAHHmk36PGTKtRIDtQDxG7+DIDkgrCfDpbjZZa3rKBLDYyzAZjXTTaObZZ2abTxJnabSe7VYmDYybQaaOYTJJz9xUJcL/idqNrpCOrSKTwbh+aQIegcKKKWD+pgR4JDp6CtDo7QD9CMlT7zlfDgEAD8Iw1mfE5sXQaemwRcuuW5YAGAyAScViRAEA2arQAA1HcsmOJhDBMiuoQoAfhmQn1KPiltug9jjmKZ+PrgALL1zhE57ZDYLi7TT6blS3bRQ8jnB8S/nwgYinD6RcBxTgjyp0jBIlQojAY8jgGqaYXNEQyQz7k+YYWCamjYwiBNw2GZjTohR8YsBNHiDhKxbBKUbHCtChi9B27jaTaFFxquj5Yu6FBLA7IlRgBR7gELZSWhi+4mHHCzChgB4tZiH5qSjgWyTd4VTY5K6cBwXGbsV9Q2FzDdxoBSZ5mZaCUVl65zYEJu7LarZe7rZ1abRmVqWtZmUWUWV5zZBwC9BGrMjl5wBwkAaHBcBwyqCAnw5MmLQZiRUjBz4t58SJWUZBmd5vkjDpVoAjDqDhJfnj4vFV4rkJVy6UaIBL65WZUUk965X5WHFFWPHMiG4m6mWZTmUp5DBWVjY2WO65b2Uu6OWlbOUNluVbSeU7a9I+XdVoB+UBVx6wiJ47DJ6kCp5lS/xiApkoAdRlpBb+BECUq8xErJydl2r/grxOqSLrigJBBT6jkKLbhxh9pkTTmbxUTDlMpLgyB5gCQJSaSeTBTiTViHAnBnCNj4J3x3DGichmhdgWhqh9iaiQjpTDj6i1r/iqDrh9lqCur3WJSyAhgupdqcJ1quhTnbX+BjGLgSaY3pHXVPhWBBqth5Q/Xuy94uZRrFBgDD6iBNH5W82kJiAyATCMBIiSxNwYAjBEogpy3lSuCQKUxPXRgkT9wZiwBMAvacATTvjQzaLL5rQbS7J3TLKwQTQuwbKsznSXTXQVIQD3ThWAyQgjA/XQxwxKQqTTwA3Fjoy0wfwExEwkzWBy2h1h3h0R1h1UzyzoKGJYocqAq4r8z4ox3iySzSyywwDCyKzVEEllUuzs1L4/ViH+DcaiBICgCBDyBlqZgsIICuCuBAA==="}
import { Hooks } from 'wagmi/tempo'
import { Tick } from 'viem/tempo'

const { data: level } = Hooks.dex.useTickLevel({
  base: '0x20c0000000000000000000000000000000000001',
  tick: Tick.fromPrice('1.001'),
  isBid: true,
})

console.log('Tick level:', level)
// @log: Tick level: { head: 1n, tail: 5n, totalLiquidity: 1000000000n }
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Return Type

See [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook return types.

### data

See [Wagmi Action `dex.getTickLevel` Return Type](/tempo/actions/dex.getTickLevel#return-type)

## Parameters

See [Wagmi Action `dex.getTickLevel` Parameters](/tempo/actions/dex.getTickLevel#parameters)

### query

See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook parameters.

## Action

* [`dex.getTickLevel`](/tempo/actions/dex.getTickLevel)

---

---
url: /tempo/hooks/dex.useWatchFlipOrderPlaced.md
---
# `dex.useWatchFlipOrderPlaced`

Watches for flip order placed events on the Stablecoin DEX.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.useWatchFlipOrderPlaced.md","from":147,"to":4937}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"ec2db8af3c2ec972afbe7d0d286151f1c33da31056ce694679eda2d35e5d89ec","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXLC0UZq6ACyxSYrKSH0ZWjp47f4mZkhFILb2jn6IAGxV1F61vg0B9HgAZgCuYI6MEGCcB3AwAOqiaLYAYiZYAPKksKQACjIOMFAAPABhM57RgKAB8AAosPZmDoyHAAPyITjAAA6504WPmpgAklBkZwwAdmAAjMicAA+FzAsFBZigAG4MVisZkkSj0ZjWaz2B98YTSWDTFxqUKFCLkABdKlEg4yGSyo50/JMlk81nMUT8MiEgAGFloABJgCJSKYFK49bKDcbTWhzYordLZcSFUraTB6X9mdyNWgBPJ9YaTWaLVabSH7Y7LXqXdS3YrqcqvarfTzXB6VQz06y9qQIMwAEIyCDWfiC4VgUU07M+9VYs4AUVIBdIhMhkLIbZRLbbAEpOABecGcIgQRhQQfJz3eqBZ1M5hucNgKwkOg4wBdz7dp5erqYKXHVshEUQyQnEskUmd1+e3xf1v1anXtlG20MO8PWh9z3ONsAnkYV53jIb5fgJFFO3ZFEAHc7keZ43g+cDrD+AA6ABBLQ4AoThSwUOCEPwICQJQn40KgdCABkIAUQcRzHCcp13Jc/QDHUwGDO0wydH9a0fNU/WsEEwUJYEwFBBRWKfHl5FEUk5EgzhST4ORRHOX9VRkoTXH7FFx0nDEwFEOE4BhNCLiuW57hIpDQK+Ci/n8KAywQPQck4PZ2E4eDbItLznk4PkKSwJy4WrTgYBIas4GC85lC3AARJsAA10P8MQFHc5BkBAOhTLC3AqD1Uq0DgWgMRCVpUXCQxOEzfNC04AByeCFGYRgAHoaBaFqMQxQ5jjQU5zkwrAsEhQcuSxHI4HQ9p0MuG5iNI5CwKcqBIRm3lAPs8iIMhdlpuXbEzjgCA5HQgjIRa0jgocldNsQFq8OO5d3HVPSBsxUgdAOUhzn+KBGCIcEbNsALvNIQLgIej4nt+CLyvQ1H/i6kGwYxVwMVKvUQClCg8phUpmH8EnTPhUg4oAWk4T5YSp+aCcJkBogkRBukSYxkkGRACmGTQsjwZaIbs4D1sciDJnyGZigWcpEAARkqDx1hqPQ6j8Rpdj0aECxwDgMEHM41oc1C/g7I6cKI2yzYOyisJwvCCNtxCJfNzaaLohjR0MlitIZFy3LwQFzxkUkHH4TgA04Uxxx1Xz8HkThRFhrB4YpRg4rCiCMuELokHidI5AGVIle5oWxj0U39o26W8mmRBhnmUpFmcAo1kwDWfHqTKmj1im4ScQcYNRZcQtIfEUXFEV/04F8yHfKNeNjeeOPkZeeK/Pj59MiAjjQGeqzQefs6LScZ7UmANPXxhyxRK9yVIee9meAAVe/+Efkln99VxOgxCkCXXmqRugaEyNXEA7IZZNxbiUMoSwCidzVt3bwWttg0F1iAaEjMR74Tom7cWZF66O1ogoQBHMVZK36CkIYEDRhBAIrA8w8CFZIIABxdw2JrLY/dsEmTMhZLcIkwAXTkBiM8MNRHiJgCiCSsjg7WHciAd+ydOB6hkZdGA1pmDQHlFuLABYiCTngKnTgcAQhyE4LAUkBwFASkUJwLR1jlB3DjnFSxnUfgw1jolDEAApUQZ4ADK1hzRYC4C4rccJ5hgGzswFcxjTHzlJBgXyMBSQqQLLBK41N0I/TUTE/R1i6ChHKjHWCEALE4GsIwUE1hnGFjYGYWKiAfoACpOCYQ0Qo7R1prA/DgHFWCjBlALx0IQKAniDi2FTnFTR51tHXTolNPUeFFliOWd2dgazU60g0dE9C8FAZ7LcVEjSKktzLXnLHWC5oaAx2qRpdJAA5aAMB0IACtPEOhvswApYAuk9IUKWSOipNmyOtKYaIxwRGiQUADP4TzfIPK3LHZAeojFlngPNEQrkDhoD1FKSE+A0BoCwHARAXUuqQFgD89C7AFAYzcl1H4NARA0yIAUbo6FaBdVEFgbq2K0LDPQmS5gMgADEIrcX4oPmgUetIMSYtlWK/F3ZiWkvJZS6ltKPkMqZSy5RbK7jwDQFynlfKBVCq6mq+aErpX2o1a2fs6FOBFM4KCiA4LDlLLkAMy55IrLItGcoBVccWgcAColDRdK5HRN0SUz5P0AD6HSOm3EBhaDNqaUSeu9b66JwVSRfJgI4FqcVh5TLiuILcZgxnJ2kedbONBqwyAwBiOAGBjj4ALJAS4+FGCJ1jaSHJeTumfFxHFRK6S/pXDJHIPCkAYZ1pjsndJMjW3yDQB2jEohu29v7QfOKJhE7h2ColGG7zYDfN+X9Uy81OAhJgOi9RmLICPLOEknFwzOC4i6i8LVZKKVUppfGw1WhjVwFNRyi13LeX8sFcKgsoqHVoElVK0QNNP0wBpmcGm9qaanEHNDDEei/px0kuwLUI0ziAoxE2WghVrGXBjeowt54/VbIDe0sAuNSo/IxEcm6LVk4KmqVU0gMgoAtX7L6Gl9NHTlRROJ0svl2AybwrHeVhLhP+s+aJtT1SACkcBXqtSkzJuTCmupKZFFSzgxmNPSagNp6pum0D6Z458nZpBIRmFgpwPsuyWrXEIBASleELrVoCpHecdgJryD+HJ+TGJFOfGU3FPzEzhmiG0Ps+c0RywxzbuijzaAPikD44prEIXqucHC3wKLFjCyTLi6IBLgqcAMnS3Znk7jkDRXPFKNIytVB9Y1O4sJES0DoVIEcY8ajs4SSwVwALHzEBEGYMrWIBRlYcP7JNgbXAXilvLXNhbYAlv4BW2cNbnANuwC2zt2IFhJDN0O8d1k7j42IBFGQEyMg7WodxV1Og5bCWjUQPEeIytJDfbZFwIbZ4ZBShpvc7rS9lj8wKIj1OXBhsyBm8Bdbf2AeA3PCD39MGIfWCh2cGHOPlgWCO2AWrP2uDk5PJT4HWpTDg9R6m1e/NYjNx+jIrnlNhytWuIwd0AAlH1MKzgtV9Eck5YBIR6iShpbQMMTSCJgK4AAhJwXXigyAm71Gl9ndnMsOZRBb/XjX5eKiV0KLZYAzfO6t+5ixlXuwCb1D9JjLHrmWKcbGvUfSA3OKGVSn6eMhPHHOlwCNQ4vU6BCX80yIS2uEFglNdXaeoqthl1kHPD7mD57hIX4v3mRALwwLHrcmfAtNJ8+hVvkIFV4W7Lb8jLeDMrIULdZzVnZO24y1l1TMAJMua0yihVQ/W+j/H/P9TZmLNtU01P2z9m2lOc35Jvf/uV9gGYMPrvfmAswCC/V26TXIu4Va7Fpx8WnNY4ZKlg/Duj/ID1YojP4tYxbtYf6dZf5JYMiEwopB78ap5iJS5wgy5hZu6cAe4q5gBq6r4j6a7a6+4G7ABG6m7m565W425/6z5kGW4wxy6K7K5e4+7kGkAm7+7wF4yZT5Y5R5RXDFQgDIAXQAxoQkoga6o0oSjKAHCkjoQiTMD6r0owbxpdSKQ+pdQIbWomCkhdRHI/L9gswFxALKxKwgJlxFwMLCx6DRIsJIDgJzAILty2HcI9wYL8JBCQjVrQCDhr43RmRwD5YwCEgvJ4SoyMqRKjTngMykyOYvLSj6RMSTiPYADUSswU9QpYnW+hVArkyieA/+FSsceonm1oYa+ARI9+UwnynAAAsvKCNEVKnFoCSDunFNYEGoYgelcG5r5I2uujAINIwNTFwDcvMn0UkiwOIOkn4QEYVqnO6J1iDHRkDiGvOAehYtISIGMgzggajpuJ4iwPLuICiqqspnsJCLEP2MBjqnqlqGAPEIylBlMAcPyrcYRgETBrcbECDiKHsOhLEOKhhjIGzpCLGpkM0bFI0VuBejCMMsihinqFDjIOhNDLRmsqITqmBgoTAJBsyjkTBuyuapaohjat1IiQCZhoiSiXcFSRasdG6knoJnAI3lEgfJFJnqoCXl3qJiJIfCiCZrJnhDydWNPvbtQUKUfJwOoCip5o3sstyayUfBZuKSKYfipk0ryZKf7jKWAHjD9C+luJimSTSWidqqBnqhBvNEanibBoSRoUhramSY6lKpSTRtSa6bSThKRj5BRluKYDSaNPnBkNlEgLlGzKYGhP4EQBYOhErDGRYBYAYWzIXMrALLQnzILJAkwnRDYZzPLG3IrErCgtUOgnwjrO4UPFTKPDbOPH6JPNPCpCfPPIvA1h+NGN+OvIGGAFvJ+DGFaHvHohqbPNWGfHABfFAFfNorfMuCNA/HKNeC/MuG/MBJ/LOU/GQP/JQroErLEMsGmWAhYVAjAo3OYHYa3Igh3KoK4KzCJLAM0OUrVHNA1F5AWIkm1Plp1D1DAH1D9HNAtHQEtNZKtHXFLJRNtOqLXB7A7H8FBOyC7D7MOKODtGdFyasi1DBBZu9JiJ9GAHpP4MPKIEgKAIEPIJYmcHgOVCAK4K4EAA==="}
import { Hooks } from 'wagmi/tempo'

Hooks.dex.useWatchFlipOrderPlaced({
  onFlipOrderPlaced: (args, log) => {
    console.log('args:', args)
  },
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `dex.watchFlipOrderPlaced` Parameters](/tempo/actions/dex.watchFlipOrderPlaced#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`dex.placeFlip`](/tempo/actions/dex.placeFlip)
* [`dex.watchFlipOrderPlaced`](/tempo/actions/dex.watchFlipOrderPlaced)

---

---
url: /tempo/hooks/dex.useWatchOrderCancelled.md
---
# `dex.useWatchOrderCancelled`

Watches for order cancelled events on the Stablecoin DEX.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.useWatchOrderCancelled.md","from":144,"to":4616}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"ee48b5f79e7f2895e840942af571c220f1e3dff682b0163666b36294801e6325","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXLC0UZq6ACyxSYrKSH0ZWjp47f4mZkhFILb2jn6IAGxV1F61vg0B9HgAZgCuYI6MEGCcB3AwAOqiaLYA8qSwpADCoscwMnJQADyvZz2jAUAD4ABRYezMHRkOAAfkQnGAAB1zpx0fNTABJKAIzhgA7MABGZE4AB8LmBYECzFAANyo9HozLwxEotFMpnsF44vFE4GmLgU/kKQXIAC65PxB2+UqO1Py9MZTNccqpMBpMCVHM4e1IEGYACEZBBrPw+QKwELKQraQydWcAKKkfWkPFgsFkV2I52ugCUnAAvCDOEQIIwoAGKfKNYq1batfbOWxvni0KQDjB47HadnNdrkxBvqYFFirWQiKIZHiCcTSdH1fm84qk1ywE8Xu9Pt8te6wSzEQB3O6PZ5kLvWL4/AB0AEEtHAKJwTQohyP8B3xx9Jz2oNOADIQBQB4Oh8OR5t25Xo7lkXmIkWCy9a58FpnWQHAvEAsBAhSv1t0XkUQiR+Pk+DkD5XwA1FXD9REwwjVEwFEaE4EhScLiuW57g3Mc3m3KctX8KBTQQPQcl1dhOGHXCS04W9SE4axCO+O5TnOGASCtOAGPOZQswAEUdAANad/DEBRyOQZAQDoVCsDkfwAANVLQOBaFREJWiRcJDE4VU9QNTgAHJhwUZhGAAehoFoTNRVFDmONAOM4WcsCwMEA3ZdEcjgad2mnS4bnXTcCO7H4wR8tswonIioH7BdvOvd8zjgIsYGnFcwRMsLmNYn5EBMpcWT9FL3GVOCHLRUgdAOUhzl+KBGCIEEcNsei9moxj8oi9i0unQbfis5rWtg1FVOUkBxQoWTIVKZh/Hm1CYVIXiAFpOAABShVb/OmmaQGiCREG6RJjGSQZEAKWZNCyPBgvavDOwK4i8mma7igWcpEAARkqDx1hqPQ6j8Rpdj0CF9RwDgMADM5Yte3FEQ9AcaNC/C4t3OcFyXFc11wxGIq1A8jxPENEIvBsEygEiyLwd5viJBx+E4NAIE4Uww34LNB3weROCgnrGF4ljib3ToYiQeJun6FIkF+5YNEyMY9ARzGkcmfIhi+0pFmcAo1kwYGfHqCSmkh5boScAM0eim98JxB9LTQe1XElk7JGGOQBlSWWRnuvQWS1j7hnmPWfoKX6jY2EGtnNiGQAhXabeXI8CdHF7xdJhQPd0SRpAu32dYD1XjCPEPzDDkoyiWAp4hjk3Qe2GhE5QtCMKzD8wHSuRUUrJju97mBER/Ye6esciQAAFX5zhlKHjLlM4ZhoBlLMsH1IgI3gQXODgEI5E4WAiQOBRRUUZi0oytm7C4EX95YRgZHENmOYE1EAClRErABlaxSCMCwFwReR9oTzDACLZgnBN7EB3lATgRIMA0RgESRB+pBxXDWtOaqs8syrygOvTgdBQjqTZoODm6EYDWEYECawV8WhmB4ogaqAAqNy88x5L2Yi/OAvFByMGUCvHQhAoC8TgAcWwgteIL2vnILKR4vLKSXLInuGVpxenYEowWVJ56gMysOBq2jlB3F6ogrMwUEHsxooAmgb8dHIIAHLQEygAK3EemGAqEcFgHYbOTgCgTTMxkHouRMBl6mGiJ8K+v5gT1RfNYwctiszWOQMpWBk4+HThEKRA4aBlLijBPgNAaAsBwEQFZKykBYDuOnOwBQI0yJWRfjQEQ60iAFG6NOWgVlRBYGshk+A/linMBkAAYkGXwnJEA8m2ypKiNJkz/I5K9AUopJSykVKqS42p9TGmT2aXceAaB2mdO6b0/pVklnThGeMpZKyXR+mnJwPBASglVlCWouQy8xbmKwi+ARygZn3xaBweiAl57VJHvo5eBD14+NRAAfVYaw24DUSwosRYiV5gSIDBJicPBiRJXHULQCZXi1tRG8XEFmMwgj+aDzSiLGgVoZAYFRHADAxx8D6kgJcZcjAea3yzESDBWC3JbSxLxASyDapXGJHIJckAmI0uFcgoezL5BoDZaiUQnLuW8pmbxEwQqqwhIgAJJizjYDTncfvTxqF/KcF/jAFJc80mQDsWcGB+pMm8SxFZB4azimlPKZUqFuytD7LgIc1pJyOldJ6X0gZvqhk3LQKMsZoh1qepgOtM460lnrVOAGLqpBUSr1qpzX87BmD9TAAisAjpaAKSPpccFc9cX4tUcPZSLCwATVUu41E+iFEKByvzb4HMKGkBkFAEyfp7SVO2oA5hnBJ0mhouwOdS5rHTLySOsJY6J1Tg5gAUjgMVUyM650LqXVZFdgpynrtPVu2dUBd2ULQLktAh6vmZU0aQMEZhBycF9Foky1xCAQDKUudKlL6LMwQXYDy8gtQLsXaiZdW1V1kMA8IvhohtA6IQdEM0bM9YpK/S8Ug/bl3onA7RzgUG+Cwf3gaERiHRDIb6TgWkWGH2clMcgLiVZxRpD+qoATnJBZcH/oA4B04MxgDLLPEWP5W5cGAy4xARBmB/ViAUP6AAOMqYB6NMlMQ8YlpKlNHFU/gdTZxNOcG07AXT+nYgWEkIgWIpnpNCa4FCxAgoyAoRkFc1NfCrJ0GoXkjiiB4jxD+pIALlmuAicrDIcU60km8bICsa6BQ0vMi4KJmQ8mgFaeC6FhqVZIumiGTF2gcWXJnES8sFYFgzMWdK/iHTtXwtWTraYGLWXEUiFXauAosRfPVSHkFlaQZTLXGfiEgASniyJZwTL2lHYYsAYJlKCQ+NoJiAASYA7cYCuAAIScBO4oMgt3lKYfMw+nDT7ESPbO8xtbnBNv8jUWAe7P3nufvtTRwdylqrNtbRYg+l8IXKS4d8nherynVUmsO44aUuDAuW1kX+DrmC/w44QQcXk9t4+IS6QnOhie1VQmT6EFOqd/pECvDAqOsyBnxDAUDo6edgmBUuL0b2K3c6PdlEyG7p3bvnW97DuHn1y7fTu+xwLJc8+PbL19F6r1mQV3e6Tn211q5vR+zXB6wDMCl/+jRLotEgbA07oDkHoNsfg5xy+SH135dpBh+9j613IEY4iFjMHFzsYQ777j/vUO0hmvYr082afXeW5B/7gPttgF29ro9B2jtg4u1dlad2Hunee694PZv1Lfar0xVbsoc/A9B4327EPU9gEmhJIj0lZJXFwFQZA6V6qTkKSGzZlTRTKAOESacH5mDbJqTGqFVlQJ4qsgm85JgiRWVHe4v0B1hBdAVr9b2l1UjnTumXfRlckD+3DrXZw3RG7eGbgnIIYJKXQADDr7KNCOAIjGAPED4DAJcQaOpYBDiKsHaBaZ9cAiUeCM8CMVzAAal+gYnqBNG42PyoFIknjwDr2lQ5mUn3XyRonpX50HCmEyk4AAFkZQXJFIsxMhCQtVRYoISQYEMctQlxAV8BhVHJGA1ouBLFpFhUfUWBxBkEgCQCSNBZZRuNmo2twt/kEE9V9558RBBF4szh+4qxMxxEn4X4mJUl0lcM9gwRYg/Rg0Nktk60wB4g6ko0pgDgeknDC0QCY0nDYhItBQ9hpxYh01RkzMwQIV2DoQeJBYq0zVeC+EEkOY0l4sZBpwy0600AlFJ8Nkw0V8YBI0GlCCY0WljlTlE0LlrJUjQjxlUiMi7h6iTlSonksch04AOcQEZkrRltVBqcHcZcPwjg0BEQz150lxBirQlcPsVdEQJjhjOB1B7EKCOd1EBiujhir05ipiQ968r4hjERFi91v0tce9VJqoXUswUiXI0jGjsj1lQ0tkI1/I9lijY0yid8k1Llqjbkxk6ja0Gj/imikoqImJK0sxTBGiOJxJlYpIkAZIjpTBJx/AiALBpxfo0SLALAT8joz8/oo45Yrphhb8ggVwH9TpdYX8FZDZAZjYP945wZv8rZVpbYFw2QUpGInZEEXY3Y84FZYh/YfZ5ZyTS4ghg53pzAn8a59YZhVBXBDoPxYBmhSFdI/IDJdR9RoEzIiNLIbIYA7Jqo/IAo6AgpsIMYs4dxIpop1ZzT4oUYWQ8YyYgwQx7YCVVjFETIBwr1SpKoKBYJ8CQBrZRAkBQBAh5AD4zg8B1IQBXBXAgA==="}
import { Hooks } from 'wagmi/tempo'

Hooks.dex.useWatchOrderCancelled({
  onOrderCancelled: (args, log) => {
    console.log('args:', args)
  },
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `dex.watchOrderCancelled` Parameters](/tempo/actions/dex.watchOrderCancelled#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`dex.cancel`](/tempo/actions/dex.cancel)
* [`dex.watchOrderCancelled`](/tempo/actions/dex.watchOrderCancelled)

---

---
url: /tempo/hooks/dex.useWatchOrderFilled.md
---
# `dex.useWatchOrderFilled`

Watches for order filled events on the Stablecoin DEX.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.useWatchOrderFilled.md","from":138,"to":4756}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"d6ebca7ccec7392508f050d98ee570f2e62a86cf7af165696dace79303079a4f","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXLC0UZq6ACyxSYrKSH0ZWjp47f4mZkhFILb2jn6IAGxV1F61vg0B9HgAZgCuYI6MEGCcB3AwAOqiaLYA8qSwpABijDJyUAA8AMJne0YCgAfAAKLD2Zg6MhwAD8iE4wAAOudOGj5qYAJJQeGcMAHZgAIzInAAPhcwLBAWYoABuFFotGZOEI5GoxmM9gvbG4wlA0xccl8hQC5AAXTJeIOn0lRyp+TpDI5jOYon4ZFxAAMLLQACTAESkUwKVyayXavUGtBGxSm8WS/Ey8lymDUmCK9mcVyStnKznPMg8hHCgWSkNgND28mOmSyymuhX0z0c1Xq0hanX6w3G03mzNWm0mzVRqVOinymlJv1osRpjOW7O2s3ki1Z6054sS6PS2PO+Nuj0c719ivuquMvakCDMABCMgg1n4vP5Ebjo8HnLAAFFSFP0wjQaCyHuETu9wBKTgAXmBnCIEEYUEvI4TNLXr7HSrRbE+uOtBxgd8ByAxMv04H8pgUTEIzIIhRBkXF8SJEkX2A1DQM9VMNQRVsCw7EDKzAs4nhed5PndXFD2ZBEAHc7keAM3g+L4ADoAEEtDgChOHnBRaPo/ASLIMjWIAGQgBRLxvO8HyfAjP09LlAxxYMV0FcsPygeSNxrNVsM4XDGyLbTx3RAEgVxf4wEBBQTLA+RREJL5eT4ORRHOdC308hTXHPBF70fFEwFEKE4AhaxAMuG4BKEpjyKgfwoAXBA9ByTg9nYTg6PufBjU4JTSHS5j3U4GASAjOB8vOZRAIAES3AANFj/DEBQUuQZAQDoEKsDkfxNQGtA4FoFEQlaRFwkML10qnZhOAAcjohRmEYAB6GgWnmlEUUOY40FOc42KwLBQUvX1JsEFj2hYqLbhy2KRPdUFzrRYjGMeqBQWZM6wLMsA4AgOQWN40F5tior4sQebuO+sD3CVXzttRUgdAOUhzm+KBGCIYE7tsPKMsKgqIZkOAWPJ75VqxnGUVcFEBs1EAxQoTqIVKZh/DZkLoVISqAFpOAABUhHmyaZ5mQGiCREG6RJjGSQZEAARmkEYsjwW6Yve4qEryaZEFmeZSkWZwlcqDx1hqPQ6j8Rpdj0cEpxwDgMEvN7SJ1yivs4/j7u1+L2M47jeN9hiPYD8TJOvW8Ark7zdZAJLrBSkBfngmRCQcfhODQCBOFMe91Sy/B5E4dz8sY/PKsBAPOhiJB4iV/oUiQJXhk0dW9Hd4SdcmfIhmKBZygNtZMCtnx6hapoHa5qEnEvaisq18PWI4tq6+lgAOOW5AGVJug0TIxj0Zk+/14YjbKJYlc30eNmtrYp/tkBwRF+eeIk0PBP9sSJI33RJDDF3i3RA7cj5BF4mfcwF8ShX2cAUbod9x4222DQZ+wVQrhUAtYM4AM5AojgoVHB/1AYwARFZPBuAqBJxTgAFRLgZYhlCzTMGgNKQCWApxEEfPAMunA4AhDkJwWAhIDgKBFIoTgTDSE5zsFwRglUBErRkOIHOecaoogAFKiDggAZWsEaLAXBpFCKhPMMACi5qcOIDwrShIMBZRgISTghIpw0SuLzFiSN6GAVYVAdhpVaChCGjnGiecwowGsIwQE1gpHTjYGYCqiAkYACpOBsQMhQ0hZprAqLgJVGijBlCcDnoQKAiiDi2DLpVTUJiYDAwkqdTU3Fam4NISxY87Amll0pIwtpQM6Lo26coO4Ujy7EguFcLSucspGhoGonpDiABy0B6kACtFHWhgCFLxYA0kZIUPOTOsZWkkLkGaUw0RjjYPMgoNGJUZk0TmYBGZyBNTWIivkliIgkoHDQJqMUoJ8BoDQFgOAiBVqrUgLADZLF2AKCpslVaKiaAiD5kQBBLFaCrVEFgNaHz4Bk2BcwGQABiAl+SfkQD+QvSkKI3kUrJj848AKgUgrBRCqFqzYXwsRcnZFdx4BoHRZi7FuL8VTk+UStAJLyWSsJcy3c54WKcB8ZwQ5EBjl9LOTAHJ4zIpTKykUwgfz84tA4HlGqBloVkLqSwthQMkYAH0UkpNuOjY0rqnUIjVRqrVdT8qEjWZEtA81KqlOgJVcQgEzDGpJEwhRNAIwyAwCiOAGBjj4CnJAS4PFGBFyta4iA7iSRsUFpiSqNUHEoyuESOQ3FICFWjbImADiE0iHkGgFNKJRDpszdm6llUTBF3TvlGqhUVmwBYhs/hWyQpk04LomALyGFvMgPMs44F5X5M4JiVaDxWXAtBeCyFNqeVaD5XAAVqLhUYu6FinFeLVqMpYsSslog+brpgHzM4fNGV81OJeQmKJWEo3ztZdgqp9pnF2SiLctAepCMuJahhfr4LauYcksA9MBobJRHUhpChQYl0+HnMJpAZBQHmueJMkKhY2iGgiEj84srsEo9xGZVK/n4f6fUkG81mN5wAKRwGhgtcjlHqO0dWvRgU4LOCCdYxRqAHHwloF+WgHjOqOm7i6WYGinAzxdPmtcQgEAwXcQBqUvKmctJ2GOvId01GaMojo4LBjlVOmFVCnAUQ2gelaWiIuHOxsXlqZeKQLDdG0RGci5wUzfALP8OnDoXKkjbMKdxTgGkrmZMclGcgMq8ExRpGVqoXLypRn6MMWgFipAjjQXoQoqyaCuCghtYgIgzBlaxAKMrTe54Kv5a4A8INIa6sNbAE1uALXAicHa6szr3XYgWEkKAgbQ3GSjI6wKMgwUZDPu3VeugkS/kHUQPEeIytJCbaZFwQrcEZBij5k8rLZAVgGwKLdsuXAisyGq4wIx82dswXRvBQ7C5CWrRO9YM7ZwLvLBWBYQbYBotba4CDpw+3VqqlMNDx7TqjIG1iKApGTCMfc2vAta4zFOAACVNWXLOPNJMBHBlgFBJqWq7ltCFX1BgmArgACEnBueKDIELzULnUcyfc3JhEYvefxdpwzvkJCwAi8VxL1Ts6Is4c1EjeDiGDUocApqLJ5ypF5PBUjBmeHji4K4NSrgV51U6F0XO5guiUuEBoqdVnjvSq7ip1kD3KMQre6hL7/3WmRAlIwBbwCrv9NxO04n0EzvuLHmlyBhPvHCPEZgKRpTknpduY80xovLGJMqYWc73PieC8Car8J0T3FFpsao2X2XFeFMt5L7XmZ9ewDMDz9prz7WYAGdi6DBL5muLJes+l0Qdm3s0mc9J2TSTODIFiwiOfSWrOpZsyvzLDmaTMwWceMngeBdU5Myrxn6uWcN/z+zznWu+fAAF8L0XPOJdS6b5y7b6f7K4yiq5M4a5/7i6kBC467X5gAMwtR+btSdRXBUIgDIAAxowRSApHocqQoijKAHCEgsQ4LMBcowpXo2qrROSaqrR3oPomCEirQEYbLnjizCBdCtwWA7wKypBywdzHxzC8ZQJIAHxzCwImziFILeAoJPxBCggRpySN4gw+Z+YwC4juQYDcTkxwpGIHTwTCzszybaHih+QySPjzYADUSs+U9Q84K+HB1CyUeAwBISMymoXG/yRqxS+mUw9SnAAAstKPtL1IBJkASJ2pVNYPquBL2lMtxIUsUhotZIwLzFwFFFpL2i2luiwOIA4uof5u5NkTKCvljNBvtpMiVDkXACQSIEUnDthmAI9gBIoiwB8Koq8u8gxnsKCLEOeIeuypyqqGAPEHChelMAcNiqMX+hoVeqMbEIdgKHsCxLEK+jKjICjqCFapEVCBVGXGBqOhCPkg8nnG8mdjICxITFBk0ngeyiepQTAOegijQtekKiKvemKk+pcRsbKpcTcXcICcKt9MqrbrhnALHsYtSquK7qoAHtpvxjgkcGgAiEJlRtxMiRGN3lvoxnEiiQiOoAst4bHu0kiTCaiWJliWgDie4fJtSYSTriSYgQNEjEuoBBcftFccCXcWysepymemTLym8Sih8Ywd8WtL8W+qSgCZBkCXKSCZxEBplKBoBKYMCQdM1IfOvCgGgaYBFP4EQBYCxErCaRYBYJwZLNwcrErOkMAorGAqMBAn/HrOYBIZfNIcrAULIZsJPHbIobPDzAvD7EvH7CvO6IHOvFwfXF6ZvM3IrBIUIUEKfK6eIYPMbMPAUKoK4BLDgrAM0MEhNDkJVN6JONOOJn5itOtDAJtEjMWVdHQDdFcHjN/OGZ9OdN3HFF8AeMyMHBJFJLeC9KnpQk3tRGJrDKiPDGAL5P4HPKIEgKAIEPIAImcHgENCAK4K4EAA="}
import { Hooks } from 'wagmi/tempo'

Hooks.dex.useWatchOrderFilled({
  onOrderFilled: (args, log) => {
    console.log('args:', args)
  },
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `dex.watchOrderFilled` Parameters](/tempo/actions/dex.watchOrderFilled#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`dex.buy`](/tempo/actions/dex.buy)
* [`dex.watchOrderFilled`](/tempo/actions/dex.watchOrderFilled)

---

---
url: /tempo/hooks/dex.useWatchOrderPlaced.md
---
# `dex.useWatchOrderPlaced`

Watches for order placed events on the Stablecoin DEX.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.useWatchOrderPlaced.md","from":138,"to":4844}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"3e7dca1cf113bef29341a671f24d7e6ec1d9eec74f78c78ceefe4f494ee9551f","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXLC0UZq6ACyxSYrKSH0ZWjp47f4mZkhFILb2jn6IAGxV1F61vg0B9HgAZgCuYI6MEGCcB3AwAOqiaLYA8qSwpAAKMg4wUAA8AMJne0YCgAfAAKLD2Zg6MhwAD8iE4wAAOudOGj5qYAJJQeGcMAHZgAIzInAAPhcwLBAWYoABuFFotGZOEI5GoxmM9gvbG4wlA0xccl8hQC5AAXTJeIOMhkkqOVPydIZHMZzFE/DIuIABhZaAASYAiUimBSuLWSnX6w1oY2KM3iyX4mVyykwalfenslVoATybW6g1Gk1mi0B62201ah3kp2y8nyt2Kz0c1wuhU05OMvakCDMABCMgg1n4vP5YEFFPTHuVaLOAFFSDnSLjQaCyE2EQ2mwBKTgAXmBnCIEEYUF78dd7qgacTGZrnDYMtxNoOMBnU/XSfni6mCkx5bIRFEMlx+KJJInVenl9n1a9ao1zYRlsDNuD5pvU8ztbATxe70+HEEVbZkEQAdzuR5njIADrC+AA6ABBLQ4AoThCwUcDIPwP8YI+OCoHggAZCAFF7AchxHMdNznL0fQ1MB/StIM7Q/StbyVL1rABIFcX+MBAQUGi7w5eRREJOQgM4Qk+DkURzk/RVhM41xuwRYdRxRMBRChOAITgi4rlue4cOgt58K+fwoCLBA9ByTg9nYTgIJMk1OC5EksAsqFy04GASHLOB3POZQ1wAETrAANeD/DEBRbOQZAQDoHSvNwKgtUytA4FoFEQlaRFwkMThU2zXNOAAcgghRmEYAB6GgWgqlEUUOY40FOc5EKwLBQV7Nk0RyOB4PaeDLhubDcPMwDQQGzlfzM2CvlBZl+vndEzjgCA5HgjDQQqqaFwsqBEAqtDVvndxlVUlrUVIHQDlIc5vigRgiGBYzbDcxzSHcsyjs+HzsvgkHvjq173pRVwUUyrUQDFCgkohUpmH8ZGdOhUggoAWk4V5IUx4b4YRkBogkRBukSYxkkGRAAEZpBGLI8HGz7TP/Y7JnyGZigWcp6cqDx1hqPQ6j8Rpdj0cEcxwDgMF7M4pqWqSQJQrCTKV46kJQtCMPVqCOcA4jSPIwcNOoxSaSsmy8F+Y8ZEJBx+E4H1OFMYcNWc/B5E4eS/peN2gq8o3OhiJB4jp/oUiQOnhk0Zm9EVxbObyaZEGGeZSkWZwCjWTARZ8epYqaKX0ahJxe1AxF5w80hsQRYUBW/TgHzIZ8wxYyNm/o+R2+Yt9WObnSICONAG7LNBm8YOA81HBvZJgeTu8YYsETPYlSE9VxQ/JgAOKm5AGVJug0TIxj0ZkubTjOSjKJY6d3vONlFrZi8lkBwQJiv0NI/X2bwo2JEFA710JIYYh9o7p1PqMIIGEr7mBvnzJYBRuhPwLmLbYNB37aV0vpNc3EwBbTkCiI8v0CFEJgAifiFDrbWFsiAAAKt7TgWpyHbRgOaZg0BpRriwDmIgo54C+04HAEIchOCwEJAcBQIpFCcDYeI5QdxA4iJYIwD4v1XahRRAAKVEEeAAytYY0WAuAKLXFCeYYBp7MAXPwwR05CQYGcjAQk0kcxgSuFjeCt0mEWO4eIugoRsouzAhAEROBrCMEBNYeRuY2BmECogW6AAqTgiEWHUPYeaawHw4BBTAowZQLcdCECgEFOABxbC+yCqwza7DdqkT6lqNCdTCENPbOwZpvtKQsPMfBCCT1ulKLMX7Ykhkvgu3CWBY0NApk9OcQAOWgDAeCAArCpNpF7MB8WANJGSFCFkdrKNpFDzSmGiMcfBPEFCPUma7GZRS1yu2QFqPhRZ4DDRENZA4aAtRilBPgNAaAsBwEQHVOqkBYAbPguwBQ4MbJ1Q+DQEQ2MiAoPgrQOqogsD1XeXBfJ8EgXMBkAAYnxZ875I80CV0pCiV5FLCXfPbP8wFwLQXgshSsmFcKEV0KRXceAaA0UYqxTivFOYCXDWJWSxl+S0AvFIN2eCnA/GcEORAY5fT6lyByWMtc41pyFOUNSt2LQOBuVCiwqFlDzGcICas26AB9FJKTbhPRNK6p1CI1Uaq1eY9yhI1kwEcBVIK5cylBXEGuMwRTvZkM2tPGg5YZAYBRHADAxx8A5kgJcdCjBPZWsJB4rx6TXiYiCqFZx90rhEjkGhSAv1o0u29s48hSb5BoFTSiUQGas05pHkFEwnt7buVCr9ZZsB1mbPujpYanADEwGecw15kA5lnDsR8/JnBMR1QeKyoFIKwUQptTyrQfK4ACpRcK9F3RMXYtxXVOVRK0AktJaIbGa6YDYzONjOV2NTi9h+iiLh903YCXYGqDqZxdkojrLQVK4jLiWuYX6482r2m6uSWAGGmUNkon6XtCq3sZTTPYDIKAFVuyeghXjW02UEQkcLM5cjUA0Kuypb8gjOrVlEaY+EgApHAM6lUwmkAo1RmjdU6MCjBZwfjLHxNsfmZxtA3HMOrM6aQUEZgwKcC7F0iq1xCAQFBWhLaEa3KO2nHYHq8gvhUeoyiWjrx6NBS0yU/JohtA9OnNEYsLss7PPCcyxs2HaNogM6QBExm+BmZEbmUpVnRA2ZxTgGkznpMcmUcgfyx4xRpHpqoTLKplFGJMWgeCpAjj7iYdPfiWCuA6ZWYgIgzB6axAKPTXe3YSvZa4A8INIbKvVbALV/A9WziNc4M12ArX2uxAsJIdOPW+uMmUTaxAAoyDaRkE+yVny6p0BDb8zqiB4jxHppINbTIuC5aPDIMU2MZlpbbssRABQCg3d9lwPLMhyuMFMTNzb22nrHn21uy9x3rCnbOOd97ywLC9bABF9bXAQcHjB3ttUpgjsPadZ3D7sR063XIejjG/ZKrXHUbKAASpqi5ZwKqen6YMsAoItRhXktoX6BocEwFcAAQk4FzxQZBBdaicyj6TrnZMIlFzzzg1PnT075O0sAwuFfi/YyFhV7ZcNaluvBxDBrRFyKtVqLJur5F5LBbdWG+HjibS4Kavs6qdAGK2TpAxiXCBgT6iz53flGyU6yJ72dzAfdQj9wH9TIgW4YCt2uN3um4kafgkn0E1K0LtilyBxPPHGkKH2gpsTEmpcubc4xmApHFMUZ1+5LjYBmAF/T3xmvzGhMiaqqxyTJXZdJPkx3sjSmG/Uvz0n+CWmdMwD01F/asXTOoQS5ZuR1n5OvZpI5qTMnB/ICizFkz8WLNJbXyljfdmaQI3mfrnDTvCHk6hJTozNPOCq8Z2AZnE/C9s451r3nwA/OQuIu3O4ukuO+A+DGIBYuv0yudODO6umuoBpAguDet+sMsU3mCUSUVw6UIAyAW0j0cEAKh6HKEKIoygBwhI8E3EzAXK0Kl6NqdUEkmqdUt696JghIdU/SGy3YxMwgXQMcFgB8NMqQVM8c58cwPG8CSAJ8cwt82cshaC3gGCb8QQoIEa0AvYk+e0ukcA3mMAuI8kGAaEIMsKpinUx4+MKMcmxh4oaklEo4M2AA1HTO5PUIWClnwVQNZHQngJAZWuElqKpuaMavgHiLPlMKspwAALLSgdRpS+xaAEidpBTWD6oLi9pXDKZhEtowCtSMBYxcCGo1J5F2IsDiDOJ6EGG+a+zOgpavTQa7YTLTi9oiJUEiBFKw534PargVJqIaLzIMr0Z7CgixDdgHrsqcpqhgDxCwrnpTAHBYozF/oGGXozGxD7YCh7DwSxAvokrI6ghWqZApGBRJFrijoQj5L3LhKvKnYyDwQ/RQbNIkHsrHr0EwBnrwq+GXrIpCoip3piqPr3H7Fkr3FPF3AQnCqrTKr254ZwBx5mIjy+Ru6qCB5t5NIVTcSjwIgCaUZoTYnlgV4y5V5xI4mcDqAqYKrj734UJF77SEljwiaMnEm75QGMkIiUkcbUlN6wy3SLprh3EdQPFQkvFspHqcqnrDS8o/FXr/HsFAn1QgkyqkrgmQaQnqnQkoRAZOSgZrimBQmdQxSnzxRICJSkymBwT+BEAWDwR0x2kWAWD8GkyCH0x0zpAQK0xxxnywKkQyEUy8xZz8x0y5xCz5wqGvwSzqFlyYyVxqzVxei1z1zSQTzNytzRYsIdwDxdzzg9xgB9yvgRhmhDxcLkmNzlhTwzxzzSQLxLy5krz8BrwEgbxbwgIxwFC7xRy0xyESFBCXypzmByGZx3w5yqCuAkzcSwDNDBKFRDQlQOQ5i2JVTea1QNQwBNS3RDQjR0BjRGSTTJwzRzRJyGwETATMi6wmz9iDhzQbQYnF4VSgQiYXSohXRgCqT+DlyiBICgCBDyCiJnB4DZQgCuCuBAA==="}
import { Hooks } from 'wagmi/tempo'

Hooks.dex.useWatchOrderPlaced({
  onOrderPlaced: (args, log) => {
    console.log('args:', args)
  },
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `dex.watchOrderPlaced` Parameters](/tempo/actions/dex.watchOrderPlaced#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`dex.place`](/tempo/actions/dex.place)
* [`dex.watchOrderPlaced`](/tempo/actions/dex.watchOrderPlaced)

---

---
url: /tempo/hooks/dex.useWithdraw.md
---
# `dex.useWithdraw`

Withdraws tokens from the Stablecoin DEX to your wallet.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.useWithdraw.md","from":132,"to":6780}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"1ba49397fce40202581f9380b2e1c849c02f8b39dbc63f623cec1edd321703c9","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUoiaicACUnABmAK5gjowQYJxY4nAwAKpgjGhwwURhcTCInCKkpgoUnLDWLGFwZWBxzABGZJFlbYwKpmgAOrms7FzppJk5eUZQENYIegCycTJojFgm8Jyi5WiVipykMFhHmWBiaymcEDHbnC3tZJxtGHd9JKl0bGbn17dtERgnAAjBZOMFQV8UvI0JEAHRDIYAWk4ABE5k1OPg0GgsE0APT4oiMGDMOFwfD42bzfFxNYmNbwfHjSa5fL+MQKBbIZAgOiiVhyfwsNgcTjANIZbJsuCcVyxUgQZicADkxNJKsRYBZ0umwRVABYAEwWFU1SSRIaEzjGix2+0OsAgAC6zuEml0BvUxnkShUiFBGnE2iCOqm7NkpnMwJsdlIDicUncnhweEIJHIGkCeGsKREnAA7nl8FB4wWAMoYRJlAyCOGwWhwuKZADqxdLogrVescIASjo4qQwAAVLwAHgAwikYr0agl+JAC2AAHz+ETiXQAdk3sl9yiQwKNQa0OjwReUHa7iX8JjMSAAzLH7I4/IgAGzJ6heNO+TMBehMCMYq1kY64SC4R4+oo+6IN6mghngIE3lGD5PvGL7OEawKfpgqZ6OmfhZgBegiqMtR0GuHpSAAHLu0H+o+1DBqeegNshd6IIxtjPomiBGpuOHfvhv4ctmejxIklypM2MBtheZaVokk7TrOnDzouK7BOMAo6GQcAAPw1nwdYNk2rbtgp3ZwgACvYzC6RMylgDO1RqWAC4QEuy5dDwxlwPWdBmbJFmdopPb9mgg4juOU7Oap6meSuQxgDpcDpNYQIyXJJaWdeVDUgs+jGbE7CFiFRYHGgAjyLKMSKsqyhAqiACiAAanBVR1+BAtYYRyKQKqygWfU6AiYBDAAchANBlMO+CMLKC13HA3b4IqkDNlixXKKIXDDdMJWkF1QJ7KIYBwAmyTjecEDPECpjWDIcSwFA1ypDsbQyHM/B3TE7BAkckVDlUdynN8mRwhyohckgPJ8rQAobLgVAAAZo/ktBDKRYoSiBcoKkqqrDQozCMPiNAjJq10SUkVwAIJYFgwTRMAQycJwubnVwErMHSu0wDUC3WfIUAg/KAC8vmGAFjZZeVYXM1q7OA1F4Js+znBjm0dJVddGsaykE4mNY/Di8AzOcOLy6cLzFwwMErOpPrGsChACRoGUoIWGAFDq87HXVWAZQqhYtAmj2cJwsCwJmn7GuuJErhx+zosXZ9MBQGbQsi1USdO+zy7J5w2WXnHY74trOIpIXTuWmAedoyjLoULy2nMP4bcObKKK2fG9lOP5ze8irQ5GMsFxXYc8ArGgkOuu6G4HhYkFyPRB5wcxQRy/JoXdux5hcXGCavve2EeF+eE+BmonESAnP5ueOW79WUsmYF29P1e4UDkOo44E5Lk5zuQ0quBe4ETQrz3P6Q8x4EJ6EfpeMK+8kBvjQsfZwFhBKXwIn+Ggt8tKKhwBwDA0Rbb8zKIUcQjBRDp0xAg3KPZe46QHgA3oy4agQCwFJAyZRx78wAPJcKunAMcjt9ZHAyusD2nBhzxnOpdFI/ZJFcIANxDHcJwAAQoCZqpBFSkD/gLMqO8v42Tsl3VhCh2FuQ8l5TgAAfNysAZxmCgNEK2nAiAQEYFAfwBU8BzSBGQqSsQEi01SBgN2HMzrRJkDIYx+BPFUJoXIWUnU9i9G0EdRqNs+YhLOq9ThUk+qvEIIYN62woCi2KfE3qcSAQm2uEIvMkMgwwxQK3Oy/giiVBSVsFEgSkm9NodcNoAArGAjgA6SjgGk26OSUbBKugAMTACjOeLcQBt38EU4RcIUjljiNYDKszOADPmrVMJISixxNiIwI4hZuqpByUsq4S04BHJOXAeI8SCllVuR0GZmRXovLyVdQaU8PmrA2Z0vuOzmnnX2WAXR+izkyIuaEySk8bnxJnA8xgtxQUTyuPIXM7s9LbE+Ho0qfycV3SBRnY6nAyD6JhVsrpVBdktIOToNAchXrnKWjTa5jBbl4qBAWJ5TLXmpCWjAYsTwPnHPgN8lYMhXgxB0LYRlpVSVu3OBSmJLKaVgFeoC9IszGXysatk7qtRdo7F1dS0gbKjjMHEIIfwKIACStxIlxBtqIfgQSZ7rDkFPAAjiUEQcAagowOZ8lVKN/m4vuUCFI6rtgxCcEymQ/N8x1Pif6tUQTRCwDGiiOmtycmFoaT9YVwjwTxrAIc5VsyUZxpSCi9gHbODNvLLy/lKNojiCBF4nxmLwmxspSCu1I9XFJKehK0V8TAW9EgEcKAc83QgDAroLC3pV5+hQbAliIBgnI2MChd8aCMIHnvFg7wOCb5BAIZwsgmAR3MH1dInofRziUUXnxI0qCoLHpvUxE8QRXbu2QYgHcd8j53r4o+n818iKvrCNQqIkoJi6nyJQpdZQKhVBqHUBoMhMQPA6KQHyf7+hYyAmMKU4YZgYjwMsVYYaSSyh2CRg4RwTjwBhLtSeNw7jUaeC8N4jAPjMtoN8GEfxniAhBGCCEFgoQ/FhGNZEaIMRlGxLiAkRISRkgpFSDEtJ6R5B48yFjMoobtLhvyQUl7sbc1w6yA68o6qEzVGZqmQwwwyn1LaM0nALRWnxDaE0Dp4tOnnruqifF7wGjouBwMkG4Hsrw6xuDCHuLoV4qCVDwl0P/lfScd9xDohVWDUHTgAwQCh3DvF9rHXOtdYsMCZrgHwGqFomBmCG8oN4Hq/IODQ2ivoKQEaMrV9CKVbwCleyaUHA9TzBAOQQwekcy23IMosU4Dbcvf4vQgyUb31O8m79UAVhAmq8SWAvHyginDbAbWCh/0KH2+dU7XVdqcHeSwUV4hpmNSGAAKVEEUcs1hKhcL+yd8N9luK5DgMqJ7PjGXSYLDANozxFQFkyBMXTI47V3Ye/J0U+QOoFlumlSZBLGDWH2yMbTTQtQACpOB0z7cdm7HM82nMfjbHQhAoCyiVYkiIfbrtyDhF9BQzNe1XYOzAOExrSCq5nfLjXcJhpDl1ztLgvVUiApkiC26BZKg0GmWdV4U1y1jOl3sGAAoxq8/5woL6AJ4nq/+3IZNph1yJE23FBQg5GWdVt3kE6t1kAo2q188kaBZh0hRs6YIRm8SIEJJAWArv9laEszSPNNARBIiIEaA0cJaD4lEFgMmKeVVwmxMwGQABiVvsyRAZ9hDOoYSfe/+X7yyrPOecR54L9AGAxf2AKDL3AfEFf4BoGr7X+vjfm/MkVKnjv3fR/j70fCdFQJfcQH9/roPMBk3m/pVbhJbsuAeZBgswvpQFd35ttAB75OAB9bnbnFscQXIRQYAgA2aO1S/a/b/UZCZRwCFfuSXXjB5MwBVI6e+BaGgc4dVIYFaRINaFIN2WUEwYNJlNoYnUnPnayb1NJbqV4U4UkdOGoDdbYB5RqV4bAkQGEfAlKQg2wdaUgzgcgoEPqa4G1TgZ3TXV3XYI4AUfyTgAdE6O1JPSAe3K4UfTgb1fEfhSfXPEzT/BfUvAqVffNDfGvOvBvJvFvffNvQ/LvUQJEDQmAJEFIJEUfJEZIaIP6UgIYb9fFZydgd1KScnZqBGNzNSOAd/GAv3MIG/FHO/RALURuV3IYb/JXCAFXFUbqOJG3dgGQKAFUSINRMAa0ayfYfIQzGAfIwsQoqAGoTqfvF/DIg3ZXfUPIr6TgAAUjgAixVAZ1ICKJKLKIqKqMxC6IKOGMaOmRaLpDaNvy12dWCDMALE4G7R1xVBbDKTxBqBOxQJBgBFejsEZnkAzhKNKOi04EqP6FlG13F1mWhnENNV2AcB+lOgyjmPTxZRSPKJi3Zk2LKB2L4D2PKCVAlyOLLSxCbxwFcWuP1iB2QBgCKBkGdFggDFUARJdi4Hh0R1nlIASG9QpwWlijwS4FWLn0QCIGYADHvCNADGojrmtERK4H4XGUmQJKJJJLgDJMCHBE/2pNpPvAsEkE4iZOxPZiB0FP6DIBShkD3zmBVXxDoEmTpCung03ADEkElO2C4GRNROdCRFt1hLIHfGA11KBxRLCDxKkQFKpNlKHDCEVK+RVNoDVKkngzfHfAsGZIBJxPuAdINSdIVPdVMBVNRIAP4wUFS04i1Hvi4FWyBElm2JXU4F7Cv1DxSBVDKMyKNzAGCBRlRDOiyU4AABJgAkzXAABCNEEssgas4dMYmLW484TEYsxQJ4NsW5DMnof7MAWsjsrJaspoxnH4vRIYRuLUCIxGcNZsWIoEFGQXYPYXCILna6NIuARY/MF/S2TgEMcsd3AUcsCEwgAsZmXMvMLgFlPcg8o85gE8+yM8i87crgZgDAZc5M+4GAdYzIz84IF/GoFlK466d8z8rInIqY+omY0Y641s6orEWo7ooYoo0c64BYsAMC9o7IzopC26PogYlC4okC8Yu4mouooitC1ozCj8g3bXVYn8jYlY7Y3Y6dA4yEg4Y4mEs41xS45sm4iYsoZAIE4uVi/YiE5QKEk4001xN0aZFleMq8+4HSPc1MnszM/snMgI2ipY/Mwsocp4Csqswc+s0gRskilswSuszso6bs+JXsrMgc6y4ctChStZNGJzbkXkTIS9ZAE7QcDKbPQw/PfEPoZQOINoOEXMZgfEYwlfT/CuP3IkLfBvEwNofETI13SIF0HdPdB8YEQ9KBJABDeCM9b/ODaOW9XiTBc+XCJ9ESDDPAYIFA6AaIcCjotbC6bQQySlDAGoSOfZBFMIJhZgTER3ZAZ0HycdV6YIAAamBGuAzC+jLWyvynYz0HgrmT7XmLQGTTFzWNvE104E4zWCRg4Kj3sjbOiQt0ezXIzhqDF0hzigmC4CfzlxyROAaFIFeE6ueL1wkLLWqSugSLeulwipEDyHVJSF22KC2BiNJjzWyUT2TyqJiGCHvEiAMOnxCvdTAE3BLyX1vDiAb1xs8OeJX1xvvD336BiDhHvHbzQE7zrmCByWDFaBhDQPENuQtWBWmST3VJkDhD8NCNVyCunyMLnxMKXzMLXyrysO31sOs1FQZs7y7wFuFt2g1o32DCiHhFSLRnSMSCUrJV+EllUEvKWI6JVBNukR6OKJqBtosoErIv23djKHUG+IH23NOwgv1BtsQAi0dv4s2rKH9s4A9uaPT2oqnOuhUM4H5vpCFpCN2lFqn2MxCrioJuX3MMr0sJSp3zJgFpVu73VuTrQC1qRB1t8NKkCPumCNIFCKulaSYmc28oekvSIAsCjijjtByrAV0HpMYiPRgkYlKqCGVwqpjEQx4lfGogW2fUar0ATISUQW7CMmllMg/lXsSD7B/min/likARsRAX6wHoNCG2HugUgjHrPHlj3kjA4kqunuKxPgfVqqEkW1wTEhCGqyIU/XtTEDKDEQ1gkXlS4VmjkQunCSUTAbQDKPlEcQSGcSjF8TWvmACTtRFy4CVS+R+UzVOG2xIFeigAdUOmlTBRSHJyGEGSwfKETVmTwaYPgEIcZRIbEDIaJVE0oa1GocwYiGwfodVTiSYZRyIYAZ2D8PIeJTACoYpyBFoZwZVUYchRYeIdIckc4bCNPofDfCnsvqQHS2yzPTYdEEnqqtfANA/HfuwQauWz0DfT/pISnmUWkVkTOigakhgakT8XWpADcfkXCWcdgebrys4jfAQ30fg1PSCFAe8YfujCnpm2Q1UHm2sfqoq3JKat/o/ScdOgCakm4AiHwDKBRlDgrOjNcGTUQdNRgBcQzh8fQb0EKYpGU0krSUgYUSdH7ofE3EKrXkxOifGw6fCWaZUHiYPESaQ14jfEwR3VzFgEAlp3FFfllF83qiJmhlJnJlJDYCpg82WZCx8wJmVACw1EUq5hXoYT3JAhliChLgYUVmumtAnAkMWTyR/1MEhXBgT2iKeE6fBE1wUDhGeB1iuEelZ34BqGFrobaFJlmSujrnoWfh7AvQdnVhg3ODKEOYIxVC9gizfEiF9idgm0axDjDgsGsG6ypepftBjiJYTnOaSN9pVH8Y8cnjsApADoervp3pMf0jhFia4ThDybZZSFGdWvPR0FMcQFAECBqiunGwQFcFcCAA==="}
import { Hooks } from 'wagmi/tempo'
import { parseUnits } from 'viem'

const withdrawSync = Hooks.dex.useWithdrawSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
withdrawSync.mutate({
  amount: parseUnits('100', 6),
  token: '0x20c0000000000000000000000000000000000001',
})

console.log('Transaction hash:', withdrawSync.data?.receipt.transactionHash)
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `dex.withdraw` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/dex.useWithdraw.md","from":7120,"to":7555}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { useWaitForTransactionReceipt } from 'wagmi'

const withdraw = Hooks.dex.useWithdraw()
const { data: receipt } = useWaitForTransactionReceipt({ hash: withdraw.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
withdraw.mutate({
  amount: parseUnits('100', 6),
  token: '0x20c0000000000000000000000000000000000001',
})
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `dex.withdraw` Return Type](/tempo/actions/dex.withdraw#return-type)

### mutate/mutateAsync

See [Wagmi Action `dex.withdraw` Parameters](/tempo/actions/dex.withdraw#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`dex.withdraw`](/tempo/actions/dex.withdraw)

---

---
url: /tempo/actions/dex.watchFlipOrderPlaced.md
---
# `dex.watchFlipOrderPlaced`

Watches for flip order placed events on the Stablecoin DEX.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.watchFlipOrderPlaced.md","from":147,"to":5292}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"546bd06c6d922c9812fee931dd4652721a211f4c197b95a0862ff50f70b8b057","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGcWC0fEVGQ1Un1Bl/KkGEV0nqIRnM06sxAAJkqCMwXJ8s1KNH5IASa34uM4wPsADFzFgAPKkWCkAAKcicMCgAB4jlkAHxBDrJVK+5IUThYRzMPRkOCpGnCAB0IsTVvwtsYDqdZDdHqgiZdUZjpDgPuKSj9ET2B3wRxOwwuijQNzQd0eXlyYHE0bgkd4MEtNYzWeduf7UFKUAgvAQBn2IPgnAS7CXds47GdEfd/ejx04MEuaDg67AnFUA4AImcABqJw3iJSz5DIEB0btYBSlAAGP6PuUFhTANEpAwFsMChko4b4GgaBYJwrhLqQEDMJwADkAACmxKMwjAAPQxCBqH/pigFnjAmLwYhyFoZhD44fh7AwPhDgWHARF5CRXBAQmx4IQkSEoRhWH0QRTE0Ji7G5EscTlpwAC8wGgTQEFBMAuScNELHCKkyDiWwDzwGglhoAAuhQ6lnkMwgFEeqRqaeGmcLp5FsImjBQCZqTQbBQQROZDnuLkrgRLkUmxKsGw1vJPDmiYyZ0KmQ52o6o7bp6gbluG9kaUIw4pTmaVQKkIQ6HA4ZyBAShRHJfqcNljlLBACiJhVShBKhw7rtmpBbnmiCoeGrSRBZgVgMFuQ/l+IBmS+kZDMwpRBkonAALTpOWd4zSAc3dqUO3RiMx5rYW83FnAm0UC+IGtvcpjcEuZrGKeaAQBFcArAARnAvCkIwH0Dvx1Hnvuh6bWZZQEn01j9F80qarY1CtACBhpnl3Vjp6iqQtCaouJqhI6ki+qokagQhGEkRFMIMmJMG620zkHE2VTnSiJDiC9BqGryHUPxNLKyNMuWWMykygzDHjlTjByureCivKk3gQRYEhOAcBgUS5cl6OFcVQ2pKj2upXmibcKV5WVQbSWZvlrqFYmAAylXVbVRAQO5k7TrOIBpKEcgfU4ADWZ6vRYbuBwO6z4IonDiKumZdZujDHh+Jtim8vQQpUPNkn0FJI4EWs2zreYi4g2diyyeMaoTery4a6IGMrRYjFE+t1RZOXdQAkkVnAfckFhoAA3J3nDMOIEekKkX7WLQAAkwBiL9yiuF+o8ORpL0R2AM9z4vy8WEoa8b45sfMBAaxoKkA9KEPp+OcnABC7k3xATWgWAD9b4wvCB6kYAVjMH+qQb+8csAPF/v/TggDgFkA3q4dO+hegAFZuawz5hXSkgshplwrqqCWowNTWFrnLHkDdjTN1Oq3TgrUrYgjRsbccjtKpIL6CgwkOc4aMmwYEVqeCcaEKQBqdkkwyEGnmIELsPY+wDkagoXIRBJBUzgB/EMJgP6exnHgB40dOBfnkTAL849oArAUBGJCRB3KLjjnAfI5jYAfRWEoO+ygVEfzPA4LgydOB2Jwu6HqL1PEwFyAAKXEEogAyj9TMNNVHmOjMyPIcAUIq2INYqA/cMCWhgB9fuSF1hwFjImUKjw9EXygGYgcdAbLHjQOsV6vYYC8EYEkXgRRMSWGOHGUpAAqHg+ijjxKMdEd0cBjzrEYKoceehCBQGPO9ewsdjwGI0c1VqvkvzhlWcID+iYyBIVIJs2OYBMk7OGYle4xzVBbGiOIU8/1VhFMyUE9Yv0aAhxOdkgActAGAiYABWCyTigWYCUsA/T7pKAqgHOQ+jDHGNYhIMA/YWbJDuJ6T5bypkDiCcgL8aT+zjMTGIKcKw0BfhMkEbyWA4y4VwpAWAQLEzsCULhKcM5cLuhoGIFaRAtSJloLhcQWA8KEvgOdaCzA5AAGJxXjNJZfNAbdTm5HxfK86pKDmUupTBWliB6WMpgMy1l7KvZcrAry/llRBXCtFbhDViYpWyo1Vq0gpAIiJk4Logc0KICwvhWskZvB7n9wHCsZ5lopmEHJZwACAg3HAy/EaxACKTGVOaqUgA+r03p+x7hH1zVm1IPrOB+oDYY9cH0AXNLQKhY8B05nHkkAOSw0ayAqOTjQY4cgMC5DgBgFF+AkKQAjbQxgEdgn5IgIUjt3AXTdzqdHbJIEinAIUOGSAPUW3BOyUsLtTZe25HCIO+wI7L7HnMJOv265zw9V+bAQFwKQLdnOpwSJMBcV6PxZAD5QgLHTglZwbuuF7Q6ppXShlfyTU6DNZy7lhk+UCqFSKsVSEiWSrQNKmV4gVq/pgCtIQK0NUrUEFEZcpBcgXxAnGxI7AJ5PXBbkM4tB3zmIjUfKd5bQiBt2QoL8iBSmTSBWFPj/yNmoWjnICqlp2ByCgKhCIG96WcBdCvWynApMyYaaQeT4YgmKvJaJi5EmtOvQAKRsXDKhHT8nFPKdwqp9TcZNMwGk69WzUB9ONLQGStAxm9kHPYEESw6xOBnHdcF1CuxCAQFpeGVRjbOMB0yQ4LAOBLAKYiEp3IKm1ND2PEFnqPY4APgHPczJ5Q/6WQ9J8t109cuOY0hFw5exYvxd8chWZyXxCpZFRlz0jWz6xy4MgA8oRPIoI5igobZ9bnRN+lgNAiZSBrG7mU5OdYAicBC38xARBmAcwhBqDmhIQpgBU3Nrg9pq21pW2tjbcAtv0B2ymg7yprDSGVGd2bjlbkpqHmQLscgHXoYlbhOgzTyW4neOoDm0hfsaVuWNpRcgTIrTef1sgTRNQakRyNkGoQFuxNe3twH9xQig8A+MiHtAodPXeI0Jo1hzuXb+1wAHxwgeU4nhYCHqOs2H2UJqCEypSnSRgd2AcClouMGk5wK4/rWJCFQhvQxlywBBC/Bee5ugeqL2kTAVwABCTgOvlBkGN1+HLF3HP5e6akc3evOC7Dl3CxXA9dlgFN07y33nfG+YORNH8pSWNsfDXYxNeivxDI/sY3gYyelgGD1+ETKLwpKuim0SJILuyRK64QdYvk1fhQOVnvQOeX3MHz9GQvxfjNcGYBgWP5iFKhfcc1FvMAghKvDAcm3VHm9BpapVdqZnZO6ayw5pzBWvJue03JrznylWD67yPtqkn58Was2hTz9mhv240+Pzz/uV9gCb2vorIWYBhZa1FmL78OuJe624lLmmseZcUzbvLzmdJ3+ni7u1mVJ1klq/r1u/ulooJ6GZJ8kHsnuntTJLtGNFLLvLh7srmAKrqvsPpsFctrrrh2gblLibmbgQaQFbt/nbr/qQRbj1K7mgUrl7j7mQcbv7nAZNPeI+EgM+GUJ+qUMgKoncP2FShBgarhHfKoJ9ImDEMwFBkynAHIUxB9DCrhNarauYB9AxGJk+hENNODK8Mgo0CSLzOSALO0EGmXCgoIrCEgNqDLETPXJIkrI2tAFEGvhsiVmVgAPypD3IYDhiJiBFxZPShAnSvq+FgAYDIAmRVicBuzuQ7YADUvQ64swFUvWuhVAHK3sh+dSr0X4hmFKUa0yoW3Q/ynAAAsmYgIB+OVjoEAk2MeCGg8gOJGOMp6OGJMtMueLkEkCWFwBGpiuEFOirCwJINkp4boCcpkjer1lAFMriDxoMTMQsp9GIFMtDkIIoqECsIuH4nLsonigSupgkEEBCBEOBnqmIRPGAOoCyrBt0CsEKjccRmVgoTcRCKDkPAkImBCE6lhnIOdkEMDK0A0d0rHDRjem0ZGkcdDnIImBRgxpsiIXqpBkajBmytkRajymgEhjaihvanCf8dhnCYiVsGSbiUNNlkxmAMJnAA3kUFfNFCgiXtoRJjEFfKkOZgpuGByccJQTPg7oyccKkFYXVr5mfuruyZfCKQNMKcqtPrkakHydfJwGKQZhKUZrSSHvAR+gOPikSRScibqrBGidBudKaliQhlashnanhESc6jKqSfRuSS6ZSaVORiuNRgOBYBSbiHeC0FwSgC+JHv2KUEQNYImL0FGdYNYHoWzOKBzOoJKCYaLLwngPwmCEqFYZXLjKMJzKQtMOQk4U3PtMWG3KVHZGPBuGQL3DfIPMcGAhPFPHvAvEvCcEfCfGPNvIoK2QfB2avOvGPN2DKaqbfPfGPM/K/P3O/AoPcmAgIH/AAkAiAmAgkHaJAkuTAiufAkFGwvDgjFKJgmYXgLglmVYDmQQjYZqCgoWdyBInyOYYgUCDWMVC7HEe7BOAmW8FzMYbnO8CeQYC+SCGXL0AjFeeqCQuDDELABiMzNxLFMIJRIDIJMJHhHpBAOxPGnVGistHxAJGhImFoVkJJAgcsMBUsgpDxPFLQIlAwkbAVHmBlAzFlBZEXCOIxeOCVI+BbFVB3JvB3uJqPqhPrHKVSSNP5ONPASpg7GBKQAli9HBGmEfLkBRfgL5KUAdOIEgKAAEIoHYkIHgEeCAK4K4EAA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.dex.watchFlipOrderPlaced(config, {
  onFlipOrderPlaced(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.watchFlipOrderPlaced.md","from":5378,"to":5407}<fsm-vh3gqscxm4e>
type ReturnType = () => void
```

Returns a function to unsubscribe from the event.

## Parameters

### onFlipOrderPlaced

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.watchFlipOrderPlaced.md","from":5531,"to":5991}<fsm-vh3gqscxm4e>
declare function onFlipOrderPlaced(args: Args, log: Log): void

type Args = {
  /** ID of the placed order */
  orderId: bigint
  /** Address that placed the order */
  maker: Address
  /** Address of the base token */
  token: Address
  /** Amount of tokens in the order */
  amount: bigint
  /** Whether this is a buy order */
  isBid: boolean
  /** Price tick for the order */
  tick: number
  /** Target tick to flip to when filled */
  flipTick: number
}
```

Callback to invoke when a flip order is placed.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.watchFlipOrderPlaced.md","from":6094,"to":6315}<fsm-vh3gqscxm4e>
type Args = {
  /** Filter by order ID */
  orderId?: bigint | bigint[] | null
  /** Filter by maker address */
  maker?: Address | Address[] | null
  /** Filter by token address */
  token?: Address | Address[] | null
}
```

Filter parameters for the event subscription.

### maker (optional)

* **Type:** `Address`

Address of the maker to filter events.

### token (optional)

* **Type:** `Address`

Address of the token to filter events.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `(error: Error) => void`

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Whether to use polling.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`dex.watchFlipOrderPlaced`](https://viem.sh/tempo/actions/dex.watchFlipOrderPlaced)

---

---
url: /tempo/actions/dex.watchOrderCancelled.md
---
# `dex.watchOrderCancelled`

Watches for order cancelled events on the Stablecoin DEX.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.watchOrderCancelled.md","from":142,"to":5136}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"1aec0eda0f46341180a0b333aee616ad8d50c79358e60da62345f78224a573d1","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGcWC0fEVGQ1Un1Bl/KkGEV0nqIRnM06sxAAJkqCMwXJ8s1KNH5IASa34uM4wPsAHlSLBSGlxGBeDA5AooAAeI5ZAB8QQ6yVS3uSFE4WEczD0ZDgqRpwgAdCL41b8Lb7Y7na73fGAAoRqOkOBe4pKH0RPYHfBHE7DC6KNA3NB3R5eXJgcSRuDhl2WytpsgZl1umBQUpQCC8BAGfYg+CcBLsTjse3RJ1DuRbC0wS5oOBLsCcVQwTgAETOAA144bxEop8hkCA6B2sApSgADD+73KCwrAaKkGAthgYMlFDfA0DQLBOFcedSAgZhOAAcgAAU2JRmEYAB6GIAMQ79MV/Q8YExaDYPgpDUJvDDsPYGBsIcCw4DwvICK4P84z3GCEjghCULQ6icLomhMWY3IljiEtOAAXn/QCaBAoJgFyThogY4RUmQYS2AeeA0EsNAAF0KGUw8hmEApd1SJSDxUzhNOIth40YKADNScDIKCCJjJs9xclcCJcjE2JVg2StpJ4c0TETOhkz7O0BzXLMR39EtQ2slShH7B1EuHKBUhCHQ4FDOQICUKIpJ9Th0tspYIAUeMSqUIJEKy1dM1yxBENDVpIhM3ywH83IPzfEAjIfcMhmYUoAyUTgAFp0hLK8xpACaO1KNbIxGPcFrzSaCzgZaKAfACm3uUxuHnM1jAPNAIBCuAVgAIzgXhSEYJ7j248ij04bd62WoyygJPprH6L5pUQXpPkpAEDBTLLByS0cwSVFVBmGFxNUJHUkX1VEjUCEIwkiIphAkxJA0WymchYiyyc6UQQahjVwalH4mllOGmRLRVIWhNUscqHGOV1bwUV5Qm8CCLA4JwDgMCiTL4uy9r3XynrUgRlWkdy+NuEK4rSq1uL0xy7MABlSvKyqiAgZyxwnKcQEdN0nqcABrQ97osO2PePdZ8EUTgnSXFXOEYPdeHNkcryZ8UoYhRl2YaXpmmoVpueVs21ZHPmkEqAXMdGDVcb1CXDXRAwZfzEYok1qqTIylWAEk8s4J7kgsNAAG4/LFN5egAVlsCGOcLjP/kCHr88QCfVWLvpxlFvGK/mInNoLKJGpNkFEZjqB4ytpQB/0Yf05TmVJ7lMxStn+eMdhJANSHsvxZ5SvjXbTtu2PWqFFyEQSQZM4B1RgEGEwYDHaTjwA8IOnA3z/xgG+TgzBoArAUGGOCRBnJznEJwOA+RMGwCeisJQSgLCzSQYeBwXBI4EJYIwDcpBvY0JgLkAAUuIIBABlN6jAsAU1AZgyMzI8hwAQrLYguCoAdwwJaGAT0O5wXWHAaM8ZAqPHgWgqAGDjx0AsnuNA6x7pdhgLwRgSReBFExJYY4MZNEACoeAIKOMI5B0QNxwD3OsRgqhUF6EIFAPcj17Ahz3IgyB9VGqeTfKGSJwgwHxjIHBUgsSQ5gFkQk9xsV7jpNUFsNqHdjwrDUbIu6lp3o0FYU6eRAA5aAMB4wACsQknEAswDRYBnGXSUCVd2cgEFIJQYxCQmYGbJDuCOVh6wqnHgqcgN8UiXTePjGIccKw0BvgMkEdyWAYyYUwpAWArT4zsCUJhcck5MIbhoGIOaRAtTxloJhcQWAsLLPgIdcCzA5AAGJPnePWRATZ9dMm5EWYCw66yUnbN2RBfZiBDnHJgKc85lynY3KAvcx5lRnmvPeZhKF8Yfn/KhTC0gpAIjxk4HA48fSIADKGVEjx0cDyfVWGUy0fjCCbIjqxShbCEEosQMM1B6D6qaIAPqOMcfse4lDZVStSHSzgDKmXUMZc08xaBEJ7i2kEvckhjyWB5WQEBkcaDHDkBgXIcAMDOnwHBSApTODmH9kKp6Ki1EsO4DmFuRig7yIAmo5gT0FChkgCw41bD5FLEtfWG1uRwgOvsM6kFe53XHlCIMiAR4WENNgC0tpAEOyHU4DwmA8z4GLMgNUoQWCJxfM4C3TC1o4V7IOUcxpaKdAYuubc3SDynkvLeR8uCKzvloF+X88Qc060wDmkIOaUK5qCCiAuUguQ0EAQjokdgzBNxCC6bkM4tBnyYNKYK366rQjMsSQoN8iBNHDVaUFB9TSYmISDm6e6JjSByCgIhCIfcwCHM4Dmd69i3JZj/ewQDoYKnAs2e+nJX6f0lU4AAUiYqGRC/7APAdA+ByD3cYycAw3BgDUBEOmLQBstAqGkkpPYEESw6xOBnEpaxxCuxCAQH2aGUBBrBXu1kQ4LAOBLBAYiCB3IJGoO7j+txlhnY4A3mzZkghEheBexrD2JD9GUnPrA5hWyXHUl7H44Jgh8FAmifEOJt5UmRzybM7ZEOXBkDblCK5IeUMh5uY855it/DBHxlIGsFuWjI7VgCJwNjjTEBEGYInDUUNCQBVM8Fwp1onrav4BFqLMW4BxfoAlkVKXlTWGkMqTLQWPOFJFd3Mg7Y5BEonV8zCdBzGbNxO8dQUNpANdsoU7zQC5AGTmrM5zZAmiag1CNlShSfNyD4e9QRFWkstfuKEDrTbvHddoL1m67xGhNGsFl8DjWuDNeOK1vbh6LDdYm1KsQUGUgaghMqTR4lODf2PDJXjTDBlXEZYxIQiFQNINyWAIIb4TxOl0CwgAJMAAHrgACEp4kdkEx2+OT2XSPQZx8oc1uwQecDB53RJYBseI7J6QTHtHtP2i3WAYamiz0XpKYQ5QQq3xuLASg3gXiHFgCGh+N9zpgogq4DJNoPD2kdh4XZwg6xPLQ+Cik8KivlfMFV5GdXmvUNcGYBgIXmCZLsZAUky3MAghy9DCkwn26LcsoaqVZqlHLTwZk8RszxPLIUdg776jLO5du/t57pq37Q84a6khAj/ugtB/Iz75PEeUNgHN9HljaSbcWZ43xiAAmiq2ZE/zsTFHZvSeA4ThTZGNJF9IFZ0vNnhP2ar45mvknFAjiMqwlJv3goA/CsDt0VPwe06h1Hj3mw8kI9x6j9HHYYBY9J8j/HDfA+KfIwz5HnAKeT+pxDunm+8cs+Hxzj815bxIHvGUKtpRkCgLuC6HZnakWYQoaoZ68YYhmBu0Tk4BgC6Jw1GVMJcV8VzAnoaIP1i0IhRogZXgz5GhJQ6gOYKRM52gWVZ4h4i4n45435pgP515pYDVoAoho8Yk1MNMAB+VIWpUMeMVggTG6UIPaMtJgsADAZAAycsTgO2ZyBLAAal6CXFmBKkcyQKoCuWdjT1YTfGQy2W5X8XY26CaU4AAFkMEBAXxs0dAVhIx7EikOVwxvERxQxfF/EjxcgkhCwuBSlplwghVZYWBJB5E6DdAMlZEc0Q4oAoA/FcQ71nC/CQlnoxA/E+shBAFQgVg5xCEMJmFWFIVFMEgggIQIgO0EVv9D0wB1Azk+1ugVgXl8iV0NNQD8iIQOtu4Eh4wIQSVp05AssghfpWhjD6wjVd1/CLCuUFk3w+s5B4xN1D00BYlP8EUu0UVe0Ll5CsU7k0Bh08VR1CUhimiZ0hjRithtiliepZMT0b83xpc/sYg1h5dOAh4tcECv0zjjhUgsMgNQw7i0Ad8IM99UgXjUgCDWEVCmNokvdEIvjE8Xi3i09PiQV7jLiWc/ijjNFK1jxFl1jdiJj4VIJpie1Dp0V5jB0cUR0CUsJ1jSU/ktiD0diyS9jCoN1Fwd1jwLBdjcQ44M578UAHw+cXRSgiBrB4xegeTrBrBkD45B51ACCx4GhGRYZAhGp8DCD1RehS4V5y4yC+QN5a4yB65CorIm4w57Q25UhO4KFjhQNXBT4l4SRMCGgJ5JS8AZ5UYrBRSF4iCIR2RJh34DRyDq4pF5ZMAlZW524DTu5TTNRrAJ5L53guZAhlwyA24ZSmRH51RKhegSDuR3SVTFhgogRKx8obYhD7YUZgYE4tQL4LTfhr5uZMyQRZ5ehR5HT1RrBXAgYYhYAMR6Z2JIphBSJvpeJ+IsItIIBmIfw2IJlZouIeIkJ4x4CshRIZdyYQoUxwoOJopaBYo94dYD4UoaY0oTJs4Epc4oACpbwjYypG4bIVIYcv1Wo2V1wRxOpupCoijdSoAssVJ+pBoJdssLYgJSAhM7ooIUxKFcgKz7BPJSgtpxAkBQAAhFBCEhA8BdwQBXBXAgA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.dex.watchOrderCancelled(config, {
  onOrderCancelled(args, log) {
    console.log('Order cancelled:', args.orderId)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.watchOrderCancelled.md","from":5222,"to":5251}<fsm-vh3gqscxm4e>
type ReturnType = () => void
```

Returns a function to unsubscribe from the event.

## Parameters

### onOrderCancelled

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.watchOrderCancelled.md","from":5374,"to":5506}<fsm-vh3gqscxm4e>
declare function onOrderCancelled(args: Args, log: Log): void

type Args = {
  /** ID of the cancelled order */
  orderId: bigint
}
```

Callback to invoke when an order is cancelled.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.watchOrderCancelled.md","from":5608,"to":5696}<fsm-vh3gqscxm4e>
type Args = {
  /** Order ID to filter events */
  orderId?: bigint | bigint[] | null
}
```

Filter options for the event.

### orderId (optional)

* **Type:** `bigint`

Order ID to filter events.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.watchOrderCancelled.md","from":5940,"to":5985}<fsm-vh3gqscxm4e>
declare function onError(error: Error): void
```

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Enable polling mode.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`dex.watchOrderCancelled`](https://viem.sh/tempo/actions/dex.watchOrderCancelled)

---

---
url: /tempo/actions/dex.watchOrderFilled.md
---
# `dex.watchOrderFilled`

Watches for order filled events on the Stablecoin DEX.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.watchOrderFilled.md","from":136,"to":4993}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"31f40edcd3e0cb0dd5299ece3d0406a3ef9a70aba1beaad5bca49c399a7dd538","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGcWC0fEVGQ1Un1Bl/KkGEV0nqIRnM06sxAAJkqCMwXJ8s1KNH5IASa34uM4wPsAHlSLBSAAxRhyBRQAA8RyyAD4gh1kqlPckKJwsI5mHoyHBUjThAA6EWxq34W32p0umBQWMABTDEdIcA9xSUXoiewO+COJ2GF0UaBuaDujy8uTA4nDcFDvBglvLKbIaddpSgEF4CAM+xB8E4CXYnHY9unztdnBglzQcDnYE4qm7ABEzgANWOG8RKMfIZAgOhtrAKUoAA0f69ygsKwGipBgWxggaUwfwaBoFgnCuNOpAQMwnAAOQAAKbEozCMAA9DEn5QS+mJvtuMCYiBYEQdBcGnohKHsDAKEOBYcDoXkmFcO+MYbqBCTgZBsHwSRqHkTQmI0bkSxxEWnAALwfl+NC/kEwC5Jw0SUcIqTIDxbAPPAaCWGgAC6FAyduQzCAU66pNJW6yZwSk4WwsaMFAmmpABQFBBEOmme4uSuBEuT8bEqwbOWIk8OaJjxnQia9na/ZLhmvpFsGJmyUIfaOlFUCpCEOhwMGcgQEoUTCV6nDxWZSwQAosbZUoQRQUli7pqlUHBq0kS6W5YAebkj73iA2mXqGQzMKUfpKJwAC06RFsePUgH1balDN4YjBuY05v1eZwJNFCXp+Db3KY3DTmaxhbmgEC+XAKwAEZwLwpCMBd3YsQRO4rmuk3aWUBJ9NY/RfNKiC9M01CtACBhJklA4ZoqkLQmqLiaoSOpIvqqJGoEIRhJERTCIJiT+uNuM5LRhlY50oiff9vSEvIdQ/E0sog0yRZQzKTKDMMcOVAArIjeooryqN4EEWDgTgHAYFEiURcldVpU1qRg1LEOZtwGVZTl8vhamKWxgAMjleUFUQEA2UOI5jiAaShHIF1OAA1tup0WEbtvdus+CKJw4hbvOZCcIwG5JHVx5k+K/0QrYv2070jKUgzkta3VzOIJUMPs6MGo894fOGuiBhC7mIxRHLPYguD2sq2eYpvL0lQp5HDR17HgRNUndeqmnbKZ9MPI58a+erYXnAVRrpeK9retKFX+i9JzEdSrTMfA4EFWt6nsJIBqGccrqWc9/MgStu2nbdiVCi5EQkhY3ApUwAGJg36bo54A87ucPep8wPenDMNAKwKCG4EiA2SnOITgcB8j/1gBdFYSglAWGGh/bcDguD+zASwZ0l8TpIJgLkAAUuIC+ABlG6jAsA42vv/cMzI8hwEgsLYgwCoCcAuhgS0MALrMPAusOAkZYxeUeK/H+UA/7djoIZDcaB1inQ7DAXgjAki8CKJiSwxwoz8IAFQ8DfkcChn9ohyHCBudYjBVDfz0IQKAG5zr2E9hud+98yoVScveYM9jhA31jGQcCpBnGezAEwtxuiwr3F8aoLY0QvbMO7CsHhTCsHrFujQB2fjWEADloAwFjAAKysScL8zA+FgE0ftJQ2UbZyDfh/L+VEJBgC7CTZIdwMzJISSY7sWDkD3noV2OA60xDDhWGge8mkggOSwFGJCSFICwBybGdgSgkLDlHEhAxNAxAjSIFqWMtAkLiCwMhbp8B1oAWYHIAAxIc3p/SICDKLv43InTLl9LQPaUgwzRmAXGYgSZ0yYCzPmYss2KzvzrM2ZUbZuz9lISebGE55ynn9K8REWMnAX7dlKRAcplSHF6N4JE+6qxYmWhMYQQZfs6LwOwW/X5iAqnf1/mVfhAB9dR6j9j3HgayplqQ0WcAxVixBmKsmyLQFBDcC0LEbkkN2SwJLfZLH9jQY4cgMC5DgBgOp+BwKQBiUPRgLsqUXS4Tw0gPAswAEkJHu1YZ+HhzALoKGDJAU10rsGsIVWIWsKrcjhA1fYbVNyNzmANVbOcO5TXpNgNk3Jn42zrU4IQmA7TX6dMgEkoQACRxHM4OapC1p3ljImVMjJ/ydCAuWastSGytk7L2Qc8CPTjloFOWc8QI000wBGkIEaTyRqCCiDOUguQf6fj9okdgzAti4kKbkM4tAbz/xiZS56/LQjYvcQoe8iB+GdRyd5DdmSnFQXdi6U6UjSByCgFBCIABuXIkzOBZluqo+yMBT2WnYJe4MWDrmDP3UEo9J7sqcAAKTUWDFBc9l7r13rAA+p9FgjKcCA2ez9UBv3SJeTctA/6PFePYEESw6xOBnFIN4qquxCAQHGcGa+ErKU2yYQ4LAOBLBXoiLe+9SFH3PvXCuMjs52xwFPN2L2TDyi8HtlWepP6XleO3XB7jslSPeL2FRmjYCILmIY+IJjezWMZi42ZWS4TkCrlCHZTm/1OZGeM+E4ht0yGxlIGsc1Aj/aVgCJwQjGTEBEGYGHDU/1CSeUU8Zz2XBrQXWFfwZzrn3NwE8/QbzNL/PKmsNIZUIXbNmXCTSxDZBWxyGhQ2o5SE6CyMGbid46h/rSByyZrgZmL5yE0iNBJ+myBNE1BqBrEWXqhAc6QrgPnYCIAK/cUIJWs29PK7QSrR13iNCaNYULD67NcHy8cQrU3J0WHKy1plYhn0pA1BCZU/CBKcEPt2USUFdhLk4FcTFVEhBQVgx/YJYAgj3l3F7XQpqAAkwAbuuAAIScD+8oMgYP7ycbCwhl9kP/u+wey6J7L33FgAh1DgHYOMNgLk2Rjqj5+FzoXdE8BygqX3h0TfL+vADG9IUyT+8e66k+WwwFNohC8ltkIVpwg6wnIfZ8l47neheexuYAL8MQuRf/q4MwDAdP/6iSI1fDxquYBBGw8GJFsHh0q5xeVHKVUUMfovex2D8HeNRmQ2+4DUH0PJOw0b7XpvKrHsd6dMDDVoLO5g0ZxHSGLfO4J27sAyuPf4Z8RrlTBH7vqcypp+j1PGPIc62x698PbeIft8gBPpA1MQGoynuj2n0+6czyxxQGZtLJK8ZdnyN2Ar3ce89i6r2wDvfdybzYITfso6ByDtsMBwfI+h6QWHufuMh/t7j1HHfMfX2x5PvHBOm9gE6ieSuKBLw8NwFQZA187hdhGYW75SE4GqEurGGIzBi0zLgE/8iDrMVITBRC8wF1SIHujREN1O9K8NPI0D9PPOSPTO0DiknJzGvOqNqNvEjNnPvILBKtAFEB7k4kJiJgAPypBewYDBixgkHUZHShArRxoEFgAYDICaSlicBGw2TeYADUvQc4sw2UumgBVASy5s8+yS94v6QyxKpiRG3QmSnAAAsn/AILeKJjoCsOGKohEluASqGL0hmMGMYqYjuLkEkPmFwDEs0uEFSsLCwJIKwjgboH4kwqGrplACYriGusYXYVYpdGICYlVkIOfKECsFOOAohAYqah0l0rxgkEEBCBEAWp8lfpOmAOoHMmWt0CsDsvET2iJi/vERCCVohgkLGBCLCs2nIKFkEM9K0EobWFKqOqGhoUSqEVVnILGIOpOmgM4hfp8kWr8qWgsnwcCmsmgNWuCrWlCo0UUS2o0S0VsFMYMU1BxjOtvo+OzldjEGsFwKJJzKLv/keqsccKkCBlesGLsWgLPjxvnqkMcakHAcksIbho4mblBJcf7scacfPhcTcnsZwNcbJgMjhosfePwomt2J0mMTMe0R8kBF0SWutACn0ZWqCjWpCshGMXCmcpMROtMRibMRlAOoJmRGOjMdOrvueAfhYF2KUEQNYLGL0NSdYNYEASHNXI0CSDTA0IvP8MvDlLAfAXDL0FvJMLvAaKgXnPNHmEXBlCPDaGPEHBXKYCAX0ISBqNTGSEgI3EvHgC3GCEqHAazCyHDBqNzEgbzHvHyNAdjL5EmGlAbIwcbFAFPBvBqOAayb8EDByYCH5CCEnL0BHO3OvDYK4O9DELABiMTAxEFMIHhI9GxBxMhMpBADRK+PRA0sNMxKxNBLGH/lkHxBzuaUCP5KJIxCFLQGFKPAnK6DFATHFLpPHJFHVOlGeGrLlIVLpLJJ9kenLP7nMS1C5O1GAEZjrN+KQLRidMBEmPArkHmSCE5KUAtOIEgKAAEIoOAkIHgOuCAK4K4EAA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.dex.watchOrderFilled(config, {
  onOrderFilled(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.watchOrderFilled.md","from":5079,"to":5108}<fsm-vh3gqscxm4e>
type ReturnType = () => void
```

Returns a function to unsubscribe from the event.

## Parameters

### onOrderFilled

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.watchOrderFilled.md","from":5228,"to":5537}<fsm-vh3gqscxm4e>
declare function onOrderFilled(args: Args, log: Log): void

type Args = {
  /** ID of the filled order */
  orderId: bigint
  /** Address that placed the order */
  maker: Address
  /** Amount of tokens filled */
  amountFilled: bigint
  /** Whether the order was partially filled */
  partialFill: boolean
}
```

Callback to invoke when an order is filled.

### maker (optional)

* **Type:** `Address`

Address of the maker to filter events.

### orderId (optional)

* **Type:** `bigint`

Order ID to filter events.

### taker (optional)

* **Type:** `Address`

Address of the taker to filter events.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.watchOrderFilled.md","from":5965,"to":6010}<fsm-vh3gqscxm4e>
declare function onError(error: Error): void
```

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Whether to use polling.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`dex.watchOrderFilled`](https://viem.sh/tempo/actions/dex.watchOrderFilled)

---

---
url: /tempo/actions/dex.watchOrderPlaced.md
---
# `dex.watchOrderPlaced`

Watches for order placed events on the Stablecoin DEX.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.watchOrderPlaced.md","from":138,"to":5195}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"2279834665a0cfd3fb844984d371abd87f4fb79413544bf125a15d46b41d1004","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGcWC0fEVGQ1Un1Bl/KkGEV0nqIRnM06sxAAJkqCMwXJ8s1KNH5IASa34uM4wPsAHlSLBSAAFOROGBQAA8RyyAD4gh1kqlPckKJwsI5mHoyHBUjThAA6EWxq34W32p0uqCxh1hiOkOAe4pKL0RPYHfBHE7DC6KNA3NB3R5eXJgcThuCh3gwS2llNkNMdqClKAQXgIAz7EHwTgJdicdj2kPOjvh46cGCXNBwWdgTiqTsAETOAA1Y4bxEpR8hkCA6C2sApSgADJ8b3KCwrAaKkGBbGCBpTB/A0DQLBOFcKdSAgZhOAAcgAAU2JRmEYAB6GIv2g19MXfHcYExUDwMgmD4LPJDUPYGBUIcCw4AwvIsK4D8Y03MCEggqC4IQ0i0IomhMVo3IljiAtOAAXk/b8aD/IJgFyThoio4RUmQXi2AeeA0EsNAAF0KFknchmEAoN1SGTtzkzhlNwthY0YKAtNSQDgKCCJdLM9xclcCJcgE2JVg2UtRJ4c0THjOhE27O1e0XV1fQLYNTLkoQe0daKoFSEIdDgYM5AgJQohEr1OAS8ylggBRYxypQgmg5KF3TRBoODVpIj09ywE83InwfEAdKvUMhmYUo/SUTgAFp0gLE9epAfqW1KWbwxGTdxqzAaczgKaKCvL863uUxuCnM1jG3NAID8uAVgAIzgXhSEYS7O1Ywjd1Xdcpp0soCT6ax+i+aVEF6ZpqFaAEDCTZK+1dRVIWhNUXE1QkdSRfVUSNQIQjCSIimEITEn9Ca8ZyOijOxzpRC+gHekJeQ6h+JpZVBpkC2hmUmUGYZ4cqABWJG9RRXk0bwIIsAgnAOAwKIksilL6s4DLz1ScHpchjNuEy7LcsViLU1S2MABlcvywqiAgWzB2HUcQDSUI5EupwAGsdzOiwTftzt1nwRROHEbc5zIThGE3O90xPcnxQBiFbD+unekZSlGalnX0xZxBKlhjnRg1XnvH5w10QMYXsxGKJmpMvTEulgBJNLOEu5ILDQABucvOGYcQ3dIVIH2sWgABJgDEO7lFcB9m7MuTTrdsAu57/vB4sJQR7H8zveYCA1jQVI66UBvl/MwOACFbK3iAyu/MA94nxheHt1IwBWZgHtIMfXDFN5ekqNPo4aL/48CZqU5f1VBnNk2dpg8jzsaQua1i6cEqlrEEENdYGyUG/fQvQuZRylHTOOINAiVUAenWESANRZw5LqHOED5iBGbK2dsnZSoKFyEQSQ2M4BnwDCYM+5sRx4AeJ7TgD5GEwAfK3aAKwFAhggkQWyk5xCcDgPkSRsBLorCUDvZQbCz47gcFwQOCiWCMGdKQJ2OiYC5AAFLiBYQAZVuowLAuN2GSPDMyPIcAoIi2ILIqAtcMCWhgJdWuEF1hwEjLGbyjwBFrygBIzsdAjKbjQOsM6bYYC8EYEkXgRRMSWGOFGSJAAqHggijjOJEdEZ0cBNzrEYKoVuehCBQE3Bdew3tNxCK4eVSqzkHzBk6cIM+sYyAQVIL072YBfEDPKeFe44zVBbGiD7WunYVhhN8adS0d0aCmJ9v4gActAGAsYABWLSTjfmYBEsAxSDpKBynbOQgjhGiOohIMAHZSbJDuK6Ux6xtmdk2cgB8XiOzVNjGIIcKw0APi0kERyWAozIWQpAWAZzYzsCUMhIcI5kLOhoGIUaRAtSxloMhcQWAUKgvgBtQCzA5AAGJqXVMhevNAJdJm5GBcyjakKRmwvhUBRFiBkWopgOizF2KLZ4p/IS4llRSXkspchHlsY6WMp5Xy0gpAIixk4Pwzs9yICPOeV0ipvBlkPVWOsy0dTCDQoDvRBeZjBFisQC8sRsTyqRIAPqFMKfse4C9/U+tSAazgRqTXCNnJdE56S0DQU3ItJpm5JCdksHa/2SxA40GOHIDAuQ4AYA+fgCCkA1lwMYG7F1l0QlhJMdwB0lckme38V+MJj8FDBkgCYtNZj/HZrENWfNuRwjFvsGW9em5zDVptrOXcJjDmwFOecr8LYNqcBsTAQFAjgWQB2UIKRw4aWcErsha0AqEVIpRUciVOgpW4vxepIlJKyUUqpRBMFtK0D0oZeIUa+6YCjSEKNHlo1BBRGnKQXIa8vwB0SOwNux1rm5DOLQW8ki1nOpepG0IprBkKAfIgSJXUzk+QI8cnp0FPZyBypadgcgoDQQiGPZFnAHRD2MpwGjdGUmkEY8GTZrLoXkZmVRnjZ0ACkNFgzQT44x5jrHkLsc41GbjMBaNnXk1AQTqS0BQrQKJoZIz2BBEsOsTgZxtWmegrsQgEBEXBnYcm51dtfEOCwDgSwTGIgsdyGxjjDdNwmZMa2OAZ5Ow+18eUG++kXSmK1Z3fzym5JWdGXsezjmFGQUaa58Q7mKVeddMlle3suDIDXKEeyXMAZcxKyvRZdi7qONjKQNYlcomB3LAEOWbqiDMAjhqAGhIvJgDYw1rg1pY3xta+1zrcBuv0F60cxA/XlTWGkMqEb9XzKLLdQ3MgzY5Aqs/TS5CdB0nQtxO8dQANpA7bkosirLC5BaVGv8wrZAmiag1A9srr1QhNYcVwMzK2Dv3FCCd491Tzu0Eu8dd4jQmjWFG+N3bXB9vHEO5DtuFhzsvZ9fPZQmoITKkiYJTgtDOxiVs0Yp5VxjXUSENBMewjZlgCCA+PcPtdAmP7lT1wABCTg3PlBkEFw+PzY3lOBfyakUXvPOC7Dp5wBnddBlgGFwr8XumFH6ZGZ1J8kS0MYdWYozRL0HxlLPqI3gVSClgENw+MjHzfJssCm0GxFyWw2Jy4QdYzlWe+RGR7vQXu13MF9+Gf3gfRNcGYBga3kixLma0eVJPMAghsuDCMqXMHE9moqrlaqEn6P8Z80plTQWHIad4wxnTpi2X54z0Xqq1Ha9SZkzBbTimSuy646X7Tuum9gATy3kLZmYAWbSzZuzp8svOdy5otz3HPveeY1LgLqmlIz87krzLWVssueX/l1fnnFCuh0qYg3jvXc40py2anMFle0dV4zjXLPm+F82HMrnPP/b86P5C4i7/6kAS6b4y7b4gFi4mIv707v7sKa7QG86C66435dSnjnhICXhlDbqlDIDsJ3AdhwpXoirIQ7yqBXSxgxDMA3popwB0EUSXQPLITyqKrmCXRkQUYroRA9QfSvDoKNC/TYLkgMztBmopxcxELqjajkLIy5zUJCzJrQBRAt49JhYRYAD8qQeywYsY+hDmx0oQq066OhYAGAyAWkxYnAJstkcsAA1L0LOLMDlPlrwVQDipbP3kkmdA+MJjCravUuZt0McpwAALISICB3iRY6APzVibgWrbhWqhjVKujBi1L1K7i5BJC5hcBrK/LhAuoiwsCSD+IaG6ATK+Jzr5ZQB1K4h4b5FVEtJXRiB1JXZCDMKhArCTiKJITGKmLcqcYJBBAQgRCXpCpkFtxgDqAYr3rdArBkpTGgYRYMFTEQgnYNwJCxgQhqo/pyCjZBAvStBxH5LexwZzopE2pAoPhXZyCxhQZIa9IkFCrXpip3pYqeEyoEpoAvoKpvrKq3G7G/q3EPFbCgk/HNS+YoZgCkZwBx5FAbyBRcxB7cFUYxAbypCSZMbBjonHAQFV5y4InHCpBSEJb6Yj5s5onrzEmNREnsqV7eGpC4mbycCklCbkkiYwlG635bqdjAqAnglPGCrASvG3obSSqfFPpyqvpKooSAnqoMogmIZgnKkQmZSQYziwadgWDgm4ihzAxYEoBXjm4dilBEDWCxi9CWnWDWB8FhzvyNAki0wNC4L/D4K5SSHSHwy9BkKTCUIGiKEFwLQ5glyZRlzjyzhVw1zby7wtxtwdwzx9wDwnALxLwtyTyKCJlzwpnDyjwtwtjUkskxnHCXwBxwBHzRmnwKA+ylkCA3x3wPxPwvxoJ9CEgag0xkhIC/x4J4AAJghKhSFswsjwwag8xyF8xUJ8jiH35AiljpRGw2GmwDj2n6CkLCHOm/DAxumAj+Qggpy9BRzALEI2CuAfQxCwAYgkyMTBTCD4RPTsScQoQqQQC0RvgMRfIjQsRsQwSxhcFZD8R37LCzkgiBRMShS0DhSILKypSxSEzxR6SJxRTpjyyH6VRRDFRySUnF7QSly0mQmtSuQdS35sZ6w/ikBOanQgRJgLy5DAX2DOSlCLTiBICgABCKCKJCB4AbggCuCuBAA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.dex.watchOrderPlaced(config, {
  onOrderPlaced(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.watchOrderPlaced.md","from":5281,"to":5310}<fsm-vh3gqscxm4e>
type ReturnType = () => void
```

Returns a function to unsubscribe from the event.

## Parameters

### onOrderPlaced

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.watchOrderPlaced.md","from":5430,"to":5823}<fsm-vh3gqscxm4e>
declare function onOrderPlaced(args: Args, log: Log): void

type Args = {
  /** ID of the placed order */
  orderId: bigint
  /** Address that placed the order */
  maker: Address
  /** Address of the base token */
  token: Address
  /** Amount of tokens in the order */
  amount: bigint
  /** Whether this is a buy order */
  isBid: boolean
  /** Price tick for the order */
  tick: number
}
```

Callback to invoke when an order is placed.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.watchOrderPlaced.md","from":5922,"to":6143}<fsm-vh3gqscxm4e>
type Args = {
  /** Filter by order ID */
  orderId?: bigint | bigint[] | null
  /** Filter by maker address */
  maker?: Address | Address[] | null
  /** Filter by token address */
  token?: Address | Address[] | null
}
```

Filter parameters for the watch subscription.

### maker (optional)

* **Type:** `Address`

Address of the maker to filter events.

### token (optional)

* **Type:** `Address`

Address of the token to filter events.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `(error: Error) => void`

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Enable polling mode.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`dex.watchOrderPlaced`](https://viem.sh/tempo/actions/dex.watchOrderPlaced)

---

---
url: /tempo/actions/dex.withdraw.md
---
# `dex.withdraw`

Withdraws tokens from the Stablecoin DEX to your wallet.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.withdraw.md","from":132,"to":5739}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"023ba6e6ceee483261ba554408e01773012c9493ad2b5216c866b9cc71fec07f","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScAGYArmD8gmCcWJJwMACqYIxocEFEobEwiJxipBZKFJywvCyhcCVgscwARmQRJS2MShZoADrZrOxcqaTpWTmmUBC8CAYAsrFyAljm8JzipWjlypykMFj76WASxskQ0RucTa1knC0YVz0kyXRsliecF/fhMJwAjNZOEFAW8hIo0BEAHQDAYAWk4ABEZg1OPg0GgsA0APTYoiMGDMKFwfDY6azbGxATmATwbGjcbZXKUajiJRzZDIEB0cSsBQslhsDicYApNKZJlwTiuGKkCDMTgAcnxhMVsLADIlkyCioALAAmayKqrSCIDXGcA3Wa0221gEAAXQdom0+l1mjMihUakQgK0kl0gU1E2Z8gsVn+dgcpCcNHIiGk7k8ODwhBI5H89DwITCkU4vBMXALYGi3RKAGEhKWlANBcN81XuiyxJJ9AAOSOe5SqJAANn9Oj0eGL1ZZ5ksSH1UccznjiY81C8qd8GeoAWHhb2MF4MEYWDQJQAKjHhLGkgAlbe7/cs8lzEDH8SnxJCLc7vdoKHN11If7/ACs8hej2iAetogZ4Ps743mGE6ILq04xrOSBtkmi4pgYaZ+GuWYGHWwpGEkpgtlIvoAMxkUB3Y+mBAZDgYhEmGO4ZIAhID2DOcaTr2aGYBhPjpiyNC4SA+FcLAtDfq2v66p2CjUUglGsoOgQScxcFsRxSFcYgZG6rxS6YSuQnrgYcQJGcnAAO45PgUAxlZADKGAJAAPJWJbdAAfEEI5lpwHnVlUoy8noZCooxwhQhJUI2ao9niE5Lm8FCAAKjjMGFYzuY2SheR0nCpXKzCMOkrnAAMnBVW+14Hpwj7Pmcl7QWgADcAyuF5AxgKFcCpDu1m2QlSUJLeKJ4AA6kNDlSmgEAANaKFK0TFZwqh/IiACiAAaa0QGt+B/LwoQKKQipSlZJ16DCYADAAchANBHvgpWcK9mxwMl+BypAsRSmer6qOIXCXZMMTsAdfzbE+cAA8kc0DG0b0JHIsSwFAXzJJsLRyDM833DA0TsH8+xoLEpDZLsmxHO86Rfv67JIJy3K0Lyqy4FQAAG3O5LWQzCqKvD7MDMCBd0VTopi0qyvKSoAAKXUoJXYgW+xqoMQpcKKNBDNLK2y4qCtssrqswCrDgWHA6tiSKPAvsIeurYbism8T2I62w6sDMWYgNp5SicAAvPmws0GLShBBVyT5hbwglMgHsQIe8BoJYaDOpVa0nn1wyolH1WcAnhJsFCjBQA6JSS1gQQRBQmfuB1Zq3Qkm5HEsXDB4l4g5HbZxwNFdCxdNiXOQkvm5VU+cbMwEDxHVgLWGAdfR3Ni1gCUirWLQhopVCUJ/sajcDNznOOhQXIhcwLJ+QHCLh1+zoXxlLKX1lUoIulMaZXG/dn1ypPk2ECyQ8h0s4wzhjVD8GwwAYxgC8cSwNxAP2dCAEi+h/i6kAl2b0v4pzKQggYOKdkHKj14OpKwmloyxhcLpVCC4+LeCwquYSgQcyMHCFEH2RZcoVlynzTWftRwumkr6f8bYqI4MQP2fB9F2K5XIaxRC1D4z/n+AZfiTCTIiSCIcCAOAOAYCiLyWeJxOjdF6FJUi/x1C2GwSBaR4FZHGLngoxAWCtLKMnOoxhxlMysNCOwvMwZJT5EKMULYOxKjVG3HUOQqIbhtFIAVLoPQTj8PrMEyYY1Zh4EWMsPcax/oRIqFuQ48AITAySF8S4mwEl3AeE8RgLxOBgg+Fwb4LRfgAiBCCawrSITQnVAiZEsxK4YixIgXEKoiQkjJCiSk1IcgEjgPScUIZTASEZigLkPI+Qc1EvzLWYoxhalyI7A20yvYajWSEvUhpjScFNOabElpDS2nefaJ0wirHqHEXYn0foZFBhuVk2CVh3FUOQr6aw3jlyCT8dmXR+jMBRFXooEofQQBbx3u83FeL8UEusP8TFlj9CGjwfJSRWDHGBDRfaMFfYlFQv1LCoy8KcKBB6plPqTgjomAgAoAYBRSB+zgAK8JHkxX8ioHePAIC/icx9uKzmnAZ5QCWH8XR+JYBFLgIKBQ0SWixCUKkgOSqDVAy4K9PVJU5CSD2pDAYAApcQBRHJCygeav4mUOLZDgAqLVZcYAYwaVZGALR7hyisukMYN0BjytVdADVLTaCa1mlZfafUYmll4A2IYbSGjqgAFQ8E4JzSVyr8x2rgBdWyqq9CECgFKOAsR7AbClIq/lCgoS4wjhETmVRO3CHFVCMgcpSA1xVU+DGQ6pUwFipIMAk6DrA3zE+AmnA/rBodVZcoNAHVPkeA9WAUIABWzbtgwF5DdEt3BOBKFxp0uQZavUqsthIBIfL/bk23XNaye6ob7WQJzXRO4a3EjQNMKknMHRBCrjibEkBYDnqhOwJQcyKR2poGIOERB9S6ihLQbE4gsCMHpHKMD/d0TMDkAAYlA/AGtkHZ6QmgVAAYwGGPgbELAUgpAYNwfGQhpDMAUNoYwysrDKdcP4cI8R0j5GZiMahNRujXGmO8aSVCeqoCH0QCfS+rtMAVXHWSEjLdGMiEsbeockp60y0icQK+xN6ru3qgAPpFqLRNRdFQvPueen8PTBmvVfBaKe7caBzr1tUNAf6+xri7nWiKn2pUaAnDkBgAYn0EjfSELPKU5hFqQ0jRAaNdxuCpQAJKzUOo8I4hIcYwCqJAEVkgoZ1dFWliEmWBjhC+j9ArnAit/BOl8ZLnBj3zvPREq9zB+6cEcjADrfxgOQH3a+dTnAqvYgAPICfg5MxD0BRP93E3ebEUmcN4YI0RkjZH1MqbQDR2j4g4TrZgHCIQcJ1NwkEFEImpABgzwSxYQHzBKlCDjWATarM9mbr1bsezwXQiGeHQoTmiB1Qn3Pd7IzPaIAR0VIdOQuNrLsDkFARUER2pgAtEVXoqISdk4zaQSnVQ/08ZY3j9H87e06mZ/tAApFbKoipWeU+p7T+nOxciVxgKT/aEuoAc8zcxqkPO52jr4+wIIlgrKcE2jridioJqED0XAKoYrv4vV2J0jGDgsA4EsFTiINPnmFVl1KMdENuWw10GxrYTh8bQwGpzyDY6sd05eVVI346Shm4gBbq38oG0lPt2iEjzvg0e4Lqu5AcDQgV3/KI3P1VV3uvKPuKEpB4hVbACA0qHkWHAkc0QZg5F9S+jbE3C0eeuC7fC5FmvdeG8vTgM3gIreTuIHb7paw0haG95j+XrgjnehkB6nIRTlHsR0G3FSJIoF1C+mkGXqq+fC9yAdHCXdWeyBSMQPqfU5+NhcCv5XqBeuZ8b4pqEHfjGe+tAB+ZwoEvYUi1gy+Bcb+1wP+Jwm+/+EOFge+BQcg7mZQFQT+ZEuk6oXC1woUQcSoU0pOnA54+mlsQgiotOXqC6FMQQnMiIT4ugIqAAJMAFyjAK4AAIRIhMFkBcGczu7R6e6M4lCMHKB3DEHPpkFdDDpgA8HiHMFcGq5bCabHzczqiw5swGp/R2agLlpGYmbVqFrNw45wCa7tJUiEGBiOSXq8iOSp6EBWQ1zUGbhjrWF6C2HCzMAOGZROEuEWGqoYAVoGrBz66iojohEwBBAsZVBjpCHA7BH4787E4K4s4U6u7S4vIM4nBM5pFK4ZEqHc5gDMBJG84E5E6C6cAi4PLi4ZFS4e45Fy5oj5Hk5s4q4OrFGlFRHa7jp64wAG5x666m7m5Ygp427p7iAO734u7U5CEy6iGFxDGkAJ6jGW6lCp6qCTHTFO6KDBrOgOpjq4GbgcGEGm6MAkEyEUFgBUGJE9GXR0EMF8GsHsGhTcG8ESGkACHzHZFe5iHPGcBSGkHkFyEKHPHKGHF8bqGnwMwchcjpD7LIBirkw7iwaHa4g9CqCxAtBQgFjMDHbIYrIibYg4z6Z4iyZEbmAtAqz47noRCOgoJoKTj/iyD/IaADgEJyK86uKskeJQowr0KGQCTYQsLZg27QBRA9H85+5sgwAAD8JQh6VQe8qG+4SQoQn8vIqIh6yADoBURAEAZcwIAA1P8F8OmLjFMfSTKuNAYE0bNPtJzFztBoNKoIllZOOPOpwHkisAagGM0BCFKKZhuqkDWsGlUEQo6p5GMFwBZu2iVocHUKQI8DKQHtOhsCQVMVAEskIKjnGeEKUNiWIDkIfkIEKmEs2iwBcfan+pxrLtEEEGRP2mieMkdhDmAOoKhjoJdhYLEERu2T9rKSsu2WRORr0NEFCGRE9jRk3EEPZv6ZlLkRsAlmNqGekBjLWZzIfnIFCODsDJOi2ZiMJidmJt2RdldmgDJrdvJmRtudOXRtuXuWgE+XCAGJEIMqYdzLji3MINwnPIQf+K4eUSkQWHPCUELlTlUKBScD8SIbkSUNBXVIBA6s6f0D+VriBSYgeA8ohbBfaQhVhSUMheHlBmhSfOqEtqtludSLuewBDmgAeYJkeUdiJqeehueSLNdhSTeQshcfebRo+XRcDC+W+QDr7sTMjE+UkPTKyFsszIjjuCyEQNYPvPvNaAyd8mSr2B6JSiBEpDSngL2jyUyjpHQsmD4uyqKQYHgVBLVEeNnHDM1LVNkveA1LDPbJAtXqSpONIBSsBDRBybIrZR+MZexJCjpBRKysKcwqZMEEimQCimAo1EkAABLhD4AlCcxbxsEYHKCuAwkgCyoGBpUkjVIHSvTQzJVCDeXz62K6UArUp0S0oOX2wlVqAMoJgmU0KySuAoIFiwBMCHK2yRRSgyj6wKji7GxkaJzWxDWiiZJnJjVOyXLpICyCLdDnITVQg0n+xXJ4GijBX7jSydygxcAjUDy0BDzxQkLJTjz+yTyZzOKmLHKMjaiKgLwPK9i1yZx0obzYrWC8CEpA3A02j/CHxgCuBNya4jopFuUQIOAkiIAPKHWfiVXuVnBtXWkgDfziBICgABBLRJB4DMiuCuBAA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { config } from './config'

const { receipt } = await Actions.dex.withdrawSync(config, {
  amount: parseUnits('100', 6),
  token: '0x20c0000000000000000000000000000000000001',
})

console.log('Transaction hash:', receipt.transactionHash)
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `dex.withdraw` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.withdraw.md","from":6081,"to":6418}<fsm-vh3gqscxm4e>
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'
import { parseUnits } from 'viem'

const hash = await Actions.dex.withdraw(config, {
  amount: parseUnits('100', 6),
  token: '0x20c0000000000000000000000000000000000001',
})
const receipt = await waitForTransactionReceipt(config, { hash })
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/dex.withdraw.md","from":6445,"to":6526}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Transaction receipt */
  receipt: TransactionReceipt
}
```

## Parameters

### amount

* **Type:** `bigint`

Amount of tokens to withdraw.

### token

* **Type:** `Address`

Address of the token to withdraw.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`dex.withdraw`](https://viem.sh/tempo/actions/dex.withdraw)

---

---
url: /tempo/actions/faucet.fund.md
---
# `faucet.fund`

Funds an account with an initial amount of tokens on Tempo's testnet.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/faucet.fund.md","from":142,"to":4900}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"2a334c0a8b0b464e60d225d6b8c383a129c837283be2bd8d4d6de2830fe35d4e","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinA5w+PCpCQCuYFAAdABKelukYABqoVu4otr66rK1yqpIzdStetPh66bdVgDMA0czlGjQm1C8018c2oASYrHYXCMgmEpXKUjGlXkdWeiBq2jaeCRJi6Fn+gKGwKQACZemDMFMDDM/DCFgZ8gjOAlxFteB8bhU+tYqVing1XviPgYuTy+WZSUgASB7ECRtTxh5wQyfLNSjRWSBtmB+MjOTsoAAeDKJZIAPiCHWSqStWQonCwjmYejIcFSwFynAD0QcFgAklAAPypMBbZgAIzInAAPpwzTAkpYoABuf2BpwxHZoVJ8fNgLjJ7hQKCkeBwbNgVwRVIABVIEGYjDgMHNROEe2lvLQfbNh2OpwuciuNtyYHEnrg7t5pt2pSgEF4CAMADEzXBOOIwHveCWuAB3RiqPcHiznxihPfMCAFzgQBKcTtcNAQADWiiCkVyQicAAKjA8IAOS7jQYiWIOuriEoG7IMgIB0LOWAKKUAAG2FoHAuTsoUwDRNW4g0M6ySuvgaBoFgnCuJyrbMJwYEAAInvB7YAPQxNWYH4fChGcDQ8J0QxbbMWxHGMNx7AwNxwbCHxeQCVwRE9ru9EJIxEnsUoXE8XJwlsEpuRLHExRKJwAC8xEwKRMDkUoQR+geQbiBYPqcMgRkQCB0F6AAuhQOZoEMwgFLhvo5gG3mgWweyMFAAWpFRNFBBEwWue4uQNrkpmxCsXzwNZe7seePDGiYfbcgOQ67PaFmui5AZ5o+papGB1i0LA4hQPGaY9X1MADXZQ0jb1/UJINk1gZluVgNhmEgEFyHukMzClA6lkALTpBZezLRQq0eqUa2zl6pC7rtTYehdcAHStIDVmgJwolQQHrEJYVwMMJqrN8D1BWUtyCg8CiikgmJvDokoGmaJI9IgirKhSqpI6CGr0t4TLQnqgQhGEkRFMI5nWike1k/xEXE50/Lor0vRQ+D9QvC0MPtBZCNkkqgzDC4iCVLSmMQoyUK6rCBhBFgrY4BwGBRK1BapJhXUACTAGIpAWEoriYUmFXHiua4boYR5tR+EBLvsqIg4gvRUq8zM4ni7yBIrpZc5D5J86MVJ0iL2rMnjeAznOC4wMTcAQAouREJIkfRzATomInRvrngH0R5hSyJ3rD5QFsChuq2RCJcV4hvvkRewLGWxKEo2sJ0XqikZwHaV+2cjx5+QnrLkABS4hxwAyrwWtYKTUdF56yp5HATHS8QZdQJwsYYJwJ4wLGq+tienaXXseVgJnnD54XEd0BFkEnpb84wLwjBJLwRTwpYpY+kfABUPCcJhVpTzAPWvAu5wF3GeC8npVDQF3HAHk+A9y7mzinBQew5AQCchETCrokHCETnsMgrZSDpT1vuFeOCAF7HYqcYhvdW68H3KvCOWxOwrx7ieLWNAhKW33OvAActAGAewABWMDQp2WYIfMA39uCcCUGg2Md5yG5zbiTfci4tonBgKwy27DzwRx7sgTCi9eSgL2GIVcWw0CYQCkEVKWAfScU4pAWAIi9jsCUJxVc65OJdygmgbaRAqSVD2LQTi4gsDSWMTWPYVFmByAAMRRNAeYx8aAFa7FyIYpJ91zEEOsbY6i9jECOOcTAVx7jPHGx8fZMQASgkhLCREzi2SYloDiYk1sJjQFoFgKQUgEQ9jAU+nIiACi5C/xzgoIBDD4wphYRvc8hBLFtxUo3VQWdSmIEmYA0+0Bz6SNyAAfU/p/AA6pIPIygTmHNSCfEZYym4R1GUI++aAIKnz0IQKAu5JAR0sIshMSwOw0FLHIDAuQ4AYCNPgVskBmGcHMD+XuEdYy733jwJsIZILrHXtWTscYFCukgKQPc1ZkXryBWIRQaAwW5HCFC+wsLHy7kRRHUI4yIDrJJfw2AwjREkWYPdTgw9hrIq8phSAnDALZM4CGTiAB5fJdiHFOIEeUnQlTvG+PgP4wJwTQnhMiZ06JsSEniG2pKmA20hDbWydtQQUQEjsFyA+MlFgnWkGYKRZEBywAAFFaBoSLswtZwz5GKO2ZhRAR9FoiPyrglBaCnJgXWHINBG92ByCgGBCIdZHGcBbBYSKKwYBpp0ZmqAroe4pMsfGihSaggptLemgApHAWazEb6kCzTmvNnEC1a3filZt5bu2Vq4W+HpqS614IIewIIlgTycD9X0+dYFTmEAgPY10UdIH4EbgoleDgsA4AzDm3NuR82FvfpwOdJK5w/V0JeFe5ReBfi+k4fRt8ekEOjWAfNAYV2ENSBuiAW64A7rbJ8g9vVConsUFoy9/bAx7i4MgGAcc5DJQAKx22w0hlDqHhVj0YBPPYpAdghmPvuuAVo8acAXQIxARBmB2z+FSO2AAOCIBGUOt3lbGF5/ByOUeox2OjAQGObJY0jaw0gkbcd47mLgmyi1kBnHIZpxrQGcToPfSxyJcTqDttIJTLU0MYdCAFba7DwmyyaIgKkVIzNEcs3IUe48uCMdgIgNTpxQhabXDWXTtB9PGDALiRoTRrA8f/ch5TnBVOlnUwFr1FhdOYcOZrbWjm/hIyPmZRL50SrrsYGmzgBxRkeSEGBOs2zKEXKCJhAAIvuXQJL1ahxgK4AAhJwVrygyA9cwheuLA6i2eQG+1zgpyyvjMq7GarYA+tTaG1W79vTSC5EWkfANQamFwFDVnf+yjgHhA/mAbb2E41GgKqkkqbRh5iNnMPKDhATzpTqwVAhD29BPYFa9z073Pt1q4MwDAJ2i42UXY8vYkOYBBFSa6Aho2XUQ+QYIhtTay0ZrHb2gj17i2pvTV2rN63ny1rAOD+HqD0GNuJ5bNtHawKk+zaNq9g6icjtx2Tid06qfo4TYIu9C6YBLqA2u0D4HIN7pg0euzCG2fs/7YTzyyAJekBA5u7db4oOqDl3B09WigoToIQVgqXWSuzfKwtpbtW0c06oWAJrq2OvAC671/rbWhsjb7eNodXvBskut/NqruDluB/az18nZuFrYTgghJASEyjDVKMgKOJxeQ2OVcUziDdVBbFjHsGIzBVUuLgGXuSsZ5GcT1Q08wsYZJC75REZaQM0T6F6Jx7DIoWa4jZgSAw2zPb955iqfm1h/ZahxuLfUQQ93QCiDThtD74IwEjJeDAro9g763eF0IN11qeR4cgAKjZOBEAgIlBjABqXoz5ZhoN6q3qgXiTaq4nZhGtViFkXkXb8QZAAWULgEHQjZR0BjGpV3HoQPFmXdFAS0VdHAXgXWVyCSEui4GYS0QQTFWlhYEkHXlXyfVIT3HK16igBvCEDvCwJXnCDfELzEHPAMyEFjkuGKkO07m7ktiyU5wSCCD+EwWz0KVzy9TAHUDcQ1W6C2FCVENtTXwr1EL+C0yLQSD2D+FaTiViyCHWVJSUEgJvV+VIPGXgPmQMUwgMzkD7HYC9TQGISEJohVVKXVQ8Tf2qT8TqX1UaWkgsI0ISQsI9RsICNIm2laEiAGRjWuzwluxJiKCfBsmwy+2byx2PFSBbWzVdGPGV392LRSM4B7wnW/xnUTTpzAhSI7UyL91V1SFyPyOrSnUpx20uzABFQjkMR8KCNsMEIKQcNzycPugqVcO1VqTrwNSaR8NNXiX8OsNIg6JCJ0CJg9V2TdUSGmPCwOhaETxQGQkOyNGuBACIGsD2F6COOsGsDbzpk72kEVCdgaEVAlECCTRHxqBRh9iQE4yn2xjFnmA5hiP+g2CthHBejHDYJtgFEcypFsEeD73FFdk+DWHgCeO9kpCRmww+LwAkCUFKC6zwEeIuOpCpE417xxEhODgMCAm+l+kAj+LV06loB3z2GZy6npLAgChHweBeORMnyBhiFgDhGpjUkqmEFEi0nEhZykk4h8iUgIlUhpmSGFO0jAj2CbyyBMmiOWGpJKnEDKkREFPun7D0DqigAajJiahzHdkLGYi6mmmGimlGkmmtPGjGltImhtNmhyliyKMxxKPJP3B+kFMKnhJ9A7WpNi1KEgXECQFAACEUEOyEHRIQFcFcCAA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const hashes = await Actions.faucet.fund(config, {
  account: '0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef',
})

console.log('Transaction hashes:', hashes)
// @log: Transaction hashes: ['0x...', '0x...']
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Synchronous Usage

Use `fundSync` to wait for the transactions to be included on a block before returning:

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/faucet.fund.md","from":5091,"to":9795}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"4cb3e4d43afd1edf434898c4fbf7dd960d22cef1a4ff558f529b06bca056f27f","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogvCZcpDC8MIxYaHCInABmAK5gUADKGGC8AHQASnqJpGAAauJyibii2voALACs8ooqaogAHFqSuoFhEVExlGYWVgBMdg6kTjTkiABs7p44eIQk5P70TKzsXEaCwv1ikvrTI2aNqhrtOnp42yb95pZIx/aOzlNDAMxz1F6LvivUAXWbA4CXEiQiDEqBw0thOyjOMwunTw8TBELug0eoxekyQ7wAjF9MAsDEs/AC1gYkpljGAEsk0hleAAeADCQnijCUAD4ABTBMCcpRxdmCrkUThYRzMPRkWKcYAAHTpnFVzwsAEkoAB+OJgRLMABGZE4AB9OAyYJzLFAANzK1WqpzBZJoOJ8F1gLjm7hQKBhOBwe0q1UCGUQRJoXWcfVGk3my3WmBQM0WlJWwZ25WuACUcQACqQIMxGHAYMybsIsqjwXpqwz0plcvlCiUyjBucqwOIZXApRF6SlG7x+lAILwEAYAGIMuCccR050Rr2cADujFU87pFg3jFK8+Yy64EHinDLXDQEAA1opeXAc8qhJwACowDYAcjnNDEljQWU4eRoAUwhrhu+CcKoMAQeMwgTDsnDdJE0RwFk/QSEok7IMgIB0D2WAKP0AAGxExMqLDAlwwCcLwYTiDQopChK+BoGgWCcK4CRFswnDvgAAqu4hKCWAD0wRhO+ZEbCCVE0Bs7GccWPH8YJIliTAokOBYcASWA5GbAqPD8Dsc4cfEXFKQJQmMKJ7DqbJbA6cqApiNRHJcpwAC81G0fRblKLySoquqwhxMg9kQK+P56AAuhQDrQQufabPKgWOpwYVvmwWSMFA0VxMxrG8jmcUqu42YPmATkhAh4RITEnnzgJG6GbSKE1hC9ZDky/J+RKqXzrwnpujx1i0LA4hQMaVrjZNMDTTAE1TfEM1LStc3xO+JW5sqxGESAsXYVK4zMP0ApCpwAC0nAMVyqEHSAR09v0j0ypMc5Xfm0qyqQKH7RQ2FhEBhSmM++BQWgMFwHBT4OHAYO/dFsUgPsUiIOomhwk0SBtNQHRXFSDZMhiDyIE8YwTC4iDvC0RI/KSfxoYCBjOVwZ1ciKfl7FU2PTA08LNLzuOXIEbNKMTwzYuMrxINU6i0ySPjLIzlIgLyWBFjgHAYDmA1DXEhGjQAJMAYikBYSiuIRqYekeo7jpOhiDUeEEQIOUCoVCqPSDjCj8+cQvIgYS6uuLeKSxTbzy94ZL/DQKvdr2/ZQc5EAKMqRCSK5wipzAHPZwRVBjhOeCg1BhEpwoVuHlAiQKJKRZEDl8Dzme5F17AhqJEoSjm1ncA5xBDhcKWrclnImeXoPMDKgAUuIGepDRvR9wPMrPLpcDcerxBNymhoYGuMCGpwhpFquZY/VkyrKqXnDV7XUF0BRX6rq7fbhIwnK8K5GyWF6sTXzAAAKh4JwQiop+6V2ouPQMoFNyvUIFAOccBwTgXEHOcuJgc5ZDkBAfyOZCISkwfnGAWQyBFlIEVK2C4UzEMgaQgShQqGDzotRBcJ8oKJDLCmSeq4zY0BdluA+AA5aApCABWyCIYLWYFfYBoClC4MNPuOhOcrZaQkJkZOfkCjJkEXwjc4NXbIEItvCIgYshiDHJGQi0VeQFSwLEYSwlICwEkVkdgShhJFzgMJce340AXSIEMaoWRaDCXEFgayZj4AoWYswOQABiGJgYrERjQDrGhyoTEpJQlY8htj7EsUcYgZxriYDuM8d4+2fi6LwECcE0J4TInRKLOYuJaAEnJLabE/JpBSA5n/LfRREBlFyDARXGAVteDsONBabhcDCCRk4HpDgvdIJgPKYgSZVdoAPzkcqAA+kAoBAB1SQullAnMOXEYZSj9yTM4KM8R4Q0CfjvnoRBc5JBQUsGBE0zlSw0C9HIDAyo4BMnwEWSAXDODmBvFPE+Z8L48HzBqL8YMD4BjfIaBQEpICkHnGEKeB9AViEUGgUFyp0GQuhRGOc8KoKlHGRASChLRGwCyJIs80iewoU4KkOaiKTGQAEU+XJnANTCQAPKFIcU4lxYjKk6GqROWpASgkhLCREqJwlclZHiUk8QF1RUwAukIC6uSLqCB1vEdgypDzEosHa0gzA6I7AOWAAAorQPCdcuHrLBpwEZYyJlYMrogQBu1JFVRITgvBvJ3xgzkLgtc7A5BQHfDmYMzjOCFgsDEfKMAU2u1fqQDNEpJ5pMjLG+h8b/JJuLamgApNpCU74y0ZqzTm4Seazb/yLSWtN5aoCVrfmgaxaBa3YPIewXklhVycC9f0ud75TmEAgI4iU/cEG92USmBwWAcA2izdm5Uub83/04LOwlvYoa6C3CmfYvArwJQHFWid5DI1gFzaqZdFC4jrogJuuA27iyfL3RNTgh7j3JnPb2tKrDkAwAznIPKtRED4lqPBtK84uCLzNtELIpBkgajAKDUsoo45cHnWIxARBmCYfeEMTDLQKq/sdKw6VhoXn8GI6R8j+BKNCGo5wWjsB6OMfeNYaQVM2M4cQ1wLZBayDdjkHqnpgZhJ0HCJGHYaN1CYekApzjXBkOoeihdPhkTNYzFJkMEzTouAodKAR5e4nc4qcKKUDT45YnadoLp2kaNpgzGsOxhDpmYx0a82p4SbqLDadQ4c025tSbvCpoAlmMYexQS8muxgKaAKjK0kId8wZJlZEYWAXkhEAAiC5dCEuNgnGArgACEnAGvKDIO1wiZ6f29svYWrrjWTSnMK+MnIJXs5gE691pr7Wx08tgP0naxFAE+r9ZwuAgay4QLUdA9BADKpgGjXAWtx5lleU6KkXlzBUjgcIKuIqFXqrkIard+7j2ZTPde5du+GADt1y8guleCgsjA5gLydJEpyEDYdUD8NpDcENuTamztmaBsXv7SN9Hpb02jsEekxHUP62Jvx5wVtm0eKY+7Th4b8pKeY+WyTsAzAkdxpvfOmAi7/2rqAyBsDu7lAnygzBxQyZT09r7QW+UyB+ekEAxurdZ5wOqEgwemzkvcrLfIVl6qrWGoFaK9Nw0pWwDldJ8jqrFzasLZNC13LHXRs9dIH17HQ3cfygd4SibpuZv9zm67xbeu1tneImhQSmFsJlgqCAZA/cCgRDsfK0pwke6qESIaLIwRmCKrcb48pwlcWjOEo07V5hDQ2TjZInM+0kYo30FhjGvssZoyRPjIIyPQ6IiCOTaWNgo6/CVqsQIvIEHQB1mT1HE/YmCRgNGBcGAJRZDX5u2kpRPrHXlMv5A0U8ycCIBAHKYmADU+InnLFwRNevhd7Z4EZ4Iwi1a0BW3XJuBd9xSGcAALK1wEHwiZR0ANApTnBmTpDmSlEDGTAlA/3AkgmVE5B+i4C4T0XQURXVhYEkAPjvQX0fXnCKwmigF3CEH3DQJTAwJQUNDEA3D0yEHTlKHKGQRYEKwnmMVMVx3iF5HeAIVT2KXTzdTAHUA8RVXuESHCSEMtQX18SEPeA0wLXiCyHeANU6TkAql5A2Q6FAKvR+UIPGWgIWUnhMT0zkGrHYDdTQCoX4NYgVXKWVS8R8XVXqU1SaR1WslMNUK6VMJdUsN8Logug6HvEGSjWIhjUyGqiGgalqDezjVn3fD1ip0zQlCGk91lwHVcldDiHqEEVf2nQh3iL1hp1SJl0ZziESJyI/UnXW0IkAUFSghMIEDMP8KsL4KKVsPT3sJQiqScP8RcIr2aV1U8MNUSR8IsLohaMCJ0HvASHYDvlshWUFHGNpA9lxgwiQCwmRgsAiH6CIGsCyHxAOOsGsAb09mb2mHqExgRHeE70CFR170FmeCllxFaGH3plHwpBFmqkQl6HlGpEZCbEAmAjbHKC5mhFY2ODbwRBxm0EDhAB+OQgePDkHyGFqDeLWP6FazwHuLOKQHxGkEhNOGaFhGozwDyB6GQlCiolLxfWEQNGNCV04HxA+DAFXzX3Yj6hPlwVpPpLIDiGZPeFZM4DX3/FcGil7xxieIjiQGsDFLsDESBH0iokrBMgUm4g7RUmsnCkcgiOEFCFql+IanECai2CMhMGrDRDrH+OHB6jFCUD6nimDi9DiHfFGjWnmkWnWndOWgWlmg9L9I2i2gqnyJRwTXfHJLqliBpwRJiAqn6FenECQFAACEUF2yEDwD6FcFcCAA=="}
import type { Config } from 'wagmi'
export const config = {} as Config
// ---cut---
import { Actions } from 'wagmi/tempo'

const receipts = await Actions.faucet.fundSync(config, {
  account: '0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef',
})

console.log('Receipts:', receipts)
// @log: Receipts: [{ blockNumber: 123n, ... }, { blockNumber: 123n, ... }]
```

## Return Type

### fund

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/faucet.fund.md","from":9832,"to":9866}<fsm-vh3gqscxm4e>
type ReturnType = readonly Hash[]
```

Returns an array of transaction hashes for the funding transactions.

### fundSync

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/faucet.fund.md","from":9961,"to":10009}<fsm-vh3gqscxm4e>
type ReturnType = readonly TransactionReceipt[]
```

Returns an array of transaction receipts after the transactions are confirmed.

## Parameters

### account

* **Type:** `Account | Address`

Account to fund with testnet tokens.

### timeout (fundSync only)

* **Type:** `number`
* **Default:** `10000`

Timeout in milliseconds to wait for transaction confirmation.

## Viem

* [`faucet.fund`](https://viem.sh/tempo/actions/faucet.fund)

---

---
url: /tempo/hooks/faucet.useFund.md
---
# `faucet.useFund`

Hook for funding an account with testnet tokens on Tempo's testnet.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/faucet.useFund.md","from":142,"to":5793}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"1a95b41c202f29f8ef89605e6082e91c25c3ea600cf822463485a078a7ff5484","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6INYQYCKcAGYArmBQiDx8ggB0EaJR1jpJUXAwAGIxUEkASjpRpGAAKl4APADCoRGMChScMfyQAO5gAHz+IuK6ACwAzLLySiqIgxri2kHRsf4mZkgATDZ2pA5OSABs7p44eIQk5BqBTKzsXAaCfZq6qlbG48pqM1o6eLdGy+brwU22z8iAAjMMDtQvMdfGcAvRLmwOJE0hkGMIHmpdmNFG9ENjqLMvnpUukvrJTP8NvZHCDQW4PFCjnoTn5zgiSTFHIxQq0cvlYnUGk0Wm1Oj0ABRYezMHRkOAAfniPxSqMy2TyBSSAAUZXLSHAhWBGs1WmB2hAut0AJTKxJwVVktBZflakpoMqVGr1Y0is0Wq0AHTAYFEsrg0oyfM1iyoUAg1gQelukXYkQKpgUnFEYGz1hCMS4HUYymzudMJcYohk2eYEELnAgEU4OS4aAE8glcGtwd5FRgVwA5HBODQRGZnf4xAok8hkCA6GGsHJ/AADddoOC0YMsJFcYAJQycVyRUgQZicQcdUQKZiMAD0NCHweDC25vIAglgsBLrZxgMGnCcCEYT7pwzBRGINAtIwcDavIUCZsenAALyHskpJoi6MZQL+L65pwpClOUnASoBQGcNUABGkHtmA5EUY2YC1CY1j8ChwC/qh3TgZBog0BKB4OAWYBoPEg4WLQsCiFAVEwDAERJEpg7HtargMRRiFwKIVFyFAHGwfBsSZupBFAd0GlAQKUCcB++b1qJGnVPeNFoHRFkET2YCmeuq4gAAuhQ87SlszD+CFYb6iOAC0nC6qFUVJAFQUgERHrlEYACyfFoDyuZEXAUQyJO/mBSA/QSPiowvLikwAOwfHMeAatZSyUms1JbLSzirPsjKYMyPinFOFx6CB4QLHE6EOph6qurExTEV6OBGiaormuKvQYgMSDggAHDiExINMhKfPMBRtSsiDqICNI7JYkIDd4rJwjQHIgFKZ44BwGB/hBUEwPEEpEOIVa6fA8QAWZwF2KYACSUBKpwYBRMwcmkJwAA+ZqwI0ZhQAA3BpwkOWJtn2Q22MflAUAFXARPeS0EBYLloSKvE2UAwA8izeWGpNi3pWAABq1ZRDALQAEKiDkACipBnqQVQ4C0UOMbYojw4j8Qo2jZBYzjCmUoTxMU6J8R2SJXBUzTdMM+4/qbQbBRG/jf4oTxRAQIwUD+PGiZ4BU+AwLxUF5emYDvrmGD1sBOZxzINbFqWIOkGDcgju2o5pwo2gY8oIf/fx4c5jZzOs6GicYJwhBHryMmIRX1YJzIVEOPwja82zSUzDOSBziAEVhVQqfp/AnCxUHIejzpGeNlRABWMCOKOECcNKcCZ2vBecKuRcV7kYCrklgXBTK/jl3zSShAAyukGSbxPnBB7BEdR5wxaJ5EjBER/we5jvfe4dX6FXzPAOA0Qaylw/owL+cl14yxyDZQBOU8rDkIvAIqJUUpDwvl3MI18wDy0Vk/F+I43wVxgV/Rov9GDNhQWHXk8grbyjLJwMgJDoGfxrPAjeSDRzB3YQrdgJ8cHnyoJfbut8dBoD0qQ/Ar8KHh24d/X+HR/4CMLqg3kr8YAlmDhjUBD8IFFRkNXCIOhbAwDLhjZhpNWHxw4WmaBvDEHWPYfo/WO8oD8VEI2WxwjSCiPnERZg4g7hUFinDZsMcojgVEPwLRxVGDLhDkRAAjuLEQcAWirlvvfcBq4qE1hoSHUIZjswRCcJozgMh+LwC4NYasNZYmDhIPE2ASRgyxQ/F/HeTTE5tzYm/CuI4JR5LAHfMBm9Vy5NCMQ9gszd7SLcnpVcf5xDT29jZJRbMWjQJ3mlT07iQYyHFsUzg8CmiQCIoUAKZUKq6FBCMQ6eICSaCanofeuAKRXRuhrLq91VCPWhCyWEI13qfWZmQTAGyzZk1XJJAAJMAEQadFCuCKVTeFfsExJhAJbUmq8I53O2pVUEqgTpyFqkgBqp1PkgBJoWS65gCQAuBD1EFg0XoQqCKGcMkYQ7jQgHIYMqdgJsxFYDTgPo4BStxQHPQU9d7CrkEUusUAiohywGeIgPtx5+LgLuOQnBYA0VzkhVVIdlD8U4CAlgsDxDEoLsGAAUqIEGN9rBpxZhKsIUrwLLzsGAWCF4dXEH1TZKi1cOgwCopcs8HQcgGi6fRSogiNVavYbQPcmcOhrwjMvOhjBrASquGYUScBED4QAFS2V3rKqVRTrB1MfsnfAgblDQBHKAjtMsVWSrkEkGQEAFC/iWauK1SQnGkHHWWGyk7B0wCSNecoc6bWNPjvAjUyC14dDTjQYlOZq4ADloDLoXj2tAREwyprrR+TgCgR1txrIu/1aq7WgRzFGECJoyjuKzvuks1q17IFXOG4xSQRDxkgqufyEp8BuSwFW+895ICwEvdfLQ95/ZwHvHUscaBopEFWIMJItB7yiCwA+CD4CkiIeYDIAAxLRze0H6xoA2bEYMYHWMOmgxwuDCGkMobQ+ezD7AFA4bxfh+pIhiOkfI5R6j94+P0bQIxljZ5jECYVtaJIz9BFPogC+gd76YDNq3SHHdMCu2QTtVcDgSEd6rnQ4DK16roBatTcGAA+jWmtAB1cQIbFABd8/EZVxnTNWvnkvRw6DZRdqgCOTZyM9EFwxuNWCNBRJmODHADAkd8BnkgNkWpjBEk1Koom5NtltRw0zsHauBUBzgxaDc7Mv8C7V2yyIeQsiMDBhlkV2wpX6wjhMFV5pjZMucDPZ0y9LZr0wDDA6TgN95I1LA5AQ9vI+OcDhveLmQnENoGQ4gVDbmJPYdw7JwjCmyMUaozR7TdGGPMdENFXbMBoqhGinx6KPI/wRHYMGOstDjTsDCRXHzRDaBLhNdkZzRnn3NzfXKtV1a02+UvcGKdI6x2DmDonPd7AZBQEHNaBmqG4ros3PEEnI6P7k6gC0LO7HIL46XcO0dEpicwFJ5wAApHAQcLQrys6pzT+8dPTAM5roL5n+bSAU/ZwWtAMG0Dc/M9OwJEozAdE4As2dg5Au12Qy0OVSWFGKEuTJGuVGcD4yp9T4MtPtT05HDOwNm8bwh2gf0YZ16HAgeW7ABW2PadARN/Ec3fBLctnPDoW3WY242TsN+eQ1j3ey8Yra5AMBTn+WumCVQufGLZi4F6n1zpSAxDhum2CPo3pcAN+exARBmBgmGKsMEe0vLR4orarmi9l514b03uALfAikTc537vwwLCSEQMMAfFf89cHn/LsgldVNvc3veOgy9IJ5UQHVOqYJJAb+H1wQvxfor7qd2QfEiBVirBv0BW1Rfqw15SW37fUSXfasffBMcBI/WgE/Cuc/XYfECwQfPPW/ZGDvHfcoEAsJUwI/U5XzNFTMN/YYVffCcaLfSKVCS8QLWBGsIoEzUwOVMAQcBmKdVdMAcZAAERzDzk4BRX5RgFcAAEJOB2DFAyA+D1kZc5dK14ghDOCKCv5qCqJaDQgBDpCRD1dw8OFgxfJ8JZYEdWAkcjU7cXNG0P0W1EFsdND1w8dI42YuAOMyC5gb4Vswwb5k9CAOhfxGCbChEMY0IHCnDmAXDZQ3CPCddwhmAMBjCQ40JDc/VMdl1IiJQOMWgOE3c01wjIjecicmcydVdKdUiPcvdGclcci1diUONwcIiedCd+dsiRcxcJcVcKdpcK9Pd5cq1FchdGi2cyiucwB0iecZ0DcYAjcTd+d49mYckk8bckJ09Hcs8XdrR8jZdWjJDOBkBY9OBxjE9rcU8ZiHdM9ndrFApiUNC01iDkZSC0IzdKDOB5DFD6CGZ+jddmC2COD9ZuDIp+DBC3jSBRCliJCFcVCMZZCqCaD/UwBlCfi+C1DTjfIpwbxZx5wcgfkQBkA5UygMh4MzsLtUMFB9EogqIkgQhmAxMMM8M3MXJn17wSMnt8NGAqJ7wp1L1rR7kyVdBVhwRXl6pGpiRggl0WUpBOoOUkALAuVnpwV2QggJQbdoA/wMjqjwxtJtAkZj0WglJr58Fqx4o1t4hj1kB/JbROAvYfZSIABqUERsU4EdGSFkuMPFPAFYzcYlVcTnNAIpdtdLDoP4AzbKZJVJLrBQVGAbEcJpXMVxTeaxFoD0l1X0A0LgGzftHeHVFgcQauRU/3edbML+BuSsUIZuBMntAkkQEsU/UIMVMWceI1O8OpfOUDcDenCICUYYa0U7JDS7e8MJMAOqLDKTZYKICjTsgHf3PDTs4YffeXRSYYdTRjLyCUHeWYIMytLrAPL+PhADOs0/GQFIaHficdLEkTds67B0STaTRMe7BpR7JTF7e8Tc6c5jTc0HUgGHR8mHaKWYbsfTfCXHOAUIxpIlNCVQTw3XaowcK2eIYXSnFoK2f4x09osCzgdQYlV00IqVTI/nMC8XCVQsGCworC82BCtQ5Co+dcfCTbEOMDW8l83cls/c87UTI8ns08vDAjC8mkq8lTW8j7JjB8nctAKiojd8kHNMCHEOUwfivKHuQkPuFAJE0wDIfwIgCwJIUEZSiwCwVk8qTEN/DkrkpAaqD5XkwnAUlwIU7qJAPaMUmEYaSUvAc4yaO0QwR0LCFqN0JaZWGAVaP0MUS0Hoe4HaN/QYA6GqI6KYHk86WMYwdqEy26QFEEYYYFfqUFIaNkeEKU8Nb6WFU1XxeIAWd0T0UWM5EObGF2PGaxBVfFZVVtLgIxcBSBCpAqEVEgGyHxMQVMfODNbRMAOHYMSqmWaqgpTeOqlreARq9xFqvxR8mpIBUIbq9NEOKqlsAakxKuDBTHJqrK1qyahhYuGa/CHqwRBamqwa0xYatasa3xNqqazqySx5NYVQaqalEKk6AyoIca4y6QGK4UqYUUxKwaacfwHgvAIytku6j6x6vEZ4VvQOLYMIbYcOOwOAYOdo5ACSWgdUzC1G9G/yYy0EUEUy+6UUsqEIWAREa4f8aaZCCIM8C8K8G8O8R8AcNgQcIgrwyaMglUWaZ0Fy2IPCNNWnWoGbPeHKCzT9VatgMIMPDUDGOG3kCUZdBQAzVyOiYCVifgLyAWb5QSciJlfC1G6SWSeSCIfWuSBSY2w2s2021bA2hScXYMVwLyFCodECioGG7Sd+BGpGxATCgWcaryfwJLUQJAUAQIeQI1UIPATcEAVwVwIAA="}
import { Hooks } from 'wagmi/tempo'

const fund = Hooks.faucet.useFund()

// Call `mutate` in response to user action (e.g. button click)
fund.mutate({
  account: '0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef',
})

console.log('Transaction hashes:', fund.data)
// @log: Transaction hashes: ['0x...', '0x...']
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Synchronous Usage

Use `useFundSync` to wait for the transactions to be included on a block before returning:

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/faucet.useFund.md","from":5985,"to":11758}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"70c6e7579f56d5a55b4b8b81f596b6b59a686064ee970a2e241dca8d21b48c36","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6INYQYCKcAGYArmBQAMoYYNaIPHyCAHQRolHWOulRcDAAYjHxidbpAEo6UaRgACpeADwAwqERjAoUnDH8kADuYAB8/iLiugAsAMyy8koqiAAcGuLaQdGxCUn+JmZIAEw2dqQOTkgAbO6eOHiEJOQagUys7FwGgqOauqoTs4rKahWWh0eHeRl25kOwWOpz8iAAjAB2K7ULy3XwPAL0Z5sDiRbK5BjCL4XKzGOYAxDnIFrPBZHIg2SmSFHeyOOH7KYozA3PR3PyPbF6DaORihHqFEqbcqtdqdbq9AbDAAUWHszB0ZDgAH4UmDMgS8gViqUthUAArqzWkOCysAdLo9MB9CCDIYASj1aTgBoZaHyktN5SqNTqjRwdodCudSqGAB0wGBRBq4GrchKTdLtlQoBBrAg9O9IuxIqVTApOKIwJXrCEYlx+oxlJXq6Ym4xRDJK8wIPXOBAIpxClw0AJ5Mq4O6E+L6jAXgByOCcGgiMz+zjVNC1MLL/AwZcnMKnMXV0gwXKMLBoH3+MQKAvIZAgOjJrByfwAAy/19oCZYuK4YBUkMThXEiUgIGYTh536UQFGYRgAHoaAXBMExFNAT04ABBLAsGVd1OGABNOE4EIwkAzhmCiMQaG6Rg4HNeQoHLUDOAAXmAjJ6UJANMzKJICLQ6tODPLc6k4ZUSNIzgmgAIxo0cwGkmT+zAFoTGsfh2OAAiOKGKiaNEGhlSAhw6zANAUnnCxaFgUQoDkmAYAidI3PnUD3VcFSZJYuBRDkuQoB0himNictvJE0j4yimSpSgHDa17SyfKaRCFLQJSYtIqcwEir8PxAABdCgnzVE5mH8crk2tJcAFpOEtCravSYrSpAMTtyMABZIzMPFM84CiGR/WKkqQDGCQqURP55iQeF4RpEE9GNeKzR2ZkDlZE52WcKYLG5NE+QxW8nj0cjwg2ATki4n0eKNQMswqTdt3DGBI3lJ0XTdT5xnm/ZqXJf4FmWahVmWkArvWpk9kQdRoTZM5LEO3kfHuU6hRAVUIJwDgMEI6jaJgFJlSIcQO0C+AUmI2LbFEUwAEkoF1TgwCiZgnNITgAB8nVgDozCgABuHzzOSqzEosrheewqAoEGuARdizCNV7NAWbZjmyB5vmXOZBLedKPXBaV9x+yvE8dRSXqiYAeQt0JbSh4MXrqAA1TsohgboACFREKABRUgININ7uhp1S6cZ5mUk1zmdaNgWYGF0WkvrFJsLTyyddl+X4EVnyVZgNWNfZ+PDdiY3k4Tyuk5TvLo2+4Ya/5/XCPYgyiAgRgoH8XN8zweo90M2isIwrCMF7Miq2nmQu0bZsydICm5CXUcD06bQueUfdCeMrCqwSiAHaTOeME4QgQPFByWP60/Z5kOSHH4c275vFZ7yQR8QGqyqqCXle8BOANSHvuABAVV79jkgAK3PCOCAnA1RwDXggnenAPx7zvkUMAH5WolTKuqfwx837pFCHEHIuRkHAM4EPBipYkh304I2OekRGBniYXuasaDMFYToUNWs+dohdkPkwxgLCnKIP9oUBK3C+onkXKJeAw1Rr4J/oQqgxDLakLAEHEO1DaFLnHuKZhXYOjsMYIOWRo9xTyCllqFsnAyB6JESYzgEikHSN3PuJx7A8HtV/kQk+PoyE6DQEFfR+A6FGOrK4sx+5+icK8SPfe4o6EwCbHuLm/DKFwCETIc+EQdC2GriWWx4t7Ezx8VzER7ipHV3STvbew8oDGVEP2LmVS/FPjPMwcQHwqANQZoOSeUQqKiH4LvZRl45CKIAI5exEHAboH4yEUPzh+URLC4lqXyZWCITgkkyGMvALg1hOxdhGfOEgYzYDpATA1bCLC0FnLnk/LS9DRSO0kissA5CBHII/Ms0Iuj2CAvQSEzKQUPyEXEGA7uCVolLJbDI4enU6jVzJjIL2myuwSM6JAM8UA8HjUmroeEUx4ZyGBhcJaQRMG4BhuYeGdMdpIzcB4VEqN+SYhoJjbGx8yCYBhVnCWH5bIABJgAiGXooVwGyZYir7nmAsIBM5S2XAgq6rViR/QRBMQGVK5qIBmmDYEQQxb1g2rDQGLLYTOH2Cjbw3KMZBCTCmNM+4LoQDkAmJeZFHbeuJpwNoYRA1KoHnoUB6CvVyA2T2KAw19xYAgkQHuQC2lwH/DM2ACkFAKFYjG/cyhjKcD4SwMR4gNVeITAAKVEGTOI1hl5Xn9aGmZGo6ZgAYlBZNxA00JTkuffoMA5JuIgv0QoNo7nKQaMPeNibHG0AAmvfoCDUzngsYwaw/qXhmEsnARAwkABUOF0EhrgIGjZ1gjlUIXvgKiOhCBQCXPw+9/to0BrkOkGQEAFAETBR+Qt6Qqn/uRR+ttMB0iwTqKB4tpyZ4SONDIhB/Rl40CrVWc+AA5aAkHoEvrQGeZM06T3YU4AoH9T8uyAc/TADZpgxhJE9XKBQtRq7r1Q02ItCDkAfl7Tk9IIhcw0Q/EVZU+BMpYAPYhRCkBYD4dIVoRC/c4CISOSuNAdUiD7AmOkWgiFRBYCQvx/O6QJPMBkAAYhM8goTasYWxATLxmzPohNONE+JyT0nZO4YU+wBQynlVqeOSILTOm9MGaM4hFzZm0AWesxBHJbng7unSDQ4eFGIBUfAxe2N09qyIc8XetWpaXgcFYmgj8cniaFrjdARN06EwAH0j1HoAOriC7YoVrTWUhRsy9lwtUDYGOAURqZQ0AlywtZg0zJrbM0iHkGEjACY4DlHwBBSABROAmAmUkuS47J04XNAzNee5z6DTnJTboBLKzsJ3ufC6DEaCWXyQmf263Nu9iXLt/c5z+yNM4Dh25+GhyEZgMmH0nA4jOSSbxyA6HxQuc4AzRCtsPMSbQFJxAMnqt+aUyp4LGmwu6f04Z4ziXTPmas6IOqCOYB1VCHVFzdUxSEQiOwBMPZzH2nYL0u+jWdG0FfDMgoFWMuUc7Dly9h6Z0FXwwmIDP6/3zj3HPFD7AZBQHnO6JWMnGoyuvCkNXP6mGa6gN0dedmaKK9o9+39ypVcwHV5wAApHAec3QYLm513rxCBvTBG4vs703q7SBa8t2utAwm0C24g8B4O7BlRmH6JwEFpBHdtcvlJ7oF7xuRMUG4hyF9DM4EFjr3XCZ9fmkN0uKpD7kFwT+7EMHz8DwOG42D2AwdZf69IunlIWe+A56HJBR9rEn4JTsHheQycq/+9UiW5AMBMVFThgiVQ8/VKVi4I25t/pSAxAZrOhiIbeVcGT7hxARBmAIimPsBEixcp95kiW22MC4HpEP2AY/Biz+BEkmq2v1v32kkEQCmCfy30Xy4CAMDzIFPmi0p2QUQjoHPBohPGNURAREkCgNfy4GX1XzqlQ1LzICpEQH2H2FwNIhLRX07D30vAv1gMsngM7EQLzHzhQNoDQLvmNXOCpAsGfwXzwNZivzgLqFYN6VMBQMxSa2lXLHIKmHAOEguhgJqg4mgjazES7EqCywY1CHnCViA2gzAGVA/AABEqwt5OBJU3UYBXAABCTgCwxQMgew6FP3APfdFIZwqwzQlhHQuSPQsARwnw1wyPLvJxBMAqYSAOYXVgUXTNQvSrc9S9MiG9A9YSeXOAOPcIErTiNYOIcHZMOIMfQgfoAiQwx2LgJxdQgooo5gEojUMoionIrgZgDAFImZTiFPebQNdITomAZUNWboJxSvGddogY+3FXE3DXcPbXMY6vWvY3EPWYiPKtNWLnDou3ZXR3GYt3D3L3MPLXX3LfGvQPA9YPF3I4i3dYm3MACYu3EDHo9PTPbPJFPPcfQvSfEvGfcvd0BY/3M4rwzgZAAfTgIfY+d4sfZQCfYvafMvZOEqKtSImdFQ1mNQziecPw7Q3Q0NMAAwzYyY4w0w0IrmGwmqBwpwyw1w9w04pYqklwrmbEjcXEi9YIhkreew8IlEgqW8OCB8J8QoBlEAZAC9WoXIMTTHbHGTfNZQKIOSdIEIZgHzeTVTardKSjRCbTUnNTRgOSRCIDfDd0MaHVKafYCwSlCkBYE1TQWkc6WjK1cwaQBGVlOEA6DlHkJ1E6QUIIZUfPaAQiSYnYlMfybQFmTDboNyUhE+TsJqSHFITDZAIqT0TgLuHuSSAAanhH7HuB/QcmNJzGVTwCBOvCrQ/GtzQA2TvRm36AhDS16hGmmT+y0HZiWyXDOQKyTTqRuOrJ3nQjYXCCQ0rDOyTWXl6VIHPhDKbzA3+xvnbFCClyHPfSGjkhECbHQNCF9U9iAUzQQiOW3h4z40NwiGVCmHdAx0kxx0Ql6TAEREUwC12CiH0xvOZyb1UxvKmEQMD1cimFiws1ymVDQVWFbP3Tuz+xYQ8XY0PPQJkEyD52Mn/UlK8yvLx2CQJyC3UxORJwi3J0Qhgr/Ksxgo51IH52Iv5zqlWEnFS0yK/AVySCqP9T7E4lUEqPjx2PnClhSFd2126ClgBM8KD04s4HUCrQrJyL6PYs4s90Yssn4pLIuKEpEqt2jw2JwS/GEhh33F43wrIoQvPKQqx281QvvMC3zCJywu1Jwqi3wup0syIvgrQF0s00ovZxLG533FMCcpPG1TBk/hQEFNMFyH8CIAsHSHhDCosAsBNImhJHIPJVmkpBmFNTtOMF/UdKkG2jtSQEWEdXRHRh9LwDROdiSC9EMF9F4lWiDCSBDHEgaGaBDSjC+ljF+jNP2gSpBlpTpCqusHSpcEyt2gOFUFyuOnyqxF9N7VxiFU4BaTEBSGKuelDDAA9ixX3ArlbkFnDRVSjRvS4GyUEWGl2UGm9RIAShmraWIqSR4VCEFwTG2v9l2rWWQTyQu3gGOurjOuLCaUmWsTAButnX3B2qHEetyQOpetyxOumtaU+surkWuuEluuHkBr2qetBsUXBveqhouqsRSV+pat0E5GdMNUpF+GSohjOt6udNtQGvAImGGt8v8FsLwGVzxoOAmEtOpUsAKr0GqAvCvAuNQDcR/S0iwzLlIM4HhE5DAEjLclAnDkFrzH4BFq1lIBSAlqmCls4CjNAiKl6oWn6qRgOnGhCFgBxFeCIlujYgiAgighgjggQmQjnDYHnGUIYvmvUP1Hun9EqqeiEhnX1xaH+wwT6jo1LVPHgDYDCE72NGqU+RnXmvSHpVMmkgtUsmslsnskcmcgiAzqchchzqzvzrzoh0zpck9wTFcFynEq/XYp5vST5sQGkvjrOtyn8HG1ECQFAECHkEzVCDwGvBAFcFcCAA="}
import { Hooks } from 'wagmi/tempo'

const fundSync = Hooks.faucet.useFundSync()

// Call `mutate` in response to user action
fundSync.mutate({
  account: '0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef',
})

console.log('Receipts:', fundSync.data)
// @log: Receipts: [{ blockNumber: 123n, ... }, { blockNumber: 123n, ... }]
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `faucet.fund` Return Type](/tempo/actions/faucet.fund#return-type)

### mutate/mutateAsync

See [Wagmi Action `faucet.fund` Parameters](/tempo/actions/faucet.fund#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`faucet.fund`](/tempo/actions/faucet.fund)

---

---
url: /tempo/actions/fee.getUserToken.md
---
# `fee.getUserToken`

Gets the user's default fee token preference. [Learn more about fees](https://docs.tempo.xyz/protocol/fees)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/fee.getUserToken.md","from":185,"to":5517}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"5479b50dafab06e9b134224ed428649f20a0a0eb27d506ae6e901fff4d3d8fab","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinKTwAK5yaKltAKpwZAAqEADWigB0AEp6a6RgAGqha7ii2vrqsrXKqkjN1K16eFWcA2DHkFisAGYBo5nKNGhNqF5pr45tQAkxWOwuEZBMJSuUpGNKvI6t9EDVtG08DiTF1wUgoSB7DCRkgAEy9BGYKYGGZ+NELAz5LGcBIwZ5lV59axsklfBqMykAgxiiXdSHQoaw9njDyInk+WalGiCkAJNZgfi4zi7fakI6nMAAHgyiWSAD4gh1kqlXVkKJwsI5mHoyHBUjThGdVWdbYcTucAArB0OkOAu4pKd0RVKJ0gQZiMfZOuP2hNgS7XW4PORPd25MDiENwIO8GA2vR7eOO0pQCC8BAGADiejgnFU7bWdoA5GPYAlxCDReLx+WzsbxEpB8hkCA6E2sApSgADU9oOC5YWFYDRVbiGh+5IB/BoNBYTiuUX55icacAAQAd03QsAHoYlWadL0xa9xxgTEPy/Atf0A4DGDA9gYDAhwLDgSC8mgrgb0jMdPwSb9kKApRQPAzCaExPDciWOJM04ABeW8YHvGBHyUIJgFyThomw4RUmQOi2AOeA0EsNAAF0KAE8chmEApz1SfiwEEwSxLgtgzkYKBZNSF83yCCIFM0j8LNcCJckY2JOAcOB8DYzhxCAxhsStExo3FWNOztB1FC9TMAw0wSnBiC0tl/axaDZaxeDOZLrGsABWNLp2s2ywFPY8QHk3cgyGZhSm9JROAAWnSTN10KkBiqbUpGpDEYx2q5MStTOA6ooXdVjQG48SoA5lLgYZrSc/A6vkyUKmlX4FHlPpZT+HRlRAUsgrAOkekQRlmS1Vl9ohLkkV5FFjXRAwQjCSIimEZi3RSGrnqg1SHs6F55sQXpeg+Jb6h+Fp1vaTNdo1JlBmGFxEEqeE9W5bw+VRE1AiCLB8xwDgMCiSKIGi1JjzigASYAxFICwlFcY9OAAH04cKtN4cxFBitJWbANAnVG8QVKxAM0mE+nOAtedwSgMLFK0rTxCgKAgXDHh5cVgBuaWZc4SBLRgABZPnNzIAB+VIADkhDbfXG10UgRbFmAkksKB1cszXODgZIwBNzgggxlM2vUjW3cEqbUgACXCfAXeDj8olY91ODzAsixgJ0w7obM7bAcWnaznOYGdoOtI9pQwG4NZVHYRgAC971xb3fZa7qIwrwhKdr4wwCuABHJ4xDjhOk8LYsAGVPfLyv27roQrkG24Di8TOGftx2C7zh2Jej4OS7AXX4HG3RUj4zhmwP9tXED12Y5P/fDdSMfS/EAAjBQ97gM+t7dmy2MH78U7TjOn9NbJTOJwSoJ8MKcBAUAmWSNUjZDMP2UICCgGfgZgAKTgDPLAvA+BRS5uvVeUB3RAJAZwNkbIIGrCgclIBWCbhtm9ivTeuQ0E0NAb0awVD2xkIZnxDW0DWGcAAGScGJrQMmFMqY0wiL2fsg5DC8HwVwe8Eh7BrzQBAcc+B2y8FCHIH2zA4BKDOPsbOZAIjrm+oSXoEJ+ifCBuSEGVIDD42ihDJAxIoYslhmyM6BoUZXVNI2ZsrZdEmAgAoXIRBJAPSwQoX0ESjxUD7AOPABwdFiKWJEmAtNmDQA2O2TGxADLwDcu7fIChOCwCfmsJQSgqZxJydo+8nAiwVMLHIWJmjtEwFyOg8QMSR68EplgJ68T2whmZHkOAP5ilEFKVATgT8MCcAAjAJ+yz8wATtD1OyYAMmTIKVUugqkxxoAAlolsMBeCMCSLwIomJLBc3DPsgAVDwMRroJm0xZuEMcAFPIuVaoQKAY5gT2DcmOY82SFBnDkBAXiERjwBhhUkmAZwyD5lIGZWmfMllouEDks4QFbi4paXEPmyzJz7CWT0gClMaCrjcmAVZ5tYBnAAFbgrQHeZgZxcgfO4DaBFT9QhZPRbTHCEgdafWSDcDRWiGWeXbD05Ax5iltnfqYtAfYK7HlkkEEyWBwwgRApAWA3KzjsCUCBVJcAQJdJoGISqRA2SVDOLQEC4gsBoU1fvM4L5mByAAMT+vfmIPVaA8bZ1yOq8NPVI1YoNUa18JrEBmotTAK1Nq7XyMdVxF1bqPVep9X6/MWqepBtDQmpNpBSCWM4IckVEAxUGMJT86IVKn40rXoCyuFc2kEUaROMRWbECwtyRAqAhSBVgFyAAfTeW8gA6pIPIyhl0LtSM2pQorxWTs4K2zlNy0CzhvpXMFblqGWCBWQOJRYaBczkBgXIcAMCWnwPmSAU5ODmFOL0rZEAdn3u4ImAAkucnRqygRwRfjAAMkBbaSFVdBh9Yg2YvtyOED99hv0EzHP+9s+ij0TltuyjF3L3a8s4kY0BI8VyjvVZAJlQhAwVv3pwcDIEADyKbjWmvNdAbNPVc32oLc6tArr3Weu9b6kCCbA1oGDSG8QlUWMwEqkISqCbKqCCiAkdguR8nUIsIZ0gzBp4Vn2QAUVoAeKpU4R2ZL3a28VHacnHkQPsvK3L7JErhQi3i04dFyARWs9gcgoDTgiC7M1idKYvOMjAMLSrIuS2ZZGgmaB/MTPhYioIIWUvhYAKS4QDNOS5pAosxbiyBBLFg1KOWK2l6rGWelZYrrl4lWL2BBEsABTgNn619enCuwgEATUBiwSCxpYqlkOCwDgJ2MXYu5Hi3mRrY5eu21PobFlSzyi8GOEpJwqqrm6qxd5sA8XBLDexakcbEBJtwGmwWPQ+A5ty0cj65bBd1v1Zlq05AMAYlyCMmlX6aUAea1acM0ZaAzikAtOBg5n24CujRj7cdRBmC/QhGyX6AAOHKt3ZZcB40/E9/Akco7R0WTHARsfCcQLj/a1hpD7RJzDoHXBx2NbII2OQCmOPvxAnQG5FdcTknUL9aQPPyecBB2D2SlUGW/bIE0RAFCFcRS4KD0I8PGBjOZ7ARAAvbihBF/2fe4vaCS87uSRoTRrCk8B4r/nXNBdW8sxYcXYOF1SOUNriE+19lMS1k2ds7ExuMDC5wC4racJCGnC7SdJL11BGPAAET5jbTgZMQkwFcAAQk4Ln5QZAS/HjWzd+rm2kvl7z/eldceDGJ6fsnsAZeK82xLwGDrl3625DyrZ+zrBHMe2UIB483zPPRC6e/a7I/Tx+ctA5bLrk2gjxo02Ee73CAATMmnhyWKt96B33y/fIZD/H9y1wZgGA59VPYgNppcLn8wCCNlgMWLa/Gaf3RXy2C1C3Cyqxq1rw20Sya1ANayiwHy0WywAM/2AMK1gM4DKyyl/HAOi0gPr2gKVnQJwIQKPS6zAEfxQJ236xgEG3u1Gyexeze1m2n3mx+yW0UALlWzqwa0b2QDoNIEewmym3dne1UC+wWw1ydnkmZSxXDwciL1clj3jw7y71T2QKANJTACz173vULyj1Lyb0r1IGrzwJ4Kax0Ntlb2UKTyJW70ML7xINkNylPA3C3CQB3DKHFFKGQHoVIDbENQEwzRAgaVUDWCfjOBiGYCE0tQdSzRAhflbRAmLVk3MCfnQgC0o0iAKlmgJH0H+lsAcTJApH+DBgyI8ScW8SOlhmsH8WRkunmHRhBWgCiBQKCyCD210G9j5gwADBAUm07lCE6ibCVm6OQFkhzE4CIAgAMh9gAGpegj1ZgEU5ZZEUl5E8AG9zxmVjxOs0BaZ+0XIBt1RQFdYQRjcqlWg1gQwXku1NIe1Ax/kC4AwDjelcgkg0wuApw15whANMYWBJBVkOjiNs43J485YoBPJcRxUvilkfjgQn4xBPIpchBolHgykPZOluktF41oCEgggIRkUAi00gjLMwB1BrUdBHULA1gvVSSdNDYHVSSIQRdGsEgzgIQlNg0coghR1LjritiUNQSDEgx35FUldjwpc5Box2BLM0BcUiS3xBMs0c1KTxMnUpJpMS05M0JJTOTQ1JTzNZTDT7xKpWhIhLEfNV8Lx19HoihopXI0oT8MjUDpxlFUgStosAxlFTDNilY3TOA0oSDdjutAsCtXSCYuZEAsDvTuDfTUh/TAzMtdUkDnDjx9kGN2x1VdTjS5TCTU1FSgjlTRNVT811Si0ZNS15NdTq0Q0DSZT7wczTSdB7pzNuE2lEh6zO4rE/g3CUBdwp82xSgiBrAzhehRzUpsjrE8jpAic5RHFFQSi8AgtyiahDoYZRgidajkQjQGjFgHIgQQRtgApuxzhZ4hoawnh8QpRtdehFpSQGhfglRAgDzNgVzNR1z2QEZJhvAJAlBSgi8lzEUryfoKEvFAYyQCi0Y8AAAxRjcsdSNyFWfeVIacOKBKXgVKTCrC7CnC3CvC1KLAgyVIawTSVwcoj4Nc7UGwVwWaGIWADED6IibyYQBCMiJCSrVCECcSCAPCK8QiOVCqUiciacM4dIrIBiG05YF8rgdidycQTyHgZinqGMLacsEKZ6KWSyNxSM2KWgdQSoNkKACENKNIXgRoRoCESoNIdKAnaQNkNKcQCEJ+InSoSoAAIV4GkBgHUDSmkDSgSGsCfhsyfifiylYRyhDIxTaOnFgvO0dCjIDGkpylKFanECQFAACEUA9iEDwHPBAFcFcCAA=="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const result = await Actions.fee.getUserToken(config, {
  account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
})

console.log('Fee token:', result)
// @log: Fee token: { address: '0x20c0000000000000000000000000000000000000', id: 0n }
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/fee.getUserToken.md","from":5603,"to":5727}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Address of the fee token */
  address: Address
  /** ID of the fee token */
  id: bigint
} | null
```

Returns `null` if the user has not set a default fee token.

## Parameters

### account

* **Type:** `Address`

Account address.

## Viem

* [`fee.getUserToken`](https://viem.sh/tempo/actions/fee.getUserToken)

---

---
url: /tempo/actions/fee.setUserToken.md
---
# `fee.setUserToken`

Sets the user's default fee token preference. [Learn more about fees](https://docs.tempo.xyz/protocol/fees)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/fee.setUserToken.md","from":185,"to":5268}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"f0b0a406d4ab0b85a6a931aef7b66a18557d4e63a6f5cf4303ff3b1ade02ff54","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinKQwvDCMWGipACpDwsOCYABKaxtbpeVSiAAc/bXKqhotOnp4q+ubDPIWVgDMA0czlGNwm1C8018c2oASYrHYXCMR1MV300lkD3qz2orTeBiRJi6vyQAJA9iBIyQACZGmDMFMDDM/DCFgZ8gjOAkYLhRNp9L1rDUFI8GqTtG08FyeWZiYhSeShsCSZU6RDGVDSjRWSAEgBXMD8I6cOB6ACqJtIOwgAGtFABlDAGgA8GUSyQAfEEOslUq6shROFhHMw9GQ4KkCcIAHRSqMmtDmshW21gB0GqMABWDodIcBdxSU7oiqQzpAgzEYJqdwFynDrnF1FtSAANrLQACTAMSkCxKVzNgDctfraBtihbbc73d7/aHYHrKzOX12+zghyEp0+WznrnduTA4hDcCD62NZotyftjt4pSgEF4CAMdr0cE4qhgDYtAHJX7AEuJdTkLgpTfMcwCjXJcgAOQgGhdnwStOEQ8RjWvfAy0gRtOHXedVHELgAHdxEYNBXwSdg33wD80FXHDQNyAAjD8LF4ORdVgKBOCEbDOAYuR72tXiYHI1ZFzQXVSDyZQeNWY8TBgKNNXEJRH2QZAQDoQ8sAUUpmz00jcnZQpgGiVZ8JgP1kgDfA0DQLBOFcTky2YTgvwAASIpQKwAehiVYv0M+FjLfGB4Qcpzy1cjzlJ8vyYF8hwLDgAK8iCrgTMjV9HISZyos82L2Himh4RS3IljiAtOAAXlMmBzMspQghredokS4RUmQYq2B2eA0EsNAAF0KGHGjxGEApSNSZqF060K2CjRgoAG1IbLsoIImGlr3FyVwIkgg1YkXOBAK4GrxCIkieENEwY25ONzyTMC014L0CwDabQJTVIvzbKlrF4KNAesawAFYQa/TbdtyPTmxAIb1KDIZmFKb0lE4ABadIC0U+GQERw9SnxkMRlfTGsyRnM4Bxih1NWcTJNMHYqLfWjrvnD5zi4MbOJgEgwC4KB8PEHGhrKPk+l6e5hSxRBemaHFXkCeNE0tJ7ryJHo5UBRVKTlUEPHBBkfFmTVYQMEIwkiIphAqt0Uixu3Aom63Ol5Co+ipG55DqJ4mheCUDFRjX/m14YXEQMHVSNploS1QIgiwMscA4DAolHL7OGyEBfv+4G8/zgvC6L4vrF6LPLnF2XKlsTFfZB/28WoMDg6QSpQ6VRAqSj7wY9N7UDyPE8PyWCAFFyIhJGtuBR5gX0TBn2970fEAmY/ZsR4UZtOGYaBAI/RPiEW+AeLgfIFE4WAGN1JQlF7KeZ8o/CkNfU+KzkSfR0omBcgAKXECe7S8B7Fse+58QzkjyHAFyB8iBH04gxDAnACIwAYrxMsBELRU32qvbeu9z50Amq+NABEIDGhwLwRgSReBFHhJYfm4Z9oACoeCcGbK6aem9ojvzgK+AiJF8Dbz0IQKAL9dT2Gwq+de88FBRn4o1CIzYAxSOEDPKMZAyykHWlvbmrCN4KSIpJLRj84hjSEp+GAnFP4ER7DQUC2EwCIJgrAKMAArF+NE6rMAgmAZh3BOBKH4gxUIujpEwC3klCQBph4FgkhYux1iSLUVIcgZsB91g8LjGgO8uo0DNgGkEVaWBwzeW8pAWAbiozsCUN5O8D5vLvxoGIdGRAqSVCjLQby4gsCMG8mk+AVMbLMDkAAYj6TwsQ2S0BRG5rkFJYyqYTPUXkgptkimIBKWUmAFSqk1KXvU8yTSWltI6V0np8yoyDJGfMxZpBSARCjJwHBASIBBLkCElRnDeCmKYuYzifDVAQByUhNKd93ysM2YgPRW8d5QD3t43IAB9RhjCADqkgpJKGRQi+CH5nmvNAR+F5Li1hoB/IIgFIjsKiUsPwsgU9Kw0H5nIDAuQ4BoQwoC185hbRfzQRADBdLuAZgAJJEKoog2SoU+IwADJAUgVLqLivpWIRQaBmW5HCOyoQnLODco/KEN5sEqLyqcQpNxxoPGHippwZ8iqPwpMgLY7i8zODCu8gAeWWYU4ppToBbKpjs2pcB9mNLQM01p7TOndN6WWdJAy0BDOGeIdGjqYDoyEOjeZ6NBBRBErkHeokLAiWYPhI48KwAAFFaBaXPo2UFzM8XBOURwsJiB9owzcWVUJsiICNS/FROQ/EkHsDkFAL8EQ5wlM4KWCwk1OADqHSQ0go6AyfwmYCtAXaPkKTkUEftMBB2kIAKTJQDF+Jdo7x2Tu8tOns9CVoHsXSOqAq7SHrpyVultajbnsCCJYAinAK0/s0V+FFhAIBFIDNPYmCFpJBM4g4LAOBLBjoiBO3IU6Z30M4OoiiR41y6HsZxcovBBKjVPGurJ6i21gCnXWIDGjUhgYgBBuAUHyxCLvvB+dXTkMWIwzehcT9kC81CMtEGssQYCYXNhLggDgFoCjKQfUwqwBM0rK6OOnA/1+sQEQZgss/hUlljcPatHBP1ifu6hixL+BKZU2phCcBNMBG0xC/TcprDSD1mZujlmuAQtnWQA8cgY33n6d5OgawclHEQOodQstpDSaE1wETE85ADXRtY3jZAmidypMl/zOH0vya+G53TQXJKhDC3GyLtBovGDAHFxoTRrC+Ys3WJ+gX+bBeqyWiwkX0sIunMoTufw5T7XKpwAeH4aqgcYIOzgxwXlJSEF+OceiowGLAEEZsAARMauh5Wdhm64AAhJwA7ygyBnebOh8zt7Z3hku4dulKKFtvOWwxVbYALtXaO2d19FrYC3OhnpfaVaa0fjrdJMFbDQlb1YuEBhYAwfNk7QdG2XEgU1TaHaS1zA7QccIARdaG3DrqOqv4vQ+OzKE+J/ysnn6uDMAwOwh+NV/0EqjOzhQQQN0BnUfd/NbPu27v3Ye4dy7UPXse/e+dj7SEXpfXYjdIvec7t7Xuhdx7T2uWV1e6TWG5066lyu1XH6wCs419+jRf6YAAYY7+0D4HIPGg46oLj4gEM5ZQ+O+7mG71zuQE70gTHXdsfdzBr3PukOKAsUNOx6jJuHRm1T+bi2vs/fW+r7t23dv/bpSdw8MBzsveu6QW7Aeb3G+e4X+V73M8rZUb98vAOgfJ7ADDJSKkkBqTKNyUoyBp4SXWPk716zvK31ULqBiUYYjMF9eU4NmzvJ8Red5I5kbzAMV8t2txEQ4ai1RH0aQQofYNBqOKRueiW5xfbrraw3dIQm3mPHGD0Aog293fh5SMAAD8qQY0GAAYgMlSWwRwoQ5MVqQBDiyAA0xYnARAEAi02mAA1L0FxLMPxN7oflQEGngLXnYs2O+rkkgvwtNg7t0ApJwAALInSbDnytC6ghjYZfLzg/JBg8IWIBj/ICLvi5BJC5hcCNhxLhC8qJwsCSCIK/6EY6IGrYRQBQAkSQFvKiGcTiHHQMRiAkQxZCDjyhC6jHyvwLYfzJKpJB4JBBB/AKLj6rKT4lpgDqCVI6D1IWC6gdKOGZp/7BqOF/AxqzoJBRh/AXIJpyBmZBBgrMGsGkQKrYSLZcEmiWLmExZyAxjsAlpoBaJ2F2Q+qbLbKuFBohq9ThrHJRo9KpGhGJqpHFr4S1FhqtCRD3Ltp6QY5TYxD6inScAgzk7bo9p9odH8ypBHpjoBiDFTKy616pDjGpD1x2KkGfqqLi4zEQxFCdHV5y5zozHdFA4LFd7g6o6pjcicApKVH1HZErK5GT75EBqFF7INIlFb4nLRqVGXLDI1EZF1GfENE6BWwiS4KFqJDfFlo96qTqSnxRKlBEDWBRi9CwnAxH5uzXB/T1y1yigNyBByJ341AKhhwgjP7qiv4sjtCHQczLiPKsyNabicwVzuxjY1zSy+xX64iBBkkXA/Caw4mDB4kkh/AEnGzMhxx4AJxJxkCYBpyUlHAAAS4Q+AE4HYXYNEM4sM+BS8eAMpcAAiEACQlEiEo0BwbMtJyJfwXsaJfQqJ1+gQ+pa4bMGpagHJVgXJFI4clQvQ/JEgSgpQM2eAWJSJ+gVIYM3sIoSANcQpBgewY0NpjWPGmpqQbYvQVIfwlQIMjQ6gNw0g1g4gDEvAf4CZSZKZaZGZWZOZwkeZyZqZ6ZmZ2ZuZiZ5ZhZVZJZCQd+GIuJHcT+osMQsAcIzsGUbMWUEULk56MUPSXUEAKURk6ULsyQ4UOUkUX4UYe+dspUmOywJkbJXAjkZ0F0iIfZt0CkysF4asBor0ds70I0YE30OcvAJcN5t5hcvQEMO0ZmixMi4uEZBp0ZDgsZqx65UY1pOEdpZmpQxM4gSAoAAQigp8QgeApEIArgrgQAA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const { receipt } = await Actions.fee.setUserTokenSync(config, {
  token: '0x20c0000000000000000000000000000000000001',
})

console.log('Transaction hash:', receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `fee.setUserToken` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/fee.setUserToken.md","from":5614,"to":6020}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.fee.setUserToken(config, {
  token: '0x20c0000000000000000000000000000000000001',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args } 
  = viem_Actions.fee.setUserToken.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/fee.setUserToken.md","from":6047,"to":6224}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Address of the user */
  user: Address
  /** Address of the token set */
  token: Address
  /** Transaction receipt */
  receipt: TransactionReceipt
}
```

## Parameters

### token

* **Type:** `Address | bigint`

Address or ID of the TIP-20 token to use for fees.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`fee.setUserToken`](https://viem.sh/tempo/actions/fee.setUserToken)

---

---
url: /tempo/hooks/fee.useSetUserToken.md
---
# `fee.useSetUserToken`

Sets the user's default fee token preference. [Learn more about fees](https://docs.tempo.xyz/protocol/fees)

## Usage

::: code-group

```ts [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/fee.useSetUserToken.md","from":179,"to":390}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'

const setUserToken = Hooks.fee.useSetUserToken()

// Call `mutate` in response to user action
setUserToken.mutate({
  token: '0x20c0000000000000000000000000000000000001',
})
```

```ts [wagmi.config.ts] filename="wagmi.config.ts"
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/fee.useSetUserToken.md","from":446,"to":758}<fsm-vh3gqscxm4e>
// @noErrors
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})
```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `fee.setUserToken` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/fee.useSetUserToken.md","from":1050,"to":1564}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const setUserToken = Hooks.fee.useSetUserToken()
const { data: receipt } = useWaitForTransactionReceipt({ hash: setUserToken.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
setUserToken.mutate({
  token: '0x20c0000000000000000000000000000000000001',
})

if (receipt) {
  const { args } 
    = Actions.fee.setUserToken.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `fee.setUserToken` Return Type](/tempo/actions/fee.setUserToken#return-type)

### mutate/mutateAsync

See [Wagmi Action `fee.setUserToken` Parameters](/tempo/actions/fee.setUserToken#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`fee.setUserToken`](/tempo/actions/fee.setUserToken)

---

---
url: /tempo/hooks/fee.useUserToken.md
---
# `fee.useUserToken`

Gets the user's default fee token preference. [Learn more about fees](https://docs.tempo.xyz/protocol/fees)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/fee.useUserToken.md","from":184,"to":7694}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"b8231de1b5901110cbc0e94b2094ed4e055d2895dce944b0b9737724513705ec","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUWKQQOBwYAJScUKJiiJzaaACqcGQAKgLyAHQASjoArqRgAGqiMkUwnAA+nEVgsABmpjBQ/lAQ1gh6mfg1MqIinHBF1tbwcM1FMjIYnKTwEDIkUHEJopzN7JzKNQCO1aQYuQA6YBcX/YPDXGMTUzNzC0twK2sbYtu7+5xHZFOV0uYBunCGIwekzg01m80Wy1W7S+Wx2pD2A3+xyBIOumIh93G0NhLwR7yR63i3zRGMO2POuNB+LuoyJTzhr0RnypqN+mIBJ1y/hE4l0ABZ1MZ5EoVIgxRpxCk8Dz/CYzEgAEw2OykBxOJAADncnhweEIJHIGkCeGsEDAIyKGVI2X48iSKXSWRyYAKxVKFSqNXqjRabQ6VC6PTwYIJrMeMOe8LeH2RPJ+6L+AtOws0ulUAEZZNLlFIFVodHhHV7XWBVW1Ndr7I4/Ih82LjdQvGbfJaAvQmKx2FwDIIc6KkAA2SVyRQlxCSzRKvQjoxq8xakC2Jv6xAao0eTumvTmvxW/t6FhsDjbGC4YS5pAAdkLUtnsoAzGWlyBmre6+rd0bXVm2cd92wPTAjx8C1/Boc8f0aRxGDtBoMk9Z1vQAHgAYTtVoFAoZIdHQl08kKNASnKSpqgAPlCexmB0Mg4CSFdcl/GBcirEjvVyAAFBimNIOAcLwxgCKItInVIn1yMogNaOiVi+EEdjby4tDpN4uT/WomBMI9LSa19CjdMDGiLjAURGLgLAHBqbijPkTpul6fQVPTSS0FMBRaVQsgAHI4DiGBmlEWYuA4vZeNg0QFF6ZBkBAOhrKwOR/AAAyytA4FoC5LyHThgB4FTgtcbZwmYTgAoAdzi5hGAAehoQcAuBGYwCQlCAEEsCwYJYmAC5OE4W17S4YqeUIxg4AAGQgUQoB8zhyoAXhKww1M4xzq3kYIhrAEaRocW1GjQJIAosWgNQsaxcnuiwLFUVQAooYaVuiYERsYZpOGCGb5sWnzYiWUzDswpaiBowGlsUe7ckwxrIYsw6ETBzgIcYKGZKSYAeQAflyRaoDeOBXER5GLlcC4soykAAF0KCSuzdWYfwWesoTgoAWk4ATWa5oVGaS0HKKMABFbEyQizgasYZRoprThidJ5Wmk4ABJAARIXGZAEUJEQR9p2LWV8w3RcKz0HaMJrf91yAvUW3ffcTW8E9ezgoJQnCSJMFiE6IDO/Gkgyq6ABJgBEUgfNcDK6iK96RusEx5HOzhsNTsA0EwzJdXtK80EI7C7FMBOQ1CsNCIOo7a+VqASamJJuob0mAG4k7ryBOpgABZUQrO0UgQ84AA5O1Jn7weyHLppK7MKAO9RuvRnEsAR+CeiBacFjE+XlejrsOB8FY4Z8CXg+Ps4VaaL5yqZv07g6Bo2Jgzn1oF9n0MF4vg+4DX7qRRlDsEYAALwSMhdeSRN4c0YjvZuQDCAx3Ad5O0hQAQiFiDfO+EAGoZEwgAZQAYgkBKDIE6VBF4F+X957Ijft/dov8V7/wUGAXuUw4owGgcVGycBOErVxp3S+vDOFJCIaw0QAAjOQ7CYScKYXXVwWDb58Xvvgp+tAaIKNrvDTgYpODMHYDUeG2ijqQS4ZwM4xhuiVCsQo8q9QABS7wwD5CwNYbqEwg7ZxoR/doWjO66I1BqAxRjOAmM7u8EokwR4Vz8YvKmCddH5nzKEpY4T7q+LDC5KMehPGnR8QkMQthkRoAgH5awlQZB/WYHABQuQMhz1INEIU95xwuA3DOGUT4vxWxAIHM69skCfk3DqJ2zgNQdnMd2GCZ4ghWRsnZSYo07TkhgBcIg4gVn2hWBY3COz0oRlctGTEGUxprPjoYqAswahhGIIwWAwUtj/1YHIEKkiigKAUMtc5uyMQJE4DNVeDUhgZnKfsC4jjRCbIIdYGOWAuC/LeYxLcYAZpVTuUQB5yJJELBqjASRnBJHhBqk6OADI8Q1CuTczgdBC7BTQDVcptkYDWB+owawKzBxmGzixYEAAqTg3VOAZX2Rc0aEJgpywVnAwgUBgoPHwMrYKZzVm7NyDICACgBoZUIqqg5nEyDhFIDqtW6x9VrNyHVUoprlAAsqYdSRDkMjrDKbLGONBopqwWOPWAuQABWCq0BLGsgyQVwqFCaskZUEVSKYDx1MCKHu2z8IlFKeUmqHqahuuQBlO5xIGloC6EAjK9Ngj4DQGgLALFGqNUgLAQNuR2AKCRq5RqQwaAiG5kQDUYpci0EaqILATV81TFyBW5gMgADEo6YQiGLWgAOTQLi5tneS+dRrS3lsrdWxAtb60wEbc21tPR20JHgGgbtvb+2DuHY1Nd460CTpneEYkG7SDNNyJwMEkaIDRuqRa3Z8cHVEudciaVhAgGAsHBwZafwMoHsQHGy50AbkUrAAAfX5fygA6uINFihsMYaSD+qNMa42cD/f61laAgoGJ0HKp56SzDywGOic5M0aDZ3mBcOAGBOr4HCJAR04JGCuj8sSiApKZ7dT4hrBlAxOQZGYNImAhFIDonENmxT2z/4iDTjxqyfGBNCaDsFEw4mqmUf2OiX1nFA2jGDTAay5LOAENvH5XNkBPUoTXZrRqAB5LdFaq01rrdAQ95Lj2RjgGeztl6e19oHUOkdr6x0TunaIbm3mYDcztNzNd3NkKxDRBcQx6TTBomYBAu06GACitBUpvMdHBzEv7/2xrVXIDKiBgS00DRcONGqtXBACgMOYGb2AyCgAFaIS9a131MDlJI43NWyym1AQibr51BzQINrrnFNXarGzACbnAACkcBXrVSZaQabs35uNUW7ylbp21u3em1t5lRbdv7YNbkI17BghmBqpwOrH6gcBRw4QCIcBCLvFlctaN6w7B9XkO0Wbc2LgLdUUt4KgP0QiO0GaxzDh+B7GAtm77sAP29bAAtka4PjVJGh3wat8PcEMaR4tTgqOcAL2x092uALkAwE2TIem85WyqEF3XAFsL4VoFyKQRoGsmQzX2V7P6iGiDMFbO+DUrYDSfXp0Lo6AKAuSOo44ZXqv1dwE14EbXEXEC68QO+Cwkh3fG9l8LrgiGltkCsjIe9aWYSNToKyoBkCjaPlbJIX35uuCi/F/Tbmmah2REQBOXcGpE/HS4GLyoCvGAIud7ARAgfSiVFD90KYEfaBR9QWAI2OeJwWBNwzpPnAA/ZyDzX6rpgI/i4w9HHyu53zu+BOc/3nNr7VRw4wOYnB8h/sTXaAKS8hvWrAMEDKWsB5D04JHBZMBXAAEJOAH8UGQc/GUsem+e8tq/h+Z6L+X6vyR6+wCX+v0Pc/X2jmNOpANMWUwIDWTWzqrWNQoqB2wGkqdOoBGUA2nUqyXAu28+KQBCTm1kBCnOhANUA0W+aBtKH6mBOg2BIazAeBjEBBRBf2IwzAGAYqfy60IOum6qLBcgwQu2hERqD+ZWzBB2w2x2q2k2d2M2D+OOMcL2vOb24hn2Xqv2YATBXBh2I2J2Z2l212tUG2D2suuOshYh62EhgByhqhwhBOwOMAoOTOkOrOsOHOiOigRKPOfO6OkhUhT2hhz+yAdhpALOMO7OownOyg3OKOmeHhjMXqRq0+JBp+8+UOS+1Sn+3+m+ghahVq+Ge+f+M8J+nMF+L+N+pAd+XhT+u8uR6I7+KRa+OyP+RR/+gBsRYAtMsU8USAiU+sf4VAyAUSpAkwZaIWu6ta3yygRQkiuQtozA4WDasWB6jU0if6jUiWN6JgkijUQ2ga0QDMesBsug+YBYRYb4PS1AiofScaQy2ejsIESAFgUyXYx4PYsE1oegwQsq0AsQmRR2bxHC2gI8A8GAhE8MEQzelQ/MLmSQAJyA9MSknARAEADyf0AA1Kkj2JqotNsUcrkiAD4QyuUhlDtiWrLKxj3jYWuF+r3BFKXm8oqEUIxLyqNAPKBpwHZDCO0IRBBrSBcK0MJFwFWOsMMH5GECwOIAsETjUAPAKcvsTPLJAjGvycqqyJIiIPLNHnaBsnpAqiwEvlsjmnmjIWgM0MEO+NEMFjunuo1NVmAI+E2loO2qYEUAOlaQVpwrFlae+KHkts0LkO+I+pOibsEH8LSfSTlMrOklZqyS6l6rmtHjIOxOwNVmgDqoMTumFgekenaTFnFheleklrek1LGX6dOrGVVgkKWZeoqHANEC0n1llCgTPismdPPqoMQf9t8QFAUunOdjNoRJ2WUbiUkJ2UkOoF6oSXtqgW2RoUOddn2Y9uUYOd4unCOdtj9kAkgcCO5jUDGd5HGeWcmduqFhaemVFpmW2h2jmSsclneoWRllOiWQmWWQ+RWVoFWZ5OVjUJVk+ZAq0qce0SgElP/D3P4EQBYLkPmGBY9DsW0obAcdIK+N0u7r0kEEdpcRONcTuK7IeO7E8XMjaCQVWLbG6JJDxMZBQgpEGA0O/NkliW5DGCyFCOyKSMmBSCiJ5JmPSGODBQaCbMcS4EhZWE5LWLIPWFcaMtuM7OBG7DMqeH2N7Hcn7DEPXI3DCKHBHFHMGrHPHPQrQuGPrA+PHmhfBXOI+PxXoCrFMKhehS2BKPcVBB7M8fBKfrZPZBwXIBqexgdkkGoTkrRacshqEtcm8pitik8sCmlDULAB8l8j8gdv8lwECi8jqWClyWAFCjCnCqXoirFSinYGinABiuEFirAOsLirLASkSiSmSuhmCNSm8nSkOAykyqMDgGyq0JylMWwDystgKkKiKmofAcMFKiSe8fKnGEqoKYBnICITqnqkNlYaaSTpNZxDvranYIikyU6v5K6hmlml6gCWPBFgGkGlQWGr1e1jGktQmuNAPMsmNKmksNte6vLFTpwKumHuuquWgGaYefuhFhmS2lmeeV2pefmbXgWreWumOUulACuvqXXjCIWsAd9cMTMZFraQDWeeesDdelealvDeShDe9e+p+t+m1mRgBv5SBptQqRBhgQVLBi4fBohv5bVZxMCFhrhvhj5ERiRmTX+uRrFVRjRnRiNUxjUCxjZrppxgZhgLxvxrYKZiJhZtpjUJJtJuiLJvJrSEpjACpnIOprsFptrVLfptxrLUZvLYJnaGZqJpZsvhAJLXZkdY5lQa5puZ5ghg7TUL5u9f5kFimT9ajf9SerFkDQljjaDQ+reVljlnlmAAVu9UVhACVuwGVmEp+aQImd+eAY1q8lAYzXzR1pdYgS0XWXAAwequ2cYR9pIXOQOXIWdjXYAWORXVNVXfIRdldoRLoRIfoY/vXdXRts3Z9a3YahDiauwf4aNg4cEQjlzi4cjrzpEQvJjnXQafjuPfRnIsTpKaTtYOTsGi5SucAXTl3v4YEWznDiEc4b5Ive4QLo/n7q9UXhLlLgcfnsrFwCXgirbmAGrv0BrnaFrsDi7m7vmAbkbp3mbgXpwJbtbkrirn/fbo7vQOXlwm7h7l7i7FA3Lv7i7lXsHmDfXpHtYGqS3o+HHvmAno/d3inpUGnhnmjgETnsEh/QCi/d/VwCAxXgQzXmug3k3jHo+G3h3mw3gzw33tXiHoPvTi/aPhpYoBPlPiCA2QketEkR/rUS4ukROZaitfvq/uiPkYxIUZUaUWvXjkkJUZwNUSvlo3aL/oYwAaOUWs0bTDnZAahNAX1XARKoNSXf1uXbo+gVButFgTgdQfgVJvQcE6QeiGExQREzQTAHQQ/g2RYQavPuwUNmoTwUAnwR+gISoUIZOaIR3TXX3dIZYw3e9kPUoWucU18RocYdod3RU/2eva9o3XU26uYSU5alYZPePdPUEVfXPWEQvW4cvRjtWRY7IX4ePRfY4dffPbfVM2jgvNEW6s0QwbPoxIkbY6kXUToxk3o9kQY8UcfsAKfqY04/fnM8/tY4c/Y/UWY00R+kgW0QlABd0SAL0UHP0TAAHSjaMfgOMZMbgkHXMRFgsVGssRHWsRscIVsVBXpe0jdDxQhSZaceWEEBccJQBNi1uMBDuHcRBA8b+f4KfngChdBboBi0cQhVYLJXgAAGIeZlJKzmUqWcBXQ3TWCPSCtCvCsiuitiuQUEvmBEtjI3GWC2XYWzIsuvEjWfHCHfHin/FgCAkZJNoIpykyDgm1KQlavQmwnwmInBAomUYWjolQCYkgAxZ4C4leoEmfXxyckg7kmcCUkyDeThVhkKB0lpzBRU23KDXsnEkKwQpgA8kOhRmCl/DCnVYnBb18I73qxWYymgnVIKmCljDKneQUTN4amBhakgq6nlJvVenGmmnAsWlWk2nHpqiOmWkDwunaBukDwenCnZzem+kZYBlBlaBBsMlG0RnhuPXblL7xmZ0JD7lDFpl/UnkY2nph25k3opaNQ3lPrFk7nlnlncyVnVnoaBO7ONk+LrQtmj3TUdmLlJDdkzmLkdPVNDmcDLnU7KFDbtnTm9lPsPO7yvvvtAHKHuMgju1Tu7lPnzuplHlLvo0h3ZnY15mbvbvPr3mzuGlPmHsvkp2E7p0xtfm1ZfMdEAWmCTDAWgXgX5iQX0y7H6UajgOMtzgjKWzIVaqXHSviXOCYXTKPGKtex4XjT+SEUt7EWCUmTyR6RZILw+UnK3CQhsgJgchkgpiUibBsX8gcV0uahgRMeyhwWscCW7RCXGAiWcckstgahuDkt2U4VKshDyVkD+yApQBJBf7fI+LaXxKcX0sSh6cNg4vfgPIcdWXOBihktSV6BiAKBUucw0vsfae7hihwVdJzjMsCd6DstU5KzaxJAWAmdrilhiUWfOB3F6y2iwADiFxFQbSCArQVS4I3b1RNQtRsBtQqMkGTSbBJAEUyT1frRsQcQaQwAkV7Q1zKxeJnQXRXSPhigahQDviqDYTWATgThgTYRPQG6SAaiqCiDviSIGhihigABC1gkgMAxskgqgzQFgkidWkikir0VMJu177ZWXis8gSlpMiA12vX3ohM3LVZr3Gh73nLn3uXv3glhMDyJu/gcCogSAoAgQ8g/8doeAOUIArgrgQAA=="}
import { Hooks } from 'wagmi/tempo'

const { data: userToken } = Hooks.fee.useUserToken({
  account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
})

console.log('Fee token address:', userToken?.address)
// @log: Fee token address: 0x20c0000000000000000000000000000000000000
console.log('Fee token ID:', userToken?.id)
// @log: Fee token ID: 0n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Return Type

See [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook return types.

### data

See [Wagmi Action `fee.getUserToken` Return Type](/tempo/actions/fee.getUserToken#return-type)

## Parameters

See [Wagmi Action `fee.getUserToken` Parameters](/tempo/actions/fee.getUserToken#parameters)

### query

See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook parameters.

## Action

* [`fee.getUserToken`](/tempo/actions/fee.getUserToken)

---

---
url: /tempo/hooks/fee.useWatchSetUserToken.md
---
# `fee.useWatchSetUserToken`

Watches for user token set events on the Fee Manager.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/fee.useWatchSetUserToken.md","from":140,"to":4636}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"f9462d4450dd5426fccf47a3f9f6bfcb416366af2a61b5019d81726cd9f71789","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXABmMLjCmroALLFJispIAxlaOngdXcb5SEUgtvaOfogAbFXUXrW+DQH0kwCuYI6MEGCcB3AwAOqiaLYAyjoAqlekACoC8gA8AMJnbUYCgAfAAKLD2Zg6MhwAD8iE4wAAOudOGjFqYAJJQeGcMAHZgAIzInAAPhcwLBAWYoABuFFotGZOEI5GoxmMy5kXEAAwstAAJMARKRTApXDyyZw+YLhWhRYoJcgALpS/EyGRSo5U/J0hkcxloL5gXn8oUisUSqUy83yy08lVqg4arWUmDUmB69mcVyunU0+netqkCDMABCMgg1n4uMJQNMXHJ2vdusDHLOAFFSCHSLjQaCyDmEVmcwBKTgAXmBnCIEEYUHLSbdHqgfpTAf1aLYGtx8oOMDbLcHqc7nG7JkUmLATiIohkuPxRJJTf9nuHHe9Z1eZE+/HkTzQedBzIRAHc7o8Xm9d/IAHQAQS0cAonEjCjPF/wB+3H2Nt4AMhACjllWNZ1g266emmjLWACQK4v8YCAgokFehy8iiIScg4gihJ8HIojnCu7ZrsRLaBq4pYIrW9YomAohQnAELWAOXK3PcX5Xjuxr+FAUYIHoOScG07CcOeHFihcbycEae7nFcXAwCQ05wLe/hiAoAnIMgIB0AxWByP4PLGWgcC0CiIStIi4SGD6wkhswnAAOTngozCMAA9DQLROSiKJtEcJxnJw95YFgoLlmyaI5KpUy3mxn7ftexqglFjJbslckHseT6RaO6JnHAEByLeb6gk5P4ycanAKYgTkvsypaju4+qUX5qKkDoBykOc3xQIwRDAuxtiSSJpBSSSsnyJwiyKPAt4Ld8Hn9YNKKuCixk8iAyoUDpEKlMw/j7Qx0KkHAnAALScAACpCp2qdtO0gNEEiIL0iTGMkwyIAUVhjFkeAJRxSXcXJ/gToUxRLOUiAAIyVB4mw1HodR+I0+x6OCIY4BwGDlhloP7joR4nmJiVcb+ckPk+L5vh+wMUzeYAAUBIHVjREFkbqvH8XgvxzjIhIOPwVWcKYtZ7mJ+DTaIE3jVN5yMOdClqd0MRIPE8xyEMqSw70GiZBMegE5TRMMHkZgjFDpTLM4BQbJgyM+PU6lNJjx1Qk45ak2laJcqQCI2nKCrijy0FogrgdmsH9oUVEPRIAAHNIn060g+v/UbIDMuDsyIKMiw2zDsNuIjjveKjuw0BjIDgndXuvkB9OXmgP5MyzCjx+rLjpNrKRW5nQRvrnlv59bZQrAUqgO1sKM7K7Nf0YxzEDrBYBFXIKKzuNa8bzACKIXvPPWAJIDvNL0q78VMCSsw0DOgOWAhkQ9bwJwstwCEcicLAhIHAoChJJX2/soO4YtlYsEYDIcQotlAwBRAAKVELOB41hRRYC4MAgcUJZpK0ck/Ygr9WyEgwGJGAhJOCEhDKeN4ql2rn2wffb+dBQimRkqeCANUcDWEYICawM1QxsDMCpRA7UABUIVpSH2vpKaw0C4DnVPIwZQnBPaECgMrA4th37nR5Fg0qQEIo8hfHowq19byFnYEY9+lJL5mJKueHq1jQGYMIpQ1iVxWxGjEqKGgotCKkIAHLQBgLeAAVsreUMAGK3hRBI+8nAFCRiFpqUx68ZFi3XmIY4q84IKG6mubxp5fEDm8cgHkBCWIKNvCIPiBw0A8mVKCfAaA0BYDgIgDyHlICwAibedgChlr8Q8tAmgIgLpEAKL0W8tAPKiCwJ5Sp8BVItOYDIAAxEshRtSID1O9pSFE5StmqVqYWRpzTWntM6d0kJfSBlDJPiMu48A0ATKmTMuZCyPLHNvKsjZxzTnZlLLeTgDDEnJLnHY9JchZFuOJBNVsSjlC7K4JZDgkk4HSh6fvLBt8mGhPagAfTEWI24PUxQksJQiMFSSIApIEdCgcdKwkwEcE5c6ajoDnXEAOMwyjpY70KkrGg04ZAYBRHADAxx8AhkgJcV8jBJaYqoRAGhJJ7zXUxOdOBpDOpXCJHIF8kBxo8pktLUhu9hXyDQGKlEohJXStlbs86JhJYC04BAOB41gmwHCZEzqDFVKcCeKUi+5TIB+OCsczgmIPIAHlzktLaR0rp2K7laAeXAJ5YzXmTOmbM+ZiyQxVJWWgNZ6zRAXQjTAC6ZwLrHIuqccsY0UR306pksazA7inGZu1DMtB9Lf0uBii+tL6VpL3jyURYANrGQiSifRZUnLSw1JwjhpAZBQCcqWQMXSboKlMgiFdkYxLsE3S+bxOz6kLvsaEpdx7OEAFI4D1Wcuuzd27d0eX3QmDpnAH2no3VAC9nCr1oBvYyix2YrFmFPJwEsVinLXEIBAdpL4ipqMkkLVsdgwryE9NundKI93XQPedSx41GJwFENoGxrZojRhkjbUpoG0CwGzNOvdaIEMB04MhvgaGaqhh0PgLDogcPzJwDSYj36ORgOQEpOcyo0hw1UDJg0YDUHoLQLeUgRwpznyVohauXBQTYsQEQZgcNYgFDhonJqYAuOMjAXGwkLLHC6f02AQzcBjOBE4GZkJFmrOxAsJIfO9n1Nya4OZhMZB6IyG+cW5ZHk6CsvqT2xA8R4hw0kFF5zXAFOzhkMqC6xTJNkDWD9Ao+WmSKWK1pxgGCAuxenPFucSWowpbS9YDLZwsurDWBYBzTm6t4iC3FnqHWu2mFS8VwlFpFA/ViPndqu8YsnUrM5a4UDNQACU6WmCKmAJygZ9GOLAKCHkAARQi2hxpCiXjAVwABCTgt25qkBezyIjjnv2kd/QiD792+O7c4AduM6SwBveB2QF7IGapscLLOnkfaB2sCHZ/RQZqBw8mkTCma8iOntU2vO44hUuAoq21kB4USGIPGE4QU8EUzsU84IWanOhacBuYAzqETOWcQZEKojA+OBwVjxDAOD+ixeghRS+Qsv3W2i9vQYhQ5UAPvq3b9kjZGj0wFXYB89osUXK7F2rjXBuT3PtfS5M92uv0/pEf+q3a77cI9N2AZgKvIMUbM1L+D0HSDlX46h58QnMPY+w/+irNJCOO4B875APGESh8ExhkTYmJN4ZpDtUWyOZ3k6yXiTbEukNg4h0ds4p2zeq4u1d2HD3gBPde+9u7cOfsJ7123z7oOXSV6hzD9vX2EcF82upGjWkdJXGmMgIq3UWJNKTVcrpgDlAHEJLeWCzAbm9KzdijyWE6UeTzR8kwhIPL6IiaWR6atXrwxTn3b6H1NAAz0Fgke5gM6Fwns4XoM8nZK4F4ghQROUIJzcyoqMaMYBcQAkXwFp+kMEe05xboDo/0AkVQqIwJ6wAsABqWGD1eoSMcTG/KgPiE+PARPNhbxHkMDSUJFfASXU8CGEFAAWWdDQCa2/kyAJGtXOmsDhUfntU8RfAYJx38kYDOi4C5FbHtRxzHFFC7VIFISgNo0IlkJdHE36k4LOEhRkJ0Rqg3xEGUT60L2K37AgXcmgXlk4SOQPTaFBFiFLETUuWuS7TAHiH6QzQnAOFmXcPrWgKzXcNiCSwTDaFvFiF+TLRkAc1BExR4KhBUnfnbXdQhAUUKVsJ5AyxkFvE7TuCMSX0uRTV3xgHTUGXIKzVGReTeXzU+U8myKiPLWyLyLQBaIukamBRJznTgCF0wV2WnC21UFZ0gyXVgiODQAREfS3RfDGOnB13+271mImM4HUFFjAyF3MVGP6ImNfSWPmKd0PQEXGIRFWMvTY0902nahDU4HKQaJaIKIuWTWuTTVUnuQqOzWqNPwLS+QaL+XWWaPYC7VaMBLuHaNymElEjbQHFMBaJ7VVgyE0iQG0melMBYn8CIAsFvFhixIsAsFv2egTjhlhg+if1SFGFfyzmHgti/3HltiQFhntjLlnmdjRj2BAI9lOm9ifFZFHH9ijllEW1DnDiqjkn5NtBDglDjjv10FhlC0GH7jegNnGCCBzmpPTlpJhinlcCelglgGaFYWshijsmDFDDfRo3ci8hgB8nahilyM6HiiuGGk4lbkynkFSn1BNiZgPARByk0lplZkrGrF9gZT3gtychPFfUalagoDWlIJAE9lECQFAECHkE/jODwFMhAFcFcCAA"}
import { Hooks } from 'wagmi/tempo'

Hooks.fee.useWatchSetUserToken({
  onUserTokenSet: (args, log) => {
    console.log('args:', args)
  },
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `fee.watchSetUserToken` Parameters](/tempo/actions/fee.watchSetUserToken#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`fee.setUserToken`](/tempo/actions/fee.setUserToken)
* [`fee.watchSetUserToken`](/tempo/actions/fee.watchSetUserToken)

---

---
url: /tempo/actions/fee.watchSetUserToken.md
---
# `fee.watchSetUserToken`

Watches for user token set events on the Fee Manager.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/fee.watchSetUserToken.md","from":136,"to":5055}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"466d1d7e9b6e662521a4dfa3841e61d192d4a41ddd5d17120f2190e4200b7515","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qUFRALwAfJxEEIxQpeVSiOqytcqqGi06enhrm9tq8hZWAMwDjmco0aE2oXmmvjm1ACTFY7C4RkEwku2n0AA47goHg0ato2nhESYuj8kP8QPZASM+iCPGCpgYZn5oQsDPl4ZwEjBcKJUTIalj6qTnviDJzuWYSYgyRShkCkAAmSqgzD0nyzUo0FkgBJrfhIzgfewAZT0AFU4GQACoQADWigAPBlEslDkEOslUk6shROFhHMw9GQ4KlCcIAHRisOG/AmtDmq22xRhgAK/sDpDgjuKSkOEV2B2Op3OuTA4gDcD9vBgBq2xrNFtI1rtYFKUAgvAQBgA6rX8PAOexVg3OGhE2BOBauDASGA0HBOEIR33OAAxLmcACy4lLulIYY14iUneQyBAdDLWAUpQABre57k2YVgNFSDAtjAvckffg0GgsJxXA5UgIGYTgAHIAAFNiUZhGAAehiV8wIfOEnxHGA4QAoCQPAqDD1ghD2BgBCHAsOBkLyVCuGfUN50AhJgNAyDoIIxDiJoOEKNyJY4mzTh9hfN8aE/JQgmAXJOGiUjhFSZAOLYABdCgJJHIZhAKOdUnE8dJM4OSMLYMNzgU1Ifz/PZlJ09xclcCJcm42JVg2Xt+J4PUTAjLko17WN40bMc3WzH1tMkoQ/KbRRY12Vo4B9OQICUAtOBC3SlggBQw3i0SwL8kcxwnPREDAn0YrsqzLNs3Jb2vEAlNPP0hmYUp3SUTgAFp0mzfc6pABqy1KPqAxGecOtTRr0zgbqKFPV80BWUhkSobgOV1Yxx1HJy4BWAAjOBeFIRhturBicNUatp0UNBuqUspeUQXprH6e5BXu3FWleAxo18hsIpbb4eilAFZSpRB5TRZVwQZSENRhAwQjCSIimEXjnRSTrUZQjSkc6HkKj6XpMTqR4mmFD7yWzYkAelQZhhcRBKhpSZvEZKFNUCIIsGAnAOAwKIwp+scos4EIdGDGtPm+hNmzDbhRbihLUi++spaTAAZBKkqLC4qDbDs8DSUI5G2pwbTyzgLFOO0DT7cdxCHMg8ubc350nfdceuXpfiegVid6SpScCfmVbAWNKasf3yRpuVQYh1UWZhrUObTEYohirSVMklYG1Sa9rFoAASYAxAO5RXGvABuDPHcUHO88L4uLCUMvK7AVwUTx+6GfkImGgjvEyZisOkAjmVadGXp1Fj5nofmdnBvTKIssVnzlf86X1aUduPYAVnlbvsSFah3sCLKh/poGx4VX4p4hdVZ7wUty0ras0oUXIiEkJG4HSmBPRMH/Wztk7CAS0y5ryvxgNeTgzBoArAUL6YCRBzj9jtnAfI8DYDbRWEoJQjcv4/yXFsZ2E4WCMDkJ/DaZ1cgAClxAfyNPtRgWAUbf3gQGCkeQ4CgU5sQZBUBODbQwAaGA20BHAXWA2Sa9kwCgOrDAqAcDzq0A0vONA6wIAThwLwRgSReBFDhJYWcwZpEACoeCcGvE6VhkDojkLgPOdYjBVDQL0IQKALsVj2E4OECxEDMoJT2NeH04D/4ZTIMBUggTvFgH4SE4QP9vILSiaoIhvBtwCOrFnGA/CNrrAOjQM224hEADloAwDDAAKxdmgV8ZYwy5DMctJQ8VjZyF8aEmxZEJBgCrNjZI81slmzyU46sG1kDXh4VWexYYxBthWGga8CkghmSwMGOCcFICwCqWGdgSg4K6zgHBchNAxBtSIIqMMtA4LiCwPBSZ8BJo/mYHIAAxPc+xsyIDzNTjE3I4z3mTVmeExZyzfyrMQOszZMBtm7P2UAo575TnnMqJc65ty4IArDE815AKgWkFIBEMMnBZGcGaRAVp7T4kKCgWk8cR17b8McaoL5XBHwCGUEuas14oWIAgVA+Rij6lgFyAAfRMSYnsC1G7ipFakElZKKUQIXNtCpMB+BgXnENNx85JDVksE4vspAv6MDEJdOQGBchwAwD0/AwFIBZ04OYK2Z0xEQAkQ7bgyYACSqi+xCNfBaZg20FA+kgEa3VnKhFLBNTQWc5rcjhGtfYO1Xz5xOurIbBcZ0jWlNgJU6ptTmCTU4CaUZy5xmQAKYuAFnAvVwQAPIgpWWsjZZSYU6DhR2BFJy0BnIuVcm5dzgJTMeWgZ5LzxBtUrTANqQg2oAraoIKICR2C5Bga+c2iR2DMC2EiIVuQACitALzwKzngl1CrQiUusdeRA0jqpVIclS8pWUghgT7HIeKBp2ByCgGBCILd1mcGTCXTSnAP1fvUaQX9PoNqfPmU+6x/jsoQY0QAUnIj6MCUHf3/sA3BYDoGxaoe/dBqAsGNHwbQIhhJ4T2BBEsOsTgB78X0bAl2QgEBVk+m/lqvBxt+EOCwDgSwf6IgAdyEBkDFg5ycDo0a8scBDwZpiROCQvBTY1KcKMyjaBYD4rvWAIDkkWMRNSBxiAXHYoThAq4/j4hBM3JE9kyTBHdLeK4MgacoQTLb3utvVz7mPMlsYcwsMpA1hepkfgE1To2bCx5UQZg91fjynumiMqxndJEPrSqtVV0ItgCi6A2LQh4sMbKYgJLUprDSClBlwL7miE8pk2QUscgMXDoeXBOgar5lIhuOoe60hGvZc895uQCk2p5Kc2QJooN5SjckkQibDCDrMIS5V1rC1QidfbN13rvB+tCBuI0Jo1hMtubG5wFrs42u7Z3RYHrH85AiobsoUGvwpTSJ4jdss1YBLsbIW0gASuSsiQgwItz8ZsJJ14AAi25dycELo/GArgACEnBEfKDIBj68EmjMEek0Y1IOPkddmB5wMH20IdgCx+TvHFG1P6dIFVW80ij0nsyWgjlLrLEdJpXY4xwqwAPrgIhrgLLXJtCNDUt8zAjS2cIOsPY0PHLhJl3oOXhalcBhV2ryX0CMBWIIQJRj+CMqm4UEEFlPpwmE7XSbjpyG30kZw2J/DhGZPEZgJ+jRHvmcsqd9bl9AT31+6/Rh4q4EPd4cCyTsD7uf3kbNsHsAzBnfPrDPJhjMAmOmbYxZqzPHbOqHs454Tihsn/sJ1JojslC+kHM5x7jNm+McoE+B2bomlJm3CT9xyaPXJA8/dT8H8SwBQ5Dy72HYAggI6Rw7VH/3MfY6X6QfHdficN/X7jo1lOx807pwzjfGPmcD7F7eA8R4kAnjKFyUoyBv7zSrEs5tEK4K4NUDtMMMRmCtpbKHJQpwTBrkpwTIqormDbSETZ5VIRC1Q3RXD6C9CNBkg+w4gByLAdJnzbwXzRxKi0gqjTx3zMjsxarQBRCh6u6KbKYAD8qQRSPoYYLBXGa0oQY0ZYYsRSyACkeYJwZw/CQQAA1L0AuLMPFA5ggTrEAngInqohoteFRlAkyvgDdvnt0OUpuHAgIJeBmjoCsAGEYtEOkvSn6PYtkj6KoZyrkEkBmFwFkvwj4i6pzCwJIEIrQboNEk4WPg5lAE4kiFeo4d4h4rtAIHNGtO/KECsP2GgrBOQkamMhMqBgkEEL8BEE2mCp/jumAOoDsh2t0CsFcjkfOspocjkb8J1jJgkGGL8FimOnIGVEEC6q0IYZdDqhupmuYRaDkhouMv1nIBGNulsIEu/mCi2lCu2nsgct2vAL2pAQOuigMfUeOgMSuqQDumgOsZsW1KVISvereI+j0o5DEGsFwAJNvOrtnq+mBKcbOKkGhn+j6HcWgNvt7qTkUGcakHgWbFRjRhlDcS8UVM8V8rOG8fIakECZwD8XBnpuntVNIqWnpNeMsdsSMRkWMX+BMW2pNLCjMccnMX2iiosfBMsdii8mscMVsVSbsaLMuoOOutWBYGiWtG7EfLfigKeLzlWKUEQNYGGL0AKdYNYIge7CgeoN7D3IfP3CfAlLgfgSDL0PKDfFDKQWzHgEnONCnN4qLOnDpJnNnBYnXEXDUo3M3FXKOM2LXAXCaSXE3BXDZFvCgWiBHBgcPFgQYIPP9FYHgZHJSHTPKNvCqWqEyOqQYL9u8L2PmPxIWIIU6QqPKOgVKTcB6SAJGZ8GfA9AqXTNYK4DdDELALCFjDRO5MIFhCdExCxPBPJBABRGyslH0q1PRIxOBGGLAVkFxMccjE5NGK5LRJ5OUkrHGALM2IFKjMFCpEHGvJFHoCLEePLIlMlFXH4jcWnDHqVCpNZK3GVIFqrO+KQDxqOP+NGI3LkOmfYHsKUENOIEgKAAEIoGgkIHgHOCAK4K4EAA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.fee.watchSetUserToken(config, {
  onUserTokenSet(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

`() => void`

Returns a function to unsubscribe from the event.

## Parameters

### onUserTokenSet

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/fee.watchSetUserToken.md","from":5265,"to":5442}<fsm-vh3gqscxm4e>
declare function onUserTokenSet(args: Args, log: Log): void

type Args = {
  /** Address of the user */
  user: Address
  /** Address of the new fee token */
  token: Address
}
```

Callback to invoke when a user token is set.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/fee.watchSetUserToken.md","from":5542,"to":5716}<fsm-vh3gqscxm4e>
type Args = {
  /** Address of the user to filter by */
  user?: Address | Address[] | null
  /** Address of the token to filter by */
  token?: Address | Address[] | null
}
```

Optional filters for the event.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/fee.watchSetUserToken.md","from":5888,"to":5933}<fsm-vh3gqscxm4e>
declare function onError(error: Error): void
```

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Enable polling mode.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`fee.watchSetUserToken`](https://viem.sh/tempo/actions/fee.watchSetUserToken)

---

---
url: /tempo/actions/nonce.getNonce.md
---
# `nonce.getNonce`

Gets the nonce for an account and nonce key. This is useful for managing multiple nonce lanes for parallel transaction submission.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/nonce.getNonce.md","from":206,"to":5008}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"95821029487d78766a2dcd7ccfe1331d8bf3d401ae5c2d46c01fcfe2b5f0f262","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinJBgvDCpAEbJFgyi2vrqsrXKqkgArC06enir610WVgDMA47Oo40T1F7TvnPUASYrHYXCMgmEpXKUjGLxO9Q0VzaeDBJgePUQsPsbxGSAATNYvpgpgYZn4AQsDPkQSshPd9hU+tZ+nCzohLtRWjcDHdcPJHkhMYNhi5ELiAByEn4kv6lGgUkAJACua2MYE4bQAcrSYAAeDKJZIAPiCHWSqX1WQonCwjmYejIcFSKOEADoeS7NdqXQAFW320hwPXFJSGiKpb2kCDMRhwXXOuBur2etYwF0AJT0itIYAAaqFFTBDbkwOI7XAbet1XotSnSlAILwEAYAOJ6OCcVQwGkpzgJdiccRqpwxZVcQdQbuVgDWMAwLtl4iUTeQyBAdFLWAUpQABru0HBclTCsBoqQYOIaBbklb8Gg0FhOK5e5HmJwAOQAAQA7ovowB6GIzzfQ9gWPDsYGBR9nyjd9v1/RgAPYGAAIcCw4GAvJQK4E94yghIX1gn8lH/QDkJoYEMNyJY4mDTgAF5T3PS9gyCYBck4aJUOEVJkHItgAF0KHYjshmEAp91SNi1Q4zheIgtgXUYKB+NSW97yCCIhOk9xclcCJcio2JJy7BjxB/RhQX4cEE3dZN1hNYMrSkjjhwgUdUjfaxaBdHy3y0jieQAaVnVJejALS9NyXdtxAQTVxtIZmFKU0lE4ABadJg3nOKQAS0tSjyu0RnbDLfUS/0E1iihVzPNAswhKgABV8C7HlOCIfNU1iwSygORkagUU4GjFREuRAOzeTMfkMVeIZ3gFSpJWJHxZllQEDBCMJIiKYQaINFJMv2kDxJ2zp6WhXpemaFkGmu7QkQMFK0WeWbhVGSoniW7xSX+OVAiCLBIxwDgMCiVz3M4IJty8gASYAxFICwlFcbdOAAHx4XgRzALgMeVWAkksKAogAMk4aHaDhhGkZRusGybQwsbcnGBzvJwWonNAIA7FrolCORIeYOAlBdWMwFgUgIhdAywFyPhsbHKAoDPOBKvO/RenFeQ6lZGp7rG8GceepBKle+bRS+35Vvmf7AYgYHMCiIKQs4bYlF2OnGzwGtp1nQXFWWTYu0NThbE4GcMFDzgY04FWyBICc+1Ia1Iy5mIBZ5SJ53VvoxXZQb4UQEaOWuQJnYwY22TNnELY8b5lp+tb5RLMsKy7JYIAUXIOuTjuFHNExO8m+svYMZqu23PuYFR5hoEVBQU+IJT4AHTg4HyBfYE2RUlHd5QdrgIeeYvaP23X6M5EkDtuc7XIAClxA6gBlXhEawPbD4Xu0sTyOBXztogy8JybEjl+GAmxXaRi/LGAM0tZZgHHpwWeUB55djoOJdsaAvzc3LDAXgjAki8CKMCSwONHQywAFQ8HJvqT+09oiX1VpwL8Fl8BIL0IQKAZ9FT2AHO2Seg8FAujkBAJQGltxWgEcIIeLoyCRlIOIgc4tyZTxdD+bMijVAn14IOV2XYA4wE5tzL8iMaDXyUZHLUsAXQACsz5oDPKWOBVDuDqhEZsUIKjBH0LQhIHsKUsyGPMSYiyXYuayW3HbdYqtRZoHrIqNA25+JBDUlgR0f4/yQFgHYl07AlB/hHnAP8l8aBiDSkQXElQXS0D/OILACEonwATLeZgcgADEjTVZiHiWgMG4tcjIEiZGaJCZulyKSSku8aTEAZKyTAHJeSCn02KReeAaBymVOqbU+pf5OnNLQK0jpwymljNIJLF0nBEFKHcZ4qRdDUY6LVEHTgBiJwsNUG5LgR4BD707OTOZiAp4zznkImWAB9ChFCADqkg8jKEhWC1IVybkCynpwCAmwbF4LQG+dsRVOHtkkK1GArCyAHxjDQHGcgMC5DgBgNY+BIyQADpwcwM4eZdk2FAmBPBvQAElMEtUjnHZgmwFBWkgMnIlHLI5LApYoNA1LcjhHpfYJlbl2xsq7PzdFnZk5WNTHYteDjzxCwuU/GAYTeaDMgGYoQi8RmcD5X+AA8hM1J6TMnQHmQmRZhSVmlPWRUqpNS6kNOOTElp7TxBpVtTANKQg0p7LSoIKISdcizzPNHRI7BmAXnBHA3IABRWgG4F4ByRhytxGLblAsQDLaKdjDLSKESIsRb4WpyBEcw9gcgoBvgiAAblyBkzgEZdiOk4J27t2DSB9qtOE7pnzm10OEaIoIHaYBdu5gAUnQlaN8s6+0DuHWAUd46yGqS3TO3tUAF04LicutY3jZFnPYEESwX5OBFrfQot8ULCD2zgFaQ++LK0eInA4LAOAiYDqHSOv8Y7EZkM4HI/sZY4CLm1co8ovApwiScGEh9EtSD1rPYhjiP75GpAAxAIDIGowcPA+ISDdSYOGIQzJFyXBkAwA6nIFS5xEC9HOJxrjJ8X5vzQC6Ugyo+UIPwDGfUf1IYAqIMwYTTxcTCbFPpcjXHWacBdZi7FMm5MKaU0IFTH7vWIHUxiaw0gMS6bEzJE+ALdhkBLHIXZEail0DwQk8EiB1DqGE9IVz3HZJ8dCPxNKJi2NkCaKKXEkXDMxbkJJxg79VO2c89mUIvmGxNL/AF3gQWhAhcaE0awenR3ia4B5nGXnCt5osKV/jYLqbKFFE8DEMtqIrFLCZd8ULGBds4GmDFaEhBvlPao9RYAoYABFBy6GTnDFuMBXAAEJOCreUGQHb254P6YvRJfba2yVjYm1N7Y0iwB7YO+tnb97jUkairuGWJay36PXr83m25aFDweYw8h8DG0HmfbtdFCT6JVjQE/E1pYn6McIF+DS82jJyPh20JHjjmCo7tOjzHK6uDMAwMDheDFP0HxkVTmAQRPlWjkadjNlOX1to3dO4xt6T2cfO5OnnPa513vMU+inDO13tuF3uvy74j39tO+e5DF3heK7exLjnLbUxoYUbTqj77/2AbSQxsD+8INTsS7BiIyvEOC54ob0jnBaP0bXox1QzHWPQcUIYwS5i5EDaMlt+H/7xsCzuzNsAc32dS8Wytq7G3gBbd25dw7pBjt26QxO1Iz3rvh8m9Nh7T3E+vYD2cz7MUWhLiQCuMolrSjIEPlmdYySPUzL/O7VQipNguhiMwL12SilzL/GKjFf5g1bPMJsRCOvbGRG6jnUU1hYQF11qNdo3jK7FyxHNGuBI65Em+jKG2eAgj4ugFEKXXOMNYYAPypEHBgK0Plcnv3BKEMqpZJ1P+QPxMM7UEASkkMAA1L0OirMCIixhEJ7AzILuYtuEugkqjO8mwp+t0KmJwAALLzwCCbjao6CKh2goaPJ6LWjhCxhi6oEcq5BJABhcCvJ8JVqAwsCSCRy366BKITg6osZQAWQf4CyMHhBrw95iAWQVbwL8YFhnwsDjZXzhKDIsE4wJBBBPARDupTId55pgDqC5I6DFIWCKg1LaFJpYZFLaFPC+a7AJAuhPAuhRp6ZBB/KtBEEKqEpZo6o2iqxBIKHbhBZyAuhJx5poDiJt5TKepzILL6H+olJrIbIhrbIIT+H2EHLtL+FBEXgZHrKtCRBSwNq7hNrQ7LAKzw7nBY5z5c5vgKypA7r9pWgKxZ4O5FAQyXDmJIFoAroyKVHVHy4NGnoq457NE4ypCtGLqPoJKV4ywWpdiDLJFZGhGTL3gRHepRH5IxGrJlKT6ho7LJFRptLpG5qZGHHZE6DbRJxIJITZpZEFoLg14oCrj/Z0ggBEDWAui9BvHWDWCL69QMiiiXTaxDQCgb54Btrb7VwigSiH5SgrRkh/SLDB7ahbA7BGxL64i4j5w6wNDsj6xlzahgkgC75vR4i4iWwGASBKClBbYgmiKQh9S9a4gAmFy2DkiBA+wbCcCVC4hgCVy9DMmEnmwEg9QxCwBAgnQ4RWQmB4QESHrwR/h8QQAYTfKcAngpRSkwRvguiz5ZCURFGNbajw5mTiAWSYyqg2RJjVjagOT7ROTCSGxoAeReTqCclQBPDnBpC8CNCNBPCVBpDWDnBabSDoniBPCbBiiVCVAABCvA0gMA6g5w0g5wCQ1gmwRamwmwfkwk5coU4UukemnRra66b4bJiA8uPIempQRU4gSAoAAQig68QgeA+4IArgrgQAA"}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const nonce = await Actions.nonce.getNonce(config, {
  account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  nonceKey: 1n,
})

console.log('Nonce:', nonce)
// @log: Nonce: 42n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/nonce.getNonce.md","from":5094,"to":5119}<fsm-vh3gqscxm4e>
type ReturnType = bigint
```

The current nonce value for the given account and nonce key.

## Parameters

### account

* **Type:** `Address`

Account address to get the nonce for.

### nonceKey

* **Type:** `bigint`

Nonce key (must be > 0, key 0 is reserved for protocol nonces).

## Viem

* [`nonce.getNonce`](https://viem.sh/tempo/actions/nonce.getNonce)

---

---
url: /tempo/hooks/nonce.useNonce.md
---
# `nonce.useNonce`

Hook for getting the nonce for an account and nonce key. This is useful for managing multiple nonce lanes for parallel transaction submission.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/nonce.useNonce.md","from":217,"to":5019}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"0f0dff491f1f51aaa648ec0523093330756da7886231a68a5880eae563132b80","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUWKQQOBwYAJScUKJiiJwARowKplwAPpwArmCwAGamMFD+UBDWCHoAKvgwnDKiIpxwOdbW8HAFOTIyGJyk8BAyJFBxCaKcBeycyvUAjjlkGAB0ADpgGxu19Y3Nre2d3b39g3DDo+NiUzNznIvL65vPOw1NXAcdcF09fQNDIxKV0m01Iszq9yWpFWWxeEL2HzaXx+J3+50BY3i11B4IWUJhz228PeLSRR1+pwBlyxINuEIe0JW/hE4l0ABZ1MZ5EoVIg2RpxNogjT/CYzEgAEw2OykBxOJAADncnhweEIJHIGkCeGsEDAzUgYA6SVS6TAWVy+RgRTMpSo5UqeFeCNJh2+xz+ZwuQJpNzBdwZq2Zml0qgAjLJuco1AKtDo8IaOqLipLpfZHH5EGG2crqF41b5NQF6ExWOwuAZBMHWUgAGwRrmKaOITmaIV4StGMXmKUgWzp+WICU5jx51V6dV+LUlvQsNgcTiJ3DCEN1gDskabvNbgvjeiXyfFQ7TsozzgAzBZc5hxz4Nf4aDOQN0jWhGHrcnAYAA5PUdAA8ADCepFAoFApGkGQAHyhPYzA6GQcAAPxJJ2KxLisORfr+RowCsAAKcEIaQcBASBaTgaa0HRKhfCCOhf54VhP6MSsABKOg5KQYAAGqiDISz/lR5pQRsYCiPBcBYA49TMThSb2hUVT6HRfqcEKb6KLii6MWpohgJwDi6nkXD6WMS6cPwMBBgKChVMgyAgHQElYHI/gAAaeWgcC0Bsc7lpwwA8HRcCcK4UzhMwnAAOQAO6iAozCMAA9DQZbRbCL6OO+BkAIJYFgwSxMAGycJwur6lwQU0uBjBwAAMhAohQKYChhZwAC8wWGAxuGYdhjHBCVBllYZ7QQCZSTRRYtArHN0UUKVo1LgA0tZSRhmAi0ja40SwmVjAFJwwR1Y1zWtbEgxoFxBn/i1RBQWdLWKHNKz/sl92iSNV03Zwd2MA98kwEkwA0khKxoBAADKaCkK1RWuO9n0bK4Gyee5IAALoUI50mysw/h4xJxGhQAtJwhH4yTTLY45P3cUYACK+Joj0XCxYwyg6bhnBEPxSw09jIAshIiBruem48oqsbtnocmMYePYnnKmbnrW175hOhYPtqeihOEkSYLERkTeaKHHcE7kzQAJMAIhw4orjuZw2S5eNJku5ahTFFAsQAGScFbtC2/brVO7E2R5N7tplEpeBu8Z5qGWgYi2ECkPadY/EyMdzBwAoKxflapDRE8sIJ6bplQFAZxwEyK41ogCq1pLzYbtQu5BCbJmK0gEt9jKKvOBKGu3pORaPkE+sRGQRvcx0a0YObwkWlH1o+7Hjp6EDlnWbnWFcMk9RQZwVi7/0FicHVaJkJcOJhBAkO6jnS5wKX1ai9m/dyFu0sd3GQRVrWV7nyZWZ5JSj28OPHWT5xKSWkh0cqep0QwA2HzMEFUUFJGAvqYYy4QAOmUq8dymC8HO2YNAHo9QH5EEYLAUKkw4BzjkHEGAyQcgKDNG1UhLDlAJCvqFJhSVGj+ggLiDYAApUQfMobWDhlgLgPD6jwX7GAOqUUaF0KBMkfosU2EpHCLFL8JEy5gFeBQqAVDOB0HnN5WYsUxFSRgNYQ6jBrBILLGYc0cBECwgAFScFyoHHBKDnbWD2KFDmXN4LKGgIIto+BDKhRIcgvBKwZAQAUEVdy4EUm4LkCsMg4RSDZMMvkQOSiVjxW4qUvhij9IpFkl+MYGdYpwxoLMMR+l+i/lgCsAAVoI2GMAJJPACUEhQGTkj8QqakuQztTAsh5hVUCXF05iLaZzeoGdkDuQfsiQuaByg5DQO5TGwR8ApywD45KyVICwEGSsdgCgPpKWSo0GgIhSZEGHCsWgyVRBYBSvszoKxLnMBkAAYhBd8EQxy0DG3yBsXZMK65wqKWci5Vybl3OgDAR5zzXmVHeQkeAaBvm/P+YC4F4QDngqhai9FpAS4rE4K8SZEBpk5zyaE8qDSj6fiBFEwgJyr5lg4K1bS7l7nAyUeQyhBTYQAH0/F+IAOriDUYoVVSqkjsqmTMpRnBOX9OcWgaKoUYmECgAwwYi4YCczqBg5BdUaDmj6BsOAGAjT4HCJALCDRGBWW0skQxxjAn4QAJKhTmJSL8zBkhyHApAME4htl1H6Jg118g0AevEl6n1fqJqhRMMG7Oxq5hgl6XhQZLRhkSTrpwKGMB031F2ZADpH5UWcEjclAA8piy5aBrmIFuTKglWgiVwBJZ88lPy2R/IBUC5KqKwVoAhZC0QpMO0wFJnqUmqLSbvliKCDYFC7WmFBMwBIOVTEAFFaAuRYVhSVdwOVctmfkmA7lfHPHRoMjYlSMlZOinUXoGz2AyCgNFaIABuDYtyKYO28kkMDGTOAONIFB8CGc4UTTQIBuZeFgPBFAzAcDnAACkcAFoxUw1BmD8GwCIfwshnxnA0MQaw1AHDjijn4cI1+wpzL2DBDMLFTgd6RMlOimqwgEQ4DgXOFayV0yxh2AKvIEoMG4MIeSkhjIoUikzEknABK9QzJ1ocPwWYp5tl8dgMy39iGypSeKUkOTfBrlKYgCprSamOOApwLaPTo0yr8OQDAPmMhMYtizKoULYX+GyPkWgFYpA8iRrMfgOqODJ7HRlYgIgzAsznglFmBUe1mP6aS1wPtyRTWOHS5l7LuW9T5bE3iorJXLySEQOeSriXRr8MKxkMg4kZArtpZ0ZKdBnEnJymLNcWZJBDfC1wSL0XMakzaUFsgiBaxDglGt5O1jospcYAogrXWxvcX4lNioM25vWAW3qMWh3awWCqy54bXBRvmnG/d69phZvRaVaHRQQ5zz9dhJgv7xNOoxTVYwXonA2KcsWXqaKTHKnVLAJbAAIvpbQYJbZwJgK4AAhJwInigyCU/crp6rBnvFJFpyTzgyPUfo9SLgsA1P2f0943WxzpA0aeVhA+p9TTX0QnciEsh5UIm/vF+5ADRpkFcHw4joUMNBgSShr5mAhBYpFRx5r6xzKdc6D1yM5ghv4Im7N4J5ozAMAK5YV1cTSChMe5gMEfD4EilM7Pe7oj6TMmkc4xhyD0GmcsbY6h8j6H6M8c6cak5oe/cR5A9H6jtG4qx8Y6F1jhmk8UdT8LgTYA3fZ+MyU73bnROyfk95loRvlCqeaoFzTtodNMYT2XzgyAm+kA863xT7e/NtQCxp4LJRsbp6KbDi35PEeyZRznHnmOwDY6z+HvHhPidkE4GT4mVOafH9IAz+P+nS+s8v3TsEXOt8Y75wLq/lPhfL7AOjB8CV7JHIvx8FkBzguIOhzkh0R1bl0hlAchkgVhdRmBcUHlp0ZVkpE1OVkp51F0TBkhkpKlBlogsYhYRZdAwx6xW5eR242w9w+wiMQF25+xTxBwrxRwbwoFtZpwp4rVoBYhs8SNTNzNzZulwJXoIg3w9R+JKYG0khulkBMYaJeYIA6FjoABqMMY1DUDJZqYgxSLeEAe/OxDOdyPDE5Z2YVe1WKbsVlAAWTZkuxYUFByHgm8T5QMgFWkm+BKHAksLmA2CKBIi4GYjGCaG0jCBYHEH6CEO0DKVCNR2ahakkIm0FVCPiWSBEE5le2eGiyWEERYBR3EHTxRWQwKGCHPGiEHSuVHWSmvTADXCeUnTFByH+TqIPXM2nTqPPCmwyAKBWHPDXQhSq2CDuGcNcLsTTUMlRy8OaWKPcgWxkBWCvQSGyUgOxRqPHTrkJUIRnTJQpQXSpWXQWMGKhQWOWLQHONJkFDflLlhH/TgBd0UUrkR1UHNyExI2ikTjQCSEo2g3Ai+NvxZxQyQUmk4HUHTzMIIw13eMj0+MrkQFowBIHzv0TxBPNCSHBNw340z1/wl2eGbTbXmLfEWPONWKxWHRxU2MaJeR2I+T2JwMOJSmOPpUhTOPYGvQuPZISCuK0DfjUnPXqEvS5OSPrg7jsiQAcmFlMAUhACIAsBWDDAVIsAsBIIbk/lrGkEbCln6xljoOA0YLAUHCVHYM1jvCnGLCCDh3nmBggjNFXitBtBKE3iIWJH2DJHdApDRG9ExAmDUgDHxFFLIKQDDAVG/ijG3F1MAQVlkBTDFkNMzAlBHhNNvDEAUH8HJzwH1LVPIMkCsC1ObDzMnjwCBiSDZAlDABAU1OYKHiQCvCFl1FgFLFsUCm6kEHagKEijowSiSlShgHShX0qhbJpCSAsnCi6jQgwnllwiGiWm7nRJihmjXDLKgHPFUEAmsFrFrHPDZEAgsFUDK0kAlFUFEHPGSAVDZDZAACFrBJAYA1xVBJBVACgLBkg71khkgFologEMANotoUYqsXc0kPiSzaMlwqt/AYlRAkBQBAh5AmE9Q8BvIQBXBXAgA==="}
import { Hooks } from 'wagmi/tempo'

const { data: nonce } = Hooks.nonce.useNonce({
  account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  nonceKey: 1n,
})

console.log('Nonce:', nonce)
// @log: Nonce: 42n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Return Type

See [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook return types.

### data

See [Wagmi Action `nonce.getNonce` Return Type](/tempo/actions/nonce.getNonce#return-type)

## Parameters

See [Wagmi Action `nonce.getNonce` Parameters](/tempo/actions/nonce.getNonce#parameters)

### query

See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook parameters.

## Action

* [`nonce.getNonce`](/tempo/actions/nonce.getNonce)

---

---
url: /tempo/hooks/nonce.useWatchNonceIncremented.md
---
# `nonce.useWatchNonceIncremented`

Hook for watching nonce incremented events. This event is emitted whenever a transaction is executed using a specific nonce key.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/nonce.useWatchNonceIncremented.md","from":219,"to":4913}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"3c41f7db5af5a58ed8f5640547d78b93c2c5a437602369ef24ea876941670c37","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXJBg1rjCmroALLFJispqGpk6eO2d/iZmSEUgtvaOfogAbFXUXrW+DQH0eABmAK4daIwQYJxHcDAA6qJotgByF50Akh2kMMzyNFAAPABhC4HRgKAB8AAosPYfk44AB+RCcYAAHUunExi1MbygSM4YCOzAARmROAAfK5gWCgsxQADc6MxmMyiORaIxzOZDmsEBOaHxAAMLLQACTAESkUwKVyCimcYViiVoKWKWXIAC68sJMhk8pONPyDKZXOZkxgAGkYBh8cSwaYuJS7QoHZrtUddfrqTBaTBjZzOK4vYa6YyAwdSBBmAAhGQQaz8W32sCOqkhv1hrkXACipEjpHxkMhZHzyNz+YAlJwALzgzhECCMKBVykGn1G4Pt0MmzFsXX4lVHGCd31QEdGzPMvszBQfJxEUQyfGEklk1ve0fj7sBi4vDowD7WL4/FN+wuQ1nIgDuD2erwPn2+vz9ADoAIJaOAUThxhTX2/4Hu7yPiefwvgAMhAChVrW9aNs2W4Zj2nC8mAoIKPiwJoWCiH+ly8iiMSch4sixJ8HIoiXOu6ZjtRXZIWArgVsiDZNuiYCiD8cAwp0Vw3PcjyAfeh7Hs+UD+FA8YIHoOScAc7CcDegnSgS96cKYR5PqeY4wCQKZwC+/hiAo0nIMgICwFgXzWA8fr+AAKvgjBwHJJyOOclx2C5pLyJwlnWbZY5sCIAC0b66jACiRgAstAZAPBAL6cG8XBXownqkpwx6+GOpicKIrloEcXz1mQcAeYZGoUOZdCcVgcj+IKTVoHAtDoiErQouEhiBnJkbMJwADkN4KMwjAAPQ0C0g3ouixynB5nBvlgWCQlWHKYjkBnmi+1x3ABQEPppoF+pCG3MruwkgWJF6ft+v7rchWIXHAEByC+v6QoNh3qdd2mIIN36shWyHuCaTGzRiXxFaQlz/FAjBEOCAm2Cp8mkKp+6/cdvwGS+L7/ONCNI+irjok1gogFV5kwqUzD+LTnE6GVnAhZwAAKsLM6QBlU1VIDRBIiC9NIxjJMMiAFL0oxaOMeh7SjQn7iJWl/NM+RzMUSzlIgACMBQbJgNR6HUfiNPsejQpGOAcBgVaXcrf1/Oel6KQdV049p753T+UH/oJh0qydUAQVBMF1qxCF0aOElSXggKLjIxIOPwnBoBAv0Nvww5XvgvkFea6kuRpole1EPRIPEAAcgwpEgus1xkstBA7wGe2reSzIgAwLCUZQrAbHibMbPj1EZTSW4zcJkFWrvnSy1i8vyyKKuKkrSrKk6YuaVoYKRyZoFvBIwFeh37y6KZhq45cxFIotyEMqTS03WR4Ky6tdz3iylMszgFLEhstgmx2OPC2IBoRcycFWX8/s7yO3bq+SCCgb5C11hYdID867dxlq/PQv4P7mC/n3X+cw3BDyNt4U2uwaBgI4lxHiw5UKvTkOiBcGMmFvRgMiLCzCugWTjnoRyw5BQcLkHKZg0APTDissQJs8B8qcHKqwOQfkYDEiOAoC+CgUIvU4WnOwXBnKKJYOlcQacM7KBgOiAAUqIBcABlI8jAsBcFEcOH4iwwDOQGjIogcixzEgwIpNRnBiSRivDcHmL5IZCM4BIqAUjOB0FCC1NOV4M7cRgNYRgoJrA6JaGYfSiBIYAColoKh4ZwuU1gZCiDgC5NKyg4k6EIFAFycAji2Hyi5ERuj3qfQrIKb8vSwC8JfCWdga05SUTHCMsZN5YZTP0Q8FClFQnDj2mOdOikpQ0HMflMAQSXiwBfAAK3aSqGAnFolgDKW+TgCg4zJz1HMqpv1ohY1QuhYqfp9lXl2cObZyBBQyM6PUl8IhJJHDQIKDUkJ8BoDQFgOAiBxrjUgLAc5L52AKCJlJcatSaChSIFLF8tBxqiCwBNUF8ADIIuYDIAAxDS+pkK+RoFntSdEwKWUGUhSWWF8LEXItReiuKWKcV4usHAAltliWkvJZS6lkYwV0rQAy5lKraX8rzBWJKsTHkQGeQqNx1S1mZU2YpRgyh2XqRaBwFSliFQYq4aauJkj3qQwAPolJKfcWG0pfVeuRAap5i4dGjL0Ua05WS0CDRcnCVpLlxDDjMNavO7CXrORoCmGQGB0RwAwB0fAkZIDXB/IwbO+jhxhIgBEskb52ZvBcpYoJXwbgkjkN+SAGMU3VqCUw7Nvw83ojqUW2wpa+QuRMFWxOnAICWIxscmAZyLlfE4gZTg9iYCArzpwYFkA9kXE4Ly5K40ADygqEVIpRWil1EqtBSplYS+AaAQokt6GSilVLxq8pfPSplogQqHpgCFC4IVeUhXOFWdG6IJElVMOjZgDwKqQ2zLQOqKjriOr3Ya41ryxHFLAOTJq5z0RuI+lBL6eddQZ3SaQGQUBBoVjDGijmqoWrIho3GRS7BGPfm2Wy6F5G+krs+oNbjGcACkcBAZDXo4x5jrHxrsYdCizgkneMMagAJjJaAoVoBE5G96EzSCQjMFeTg5ZJmDVuIQCAyLvyvUTSpZOY47ArXkH6ZjLH0RsfZhxlypnmn1NENoA5Y5ogJjTj/QFenYB5iI2xzE1nSDIjs3wRziiowtNc6IdzlKcB0j8yprkKzkC6UXBqNIetVAldNCsxxUoXEvlICcD4jlnJYRoVwczcVEBEGYHrWIBQ9ZVxBmAZL3IuDnuJDGxwrX2tgE63AbrgROB9dgANobsQLCSG7uN+rZW2j9YdGQDiMhf1avqeNOgWToUeUQPEeIetJBHem/uyrMgNQhX+YVsgaxJYFHeyyLgX2mvON6y6xAZ3YaLiu/GWlt3aD3bOBcJ7qw1gWAm1N0Hqktuw4u+NZDphbsLhkF69eihJaxG7pDJhbQmY1iGrcdKeoABKRrTCvTAINMMFGFlgEhIKAAIpRbQGNxR0JgK4AAhJwMXigyCy8FL5ybKmAtqeRIriXnBWeek53aSNYB5c6+V7pxR+mSwkcFGhjDyiNnlUUNWiponqm1PqURm3ZGOgvS4La6sDydD2MuZxexOXCBXjWvzv3SS8zM6yCH9dzBw8/Ej9HozIg4kYEqSowPFmI1jNzzASE7LvwljV3BnPonKMKGozAWjWnFNq/84FrjDeeMKZ0/s9lVfi+1/r43mTcnhp8aYy3jXbeNMd7o2Pi3vewDMGr8ZldpnzMnys3mGzGWHNfmyy553bmNP/bpD55Tqmin7tS+l+zWXnO5cP/l4/nm6RVX2db4jvvRmM5+Mz2zbPOBDducLg+c+8a9BdhczdJdgBpc5cFdxdldVdz9NdL8oC9cACgDjdTcEDSBZcLcP8KYjIwtTJzIbg+FkBXpipOg4Vr0RU0UXRlAjhiQXxeRmAxVMUZUXVxoiIjVxoP0v0TBiRxoKNzkKw+Zuhb49ZdZ75xZUhEgX45YFhRMCEkBn5v5+5nBehAER4qFQEghIRE1oAqx+9PouI4AwsYB8RKIMBvx8ZsUXEPJFxOY6Z1NrDNRmI4ImwNsABqXWedeoOMfLMQqgSSaVPAFA1JbZQUITGFK1JpCzGYFdTgaKD0M4eqYcTIIkXGVZS4TKGEepP0b8RpfAatOaRgHmLgS1OpF3KyFgcQIJMwiwiLfKT0fLBGNHC7PiX5aojpYkEQa1B7C4VhRcIcdpExWpDGIFEFDjA4SEWIQZGg4VUVZDMAeIbFR9GYI4clFYiDCwmVFY2IK7B0A4F8WIf9dVGQCbSEJ1TI0CZNEqOdfIm4LZDOYFB7GQF8JDB4KZRYm9UVe9AySVUI59OVN9fgxVH9d484jVd4r4tAOEkKYGPVSGCmH3BnHRfkZnVQGPFfAfQaJeFMZEKTJjb8AkjlZAqfMk5EdQfZGIzPThPEqkuTMkifC/TjDEwkzgGkwTfTBfCmSGbdYcN4s4D4uEn4oVP4u9cVQEx9YE2VIlMEhVb9CaKEgDRlWE9gZDeEzUh4REz8GDBSeDYcRDHUjowyUYEyJAMyAWDSPhIgCwF8XWR0iwCwcQgWCuPWAoeQzBCWHuTQXBYwKCFQ4WLWH+HWfWbQyhEBc2fQqebmWeT8dkZCHkPkTk1eZUVUGUQUI+Hea0c+B0HMk+M+UJA+K+FBXQXWXoKwMWR+VQnBRQ9+TucwNQ4hHWAoVQVwfmXkWAZoFJLqLaXqCMKMeTMLMaSab4NgGaT/LaF8HaBWd2eBUuP4M6E0VuI6Jcv0ZEW6Eye6MOGsOseeQvBk8TS8OTYGcGCgUmYIkAOEUQJAUAQIeQcqC4PAFqEAVwVwIAA=="}
import { Hooks } from 'wagmi/tempo'

Hooks.nonce.useWatchNonceIncremented({
  onNonceIncremented: (args, log) => {
    console.log('args:', args)
  },
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `nonce.watchNonceIncremented` Parameters](/tempo/actions/nonce.watchNonceIncremented#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`nonce.getNonce`](/tempo/actions/nonce.getNonce)
* [`nonce.watchNonceIncremented`](/tempo/actions/nonce.watchNonceIncremented)

---

---
url: /tempo/actions/nonce.watchNonceIncremented.md
---
# `nonce.watchNonceIncremented`

Watches for nonce incremented events. This event is emitted whenever a transaction is executed using a specific nonce key.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/nonce.watchNonceIncremented.md","from":211,"to":5256}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"d6c088363c7a29ffdad7dc923554c75831017d0aa12ea1177d8bb4c8f55ce3f0","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qUFRALwAfJxEEIxQpeVSiOqytcqqGi06enhrm9tq8hZWAMwDjmco0aE2oXmmvjm1ACTFY7C4RkEwku2n0AA47goHg0ato2nhESYuj8kP8QPZASM+iCPGCpgYZn5oQsDPl4ZxIGBeLhRKiZDUsfUkABWZ74gyc7nEnqIMkUoZApAAJkqoMw9J8s1KNBZIASa34SM4H3sADkhNyAJJc0gwZiKGhQAA8GUSyUOQQ6yVSrqyFE4WEc9pGcFShOEADpJTAIyb8OauTBrbxbfawI6IwAFIN6MhwF3FJSHCK7A7HU7nXJgcT2uCB7nGrZmi1Jm12h0wC5UKAQXgIAwAdSb+HgnAS7A5Lc4FhT7fTnc4MBI6bgEe14iU/eQyBAsCwtt4W07pQAKvhGHAxwbjGBOA5LwAjGCKTh7g9HqABiBiAC03DkChKKQEAALLQGQWwQBGnCWlw6yMABnBPpwqa+J+FicOIV5oCstonHmSJrgAuhQO50DWWAKKUAAGtFoHAuRsoUwDRLaR6+sk/r4GgaBYJwrhjsBzCcAA5AAApsSjMIwAD0MS2iJjFwsxnA0HC/GCRAwniZJ0lyewMByQ4FhwIpeTKVwLHhpeAkJEJokSRuenyYZalsGZuRLHEhacPsrEwOxhZBMAuScNExnCKkyBuRAJGhapQzCAU9GpCFt5hZw0V2mwEbnERqTcbxewUPF7i5K4ES5J5sSrBsw6+TwhomFGLaxsOCZWm2aaOp6hb+mlYVCB1razt1na7K0cD+nIEBKGWnADRlSwQAoEYzUoQQicN05dR2UCICJ/qTZV6VlWAFW5LR1EgCRO6BkMzClF6SicD+6SFsRpEgPdNalD9wZ5q9nDZg9uakKuN1fbaOGkMiVDcFeXI3qpEC1XAKwPnAKaMMhdlaapI6LsuaDESRZR8ogvTWGSgqPIgSr9NQrSvAYcbDcmqZ7dKfwAgqVKytYarggykLajCBghGEkRFMI3luik73y0pyUy50vIVH0SqivcQpNGKLPkoW3OkrzwwuIgwpKkLGqMlCOqBEE+4QDgHAYFEQ0thzc6OhNOiho2nzs7t85QBG3B+9Ns2pGznvBxmAAys3zRWXa7r2/YgGkoRyA+TgANYoztpx5zAxojreWHRtOl4zpzIdrur1y9L8Ap1HTvRovrgQe4mXtjan3RWJUpuKvT1veLbYu6o7OYjFEk2pfFYVODEaxoKk1HWLQAAkwBiKQFhKK41EANxL5OiYANIwBgqQPskFhoGf6VhZY6zDXfD/ps/rgohrlPCmaDrOmw8mYvECJNY2iBQHyjNqMBm48IRanmA7f6YMojrWju1WOo09oRkTkoP+TdGhKnkG3BoZI8QG3WlAmBgw4HKnUIgkWyDmSBGrLWespdloKFyEQSQMs4ArRgD6EwwjSg9j7HgM8pdqI8JgNRTgzBoArAUAGYCRBzijiwnAfIajYAPhWEoJQh9BHCIJlsaunBdHSTkAItAqNVAwFyAAKXEPwgAytjLAcshFqPtBSPIcBhJO00bAT8D4MDGhgA+JCwF1hwDzBGKqYAZFKJUWougyVLxoHWKjOsMBeCMCSLwIocJLArkQCkgAVDwTg1FXR+IUdEOxcBLzwVUEovQhAoCXnRvYTCl45FiNWutPY1F/TDOEMIiMZBgKkHGZhMAn4plNLarDRZqhLGHlvMhFYiTPwOONAfGghdxBgCieaWAEYABWfS0BsWYMksAtSEZKBmrnOQ9T5GKJMhIRMqtki4QXEc9YJzS5HOQNRJ23I2kRjED2FYaBqJESCIVLAoYZIyUgLAO5EZ2BKBkpIuAMk7E0F/EQFUEZaAyXEFgWSML4Crm4swOQABiRlbSEUQCRfPZZuQoWctXAiuZKK0U8QxYgLFOKYB4oJUS9OpKjwUqpTSulDLgKwuZWgVlHLNVMpFaQUgERoJpPeRAT53yRnNJ2UhUu+yFwdMIEi6cFlTFOPqTKxAPz0lQFUTGFJAB9ap1Shyw0PiGwNqQzUfNCGYtRFqbmFLQCJS8wYemXkkKXSwjAnGkEEReGg6Y5AYFyHADAXJ8DAUgPszg5gS4E1Lg+eJiT83cEzJaHJI4om2kScwB8Ch/SQHzVmxtUSliFodCW3I4QK32GrTyy89bS7Z04BAPNnArkxjudYh5AVmCrk4B458jbMrUUgKcoQ6jexMpgjJAA8mK9FmLsXgTlToBVfYlXkrQD+SllRqW0vpTJIVEYWXsvED+C9MAfxCB/EKn8ggojjlILkZReELAoeYFsQiKSACitAKJqP2e6wm5rLWrOEdRKpYBLq0TudVaZozZqbRHABVGeTSByCgCJCIz8sXAwPpUu8MB2PGnYNx/0RzuVIsY2ssZIk2MzU4AAUlMv6ESnHuO8f4zJQTj9/ZKY4xJqAUn8loERWgOTMy5nsCCG/TgeGjV2ZEgOQgzsprWK0t00xudPwOCwDgSwPGIh8dyAJzMQn6KLmc/m2scANwruWbu/OCUnAQvM7AI1NGBNhSc/M1IbmIAef9EI9NvnxD+bpUFzs4W9MZUwlwZAS5Qj5WFAAurDXGtHu8STUgaxrRngvK6e2nB7PgUQEQZglNfhKkpmiE6uWMqWPvQ+JN/AIz9bAIN88cARsBDG16qbAtpCygW51hrlivWPzINWOQIH9VtJknQQpSKkQ3HUJTaQF3ltNZa3IIiP4wXVbIE0emSofvLy4P9rxB8fGHYmzd2GoQHs3qey93gb2hA3EaE0awi36u/cnLARASO7syWwxYZ7/C5CBv3ofemvxZQpK8hyGspc/KuYQl8gAShakyQgRLP3kessAQRqIABFzm6HzbvDhMBXAAEJOBS+UGQRX1EwtgAi1F/2quZecAHNzzgfP77TLAMr/X6uzO7qy6hsAV18OEdYMR3RyhT0NOtYo3grTQwpKugxrkNUeVcD8m0Dxe6aweO84QdYexhc1TmQ1cPkfmDR/tLH+PcmuDMAwI08xfkHMi/zwoIIIf/RzK12hvP1q1oscU6J5TWmQu6f08Joz4muOmcLiH6vJeYwKY72pw6olm86c65FgzBVG/Ga7zb3vYBc/99mbF+zMB1iOdX659zGLSvedUBVqrgXFCdl41rnXU/Mr5fYIVnfnmys+fd35u8IPgskULnMlnNV5cNS54hU3AuYAQufetemwGyku0uZAnAcu7OSuKukBpAGu5+emk+wmVu+aRu/+/O5uluCBiuNun+DutE64m4SA24ZQz4pQyAQiuE3IqKz6UqMkJiqgGMEYMQzAr6uKJKMqMkA6FqMk/6gG5gD4+kTG26kQN0ZMVw+gvQ6gNM5CTwYC4ohsYhUC2ssCo8qotI6oE8osKCeAQQ6a0AUQy+Yy8WiWAA/KkOchgP6BGPYc7DeKECDDWP7DYcgERCWCcGcJ+EEAANS9BrqzAzSVYRASLpx4CoHRZHLUQybIrGi5r4Acjr6DzQQgSqICCUQro6ArDdSXi2rISBhtKdj+hOqNq5BJDgxcAOqfjhCnr7gsCSBRLmG6BLK1GISVZQC5pIhxo1GDLWIYxiC5pY60ZgA04rCjg2IIT2KoyCpRYJBBC/ARBPoSqMHYZgDqD4ofrdArA0rrHwaJYkrrG/APaPwJARi/BgY6pyAnRBAeqtC5EOiZp4SrpFEHKFxQpvZyARhYZbDjL0ESovoyrvqErErfrwC/qCFqrAZfFXG6pfG/FoCIk/jHQmr+70YMRB6yxFBrwNTCgJ5iF14bQiSrzpipAqY8b+ikloDIFt4pQ4lkmcCiiFxxHWbMbEnUkHRUk8rpi0lRH+yclMk26slEHUQpLHqlyfECDfGIn/Hiq8RAlvqrjypglkoQl/qqpAaySwngZsoInsDYZIkGlbAol+zIYTjoalyYbGk3gNxMykEoA7hu5ShUBEDWARi9AenWDWCSGNwyFoiMy0wUJdx4A0LfAyjqH0Kjy9BWzaHCyahMj2wGFoJzyYR+yLwvyYS8CCmbw7x7wPKHzHzPwNbRjXy3xIRfxPznxvwfwVkmLfzlREIyHSCgJBlICgJUIQJ+xqEjz8xazMIJl2ziwqHLDvDDili+Tlg+FNnKi/DyHYiKGdlvB1SfBQJUy9nmyCxkwxCwCwgqxWRNTCAaR4zaS6SyQxRmRMSWSAovS2T2QiQRiiFZAeRYmjkrkDJ+TWQtSJhtSBw4J1w9TPT9TxQ9ydS4IhwhARx1pJwLTnwi4KYLwj7HSlQlTnQnSdbxxHikClYOJ8RxiHy5BjmfB7ClDBjiBICgABCKC6JCB4D0QgCuCuBAA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.nonce.watchNonceIncremented(config, {
  onNonceIncremented(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

`() => void`

Returns a function to unsubscribe from the event.

## Parameters

### onNonceIncremented

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/nonce.watchNonceIncremented.md","from":5470,"to":5721}<fsm-vh3gqscxm4e>
declare function onNonceIncremented(args: Args, log: Log): void

type Args = {
  /** Address of the account */
  account: Address
  /** Nonce key that was incremented */
  nonceKey: bigint
  /** New nonce value after increment */
  newNonce: bigint
}
```

Callback to invoke when a nonce is incremented.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/nonce.watchNonceIncremented.md","from":5824,"to":5994}<fsm-vh3gqscxm4e>
type Args = {
  /** Address of the account to filter by */
  account?: Address | Address[] | null
  /** Nonce key to filter by */
  nonceKey?: bigint | bigint[] | null
}
```

Optional filters for the event.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/nonce.watchNonceIncremented.md","from":6166,"to":6211}<fsm-vh3gqscxm4e>
declare function onError(error: Error): void
```

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Enable polling mode.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`nonce.watchNonceIncremented`](https://viem.sh/tempo/actions/nonce.watchNonceIncremented)

---

---
url: /tempo/actions/policy.create.md
---
# `policy.create`

Creates a new transfer policy for token access control. [Learn more about transfer policies](https://docs.tempo.xyz/protocol/tip403/overview)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.create.md","from":216,"to":5539}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"e0c93d427169d0944a1d8b51a79fe35242cf5f9a3229dd7529118fcdd9ec4d11","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinGzmvBgAklCpAEbJFgyi2voAHP21yqpIJy06enirjOtbXRZWAMwDjs6jJxPUXmmvjm1ACi1iKwgawwABUvKkwABXZg7PxlY4yc4KS4NXq2aite4GR7rOFTeRvJCfED2b4jPp/DwAqYGGZomgLAxLLikGC8GCMLBoVIwobCYaCMAAJT5AqFpXKUkQeOp2PqGlubTwvP5gsOZkpiGptKGPyp1n+mBZPlmpQ5gXy7C4RklpkV+l6ACYsXUrogatotQYXSZXj0jV9TfTEJVGZNvGyQfamKwnZDoQqMcrPbILuqmpqiSASRgwx9I8MXIgAKyNS2A1nAu1ggwJRFgfiS6K88Q0ADKGA7AB4MolkgA+IIdZKpUdZCgrRzMPRkOCpEPCAB0Jc3vB7/cHvE3AAUlyvSHAR8UlOOIqlj6QIMxGHAYEPgLlOF/009NttOHsSgHAA3J+36IlgUC9mQqQAAbWLQAAkwBiKQFhKK4sGgWA34/qS8KcEiKJkNhuE6nKwqcKK4jip2QgyrqQrYa4465GA4jLnAWBODA3YwNBA4dqUUAQLwCAGGk+7wJw4iETAADueEYJuuS5AAchANAivgL6cLpslwIe+CPpAiJwDJdE4aovacPJ4iMGg5kJOwnCqLxaBinAEpCK5EC5KiekdnIiKwFAnA+bJOxyKJADWAEwM5vKcLyaCIqQeTKDJyXwGwwgwJudriEo4nIMgIB0BxWAKKUsG1Y5uSOoUwB8dBc7JAu+BoGgWCcK4nAJI+zCcAA5AAAnZSjPgA9DEvLDQ1qZNa5MCpr1/WDSN41FdNs0wDNDgWHA815ItXDNRu5l9QNT6bRNO3sHtNCpsduTckUY5KJwAC8LU0G1ShBB+OHRAdwipMgT1sDC8BoJYaAALoUGBHk0VxTprpwQO4RDK1sJujBQPDqSdd1QQREjwPuLkrgRKpHYQrycCInIXA/eIdkOTwllwNuUK/ruUmCbwU7XguWOuQRw3yTpNDmGIw0UzTuS1bBICI2V3FDMwpTTp9AC06TXgV6vFkupSaxx57mQbp5a1bxsUGVKVpcIpQwvg7med5OHkXqMlgGFMAkGAXBQRIxuI+iFR9O8zR5n6eKFu0guHmWVIVmaTTvPW1qJs2nLBKEjDhFEb267O14LQUcTXpm0fKtU8i+g0ceBkWutpxGNKDJWozqJUOcJk28yBEEWCPjgHAYFE4hQFAjOvhjQTZCACH956UDvNWaS8I0jTvJUaTWNW7w5p61biO8OwnJUlQAEK8NIMDqNW0jVgk1g7AAojsOwr5wAAfTgK817WGkNIdQEDrBpGrL0M4G9eDvG4NYPEaR1BQBQTsas1gYDWCgL0dBvBIFpBOCvCIyB4Z1yVL0V+TccQyCTngWe894CL07pUDO0ZPSDyBLaEeeAx4TzIJgKIVoYCpBXtLByMA5ZoBXlQ/QnpIF0PzBwgkdxAhiM7jcbudIqzcKZFoxsfDQQF3Ypxbi/J3pwChDAXIRBJDWNsRXYQtjhKiXEiAd2vFYJLFsbBTgzBoDM14uPYgBNpIGXyAoTgsAdiIiUEBTKfiYnWS4LpOALBGByEcWgCArkPa5AAFLiAcX2PcfsUm8WXLSPIcAhphKIBEsKOwMC2RgDsACj55KvgvCpMAuRvGBOCTEug1dzJoHkvkrifJGBJF4EUVMlgQ5rjpgAKh4JwWCo4bEKACbwHJcBzLyQcvgQJehCBQHMkzewMlzK+JMLYzc0UAYRFgguB5riFCbjII+UgZMAk0TCp83Z+U7LpQBQUmyvAaLxU4GZGAYU8m2TQjQXy/s2kaVgJuAAVtcjy/FmD9I2dwTgShoo7FCFsqpATDoSA7LxXWaVEXovkqi9y+TkCwTCfyI5m4xAiURGgWC8MggkywGuKaU1ICwDxZudgSgpoiTElNHJNAxB6yIJ6Som5aBTXEFgRgU0eWsM3J1ZgcgADEJqjkCogEKmeAdchcptTzAVvyRViq6hKxAUqZUwDlQqpVHjVXQQ1VqnVeqDVGtdWatAFrrWPl5UctAsBSCkAiJuKiHsyUUqpSC/x0RYUBQRWFE5qh7XpNOuhApPj/WIBpcMqAIT+m5AAPprLWQAdUkBlJQna23aV4uSiAlK5BOJiaOnFfI0DDXMsuCtVyZJJUsKcsg1iXw0BDnIDAuRDIdmMkIe15lzAxXcjmnY3Tek8GPBsCZHs2mMxWlFGAC5ICkGXeemAbSlibsUGgHduRwhGRMsezgp7eKhHHZpD2H6sX5TxZwVChKeacD7DAL9nAuWQDRT5V1nANhTQAPKevFZK6V0AA08yDcquAob1VoE1dq3V+rDXGqTaa81VrxB6xwzAPWQg9aur1oIKIiVchBKShYRKzBeySlbWAL+tBKoxLMjWtyubR35ppYgOmKs8WvUed8l5QRhoezkNFWy7A5BQGGhEbCUrOAPgOBjczlmpmkBswuZFdqhWGa+flEzZmZGWYAKRHQXFLaztn7O5Ec85lZxMQv5I8159Fvm5H0wCz89N7AgiWEUl/XL/zhpdsIBACVC4bELp0plSlYUHBYBwJYGLsWwDxbQiszgvyXKcS8rof2YVyi8DiijKxPnU2/N0+1qa34it/NSGViAFW4BVafBcmt9XOCNea4iuLs3cI2WQEHUIRNqzKmrPt3CMkuDlLQkKTcpB2wbDAO7F8o57ScHy5RxARBmDKlPsqE4tMZvXZskRnY07+CPee69nScAPsBC+/Wv7RowFGmB1dw7XB60HDIOxOQ7HRKsKmnQPkQrJT+nUMqaQWPvxHZO3IeGes2UGsnk0RAnpPR06/DZRnd2/bfdgIgPH6VQhE+TaT2g5PjBgH9I0Jo1gQeOex4RH7ouCdTVkxYUnDi5BttQuhTn7wjR0zeuY3iP1SvZPHVKUdh0hDDWwlUzc4KwBBFggAERoroD9yELeuAAIScG98oMggfYJtY6y51IoffecC7Tbzgdu9iuLAMHuP4fvPTMm+m5WtU6ZKZU7xNTmUNPbKMzAfZhzVkDLAPpuA/nliVu+mSvQfYCUcT7Otwg8kybO4hL81vbQO89mYN35cvf+9N64MwDAOzbGt4KxO/KC+FBBErQuX5bWJPz8r88iAANgsWZS9FuzDnZsJccklk/VnPNQGz+FPzYA59r8C4f0zbn8nhYViNVLMWL8nNOtr9ttks780tkVK1d838cs/l8sFJOB5s8tStytKskN1tVBNtZ5ts2dFBEU7Mo9L9gCMZkAkDSBFtUDVt0CassCGtcCWtEZ0VfkzcIQLdW9rcLNk97c08ndoD983cPdM8/dgAA8M8fdw9I9ACr8MYhCE8k8U8Hd08Q9xDSBA9H9mD69apCpiokBSoygMNShkAbE0p+RRUyNfUpogJVBEQdhdwnwKNZU6N/UpoopR0poI0WNzAdgZp988UIg1ZI53RzRPQVE/QAxCR2hK9O5ehzgTRe4kALRDEGwbR2QWxggatoAogYCTM+sioYAAB+VIGiDABcTcMoirWXUIW2DiDGYoihO8TgIgCAAmL7AAal6HClmGilnn8KoFozwGkPRVggywCXLTOQK26Hyk4AAFlmYBAqpIMdBkR/1zIYUcIApuIjlEUFwxja1cgkgLwuBS07la0Vg0JZNSA2lciBsgUZJODmEHJJQqVjjwgkMbCxAHIKchB7FQhERpJMlnwckP1kUXVgCEggh3g3kzDvULDZMwB1B5UdBVULBEQ9U4ShM8i6M4T3h2MDgEhNx3g40LUQcggNNWhliutJBINODNjXwkVOVYIKc5BNwZNewAVoTupyN/VA0kTaN6MYYmNI1WMjUmSiSrUmTWS0BJS9ZWhIhM09NaoDMstlgYh2xWZOBqwB9ssgtVSQ5UhQtbMFxdS0BCCgCY8ig1TUhqxH8Msm8nkdT7U9Tf9jTTTpDUhjSrSbTU0oDNDYI6Z0NeIuVRTJT2SvVOSLDuTqNeSQ01UBSPCo02NRSuNLUJT2BZMpS0zewZSdBIh+pesHpApJT5NtCSoypMkGVSgiBrBNxegazrBrAAijh653hE544GhqQ25AgXlojYie5M44xmQh4TFkwuQIQSwthdh9gQ4FEqRPQdE1Q/QdFOyHg+ZngoAezOF9E6wkjrQJAlBSgLc8BuymylR3h3h5zm4Ej+EDBjxVy2kNhPdUhegwBojjQ+zowLRI4YhYAUxq5MYuZZdLp1obopZtojVIYIBjpGozp3osg1prohphpNwfCPoXplSYLxyH8lIyRX1spGIuA+o2YOZnRuZeZoQBZ+IDwOwRYPoxYwJmEF54BwYwIvxho15KgN4t4d494D4j4T4z4L4r4b575H5n5X535P4f4dgFYWKRpQFwFIF1BoFYF4EoBEFkFUF0FMFsFcF8FCFiETgZLgZEZkZJYpFZZN0jKlY68XcgtbzoQCNHzf9MKQdSgF1xAkBQAAhFBMkhA8BHIQBXBXAgA"}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const { policyId, policyType, receipt } = await Actions.policy.createSync(config, {
  addresses: [
    '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
    '0x70997970C51812dc3A010C7d01b50e0d17dc79C8',
  ],
  type: 'whitelist',
})

console.log('Policy ID:', policyId)
// @log: Policy ID: 1n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `policy.create` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.create.md","from":5882,"to":6382}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.policy.create(config, {
  addresses: [
    '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
    '0x70997970C51812dc3A010C7d01b50e0d17dc79C8',
  ],
  type: 'whitelist',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args: { policyId } } 
  = viem_Actions.policy.create.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.create.md","from":6409,"to":6683}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** ID of the created policy */
  policyId: bigint
  /** Type of the policy (0 = whitelist, 1 = blacklist) */
  policyType: number
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Address that created the policy */
  updater: Address
}
```

## Parameters

### type

* **Type:** `'whitelist' | 'blacklist'`

Type of policy to create. A `whitelist` policy only allows listed addresses, while a `blacklist` policy allows all except listed addresses.

### addresses (optional)

* **Type:** `Address[]`

Optional array of addresses to initialize the policy with.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`policy.create`](https://viem.sh/tempo/actions/policy.create)

---

---
url: /tempo/actions/policy.getData.md
---
# `policy.getData`

Gets the data for a transfer policy, including its type and admin address.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.getData.md","from":150,"to":7000}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"7be8148a546f6e73e327ea871b234bea4c43f38a349d04fbe07fd29b5c985e9a","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinOJQzBapAAbWtAAkwGKkFkqum6VQELwIBtxrFitQUKTwcAB0peVSiAAc/bXKqiQAFYWjo9HhVuswF0LFYAMwDRzOUbfCbULzTXxzagBRaxTiYHCpAAKEHMvAwABUMVQLlc8KTyRgCV53qJtPpvt95HVAYhKqC2nhCbh5LCkAiQPYkSM+kC0SLMbNSjQFgZ8uwuEZBMIPhy+tZJQoAQ0atohTd+DrTN14YihsiJdYFRiDDM/Di1SANYU2Ey9RU+r0/sb6khmtRWuCDH7GBSYT1EJLpQ7ZUnUR50VM3ViVbiDAkAK5gK1CThtAAi4gkAB4MolkgA+IIdZKpetZCicLCOZh6MhwVLakyvWMU16V6viV7E3v90hwOvFJSNiIk0gQdZwGA14C5TgHh5QoePZ5wOAAbn3h5FJLJcapXivYFcjdyYHEfbgPd4MHLeirCRzkua4QAAcT0OBu3vClOCgKc2UjJRrmQZAQDoT8sAUUpNlwtA4FyH0uGAaJnmrGAO2SLt8DQNAsE4VxOASDdmE4AByAABAB3cQlHWAB6GJnjYwjWE1TgSJoMSGKYlj2O43iBKEmBBIcCw4BEvIxMKEjh2EGTmM3eSeL4xhBPYFSpLYTTciWOJl04ABeUiYHIyilCCPcwAPaV1NSZArIgSl4DQSw0AAXQoa80CGYQCnw1IvMPTgApgMTXkYKBwtSGi6KCCIou8hjCtcCJcls/F4IkJyVh4xgtVLYRRxgjAJwAqcW2XLskugpkAEkoFSAAmMASrKsBcLOSK0J7IZmFKVslE4ABadJl3eaaQFmz9Sm2vsRig1bZzm+c3hATbnjQQtSF1KhKXwP8x2ZKrp3OyKyn1RBg25f4w0QM0o0CScgLFRNk0GYYXH5eVM0VHNlXmQIQjCSIimEeyGxSNbMdE+K0c6dlAy+oaI1DPkI3NaMpWXBM7SlCHHUQIE4RdbMfARz0kawDccA4DAoiegbUgAI2SCwGFpECGRazg+orRDPn0Xo4R+smGh+ynAkFqBaaQAV6ZlKGhtZ7x3WxVVAg/L8fz/JYyRgXIiEkNG4Ht9sTHt4D6QMe6/02O2FE2ThmGgQsFG7DciEy+AVk4OB8nD2BhcLJQlGOF37YJBwuEYKD4/WORnbQCAs4dsAAClxCdgBlXgjiwDHXfDvtpTyOBWO54ho6gThheZLiYGF3uNy47cF1ecqwF94PQ/Duh4qgtAuJL78YF4Rgkl4IoxMsMAEsngAqHhOE2esm5gIPeEL89OC4+r8GDvRCCgPPC3sFYoP9j2FFeOQIA8iImwuxf2EPbV4ZANykHykHcQYAe4gPPq8HiN1oFZ2rNEWBvc/yFm3D3Yut8jg0AJCXWBzIABy0AYCvAAFZ5xiq5ZgE8wBH24OWP+wtQgnwDhfTg6kJAlltsua6MA8Ely4oQv8+DkCbE7r+c8rwxAXELGgTY4Ugi5SwIOfi/FICwFoa8dgSh+J0jgPxQuNAxDLSIENSorxaD8XEFgMysiXivBoswOQABiFx55FEQGUVEWBUBcjSJ8W8RREDVHqNopoxA2jdEwH0YY4xIEzHkUsdY2x9jHHOI3HIt47ivFhIiaQUgERXicGnkodhnCEH20vpg4W2DcG33vv4nO2kBDKFLifBJiBuFBxDlAMOVDJ4AH0D4HwAOqSDyMoSZYzUhVJqXIDO4cIDC2oWvNAbEoL7WflBSQf5LD3zIC7XONA95yAwLkOAGASz4A3JAHBnBzAAGtJEPWHhAUeZzuDEj6ovB6zIzxpWFgoLskBSArGeKXZkSwLmKDQNc3I4R7n2Cef4qC7y/yhFWRAVQZyKGwBoXQsizA3icGrjAT5f5pGQCIWWMJst+IAHkokaK0ToyhSSdApKuGkixaArE2LsQ4px/EwluLQB4zx4hloMpgMtIQy0wnLUEFEBI7Bcgh1hRYLVpBmDVh1Ew3IABRWgmFw44PToSthGzakDMQJPSatCKqgJ/n/DybEHpyD/rfdgcgoBsQiM+bRnBiRHD3oOTgvr/XL1IEGrs+C/HKPdYgr1QQfUwD9SXAApBpLsbEE1BpDWG/iEao0JVjTm+NgaoDJpXmgJRaB01gIgewIIlguKcDNaUztbEpmEAgJorsrt9npw4T3BwWAcCWGDREUNuRw2RvFlBDt0KvxwF4riuBccJC8DeQSB0kim2wFKc6sA4aDx9sgakIdEAR1wDHZuJ+k7VixscXOkRy6K3JXQcgGATs5DZSBF9IEv7korC4LXeuaBXikGLH1Ke+Bc71gtpwLtlDEBEGYF9OEQ0vrfHGtew86DWWbO2QhpDKG0NCAw1h2AOG8NwmsNIdMJG/1ka4H08WZAPxyElXkl4/E6Br2UTqf66gvrSEg/+rggHgPhWWuIr9ZAmiICGkNOT3HOBAdCLBxgDdMO8b3vx0IQnLgibE7wCTQh/qNCaNYTjUH0GmZGAJ/iRqLCieA2Mw4xxNNwiTJPOynArZ/mcoOxgfrOAACUNnqSEGxZ83CkGzKCJsKsygzn7Ai64AAhJwbLuhSAFc2Euq9FbV3RtSCVs5UyYurIS6LUBYAiv1bK42/d57SC5EmpPC1Vrmm2q+afb+PCr7hEHC63CbqSz4naTVNo1d6Gfmrq+wgXF8qpfxBA5behVvko232LbO301cGYBgM+mdnLdrWVQm7CggjtK7BAyrOrrsTd/v/LNcaxH1rLZBmr1b/sBsTQ24hnB2mfae1QzN2bc2cALWxItJaF3lsrWunKtaAcQ+6zDsAV24fgP7VA+7t6B0PqfS+id3Sp2ftnYoERIbKsrqrTG5AlPSD3uHaOuOr7VDvunWp+dkUocQNC/iCLNVouxZa0lsAKXYffeQWATLnXOB5c/DAQrxXYGlfK2z6rHO6sG4a01+LiW2sdfN11iXpT+u4RVLxFCaFtyihAMgV211fxqM5XE/iadVCFmFq8GIzBuV6NMQk/i4KNn8UyWK8wwtzIeqobQiIb1CZfF6ECUmvJTSCiptw3W/17SQ1GM6WGrp2YegtngII+zoBRBJ5mrdO6AD8qRSFdleP3kdxgBPHU/DG0hyBwprk4EQCAmVMMAGpejQ9mH/VYWfJbexACDxeJdNippUa01Q4WYBcVtBUgAsmHAQWFcU6ELH2aNGDvJNO7NNkRXY75H8JbkJIC4uA4JEQ/h6W5hYEkGZA710BWD3TxQeCgHqh1E4QAJ7nCDjlDzEHqjszAEdlCELBjnzhiyLhLlCSrQSCCDhEAX9xiUDyNTAHUAMT5W6ELHsRoNVR3VMRoLhCE3FgSFeDhGlQ8XGiCDtVaHvyRUOVhRgJ7HPEAKkU2AkzkFeANSNTQGgUoLoi5QSV5SMRMUFRChFSyXFTMnkP4K8XkKUOrHMOFVaEiHKVm02HmzCxiGLC4GciBF23Tx+29ScL3lSDzWDS7G8LQGNyx1qyKGcNSBBCh33zbU9V+zYkCMQFRzCL3mCO31SASM4EiJTWbUJwGywLAGpTpTkIEAUMsNUOiXUMD00LeGSR0PMT0KT2yQlWMMKU8TMPYGUMsOWmsM1XYBnj1USA6ONSEEQgkGQiQFQjKAsF/FKCIGsFeF6AWOsGsGzw+iJl6EaH1jVglGL0CC9TLxqBTEryQAzEmFNlzERjxHRiPA2BPh2H2AC2UFOC9lAluChFgLPDOhzyVm+BBF+j5D+M1ghDuGhFBisEOIZjTCGnGBrzZjNjzC9Ai2/CcEEXT2wOhW4XdnTxeLwGnjqUDhnmGXDk7ijlgEOTjgTj/CThTjTm6W4TQRzjzhYAIOhXwW/wrirnEEM2M3pJbgcDbg7kjm7l7n7kHm+V+XHknmniGRGT01oAXgJGXjjhwHXk3m3jYF3n3nyJYRPjh0vmvigk/wfmbxflQPfhQPxPh1+0AWATSw3VQSCS4VVwy0AQZKfywU4CQKh3EXqlPSgPIUoVJX3XJSYR1OqQdVWUtKDj4VgV/HxmSGEVEQIV9Kh2IKs3kX3w5RiQ0J5RqL5TqPSWFUaMMMs3yRMO8WE18RyICSgOCTADTLLJKVICzMqPiVzPoO0NSXqIyVFSaNyXTIKRlSKUrPPGbXewqWWQjKdPTwaWf2aUAKNKWyIlGz9j6QGUJJGVNTAAmWmVmWOAWSWS+XDI4VWXpI2S2X4F2UflUGgHEOORgFOQxJMERSuRuWEHRUeSECxVeUYA+R6WFhHjHh4ABSBRgBBXgDBQhXCz6KOThXOTECRRRQ/DuQeUxReRxRWFiwJQemhWJQzzJQYUpUKJ6XpQJT/CZRHJZXZTUNiTbOjw7P5VMW7KLN7JLKlVaPlUVWVTAFVRHPVQgF6L6yJwsl4UGMNWGLAC3KG1YGtXjm6TtWPMdQm02EvSd3sIIgWw8IRzB3RyByqxCNB1x3ByTSiOrNbU0ozTiLBxRzR0B1SNNxrSR3R262iIsvbTJy7RP17Q8sHT52fQFzpyWgZxnW/QXXsrXT0zJ0fnPB3VrP3ScCPRihRNMt60vVI25150fX53HTfXpw/RCuZzrNIwPAA30xAyZnAx0xKpgzriM3g0QzAGQ3ujozM3oBM2w1w3w0I16GIyqug04AowvPqpo2argHQwCHaqY06tY3YxVhc3k2gqYz4xugszCVE1oHEyHykxkz6tKqUxUyGCZx50cy012q4DKu5K4EYxgEQGWs8zWps0wIcyc3mt03c3M0E28yvTKv8xikCyGmCzhCl2uJlyi0a3l2t1diV3cMQTVw1zty12AHy1txyzKwq0xzSP11Rs4HBua0hqEBRsNxcrHMdwmlwkG0tRkpG3krGz1OiANNUrJvUou2h2UQOzQCOwYROxgDO0qzC322chWzW2YG5t5phsuy+3TxqnuzSzhxe2UTe1KQ+yJ0lssu9R0rsoxoco1vxyh0J2J2+20qMpsvYl0vCtCJ1pMvwX1tVvcsgU8p7W5yzWp2ysF1QzypFyZ3nVZy1uxxSgypxr8tp1yqCvytFxEXF3wUl3yLC1BvYlxqt1ayhuVxVpJzhqywRu1z7D106yN19tCM1wToVxtyxqJodyEsmhd3GJQHdxpVKG938VID9wqNoqD3vlD3D03Cj0SRj0oTj3YUT1YpTzT0QUz1WMVj6GkCGh5BNA0F2KuPPjLx+iOMZmrzOOFF4lKAizwH2O+Mnunv+IaFsE5mliZBuLAFSB2HUEqCGigDhCBDSF4EaEaDhEqDSGsGZmhKGiBHEDhGFm+EqEqAACFeBpAYB1AgRpAgQEhrBhYzVhZhYl6K9V6TYlR698xggTTW9DbfsICYBu9/S+8B8G4EC5AR8KUe8wAMAJ8p8Z858ghF9l8yBV8oB18QATEGQOcoc98zKg4jTj9T9YQL8r8jNw4RCH98J3SX8pDcEP975S4f9GA/9PSWkUC7UQCjVSBwCXhYrHSYDVg4Ch9EDVHX5hZ0Croh9sC5BcCmSC5CCUoZESCyCKCW7qDYE6DklGDmDYFWDdB2DYFOCQC94eC+DClBDhC78JG7zMLVkZGZCiDiiYtFChiVCXGA86Ke6GKCyhV9CxUcl+IWihy2iSjLCuiejbD8jXUNLHD/E94ao3CYirSvDam0BfD/Dkigj87q0Misiz1Cc0sEcEikjAjzbumWmIjiaW01LJ5iLpFjCyi0nsyqj2zaiuzCzcm+yCmSjyz2jxK0AymdBUYDV+i/x9UUmTUq63cpiBFZj5jFjehljx7PohpliZ6/pJQgSDBd6zBxQfhkG0xTisxziOYG8DAwtbwI0WpqQpgN9QJGQHwWQcAFZnmXm3m+R9ZPmgWkGDZUwjZAW4YkIt6dcd7/4AwvgtMC9Z6bBLiDB4XYIIWuJUMaBzAxAy8Hn/moZnR3oYhYAmBOkJIeBGooJGJDJWJi1FIzJApNIiIBXFoDI5I2JXg08sgbILLiJz7k0vAZJnJxA6oGoh83gno2o0BAJxBOpMZuprxtZUhehRpchSpga1as06XmRIQNgki3WwBxoBm4iXXEWbqkiRRxpSh9pxAkBQAAhFB44hBhQEBXBXAgA=="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const { admin, type } = await Actions.policy.getData(config, {
  policyId: 1n,
})

console.log('Policy admin:', admin)
// @log: Policy admin: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb
console.log('Policy type:', type)
// @log: Policy type: whitelist
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.getData.md","from":7086,"to":7205}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Address of the policy admin */
  admin: Address
  /** Type of policy */
  type: PolicyType
}
```

## Parameters

### policyId

* **Type:** `bigint`

ID of the policy to query.

## Viem

* [`policy.getData`](https://viem.sh/tempo/actions/policy.getData)

---

---
url: /tempo/actions/policy.isAuthorized.md
---
# `policy.isAuthorized`

Checks if an address is authorized by a transfer policy.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.isAuthorized.md","from":137,"to":4988}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"d89a8bdb355ed397122134203ceb623b3e34be73a444f2615bf50197c0945485","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinIxw3ACuquyMAF4wUKkARhAQCuJgpeVSiOqytcqqfQBMLTp6TGubhKS7+10WVgAzANHM5Ro0JtQvNNfHNqAEmKx2FwjIJhJdtPpetZbPd6hpXm08KiTP8eohgSB7KCRkgnupIZgpgYZn54QsDPlkZw2OZeBgMRU+tYABzyOqPJqE94GXmMflkoEgoZgpCAgCsjOhLNhpRoHJACXWYH4aJWny2Pz2UAAPBlEskAHxBDrJVL2rIUHmOZh6MhwVIk4QAOjl/ODqw2lt+UGDAAUfX7SHA7cUlI6Iqk46QIMxVjAbUG4KHTvKMBGLd8Y8GAEp6dakMAANVC6xgjtyYHEvrgWCcMHNUar1tKUAgvAQBjS+BgvAA1nAVglOOJOOs4GRzSuvttrZxDhgVzzS+G9eIlJPkMgQHRu1gFKUAAbPtBwXJcwrAaKkGDiGge5IvXwNA0CwThXE4BIc2YTgAHIAAEAHdzzzAB6GIf1g98kU/TgaCRcDIOguCkJQxh0PYGB0IcCw4CwvIcK4L8i0IqDcxI5ClDQjCqPwth6NyJY4jTTgAF5v1/f80yCYBck4aIaOEVJkD4iAABV4DQSw0AAXQoOS8KGYQClfVJZLAeT5JUmAkQjKAdNSYDQKCCJ9Is8C3NcCJckE2Jt2jPdxPEZDGBRU0TBLPly0jHcrX2F00y9cz5LDDAAEkDk4J4wDc+T1zIVJYOsWhg1K2DPO8sBn0fEA9OvPshmYUpXSUTgAFp0jTYNaooeqfVKBruyTRcOoTRrhu6uqQB/NAG3RKgAHUZ1UTcVrXDdSC3cRYurWq9LKTE+l6dVxQeBpeheahWhlEAYoCv55ABNVlWGFxEEqJ4tWZHxZj1BEDBCMJIiKYRhIdFJOvB7CTJBzpREOxALrFPFJWaK63naNNFWeqlBle0Z1U1DwoW+1k4X1QIgiwHMcA4DAony0hUkfYqABJgDEH5lFcGqqDHCc8AAVQ2lcoCgH84EXNAIAU2c526+GhURypcQUM6kEqaVAkZ7H3pe1VEE+4mmW8Mm/oNKmabITAolSjKjmSCwGD58dJxAOMT0PNKABEFYOpXemkTWUYaZHtCJWVPYy3WTtxmk3qNyZTd1eZAi7Hs+14AcllOGBciISQQbgXP3RMXPR1dvA1JnThHxzhRH04ZhoHWBQeRzIhGFgRdVzgfI29gQ51iUJQLFa+uB1UP8tz7vM5EL6W8JnXIAClxALgBlXgfiwMHi7b31qTyOAYOp4gu/2fdD0QmBDn3HNEI24sfLAauB2bqBW4HOgTKlxCZd7LORgSReBFCRJYMApkX4ACoeC13tPvGAjdeDz0lpwRCoV8BNz0IQKAi44DrHsCuRcdcy4KGDHICASgXKPi9KQ4QudgxkBzKQGhK4wBQFrhPYMyFGxsKnnEc4+4Bz5U4YvRCPwaB4RlucQ8AA5aAMBgwACt8FoB/N2YMuRYHcE4EoShhxQhcLIUglYoNzhZ1hskBsl9xGSMnjLZAj4z5Z0lsGMQY5NiPh0kEJyWAAyoVQpAWAqjgzsCUKhfmcBULzxoGINqRAniVGDLQVC4gsDkRcfAYswFmByAAMRZMlh4iAmwojnCgLkJxRTiweOYd43xIF/GIECcEmAoTwmRNdjEv8mkElJJSWkjJqEanBlyQUmpdTSCkAiMGTgb89EGKMfQxByChGHBERuThGCtibBWIxMeS8ByPjaYgCejcP5fy0WAXIAB9aB0CFqSDyMoB5tzUgLP0RAQxcgi6504N85Rs40CwUXL6LYeCVw/k4JYTBm4lirBoJAuQGBchwAwCafAOZIDrk4OYOck8a6HAfiLbgcY0pSxnIeCWNlDgKC9JATakhCUwEPAisQig0AotyOEDF9hsWlMXPigcoRfkQBWptBRsAVFqI0cwYsnAN4wBZZwJxkApFCHbuObJnA0qoQAPINL8QEoJiiOk6C6ROHpcS0D9OSak9JmScyuJyWgPJ+TxBtXVTANqQg2o1LaoIKICR2C5GbtCiwIbSDMD/Gia5uQACitA7xt3XIctaXyfnGIYQ3RAL9qqqN8jmpRlDqGwRnHISh6D2ByCgLBCIABuXIgTODZidgGTgFaq3/1ILWr0i8SmbCLYgihVCgjlpgJWmWABSOiXpYI9trfWptYAW1tsgR2rtMtF1QH7QAtAni0DDsYcw9gQRLCIU4Am6ZZ7YJLROP4r0xdwX4EOYYzhDgsA4EsHWiIjbm2oVbVzV8nBT2bR7HAc8IqOGcHKPOQy/ZpGwYPcwvNq7APyWvSw1I96ICPtg7mHBb7xAfvSd+/YAHLLyWnsgGABc5AOXVIjdUlGqPTy3jvNAwZSDGjSq/V9cB7QU04OexRiAiDMERoCJ4iMRSVRbWxrg+rDhAv4Nx3j/HVhCYCCJ05EmKTWGkBSOTrHLLT1OU7MgXY5AjOddk1CdBZybDRDcdQiNpCmeo1wWj9GdJtQkWRgqjRDZPE8yuLgdHQgccYLvXTYnLONlCLZ7VksHO0Cc8YMANxguNGsPJjDZmuAWcgVZpLMaLAOfo7czmY9DaAgpC/ISMKhpiTggtRglbOA1m+bRIQsEV3cN4WAIIj5vbnF0Jtdm6cYCuAAIScDG8oMgs3Hz/vQ0B9tqRFsTc4O1zr3XDi9bAPN7by293IdgNM3I1UX5JpTZs9NNdHwINzsg1BAZ83PkLSaPypSuDiTaBvdRv5mAb0I4QRCLkBt+WYa1wHwPuxg99BDqHw6uDMAwC9tu4kL1/PIVjmAQQ/temYWtsNmOTGjrLVu6tvbf0rrXcBzdk7u01t3Uhv75OCdU/HTT2d5U4I7uXZR9dplO0s+3Wz87nOwAY+52B89MBL1Ydvbh/Dz6iPKH3CRztgWf31rW4zzbqqVdM124QPDcAn2EdUMR0jX7FD7D0kh5hjW/LTda3ejrvyDtHf61zynQ2Runcm8Aabc2FvjeW6thngHRcdpD7t73XWesMOO5HpbpBZvndd1VZ8Z4LxICvGUZVpRkDFwbFnHxxqWmoVHqodYhxgwxGYKakJ0S2moTpd81CiT7UxMYIcCixaZURD2ora4TwLqnXxDcLWiwTG62RtSFUtIbBfWTr9VOeAggvugFEbnpbd/ZKgwAflSLIr0pUwm7zRKEMa3YO2yOQDpTMnAiAQC7iJgA1L0AFsxKESMx8XYBYDB48kNHxB00BG4dksEL1uglFOAABZVuAQe8EVHQdYX0DdaIdZAcPsSWfYL0WAo5XIJIZMLgURYhI5duFgSQQ8CDKDdhThUVUWKAUKO/X5Kg8IWDRvMQUKZzIQfOVseAWDFgDrBeRxZxYDBIIIQECII1JpWvGNMAdQMJC1bodYVJFQ/1KDaJFQwEWzJ2BIYMQEMZN1OQSqIINaVoLAzlHuaFVgggrZJDJxZzOQYMKNGNNAGhavJpE1Npc1CJKJa1PpPvQZR1VCdw8w91dwrwv8eI21VoSIWZT7R8b7JrGIY0f7TgdUaHEfI/WCLIyBVIadOtL0YotAQ3OPJnVISo1IE6JDKA49chQo+ogXSo6ojbDdOo0pEo3I87ZovPR8F+JVAcNwgQDwxI3wxpUCAIs1YsTpEI2JMIgZB1YZaI8ZfJOI9gbwxItqZI4NdgJuSiMxRIuNAvS8a8PuE0XAKgIgawYMXoJ4nEcff2SfJ4VWCUBoSkcOG6UtJffWNfEUDfGELfdkTGUGQcHaa0I4E4M4C4CffQJJS6NWWfafdGCOW6SsXcB6MwJ6RAZfPGA2QEawUEgwCQJQUoabPAAEpEukdUNGNEyUXECmPAClfyYcfYVIdRNsXWbEIEt6Mk/aGIWAREGGZicKYQViYiBdMiVCVSeiD8JiKxVqCCNiGCWCYMYfLIASH7KEu6LkzhIKEKMKTLYsVKCsIcXEqABKcGJKAyRmQqYqdQD6KADUNIXgRoRoQESoNIawdUaTaQJ4dUcQQEQ4EUSoSoAAIV4GkBgHUHVGkHVASGsEOATUOEOHKgMjtkyl6BylyC8jdwKLHVgg5O2nugOAF0NJtMqlKHBXECQFAACEUD7iEDwFfBAFcFcCAA=="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const isAuthorized = await Actions.policy.isAuthorized(config, {
  user: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  policyId: 1n,
})

console.log('Is authorized:', isAuthorized)
// @log: Is authorized: true
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.isAuthorized.md","from":5074,"to":5100}<fsm-vh3gqscxm4e>
type ReturnType = boolean
```

## Parameters

### policyId

* **Type:** `bigint`

Policy ID.

### user

* **Type:** `Address`

User address to check.

## Viem

* [`policy.isAuthorized`](https://viem.sh/tempo/actions/policy.isAuthorized)

---

---
url: /tempo/actions/policy.modifyBlacklist.md
---
# `policy.modifyBlacklist`

Modifies the blacklist for a blacklist-type transfer policy. Requires policy admin role.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.modifyBlacklist.md","from":172,"to":5627}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"6c776f607178f89d5334ea2398757c8b3ee4db029caff53ec164954928f7b409","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinKQwvDCMWGipACpDwsOCYABKaxtbpeVSiAAc/bXKqhotOnp4q+ubDPIWVgDMA0czlGNwm1C8018c2oASYrHYXCMR1MV300lkD3qz2orTeBiRJi6vyQAJA9iBIyQACZGmDMFMDDM/DCFgZ8gjOGxzLwMJdtPpetYagpHg1mjjXoEuYweUSeohSeShsCSZU6RDGVDSjRWSAEgBXMD8I6cZjQRgJDAAITkTgA1uYxABlDBGgA8GUSyQAfEEOslUp6shROY5mHoyHBUgThAA6aU82NmqAW6223gOxjO128WMABTDEdIcA9xSU3oiqTzpAgzCzMDdwFynBbnIg3IwAEkoKkAEbJCxoADczdb+qwUHEI1SAANrLQACTAMSkCxKVwzkdgVucJwxQ3bThzxfLtCr5Qbrc71YrmU0HucXsQdswcRgK+tj7nQ97N9wQ5CKcnxbFurjerkYDiOGcBYE4MCmualo2vajpoC6RqlFAEC8AgBgALKIYw8C7m2HaPummZiLGuS5AAchANC7PgWacCx4icHAOb4DWkD6nAu7GkInCqFOnAAO7iIwaD8Qk7DCfg8Fnn+AHbmgEC5L28EWLwcj6rAUCcEJ7G9nI2F2o+MCyasKx6PqpB5MoJE3mwwgwLG2riEouHIMgIB0FBWAKKUM4hdJuTsoUwDRKsU4wEGyQhvgaBoFgnCuJwCQ1swnAAOQAAISUodYAPQxKsOXhfCkXCTA8JpRlWW5QVnklWVMClQ4FhwBVeRVVwUUxvx6WZbWTWFa17DtTQ8I9bkSxxGWnAALzRa+NDxUoQRNtu0SdcIqTINNbA7PAaCWGgAC6FCjkpwgFNJqTbTuh21WwsaMFAF2pElKVBBE107e4uSuBENFGrENlwPqchcCt4gSVJPCCXGCYYEmiFpihWZoTmfpliGT2kTKXYPlSYAAy24hQFAN5Rrl86xozOUU5DZ53jAD5nvqMAAyDuQhTOIBXb5sFDMwpT+konAALTpGW7nCyAotQaUyvhiM/GywWYtFnACsUL5qxoHZwilDsCnCfs/7IzZwFcG+BkwCQYBcJOEgK1dZT8n0vSVPIdRPIgvQYtobR4MmqbIRmqHobwcr/ICyqUoglS9OqDI+LM2qwgYIRhJERTCAtXopHLJeVfdhedKI3tB38fuYoH4qh3iZJlvHJKJ8MLhNGnHjghnTLQjqgRBFgNY4BwGBRFTNPwHT2QgPO6iVFSUB/AArGkvCNI09dpNYG9/FS0hUhv4h/L2NyVJUVq8NIMDqBv0gbwk1i9gAor2vaL3yFR9JUcUIosSIBqC3QIs9aYdxTl3FUiAqTp28EPbOuox4TzIJgKIqNux9gHC7P+1wqTWFJMAwONwXhhwMNgqA0CN6wOTgg/u9IkFanmKPceEBJ6YNZquZwnNSDcwIfoKkwd/aij6LYCUlCQA3jZnw6B4olTd1GIwyYLCs5sLwJBaCsF1iFzgC+XIRBJD6JfIGEwL5MLYVwiAc28EZxLBfDOBCUBobwQ4UQD6xF2JwHyAoTgsBez6iUEoNcpj/EiS4CxXxdZbSkGEhAeSMBcgAClxDGKdLwVcWxwnwXDOSPIcBsoeK8QZXsGBxIwF7I+GsYk4CRmomAXIdiXFuM4HQe6/E0BiUSTBNYFoZRFHhJYF2UYwYACoeBHk9AYhQzidLhH4mJKS+BTR6EIFAfiUN7C7n4g4ixChYymU2hEGcIZ9nCBfLGMgNZSB/WcQ7I8jjDkSXsvc+SoleBvgspwPiHMEniVXDQAFb4Kn0VgLGAAVlss8r5mCNMmdwTgShTK9lCE8g5MBnFdQkEaeCks7L/LUoCqSilEnIBnBw9YcA9ZiCwvqNAM4LpBB+lgKMxViqQFgNC2M7AlDFSwjhYqtoaBiGlkQKklRYy0GKuILAjBipUvnrGJKzA5AAGIlU0rpRABlM8wBQFyBSrVtK0CwFIKQJlLLkpssQByrlMAeV8oFdY4VsUxUSqlTKuVCqTUqrQGqzVNZqU0rNTciIsZOAtJRRANFcgMWXLmdEb5mlfn1IMss1Quqol9TCaoexDrEDPKxa0w5YMAD64zxkAHVJAOSUFW8tTF4IxrjbkwyvZIVrDQDlfi6sNn8UkPBSwKyyD6OxooNAcgMC5E4kabiQhdX8XMHaRSFtey1PqfE7geZOxdIUhUm8tUTI804JAeJQ6kkVKWBOl207cjhC4jxJdnAV3wVCPGhiCl4ngrctCjisKoJ604E6GAa74IUsgMCoSJrOCdmKgAeStay9lnLoCOr1s6wVcA3WirQOKyV0rZXysVcG5VqqNXiGllBmA0shDSxNdLQQUQrK5DNNZCwVlmBTiOI03IH9aABX8XxPNFtW3ooubMrFiAwYC2hXNTFRyICbRygpOQplxLsDkFAHKEQtwcs4NWQcdM1MaZ6aQbTIZiU6oZQpxNbljlBFUzAdTiSACk3UQw5XM9p3T+niqGfPA9TgpnEk+agFZ3pZrs12ak9ci17AgiWDEpwD+CW7k5WrYQThcAQwGP7WEtFBkHBYBwJYHTEQ9O5AM0Z0Z7T0trJpZ5d9BqAP2ktnBAFdKbkybAAZlsaXbmpCy8+NleXazrMK1TELcqysc2qwFncolkBO1CF9DeQcN4LZ3LuLgmTsloFjAIsAnYwDmyzJ6EenAkvocQEQZgdcqRBxuKDPri3WyiQQ527tR3DSnfO3AS7ARruFvuwqaw0gFQve20trghbBxkEgnIUj2F57FToGsBlRxQHqCDtIGHH2uAreMXIC60sxJDFK2QJo8CqQE8plwVbch9tfBB7dhH9lQgo5Dej2gmPjBgFAY0Jo1hXv9cJ2e9nLtEdc+4xYdHJPy23mUPAv4CowbzTPVBeCK1MuMHU5wY4saupCByluYtsZXlgCCDOAAIm+XQ8SlzaJgK4AAhJwe3ygyBu5nFVt7gXjOpC947zg1b9fxqN/2S5YAPch595FgD5rSD8xCmDATQn4Iiccvm6ZmL5m2hpb11PM55PgyLoZBly1kV6CdIB5gToJuEDEn9c3EMbnV7aHXmKDem8QBb/7zXzAMAzJfNX5LuTYyj4UEEbNIZw1bjYyPxTjnnOuc0xZir/nA+jO+i5szWmIsApi2AYf0+HPKac6FzgHnma5XC357btXgvX/C4nk/Z/FM3MSxPwbiXMvZZjYcQTaqBTbFazaKAcy6b+41ZBZ0zIB/6kDDaAG5bAEFaORFYzZU7lZXQAo3Ia4Qwu7V564G5R4m5gBm5L7n6W51o27x5O7AAu7u6e4O4+5+7b7P50z0Fh4R6G7G4x5x6sGkBu6J74FgACweReRIA+RlBgalDIAGJ2TrDMooZ2rFShKqD6i9ixgxDMBobco4YOrFQmSxrFSepEbmC9ilSKbQoRBCyeyojUipxiIgJgK4jtCYrQIYhKJwLWCIKQgaIsijz9rQBRDUGObQT/i6AAD8qQoKIYjMvKWwRwoQ2sQGcRYAGAyAF0lYnARAEAH012AA1L0IZLMKZFTHYVQNhngJwQCjODZoyuJCsmejAGJN0G5JwHhNDAIIFO+joPqOGHVl8tuKmrBDShzCGJmqsvmrkEkMWFwH8gZOEEkpyKuNxqQBUpEc1ruK1h+ruNTFJCkfGksbshxFoWIFJFjkIEYqENzFsiwPriYsSsakFgkEEH8KcioTamodxmAOoLyjoMKhYPqDKn8Qxs1jhn8X8KRoOAkLGH8P6mqq9kELnq0IMZOoOtZPseMemgChSljnILGFxlOPct8SlKhg6k6kCdhrhqdARl6sRgqoSUiRqoSSSWgBydLK0JEBGrJiFGXprvuC7NXhvG3vZkpipsKYeG5jpiGNKTAQFpwakNKakHQl1tFrZuXnFqvqqXfgqRwXASqbqi7GqYno0SXmDKBhBjOCyRyWSdahSWoVSZhjSa6iKvSeYd6iRiyRRuquyewNxpyYGVONyToAXFZAhBxokCGQLu5C0FISgL5L4niqUEQNYLGL0JmdYNYPYTXP/PApUBiKQg0KSOAngMcl4fQj3KCEwhqJnMyCPIsBDF+F8LsFbCpEBN+EItSCvC4YHG4ZKO8GcF8FWWSIMMoiSH8P4ZqIEU2bnBwlwtPB1gcMjAABLhD4CzjzhLjK7riCzVHWJ4AblwCrIQAJDyQsS3TWwC49nwI3BUj9kNC9B0JSKtzXkqQnlqA/DyjeETlwKpwzk4hKClAu4VnKZ3knzFkBwNCSLzm2Idk2wOCnmpDzi9BUj1wbyNDqA3DSDWDiC9i8CwAJDoWYXYW4X4WEXEWkWVBYU4V4UEVEWWQ0V0UUWMXEXQK9D3A+HJx+GewxCwBwiVwDTIxDQNSjTeYtQKpHQQA9QRT9RVzJD1QjTZQ5SxjWElyzTakKWtk5LpRwwIyIiiXxjtjEzowphIQUQxy4ySwEyjiQLzypA5TLyrzrxbw7x7yVAHxHwnxnwXxXw3x3wPxPwvxvyfzfzMyjjUKpC9DkyjiyK8L3ipBcw8zAyvaxZXKr6/irkC4zYoV366WHYfnrmbmvalDqziBICgABCKC+JCB4DSQgCuCuBAA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const { receipt } = await Actions.policy.modifyBlacklistSync(config, {
  address: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  policyId: 1n,
  restricted: true,
})

console.log('Transaction hash:', receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `policy.modifyBlacklist` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.modifyBlacklist.md","from":5979,"to":6435}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.policy.modifyBlacklist(config, {
  address: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  policyId: 1n,
  restricted: true,
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args } 
  = viem_Actions.policy.modifyBlacklist.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.modifyBlacklist.md","from":6462,"to":6791}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Address that was added/removed from blacklist */
  account: Address
  /** ID of the policy */
  policyId: bigint
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Whether the address is restricted */
  restricted: boolean
  /** Address that modified the blacklist */
  updater: Address
}
```

## Parameters

### address

* **Type:** `Address`

Target account address to add or remove from the blacklist.

### policyId

* **Type:** `bigint`

ID of the blacklist policy to modify.

### restricted

* **Type:** `boolean`

Whether the address should be restricted (`true`) or unrestricted (`false`).

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`policy.modifyBlacklist`](https://viem.sh/tempo/actions/policy.modifyBlacklist)

---

---
url: /tempo/actions/policy.modifyWhitelist.md
---
# `policy.modifyWhitelist`

Modifies the whitelist for a whitelist-type transfer policy. Requires policy admin role.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.modifyWhitelist.md","from":172,"to":5604}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"952192056f8028f108ce757f5c41d5167a39f17553d4a449338c09baaef8c103","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinKQwvDCMWGipACpDwsOCYABKaxtbpeVSiAAc/bXKqhotOnp4q+ubDPIWVgDMA0czlGNwm1C8018c2oASYrHYXCMR1MV300lkD3qz2orTeBiRJi6vyQAJA9iBIyQACZGmDMFMDDM/DCFgZ8gjOGxzLwMJdtPpetYagpHg1mjjXoEuYweUSeohSeShsCSZU6RDGVDSjRWSAEgBXMD8I6cZjQRgJDAAdXwjBo5jEAGUMEaADwZRLJAB8QQ6yVSHqyFE5jmYejIcFSBOEADppTyY2aoBbrbb7YwnS7eDGAAqh8OkODu4pKL0RVI50gQZgZmCu4C5ThNzkQbkYACSUFSACNkhY0ABuRvN/VYKDiEapAAG1loABJgGJSBYlK4p0OwM3OE4YobtpwZ/PF2hl8o1xut6E5BAAO4wLucbsQVswcRgC/Nj7nfd7N9wQ5CKcnxbBurherkYDiGGcBYE4MCmualo2naMAOmgzpGqUUAQLwCAGAAsohjDwNuLZtpwN5pqhGZoDGuS5AAchANC7LacCcBmpFwFm+BVpA+rsQBm6qBOFHiHa7EJOwnCqPBJ5/kJMkQLk3bwRYvByPqsBQJwQikd2168AA1o+MBSasKx6PqpB5MopGrDBJgwDG2riEoeHIMgIB0FBWAKKUU6BWgcC5OyhTANEqwTjAgbJMG+BoGgWCcK4nAJFWzCcAA5AAAjebk1gA9DEqxZaF8LhTJMDwilaUZdleUFYwxXsDAxUOBYcBlXkFVcBF0bsal6XVg1+VKEVJVtTQ8LdbkSxxCWnAALyRa+NCxUoQQNpu0QdcIqTINNbA7PAaCWGgAC6FDDvJwgFMFqTbVuh3VWwMaMFAF2pAlSVBBE107e4uSuBE9FGrEllwPqchcCt4j5XaPDGiYcatjKGCJohqYoWhGG8L6JbBk9ZHo52qRUmAANNuIUBQA5kbZbOMbM1lVPbnI153g+J76jAAMg7kgVTiAV1ebBQzMKUfpKJwAC06Qli5osgOLUGlKrYYjOx8t5hLBZwErFBeasaDWcIpQ7Pgcn7P+yObl+XzbmAOkwCQYBcOOEhK1dZT8n0vSVPIdRPIgvQYtobR4EmKbIemmaYT88qKoMwwuIglS9OqDI+LM2qwgYIRhJERTCAtnopAr5flfdJedKIfuh38geYiH4oR3iZIlnK/yAsqlJNJnHjgtnTLQjqgRBFgVY4BwGBRDTdPwAz2QgLO6iVFSUB/AArGkvCNI0TdpNY29/FS0hUtv4h/N2NyVJUABCvDSDA6jb9I28JNY3YAKLdt2K8+QVD6JUcUIosSIBqO3QIC96bdyQM3JUqdRhUizt4UeeddST2nmQTA88Oa3nvKkHmuB67AMQFSawpJwEhygbiGBBCubwMQNvXuyDqRoMhLneYE8p4QBnngkmPIyaPj7O7IB1wqSUKDqKJANwXiRwMPGDsUBmHiiQSqChnDNTcJZIESC0FYLrBLnAF8uQiCSBMS+AMJgXxYRwnhEAlt4JTiWC+KcCEoDQ3gnwogH0SLiE4HAfIChOCwG7PqJQSgVxWNCSJLgnFgk1jkJYtAEAZJW1yAAKXEBYx0vBlxbFifBMM5I8hwEyr4/xOluwYAojAbsj4qw3jgBGOiYBcjOM8d4zgdB7rsTQDedJME1gWhlEUeElh3aRjBgAKh4AeD0piFAeI0uEdiN47T4FNHoQgUB2JQ3sNudirjbEKBjNeTaEQpzBlOcIF8MYyBVlIH9Dxb4dJ3OWc5fKNlXkZNErwN8plOACXvEpCiy4aDgrfHUpisAYwACsDknlfMwdp8zuCcCUNebsoQDxuJWRxUub5jHS2smCtJEKULguQFOPh6w4AGzENhfUaApwXSCD9LAkZCqFUgLAJFMZ2BKEKthXChUUk0DELLIgVJKgxloIVcQWBmr0qXjGBKzA5AAGI1WMuZRAVl89na5FpXqplaBYCkFIOyzliVuWIF5fymAgrhWiocRK6K0rZXysVcq1VVYGUG01Tq81zKnkRBjJwLp2KIC4rkPis5MBVlAtUiC1pOlNmqENQk3qMTZIHmdYgAlybunnLBgAfVmbMq0khbJKGrRW1i8FY3xuKbpbsCK1hoCyuxTWezBIWUsFssgJiaKKDQHIDAuRuJGl4kIQ17FzBGTklbJpt5WmkB4DmdsAyrZ1IctVAyfNOCQC3ZIVdMA6lLHHe7KduRwg8T4ouzgy74JXl0rJLdcLnJIqCSiqCBtOCOhgJezgtLIBQr0uazg7ZCoAHlbVcp5Xy6ALqDZurFXAT1Uq0AyrlQqpVKrCrmo1WgLV2rxCy0gzAWWQhZbmtloIKI5lchmgshYcyzAJxHHabkH+tBfKhIEvmtdra8WfPcYgMGQskVzSTRciAm0spWwIRRdgcgoBZQiBuXlnBKz9gZqp686nSCaeDJSg1rL5P3POZcoIKnUImYAKRdWDFlIZZmtM6dyHpgz0zvpOfSZ58z4KrNoBs18x51r2BBEsDeTgP8YsvKyjaZ83LgymP7TE3FOkHBYBwJYbzPmwB+dPMFXpyWdmMrcu+52/6nAmXksYyzlqnnSdK4VZsSXnmpDS/wuAmXqy7JyzTTg+XCv3l811y8XBkCu1CF9beodt7Ta3NuLg+TCm0VIIadsYBLYZg9OPTgcW0OICIMwRuVJQ43FBp19bol4Odu7TGXbYB9uHbgMdgIp2i2XYVNYaQCo7trdm6e87/YyCQTkCRwNS9Cp0DWKyo4kD1Ch2kGD5sol5sWLkBdWWN4hgFbIE0ChVIsfUy4AtuQW3HZndgIgKHNlQhw5wgjpHvAUdCEgY0Jo1h7t6fB0W5nMPCrcYsIjvHFalwrgoX8BUYN5qnqgvBFaqXGAc04McONnUhBZQ3CWmMPywBBCnAAETfLoLdC4DEwFcAAQk4Jb5QZAHdThK2VwzqQXfW84FaTXCade9nuWAJ3vu3cWeGW161gtApgwE0J+CIm7IFqnEs9x0QUmMo63Hqccnwal10qy5aWK9COgA8wR0w3CA3j+obiGTzS9tAr1FKvNfbz18i1wZgGAM+hJWvF4pMZ+8wCCDm4MEaNxsb7wp+zjm1Mhe87prr/mHrjaC6Z0LlKc0z9H4p5Txn0mudZtlJf2mV/6fK0ZzfS+o/F4i2AXv++nmxaHz12LqXCADaG9luyuXxtlVJtitL818GZkAP9SA+tv8MsglhtVBRs8sgDFB7wrpwUnklcIY7dS8Nctdg89cwADc98FMTczcI8bdgA7dHdncrc3cPdQDr8fdaCt0A88DddQ9w9mCHd78MCwAhZXJ3IkBPIyhQNShkBTFrJ1gOVkNHVCpolVB9RuwYwYhmBUMBVsNnVCoDI41CofVCNzBuwWpbNf1IgRYfZURqQ/h5EW4Gg6FJRFgk1mEMQNF+5rBtEc5mRx48Agh+1oAoh997NoJ/xdAAB+VIGFYMZmIVLYI4UIXWQDcIsADAZAC6csTgIgCAD6U7AAal6F0lmGvBpgiHsVwjwDAPBSnHCw8SzW2Xi26Gck4HwmhgED8nfR0H1DDGmWiFTR8XWXvGDBqIyRgFyCSELC4FBR0nCCGM5GXG41IDqSCNqydkmK1wXjtFiITQmOOSCUULEDtG5w6TADx15gORYE11SXSTNXKwSCCD+GuWkPtVkO4zAHUCFR0AlQsH1EVWeIY1q2w2eL+Dh37ASBjD+DIy1XuyCALVaA6InUHXfS11gkZQpUuKnBRzkBjC4wnFeQeKShQ2dVdXeKwxw1Onw19SI2anRPBJ1XRKxLQDpNllaEiEjRk0CgL2V13HdlL23gb2MIPwc05P3Gcy02DEFM91X0YKKD3FSFYTC0tV30Lyi3n0FMQFPzFIYO9ylPdhlPv3CzzzBhA3glpSpLpJxLtTxNkIJIwyJI9UlVJL0L9WIypJDW1VpPYG43pPdInEZJ0GLnMgQg40SC9OMDABchaEEJQC8mCSNFIRACIGsBjF6ETOsGsDMLIUkVARkQgVJGgTwEuScLYU0VBCHnpHQS1B4QcKLwdi2F2BtiEiAm/AkX0CpHUHuBoVsIUQ7mrO+DMGJDGELP7j+D+HcIwQrILj4QETnhkjrLtgAAlwh8BpxZwFxZczxhYqAsM8B5y4BtkIAEgMlOJbpbYQymzqR1AMR2y+hWEJRFFqAZyQzty1BE4rBnCU5NEM53CJAlBSg7c8ylNTyKFpAwFg4GhbA9E8BfwDg7ZACdzUhZxegqQm5t5Gh1AbhpBrBxBuxeBYAEgEKkKUK0KMKsKcK8LKhkLUL0LMLsKzJSLyLCKqKcLmFeh7gXC043CfYYhYA4Qa5+o7ZBo6oRoPMmpCojoIBuowo+pa5khaphpMosoYwjCshZpFTJLuzao4YEZEQ+LUY2xMZkwkIqJcYswCZy4iZhxYEl5Ugso14N4t5d595D5Khj5T5z5L5r5b574n4X434P4v5f5/5WZzLGEiFpzeY2ZlERFehKZgZ7tIsHl59ILjyTQHBYLT9uyYwjyhJHz7tShNZxAkBQAAhFBgkhA8BgoQBXBXAgA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const { receipt } = await Actions.policy.modifyWhitelistSync(config, {
  address: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  allowed: true,
  policyId: 1n,
})

console.log('Transaction hash:', receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `policy.modifyWhitelist` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.modifyWhitelist.md","from":5956,"to":6409}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.policy.modifyWhitelist(config, {
  address: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  allowed: true,
  policyId: 1n,
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args } 
  = viem_Actions.policy.modifyWhitelist.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.modifyWhitelist.md","from":6436,"to":6759}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Address that was added/removed from whitelist */
  account: Address
  /** Whether the address is allowed */
  allowed: boolean
  /** ID of the policy */
  policyId: bigint
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Address that modified the whitelist */
  updater: Address
}
```

## Parameters

### address

* **Type:** `Address`

Target account address to add or remove from the whitelist.

### allowed

* **Type:** `boolean`

Whether the address should be allowed (`true`) or disallowed (`false`).

### policyId

* **Type:** `bigint`

ID of the whitelist policy to modify.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`policy.modifyWhitelist`](https://viem.sh/tempo/actions/policy.modifyWhitelist)

---

---
url: /tempo/actions/policy.setAdmin.md
---
# `policy.setAdmin`

Sets the admin for a transfer policy. Requires current policy admin role.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.setAdmin.md","from":150,"to":5432}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"983f569302010026098cc5bbf73d68463318d1076985854dbfdfd589c471fed0","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinKQwvDCMWGipACpDwsOCYABKaxtbpeVSiAAc/bXKqhotOnp4q+ubDPIWVgDMA0czlGNwm1C8018c2oASYrHYXCMR1MV300lkD3qz2orTeBiRJi6vyQAJA9iBIyQACZGmDMFMDDM/DCFgZ8gjOGxzLwMJdtPpetYagpHg1mjjXoEuYweUSeohSeShsCSZU6RDGVDSjRWSAEgBXMD8I6cOB6bhQZgWADKGCNAB4MolkgA+IIdZKpJ1ZCicxzMPRkOCpAnCAB00p5YbNaAtVrAtqNYYACv7A6Q4I7ikoXRFUsnSBArWb7cBcpwK5yINyMABJKCpABGyQsaAA3OXK/qsFBxCNUgADay0AAkwDEpAsSlcA47YErnHElosg+HY4nU5nc4XH3O204e3EB2NQlOny2c9cLtyYHEAbgWCcMFN5uXCbtvFKUAgvAQBmtehwJwqjPku8acAk7CLlWNZhrkuQAHIQDQuz4IwQHodBcAfvghaQPqQGHEIwEOFwADu4iMGgQGQaQJHPmg+xwER85oBAuSNs+Fi8HI+qwFAnDEeInCNnIP4ANYiTAtHPqsaD6qQeTKNBqwPiYMBhtq4hKH+yDICAdB3lgCilAOZnUbk7KFMA0SrH2MDeskvr4GgaBYJwrgQYWzCcAA5AAAhRShWgA9DEqy+ZZ8LWcBMDwh5XlFn5gXaaF4UwGFDgWHAkV5NFXA2aGQGeQk3nJUFaXsBlNDwrluRLHE2acAAvLZMD2Y5ShBGW87RFlwipMgNVsDs8BoJYaAALoUJ2jFHmpHDBpwPULkNcVsGGjBQJNqQuW5QQRDNvXuLkrgRPBRqxCs8D6nIXCteIFFUTwJ7hpGGDRq+8aJrw7rZr6K0wTKdYNpwVJgEdFZgSufnDmG8O+UdZ25GZA4gNN+mPkMzClB6SicAAtOk2aaRjIBY3epQUwGIxAUTqbY+mcCkxQ+lyQpwilDs+AMUxLHXeeXBHgJMAkGAXC9hIpPTWU/J9L0lTyHUTyIL0VIvG0eAxnGNofnK/yAsqlKIJUvTqgyPizNqsIGCEYSREUwiNc6KTEy7UUFM7nSiHLqtUsKytihreJktm+skobwwuIgACsaoeOCFtMtCOqBEEWCFjgHAYFE0NgKk2QgMO6iVFSUB/DHaS8I0jR/JUaTWDHfxUtIVIx+IfyNjclSVAAQrw0gwOoMfSDHCTWI2ACijaNoXfIVH0fwYiKWKx8HgR5+HJuRyqiBUub3jJ9burp5nZCYFE731k2Lbi/P1y9NIiuYirNzr3gV9QFvMc78b+8J/SQ+Wp5iBFvPeR86xHZwGrDAXIRBJBQJgV6EwMCvw/j/CAbmz4BxLBgQOTgzBoC3WfBnYgW14BYXyAoTgsBGz6iUEoKciDqGqD7JwTCcAWCMDkAgti9FcgAClxDwOtLwScWxmHPgDOSPIcAfKkKIOQgSjYMCcDIjARsIlCxkTNBmOCYBchYIIUQ6hdBPZATQGRCApocC8EYEkXgRR4SWHFsGC6AAqHgnABxOmgQofBPFwhATIlRfABC9CECgEBOA+p7CLiAjglBCgwxiS6hEAcvpEnCBgWGMghZSAHXwcLbxuDkkUUUoUkibDeBHikpwAiMABJ8LIpOGgwFrFHlUUhWAYYABW0TGLtWYPozx3BOBKDEo2UIJSkkwHwdlCQRpnx4wUo09pajWkMWscgAcpD1hwGZmIb8+o0ADkmkEPaWBgwhRCpAWA/SwzsCUCFb8v4Qo8JoGIAmRAqSVDDLQEK4gsCMBCns+AzMXLMDkAAYjBQco5EATm5zAFAXIOy4WHLQLAUgpAzkXNclcxANy7kwAeU8l56D3n2S+T8v5AKgUgoxWGSFMKMVHLyREMMB4ebjMmdMrJfi5nRFqZxepZoBIhNUIirgVkBDKRAt4kliBSlCsIVAYh+jcgAH13HuIAOqSCUkoXVWrULPgmRAKZchJGCUbL0tYaBfJARppEwiqxOCWFCWQKB6EaDizkBgXI2EjS4SEIioC5hxIMR5Y2bRuieDJlrBYnmqjVJxVEjAX0kA6KSGjTAVRSxfWKDQAG3I4QcJ4XDZwSNoE5DWuQjzOi3SNL9NNIMu8zNOAATzZwHZkA2nEQxZwWsIUADyeLLnXNudAUlzNyWvLgFSz5aBvm/P+YC4FoLCz7IhWgKF0LxAE37TAAmQgCYYoJoIKItFciEPdRYWizA+xHE1WASetAjLUIIkwhVFqrUzOyf4xAF1Ub9PqrMlJEAuq+R5nW6xVjSByCgL5CIc4bmcALK2JasGxJqPYEh30fCEUnPA4BjSqSggwZgHBzgABSHKvpfIIaQyhtDIUMOTlcbtajuHmNQEI9Y4jaBSOCtyTi9gQRLBkU4JPcTBTfJ6sIBAK5vpoEuqYVMgSDgsA4EsMhiIqHcjocw64zgeSoL3mYroRcKK21OEknNSBRGsV5OA2AdDFZZP5NSIpiAym4CqaLBEjTS5ODad040oz7GFxsOQKLUIO0Y6qxjlFhci4uCiPEWgMMpBDS1jANzdCTpU6cEkzOxARBmCq2bqrG4513PRcrGw0ddqHU5bywVtCcBisBFK0qyrCprDSAVHV1LMWuBKtbGQW8cgt0/nBSFOgawTlHEQOodQqtpBjaa1wOL8C5CTQJi0oFWcmh7ypNtqGXB4tyEy18Pr5WpuKVCHNndi3aDLeMPndQjQmjWHqx5nbHrHvi2my9p9FhFv7a1RuZQe8/gKgug1D1d5nytQU9w61xxLXZSEL5OcKqwzlLAEEAcAARI8ug6JjjATAVwABCTgFPlBkHpwOQzDWONYdSMzqnnA9WY84Nj5s2SwCM956zgTbbsWkBRmZC677P3Pm/fKnlPjZkBJ4QctzcuBxgcuk7QSJyWrjL0NadtzBrRBcIGRA6BOrp5JN20c3dlLfW4gLbjnyPmAYF8TAk3UnJFhj9woII0rfQcrnLe33EGKNUZo3x1jqWTPUW4wn/D/H1nSujyH8jUHKM4esfRxGflE8c+M5x1PYWePwYz1L7PYAfe57E/kyTMBpNeYkwppTKnTRBdUCFrTJ3FCNJQ+X9jKelrIE76QHzPeAt9/U8pTTYXh96emusvJSOrq05NxjutQucei/xzniDxPScS+p8AWnDOmeU9Z+ztjXOuN35Z3RAXB/he47F6/qn9Opdb5gCoxaQ6RIB6RlAwC4BUDIDQIKTrDnKTpEohSMKqD6iNhhgxDMDTr3KLokohSiSWohS0rrrmCNhhQQb9IRDowyyojUhqxKyijYjaCawGAqpbxvxkiDBRyjDWAHyQhWwgJ4BBAurQBRDN4UaWbaQwAAD8qQnSvo8MjyWwRwoQDMHachYAGAyAk0eYnARAEAW0pWAA1L0IJLMGJEuFQVQAungJPusgOEJvgpKmElJt0BpJwAALK3QCDGSgQ6D6gBimY1LziiqPgHKNK+jOH8LOgZhcANICThD0SciThPqkCqKSHWbFKhDWpLhQBUQqHWrxHxKmhoFiBUQrZCBwKhD6gUKcJWg8J0R8LoqV4JBBB/DpIIEEpIFPpgDqCPI6DvIWD6gAo9HnpSGLo9F/BbqtgJBhh/DMp7pyD1ZBAKqtABHFpuq1rWphHirrI7IrZyBhiPp9iFKdFuRTokpkoDELpLpjSrp0obogoHELH7oHHHFoDvEEytCRCcogZmT67I4xCGj3ScAxz25kaQbQZAniypC0bIa+jQloDj7P5V6ImpA/zrJCYiY5Jx5okl6InImT6pBomglS5YlAHy4GIJiQG9oDjPHvGnH4rnFIGXFzrXGUofJ3HEH0qbrPEsrQpvHsBPofFCl9hfE6AOy0TGL3qJCilfaaQtCgEoD6ScJLKlBEDWBhi9BanWDWDUE+wLzna2AvwNCkjMEhypLsG/zRyggAIaiWzMipyLBXS7hfC7B8yvRnh7j3z6C/I/wmlMG4iBCukXA/DygcFKjcEkh/B8GagCEshpykJZwXzAQelfYAAS4Q+Aq4o444jEm4aM1h6CeAmZcAYSEACQJEmEc0x4X2Pp1ITcDBq8vQ/p5pgQNZzEr0pZagYZVgEZXBu8pssZOISgpQtOeAlpBp1w/sxpK8KsxpTpBgh4tZJoDgZZqQw4asdcMcjQ6gNw0g1g4gjYvAsACQW5lQO5e5B5R5J50k55l5+5h5x5p595u5j5N5p5W8go1pPBrgMsMQsAcInsy0L0X2xUiUPkTGqUIKw0EAuUsqIFeMCUpUSUvkYY5BLsdUBuywNkIZXAnkD0T0iIr0zM70n0sYb4P0f0LsAMnYecqQvkxcpc5clc1ctc9cjczcrc7cnc3cfcA8Q8I8Y8E808jYiMnYn8qQvQEMp09W2JyScey5nZX2q+65JeeFYYHZLE3Z9WpQNM4gSAoAAQignCQgeA1EIArgrgQAA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const { receipt } = await Actions.policy.setAdminSync(config, {
  admin: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  policyId: 1n,
})

console.log('Transaction hash:', receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `policy.setAdmin` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.setAdmin.md","from":5777,"to":6197}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.policy.setAdmin(config, {
  admin: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  policyId: 1n,
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args } 
  = viem_Actions.policy.setAdmin.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.setAdmin.md","from":6224,"to":6460}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Address of the new admin */
  admin: Address
  /** ID of the policy */
  policyId: bigint
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Address that updated the admin */
  updater: Address
}
```

## Parameters

### admin

* **Type:** `Address`

Address to set as the new policy admin.

### policyId

* **Type:** `bigint`

ID of the policy to update.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`policy.setAdmin`](https://viem.sh/tempo/actions/policy.setAdmin)

---

---
url: /tempo/hooks/policy.useCreate.md
---
# `policy.useCreate`

Creates a new transfer policy for token access control. [Learn more about transfer policies](https://docs.tempo.xyz/protocol/tip403/overview)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/policy.useCreate.md","from":218,"to":6466}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"e13be9674f34cecb6d1efe8ccab1940abeb9e94a06d019450df7b8523742032d","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6INYQYCKc1qQwojQAyhhg1og8fIIAdGwm1hhpAK5wMADCUTEw8YlpAEo6uaRgACpeADyFoQBmjAoUnLlg/JAA7mAAfP4i4roALADMsvJKKogAjFbU4tpBkdFxCdb+JmZIAEw2dqQOTkgAbO6eOHiEJOQagUys7FwGgmOauqpXc0UyjUGnWOjwXyMB3MJ2CZwufmWbg81C8D18zwC9DebA4nEyjGyPwm11hciBiwBay04L0BKJslMMNO9kciKOqluqPuekefhe2L0bV6jkYoR6BWK2zKuxa7U63V6/QgQ2GAAosPZmDoyHAAPzJSEZCBZHL5IolHYVAAKWp1pDgcrAHS6PT6gxGAEpDak4MbTXlJZaZRVqmhag1mq1nQq3crVQAdMBgUTauCa6wwCUW6XlPZUKAQawIPRfThtdgRS2mBScUScMwDfEmwk5JNJgByEBoyXq+EYcE4A7rnDgu3wpFCEHynEIAk4yhinAGokYaEHFdIC/wWbQ5zCFzFYCTaAgnAARlnTNYZLlYFBOOL6+eZEX+BeYJus1Fw3UayOonTUICjSfwxAUEtkGQEA6FTLA5H8AADZD11oJMWFxLhgBSQxOFcctJ2YTgAHIVwUZhGAAehod5iPbZ0RTQI9OAAQSwLA1U9ThgCTTgImArDOGYXIxBoboB2teQoH/fCAF4cPSekzSDXNdk4+i+J/CNODVXi+M4JpzxE09jzAfT9NCQosn4WTgE4zhZOGISRNKNVsMwHBklI/saBMERiLwz1XD08zpLgUQXxgKBbIkqSa2Csz9OGEL9KlUpOGtFtshSppKKMtATOSxLPSTBLkMQkAAF0KGgzVzmYfw6tTe1BwAWgyu0nD9KqapALS6iMABZFymPFQDchkNBQMq6qQHGCRECuaRjHmYFllmakNjwc00qtfNjCZY4WXONlnGmI4uQ87w+UxGhBWCASq1UxIfUMf1W0DHNSjzKoajqRocCdF1FXdFURmJBaliuAB2QEFiQFZQRpTZgzzfZDsQdQ4VZS5LEutFeQxMDXj0DVJxwDgMC44TRJgZI1SIcRGAiuQ4GSLZvt2NJbXqlqgc6YZuggLBRrCA1OGG2mAHkRaPR0eMSvilIASSgZJz06Uw0AAbhS3IsCgUpSGSRCLFoAASYARFIeLEN1xXm1NAG6YbXJmEvUh7fMqJM0YEXe33cLRVCapfZF+33E4AAhUQCgAUVISdSGd7oOb27nOt1fmFEFuMPScgAfN1YA6MwoC4xzOCICBGCgfxC2LPA+yzGmYmY4VElFzgMGnCJRDM6xRBkGRlzXfAq6Zln4AXM8906bQt2UFuRuY/uH2F0Wh5kDBZ19R8zNEKBpM3kfB+H88HHfDe5dA0EIKQKCQCahqqEZm2p7azhm4n9/IsHCBzwACsYCOBnviWOg5TzbizIhVuosABiYBELTV6s/fw19gJpFCLEXI1hMxwE/n2YcHdg5mQGIwYe5ZGBRGXDuMyS9nKiWYsOOAuD8FwGFCPNeo9KGXnAQQqK0DGFt1CMRQc41JooNqlqdBstMGhATknTg7UiEbkYsxchlCOg0MYG0IRcDmLyBCL0LqdYzJkCUdwzRI8+GagEQ+BhFj2BSKfjIqgGCwhYLALEHQaA5APhUf2NRncNEUJHtorMAw6H6JXuKYcMAx5kFHGw+AHCJrb3LDoWwgjKxGOnGAUx/dOBOK3Nw2xEDBEJKXovHcnBDZiEfFuEpLiojMHEN8Kg7VlZ6J7rkISoh+DL0mn7OQnAogAEdcjwHXN0RC2CUkEMQjw8J1CsyhAyaINoTghEyFKOEM+I9enERIP02AaQkztRYpQhhByL7WHfCQ0Wg41RzO8QsuAiFZkKMTuwT5nBXk+IKv4xCXFxBZmrrXcs6jgLdG4Qw/qZcJ63kiWEj8Q4FCQCiFAaas15q6CWNDAAHHDNaVJNBbT0HA3AjJDiY2OgiZwSwlj4x5D4J4xN7pk2FmQTAoKj6AQKGzHSCYQBm2hpMI4UBpiqEKNYK4VxpiTEKBYVQ51JAclENMc8hLJiTCjtYSQMBoaqEkKoNoFhzxx3POeEVnAi4irFRYSQkhoYuosIUVQSxCVLEldYaYLELArEKNDKAgbzyqAsDACwUACVQGsK6wohKRWemQJVCG+LCXLXJPDFwSMKUgEPlAAV8B0a0qpLYHG7IWXXSJgKIIXKKa8oXF4ZIIqolrhgH5NAIr01IGmE6klixJh5tpNyalB1aWI2xidXGF0URXXROyuteAUxpgzFmEIYQTQwCTG/fiW65DJGjHAbd9ciwlhAN/RCm6T1yCWcwaAE0sxYEnEQWu096xwAwqM2ARkFAKH/De7d24lwsJYBQ8QYCl5JgAFKiEZrESIfsuBAdGdqCtYABxERfcQd9D5zw7wGDAc8F5JwDAKA6c5plv4PqgE+4ptBMKQIGGedMIDdGEn4u8MwBS2b0QAFSsX+ce7dSybwQNHsoISOhCBQEHKw2wdZBzXuAtutIr4FCcT+Spg9MA0glK02Yh8Onb16ZXHUQzi4UNFL4eaBxZ4Bg2xoGA/uO8uxnMAfJvc0RmBUcEyxTgChXwXxHiZ0TQ4whiESBu+UChaiCKgY5jtYDkCIRw+wtIIhCwiUQpVNU+ACpYDZpRSikBYCeawVoSiDc4CUV2TQEQrUiBHEmGkWglFRBYCoul1JaQCvMBkAAYh6wQrL040CgrAFAJMqWRt+iyxY3L+XCvFdK9AGAFX2AKGq+eurey0BNZa21jrXXKJzb62gAbw3JzsIW4nT0aQv61KCwAoe/zUMwDEzZrMdnJOEBEkOd4HB/wMMQmVumH372PrkFRpMAB9fj/GADq4hMOKER3D3sz3gtvY+4+IBIC0BiOk8oaAg4wUNiqTuLcN6Bw0AKdvJMY5EgTinDOEwgyhHnjIxR1i1plaQJ3DvQCMB3ZyG6JiusNCl471pyIeQfiMBJljuOSckB2eME51vR81TODub0550c3nUx+k4D43ctTUuQGc+KObnBlaUSlktgraAiuIBK+DzbVWat7Yawd5rrX2ude6zd3r/WhuiFatbmArVQitTm61MUXFNxJgfTo507A2mi1h2AOOtA4KjPyCD7Hr3QuQ8QPRcqnmkwffUxATTxEdzDwc+wGQUBiKentiVjKNtePJCb6+ZcreoDdCgWNkSNfVMw402qRvnbB8AFI4DEW6KRYfHeu+UR71rIVA+W+kDb6P1jaBsvdsSFPvTBnGycEUewWfSO5xFe6Ce7Uyh/wXwfHYdi8good870mbva0XvdcYpH5LcNMcKbQIzI3S+BcE6XcY/WAROCvMAbvPiW/Y2TgB/PgJ/UcCAV/fsRQC8Q+WcTrHAMuAArfcyJcZAGARmGQSqTGZYVQSg8yOsLgRDG2EWNIUgXoZWBoIJaMO6LgNUcHRAIgZgdaI4ZYQlEqVAqg/SJcKWAnRwHgvggQgcIQwIHSMQiQxAftSQfQ2Q1g6grgMQrWMgFMGQM7UPAhSiOgEBESI8RAaGaGJEEwxQrgWg+gyqVqRzMgsgRaRAI4I4DwviJcOgoeTg5DHQ9bRACwuoIeGwosVJew2gRw0WFwq4RaCwOQtAzwhsOIhIqwyiNpUwew+guHa2GsYI6YfQ+iG9Mw5qByEiJHVFSoABUwE9MAYie2WvczMAF5AAEX7gXk4EtlXRgFcAAEJOARjFAyBpiQVN9t8+85jRikk2jKEOiNYt0wBZj5iF5pij8jckDSAkxyp6I88C8fsv0iDQcRM70IhdkCEUCLjkJq9z9ItHwAd5INhYhjdmBYh8CYBCABhOI+jHoLEWj/jATgTtQwSITJ9vjmAMBHisx5Jr9a90S1RxtugLF/9TJUT0S68G898h8D929CTADgDd95999D8wFxtU80SL9STZ9ySl8V8SIWNKSN9WCgCd9+96SKTGSoFmSwBiS2Sr8YAmwMD79H84Bn8QS38iCP9SDv8y4/8VjBS1jkAMDkhsDhYlS8CCD38SCv9yCopqowELEGjHpJiWjiItiR4diujRF7YpTdM0gBjhiNitwJjmoZj1iFjSAljqSt9dT1xkhDjNj2jOi9iDj/TjjbTE53iKo75IJoIChx1kAT1ahMw8sXc3cSsANlBchzw0gQhmA1tytatwc8pgtKIA9jsTBzxKJa9PNPQqpcVfg+1zpB0kBYZNpR0PtS1zAlgNoK0Z1EQLBq1F1+QsR60CDoAuISSZ8IDRBtBxZXNug0h9yPEh4eYTdkhXNU1vQq4a4Hw1QABqJYR8J4V8Q+bsgsc9PAKMyBM8RCcfNAJZchKTRsaER7YaYZeCLMdYN2BXQcQeMycpexbof88eaDGMB0LgX7WOIRF9FgcQHeTcqA7hbXQtNcI8N7dC+TCskQNcJw0IXdIeKZeTcDXZReM8WbYAtoNUaYT0Z3Qrd3Uo/uaGSrbbA4XIdrNpMAePLc+APisAaYGwrWNoNIaYC7AbOQtUBhCC7UXjKXcCyhOxAoezTgVLJwmQNITcLPLTIslbXiz3P0LbHbYsX3aZQ7QPE7KiYy5SobYysymIbyg7dYOAT0B7SvD4uAZE/ZfJLgeSVQSE70mfYiYxApZIBfdvVOCKiM1Y6M/iExZIdQMBH8sKtTOKhKtARAbk4q9Kj89mCKnKk4/KpBZCeic3QyxCdy3yiy5bV3VbGywS+y2rerJylsoPU7dy8PQbLyzPHyiavyrQAK8sSsNPK8DPUgLPI8W+NYe+FAbM68cdIgCwNIJYfaiwCwHs4QPs/QyYVYbNNaDaclUdDTcchGKc+EU6JAQlecwmJdJcvARop6TmF6BSP0JST6XaEMawX6X8SMQGaMYGPOMGUYU6kkfQ1QYlFaCkBGVYW6lGZ6faaER6+lF64Im4edAmNlRc4QvABtHlKmOpGIUQZIBWcyFWNWC8TWApL2fSfWepQI/5M2S2aoxQVwO2FKJSZ2ZIMAN2D2dmzSEBBJf2L+QOQ8EOGW5DCOO1YuT8JkOuV8xuPQb+F4rgBTdhThDJQCE0EgB8epesTcGJJhUIHPJMPW2OA295Y24XeAM2wRS2uampZeW2sAe2gQrMfW5JPBVJV2sZd2mQc2mmhpa2hhAxO2+iB22pYOw2sO9JN229aOr2uO2pBO/23tfQpaQcxAYdEcoIS2h69afG3GaYaGd60m26EmEASmymLiJm9WVmrgIuXoEuTWwuuurGK6xYFGzGvAJmquycmuxEGYBu8CfwSYvAe6hGhaaYQlIe1aRYDG5uzKU0e3IY5IJYMASerGachlJAOc2aEIWAHED4biAGvCAifAnkrciiaiUXNgOiUyH6tOUGloo0IGnaVGNSOQ1gwobXWBEaT7CLCOoCMIBA7MUpUhHSPTBQR7fKEyZ4wkfgboMy5Jc8CiAhI8OQ3+n6KlNyPSQtYtIVZAFKYiMVCVKVGVOVBVJVFVNVDVLVHVPVA1I1E1M1C1K1c8FfOhx1Z1V1aGd1T1b1X1f1QNd1ENMNCNKNGNENeNSQRNERxKaqPSK6LydtXyOnLR1wUBr40zdk4iXe1sfe0q1OYBioS2vUd6bIVWOQ/wV/UQJAUAQIeQL9UIPAdcEAVwVwIAA="}
import { Hooks } from 'wagmi/tempo'

const createSync = Hooks.policy.useCreateSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
createSync.mutate({
  addresses: [
    '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
    '0x70997970C51812dc3A010C7d01b50e0d17dc79C8',
  ],
  type: 'whitelist',
})

console.log('Policy ID:', createSync.data?.policyId)
// @log: Policy ID: 1n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `policy.create` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/policy.useCreate.md","from":6807,"to":7397}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const create = Hooks.policy.useCreate()
const { data: receipt } = useWaitForTransactionReceipt({ hash: create.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
create.mutate({
  addresses: [
    '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
    '0x70997970C51812dc3A010C7d01b50e0d17dc79C8',
  ],
  type: 'whitelist',
})

if (receipt) {
  const { args: { policyId } } 
    = Actions.policy.create.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `policy.create` Return Type](/tempo/actions/policy.create#return-type)

### mutate/mutateAsync

See [Wagmi Action `policy.create` Parameters](/tempo/actions/policy.create#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`policy.create`](/tempo/actions/policy.create)

---

---
url: /tempo/hooks/policy.useData.md
---
# `policy.useData`

Gets the data for a transfer policy, including its type and admin address.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/policy.useData.md","from":149,"to":7194}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"a27f67c0f419f67e0995e3865a87b2d08d15ce406ed36312f2acb9580f1cc1e3","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUWKQQOBwYAJScUKJiiJzAADpgnBmcolDMpkkAglBQpPBwANxpmZyYOEkAChAm1hgAKl4VYK6cAD6cAK5gsABmpjBQ/lAQ1gh6LfgwnDKiIpxwfdbWpUN9MjIYnCVwjSRQcQminEPs1fOcAI59ZBgAdGlvYHMLSytrG1s7ewO8GOYzOYku12UCweT1eYHen0Wyy4v02cDg212+0OINO8XBV1IN2hj1IL3eaUR3xR6zRGIB2OBMhOYIuhOJ91J5PhPKpyNWtP+WKBR2ZoPxbMhtxhZOe/hE4l0ABZ1MZ5EoVIglRpxNoghL/CYzEgAEw2OykBxOJAADncnhweEIJHIGkCeGsEDAKzYTQwABFzklUulMtlcmACkVDuVKpkajB6o1GM02jgOl1egNhqNxlRJtM8HyfoL0ZjATixXjzhCiVDObD5ZpdKoAIyydXKJCtqzUXU6PC+lMB86G0am832Rx+RCtpX26heJ2+V0BehMVjsLgGQRNxVIABsB47ii7iFVmj1eB3RiN5jNIFsU+tiBNbg8i8demdfjd670LBsBwnBDs0e4SIgADsD5yKemrHn2WgDnooEYGOxqvpOlrTs4ADMqgLgmy4uv4ND/iA2xgI4jBev0cAwIGYgADwAMJeiMCgUMkcYZOGeScIUxSlB0VQJkmfppjAGYAHyhPYzA6GQcAAPxJDezyoc8fT0YxojPHU8mKaQcCsexjCcdxoa8Tk/GCTGInxl44nDpJMnRGpfCCBpybNFpOnnM8ABKOh9KQYAAGqiDIjxMSGVR8ZGAnRsJPHVE5nANBJ7RpK40lpGAogKXAWAOAs2kMaO+ZTDM+iebWnB6mgpgKCBPn7BKco6goMzIMgIB0IVWByP4AAGY1oHAtBpIBW7JDwnlwJwXRDOEzCcAA5AA7qICi5AA9DQm7re8lHUbR+RYFgwSxHFnCet6XDAKyXGMHAAAyEDZM1S2cAAvPNhjeX6fkVWIwS3RkqEAJJQEkJpgBQcauNE7wZIwQycMEr0fV9iixCUaChekTFQIwRDSTjpOKM8NNMXtpPk3GBNE5wJNk9JhQRsGErKc8CWuHTDN5Z0aRjSNIAALoUH1JWWsw/iy4VRmLQAtBlhlOHAcpS31zNhUYACKXIijsXCbYwyitX6rLa1LIAKhBkHSGqcFIJBOpIUE5W6eh95YVaM5KiahFLt+K6ke6eihOEkSYLE0NQKpnAAEbmaYXBZoMMAjGYeYgAWNWZcOnBQ/6nX282Ujti7Gq2h7V4oW1MO+0guH+zhpoh1+PgkX+QQFUVJWbHdXqijAaREOII/eo0iacGxM/DVVhazLcI33WPI2cMw0A7AsYTEIwsCLRccCAXIcQwMnfQKAo30b7PNwJJwr2rCwjBLHWEDEmkABSoiTwAMrWFIIwLAXAH4XwUk+MAr01oHyIEfUEyd9ibSvincIm16LGThJSW4O8oB704HQICE1qibW/sVGA1h0YphHpuMwYAJqIHeAAKgEpwEaC9N53W+Itc2lsFLKGgItX4+AsiLXXqPWezwZAQAUNdEaXEpGLxgM8Mg4RSCKKyIMThkC1HbTCto5Qz9rCiHSMnMq9FThoG/ptUBNBqjf3MfsAActANRAArURaASiFThOw/IDU5HJyino6Rcgt6mAVFRBY90OKhVBLYzg9iLYLGScgEaB86TPBEJMPoaARoS2CPgNAaAsBwEQHtPakBYDeOeOwBQ9Nqp7SWDQEQKsiAmiVM8Wge1RBYEYHtbJpRnilOYDIAAxCM9EeSIAFNiOYqAaRMkzK1nkjRRSSllIqVUmpHj6mNOadMVpCR4BoE6d03p/TBnDPCDk8ZUy1kbNIKQaIzxOCIgUCEsJKieFmIsVY0EAjCAFJfpuDg316wjVqYmfRW8CF71wWAAA+qw1hAB1cQsDFDopRUkL5PyZDTzHpwCAydPHULQOtRaQjCBQBPiUTgZgLbzCJBvV6NAmF7DSHADAVF8DhEgNpRYjB+DpNuMnTB2CBJ1ChotKEjJ6LMGTnILikAiTiAlTAfYHKRDyDQDygqfKBVCvmYtEw4qsi7DJVCIk7jYDPG8asXxMBCpa04IAmA2rOCZMgI42iayS57QAPJbNKeUyp1TYWHK0McuApz2kXK6T0vpAyhlrLGWgCZkzRAq39TAFWXoVZrJVjRWIhI0g7yZaYQkzAEg0TAMigAorQQaF9tJQtuN88lvz4UsJ5GLbxaR9GyPkcEda8xdh2PYDIKA61ogdGqRlUBTDKmcCnXIlJs6oBcWSXMgpI6IlqLkQoydMBp2cAAKRwHWlxLaO6F1Lr2iu9O67N0ztIHOvdlC0D5LQEe1R6jXnsGCGYTanBm0ga0etDFhAIhwC4kcOl31QmnDsJdeQYwF2LrSMuuoq6yEaOuEVOAO0FhLJdQ4fg1RsLpN/bAV5A7l0ZCg5opIcG+AVKQxAFDigU7ZA3QMnAuc8MvvilwZAMBJ4yAlueWcqgxNVCyFwYBoDwHPFIAMKGHx8CvQXmRLgYGPGICIMwWcuETSzhtCjMALGwxcBDRSqlmntO6f016QzmNYWmfM7hCwkhEC4Rs0piTzKTPpzIAVGQdypilD2nQahBTG1QUgrOSQoWHO+uk1FCWKt7HCbIIgA8r4TSZd4lwHLMg1NgKMz5yLYUoqxbpAl2gSWmpeigiVg8FhbP2Yq+F2AiAGvRb2vW0wCWZMopEKuhQr5cJBfeBvLgA8Fj/Vgx/YlgVyXRK9OtDoo7DFgGCCNQMigyCcAACTAFW64AAhJwM72hSB3ZGrhuzL6CNvqSE9i7GLNucG26nGeYAHu/Zez+l1jHSCizGu8Vt7arFdoWFw49W9rB8IHbDkaw6qKjy4PMrg/09SANdYVQBvGYCEE2tdA7+PiGvL+g1HQpO/HMApwpantPAMrGYBgbhj9/rgZJTIgXchgiE64ho97Vb+fHrHWej926v3zve/hwj76L1booSryHhPZdi5PeO89l6b13o2jrudT6lNfbXUkJXlvd1OLJYesAfPDfAc0WBmAEG2Ogdg/B7jqxKfKFQ4JjDInsPRDV59jXSRkB+9IBxwPiHg98ZamhoTmHc5S2dxopb9PVtM42zaoHu2wD7YN/Lo7J3wdXZu0re7j3zHPdezH19dvm/naJP90vO2Qdg5b2QO7kP89gDFqRHaPU+r0VwFQZARxQqbGKRG3Z1S77KD6MnZ4npmD7LqQm2Fe1VXkr2im65Jhk57VHd46Iks7YO10D2Z2sFa5QXrshR8x6W7Ffbi+CwXc3gP4q4hmeAwQdK0AsQHup64BpQ5GScLiXENMDS4CjaUUBkcs66LiyAEs7knARAEAR8mMAA1K2GSi6HItkHfsvIXBrs7iNAeoUikqysyj7neB8gALKmxgIXy6h9AKRrp3TmIpz7zLDWJcQgo/xgAjDGRcDlSnDLAchhAsDiD7CkbkY6IKE2rZCkwdbRZ0SgiKFrDJwiAWzJZegTxRSPCiLvyfzO6rKEZDDBC4TRDho7J7L1pgCQQNJxpGh9B9KeElrkYJqeG4R3LpxDDPC4RZoTK2bBD1h8ECFkJarWrEolTohJLfyZLJYyDPB1oJCKIr47JRr74wCxpNIFyJrnKXKpo3JDI5ExFTI5H5FoAtEqy6hwDR7IpDpwA84QLzJMJM6qB05AYwHrSegDBoBJBXrzpcQTFMLt627MIjyTFJDqDO6ME84yJjHzFTHm67GLFx4rFMJrGQ6bHj5w48heoLDZFNS5EtGFHbKRp7IxpaxHKVFtLVHn5pq3INGPKTLNHsD1qtFAkJDtFaCdH1TVoLC1qgl6HlxiDdRIC9T2ymCbD+BEAWDPCtjYkWAWD37CCVyzitjuw1xnhtyIQNzGDyI/4IRPjYQvh2gfhERhy9xrhBDLZWzDi6TBipQJRRhCTogOQZBiQZRtSuQ5Q9D9BZw5xjATDVRFi3DUgCh/BlgMgii4isj1T1gygvDgRP7BYnhv49gf5BCoQ+yyDji/6PgWgBzOBviAHES/jslgEHyxwxBZA2SJQjQWC0DXYzbNSuBbyZw5i5zykrwgCcymCemClaz6ndiqC9iv5ngXj9hBAJS0l/6BytiOmsnOmgF6CrbFSlQi5yCWHsrHpJCG7hk1SIh/KzwIq7wXwIJIInxvysAXywDXy3z3zHpPxcCvxny5B2HJJQh/wAKiA1bgKlkLDQJ2CwJwDwLhCIKwCnAoIpLoJSoQBYJKTIqIiIoXwkJbgKoUKrA4A0IjDWD0JsCMLMJsIcKo6qLo58LMGCI6D0qiLrDiKKH1lyAK6KLKKjrEZaKuGaHhJAY16gUmIQLCGWIGE2J2IOL0Y6JuIeJOo+Js4BIcI9qhLEq/kwBRIPTmLDzxLmSJIIUpJIX2FZL3KjKMFuHPHRoHJvFxofFnIdLfF1HNajL/HPJ/qE6LKDArI0Vxboi5J/qbJFGMWlHlHxpVEcVXI/EZq0ViW8UqXogSWvLvKfLdpErgX/KwVAqnAgqE7gqkLI6cI+bwrbxNlqLvBoqYrYrNR4oEq6W9rEr6JkrOaOA0rbzvkiJZBMosp2okqcoGpGomq2BmoiqWo+pbk7lEj5ByoKrzBKowAqpqrhaapMqKqhX6rcoYBpDLD8pRVejmqipWpRTEoQAhUOpeIYVurMAerXEch+o1ULCBrqXBphpSVr4yUsUVEtKfEKW1HprcWqXZpTJ5oFpFpgAlrqVloQAVrsBVrsAwnSFwmNotptodlI78b1g4V9po5Y4XE469F46jHG4O6PqHHfYbpa6frfobH8Wu6jpjFK5m73qO7W4fYd7LHXW67PX/pbF/nAXe6+7QYTqcYIY8bp4CboaFa5w4bPp/WLTAV+XogaGUYKjWA0a+Iln7qaVJ6ZaJ7J5cap7Ibvlh4I3Z5jDlYqbZYyZyaqAKb03PxTloCuZgA6ZzAeZMKBDeYmZmYWZWatgha/VhZOaUqOBc0816ZwAGYC3GZDbC3+aBbBZ9biZZb1b82NYxZrKtbtYpaQRpatgZYS1ZZSZM35aWiYZJ4lYmhlYW0DZVYc2C1DYjZNYG2JbWDmGRiQTda9Zs0rYRa62jbjZ2ZVbTa+LNTzaLY8iclF7ra95bb95HAV4jFjzPA16nZD5EjXa3aD7d5t4o1LHrp14p2A5p1ehF2t5nFE3Y7w47VDR7UtTQqG7PliEnU9F9Eu5E7M5oCs6NUc5U7bnc4XUrAaJM4k5k7s6U5c7vacnu59lC4+4znPCG4S4FJS5aUdBV6XWK4PXK5W63Wd4A1PXJL65u5y4H0TofW3pfU3Wl1HHn1O6X2u7L1AZg3C6J5Q0p6w1U38aZ4R5Yaq6n3LEJ7QZk0w1p6AMZ7h6I1jC57JJj691J0bSV1l4g6V7X0e45114F2N613D5vbP13UV0A5YPp3EMQ556vLY6T5IkoAz7er+AL7zKkDL5PF9Ub74Bb4768b9WlHH4hJn6KWtKMBX436dEEkVz7gKaknJmaikmXif76I/6kn0l2lIAAHMmhx9gKD+CrZ4CnrxkKNGlni9gFkgBFzNCelcycC+mQRBxQD4QsTWBHi4RKgsQWCqCWaSAmiqCiC4TJw2hKhKgABC1gkgMAkEqgkgqgQwFgyczaycycGjWZzgujDoQB4cfcYBEBUAUB8uMB6h2gCBYAGASBNMEQeh6B8kWBlTOBeBBBRBwQpB5BZAlBRTNZeAZd9B9Fr54i4G7BnAXBMgTULdgVCg/BBqi0AKIhIEYhYwEhLBY50hjAsh8FEiShoC9aZIGNZG2gYFVVMZFsaBxK8hOzxhphhMehlh0U8A7ZH8U8GSNFERzhrhvVHh5i3hRyfhAR5iQR2gIR5iYRyhTCkR0RjycRCRWgszghKRpz6R1i1FDRDxXz3DJRrxPhg1Jyw1ya4jY1fxk1AJdxLRbRHRXR7wPdE9/RkxQxmd2xxuux0xsxxxaA4D66rLnA6xhNwNE9zLZ6rL+xAxnLZDnePLfLDGV9Ys7wLVtxH8eRcJjxq+2LzFuLclBLNR1yxLdxjRZLH8FLcJ4J3Uy1RI0JL8G1pAwJW1jD0+qJsSGJWJOJPY+JEsD+RJrYB4qoSjrcppJjNJlpGEmjtpHciATJOTTpIBkcX+D0XJzQPJlk8UXpAp9kqUoptjrQ2UnQUp2Y2cuYvTq8Xw/IqIQoFYTILIEo2p0oXI5cj+3YNovrnYmoJplJn+5plUxgVpobz4M4Jokbn4uTbJ1j0cEQZAccaUtQYpWUOAebMphbNBfTbUU7aiZjZtijLbSA2o7bQQREwb5gvbDJgc2TQ7eAiJRjSsgbhjhJ8jJoFgFJfrlg+TegWbq7SQm0emNAJgIgP+zsWj4bABdsnosAG4pCc0N4P0K0vGFuO0+0h0bAx0Cd9OT0EoSQnb4IXQ/06kmk3s5w4McYCcSQrYCMOUtmINRuZ6b7/J5uGHogvMCUtmb1xub7YktHbUukvMCYtm/gQiogSAoAgQ8gZ8Xo57CArgrgQAA="}
import { Hooks } from 'wagmi/tempo'

const { data: policyData } = Hooks.policy.useData({
  policyId: 1n,
})

console.log('Policy admin:', policyData?.admin)
// @log: Policy admin: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb
console.log('Policy type:', policyData?.type)
// @log: Policy type: whitelist
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Return Type

See [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook return types.

### data

See [Wagmi Action `policy.getData` Return Type](/tempo/actions/policy.getData#return-type)

## Parameters

See [Wagmi Action `policy.getData` Parameters](/tempo/actions/policy.getData#parameters)

### query

See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook parameters.

## Action

* [`policy.getData`](/tempo/actions/policy.getData)

---

---
url: /tempo/hooks/policy.useIsAuthorized.md
---
# `policy.useIsAuthorized`

Checks if an address is authorized by a transfer policy.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/policy.useIsAuthorized.md","from":139,"to":4981}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"8b9aa7de863db2bb7feb28203f7e1e641e9774ded5f3aee5221a9605f2ab7693","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUWKQQOBwYAJScUKJiiJwARnxyomCcAD6cAK5gsABmpjBQ/lAQ1gh6ACr4MJwyoiKccLnW1vBwhbkyMhicpPAQMiRQcQminIXsnMoNAI65ZBgAdAA6YJubdQ1NLW0dXT19A0NwI2MTYtOz85xLKxtbL7uNzVyHnXDdvf2Dw1GpWuUxmpDm9Qey1Ia22r0h+0+7W+v1OAIuQPG8RuYIhi2hsJeOwRH1ayOOfzOgKu2NBd0hjxhq38InEugALOpjPIlCpEOyNOJtEFaf4TGYkAAmGx2UgOJxIAAc7k8ODwhBI5A0gTw1ggYBajDgAEFcsp2IwAF6lJKpEYwDLZPIFGDFMxlKgVKp4N6IslHH4nf7nS7A2m3cH3RlrFmaXSqACMsh5yiQCel1CFOiYJrNhFIVtKYpKUpl9kcfkQCfZKuoXnVvi1AXoTFY7C4BkEsbZSAAbIrk4pU4guZphXhO0ZxeYM7ZywrEABmBO1zBqvQavzalt6FhsDicNgmawYbsSRAAdgF3KHfN7gq02b0R8YJ+LEsQs9l8sri4vq/rDdG38GgdxAHowEcRh9TyOAYAASVzc0C2tKAAB4AGF9WKBQKBSNIHTAAA+UJ7GYHQyDgAB+JJJ1WF8T1WXI4MQ01kMLKBVgABTIijSDgTDsMYXD8PtDIiOiWi+EEeiRlfNZmIQpD8w41YACUdFyUgwAANVEGRljQu10mIzYwFEci4CwBwGkU1i8wtVDykqap9GkiNOFsGBrH4UwFE4RhCk4KZFPBI1goclDgWSAYpgYmNBQUapkGQEA6AsrA5H8AADXK0DgWhNj3dtOGAHhpLgThXGmcJmE4AByAB3UQFGYRgAHoaDbeq4QgqCYONLAsGCWJgE2ThPP1FoytpPCjQAGQgUQoD8qrOAAXnKwxZOPBSWOUxzSmCMbMgmw85JPeCoCSSUwAocaztCpJ6osWhVne+r7tO1xojhCbAs4YIFqWlbFFiIY0C0zI0JWogiMW5a/Pe1Y0Pa2GiIeiGoc4GHGDhtiVNQpJgHDKiGoATXgerOGegA5CB6tcVH0c2VxNly7KQAAXQoVLrLlZh/H5iy+MqgBaTgeIF0XmR51Kse0owAEUCXRXouEaxhlAi9jLQSaDMlZSG4FlnmQFZc9FSTG9eTTUcsyCOyDqij1jBLT8yzlCtnHZGsPDrdcfE1ECdT0UJwkiTBYlCmjOGy16ABJgBEAtFFcbKnXyIoSldr1XIAVTg8Flqgc5KrQCBPPqHzmWEOM0wsa25FvJBrzHJ8QFC99zEXT2f2cSUAMDzcm1AoJw4iMgo/O3artj5JhNMLgciz10c+c709C4i6BnggARWvzfrqtVC5ZvbcQAdM0fIJ4qu7vW7772pSH7wR5DsDzMs6zOkmg17U2EQcQf8MQwCSFhf+WVPQuR9JCbKepIEwAzswaAvQGhhGIIwWAlUphwD3HIOIMBki5AUAoVaCDQEQgSAFSqeC2pNEjJXeYmwABSoggEAGVrAFiwFwCh9pODkTnGAI0dUMFECwdFAYjUiEpHCI1IuJs4RvBQVANBnA6D7nynMRqlcrLeUCq+SabYzBgHyogOEAAqTgxo44QNARnaw+xKqa21uRc0UBaHtHwMFSq8Cpr2lWDICACgRrZTwv4xBqwyDhFIGE4KBQ478LkKsZq2l4nKGodYR0yRbJwXGBXTgjUCw0DmJXDIAx6awFWAAK1oWgIYFlnjWNsQoYJyR9JJICXIDOphWSQQaAgnCWlgSFOKVrBohTkDZQwSiVYIgKhmmylzYI+A0BoCwHARA7V2qQFgHU1Y7AFBoxcu1JoNARBiyIJKdkqxaDtVEFgDqsyuirDWcwGQABiF5PwFkQDNLEDIUBNjTJ+SbBZMTlmrPWZs7ZuzoAwAOUck5VQzkJHgGgK5Ny7kPKee1MFby0AfO+eEFEELSCkGiKsTgbw2kQA6TILpiDHE5LycCVxhAzQBTbBwVa9xsp7LAckpBgjUEpLhAAfUsZYgA6uIERihpUSqSLS9pnThWcHpTU7yaB6qVXcYQTxwUhicDMFreo4IKFGhoGY/omw4AYEgvgcIkBmKNEYPwSZkJkjyKLjYriiE8RUjgswZIcg8KQGLia+YAwrUiHkGgO15kHVOpdf8yqJhPXBT6Jq+Y4IqkwFqfUxpzATacA4TAL1DRpmQFKTBMFnB4LtQAPJQrWRsrZOzBVIq0CiuAaKLmYuubc+5jznmktee8r5ogxa1pgGLfUYswVi2grEMEmwUEmtMGCZg+t9TPE2AAUVoBlAhzE+WQjpQyplDiLEvA5nUzYwqgkhOCPVeofRK66NIDIKA9VogAG5Ng7MlqncxnAP3BKKewX9eFCl/LNE+7phbgmhPfTAT9nAACkcBPoNW/b+/9QGwAga4mBrZEGMNQYI1AODei0CLLQEhqJMT2DBDMI1Tgh6KVsfqjKwgEQ4B4QuAa1aHTxh2CGvIUo/7APAfaqBpelVWPgksnAFqDQgWtDED5OYXtJn0dgBSu9IGJrcdiUkfjfBNnCYgKJxQKRloQceTgd08mzoTWocgGAQCZBcxHCfdzHnqFcJ4WgVYpB8jwTAHUI0ECx6A0FYgIgzAqyLklFWRUv0SMKeC1wZtyRtWOAi1FmL+A4v6gS+xhFyXUuLgsJIJcWWgtnWoUlpeZBzIyHxROn47U6DeTNAbS8F4qySBa55rg3nfNczFsUlzZBEC9k/JKCbwUuA+f0qFxgvDEs1Y69pfSPXKhdH67QQbaBhsXmW72Cw2XTOta4O1sxnWju7tMP13zEqU5+U/IuJccIKFPZFhtBqMrGA5rUvSvp+p6rEefWksAwRsp7wyNocEScv4wFcAAQk4KjxQZAcfZTkzlxTZiKME/R5wcHkPof/zAHjqnRO6PaaM6QdmuU4THtPXki9DRsr2PtI45xd7OfZUfZBKaXB/lcE2sKDhDSHTMA4XZmAhBGojXh9LjRFLQcK6VxZVX5ENda+Yy0ZgGAhcEM2hxkBgTrcwGCLLvCMTScbqt8hl9aHINfpg3+0npHyNJF99Bn9tGymasQ2AS3jvvdvtDzhvDTV/dEfc2RpTIeqN+/D6z2XHu48qfYzATj5neNWcE7Z+z/lxPOak+6WTxGg+Z84MgMvpBLMCZs60NXygxNOck650oPNI8xMBzrrHoO+MQ8ZVDheDO4cF694j5HzOMfACx7j/HaOick6bwpjPFOkhr5pzPzgc+YeM+34T0gOPWdj7ABzECLVkqpTgrgKgyALhaU6Cs9tsKdkyFlBchkhVg9RmB4V9l+1BV2ow16V2ph0cUTBkh2pn06lohuYzYLZdAEwLxe4bZhwLwHxxw9BhUH5Lwn4FwLBX4Gxg5txx4DVoBYg49UNgg1MNNY4Kk8JkYIhLt9R9IpYLIKMKlkAuZJJOAiAIAsFAYABqBMTVTUYJZaDA6BTeEAQ/bRQpbKBDNADODlU1EvacalAAWXVh2wISFFyHIgp08lZUPGaHyTwn0OYTAGKH4i4EUnGGaDxEPALF3RhEES6A0wSS8JzRLi1gNk6U8N8TJGSBEC1iG31EAX0mWFoRYAh2ASmRmTA0KGCEXGiDbRhThV3TAAvEOV7XFFyHuRKKXQ037RKMXB6yXkKFWEXEJQ+Wy2CHuEsOsO0XEE0xzWsh+FGUrmmSGxkFWB3QSDCT/xhU7UgMRRNmRTzgHQxSxRHVxQ6nGPaK+XGKmLQH2LFiFDgGiCpThAfTgHNz4X+TMVB1UG1yiVYPqj1HyDQCSCwz/TwheLMUDwP2D0mleKSHUEjx0PN0CSeO+LeLw0hN+PJ3A0hKBNZ1BMfy5xeArWrWym2P2JmOhQ7ThW7SWN7RWPOTWMQNHTxW2KnU+T2PYF3QONpISCOK0BOI8k3QaG3QZL4LAEPjECSiQBSnNlME6H8CIAsFWATHFIsAsEwLrh7EyybhTD5HwPbiCFQ3IKIJADnC9gXGVH9jXDfmAnoN1B1yNAJkOmulEhMkzhdDdCLFUNcl9FJC+ApDRBDExBBA8ijAJEPmwKlAsHwPPmHHTGII7lNMig4nVMoN/GoL1MAkzAUH8CxzwDVNlPPElFwMHAvisGbCCEDVEHDKJj02WHIOkE1O/GfksFcDNj1FgFbC0VKi2kEDWkKFqnwxajak6hgG6nHwNC4BmkmCSDDN1mBGqk2joniiYn2jNJdmOgeiegaleivElCgEXFUAwmsF7F7EXHZAwgsFUHS0kElFUFEEXGSEVF9gACFrBJAYALxVBJBVBCgLBkhD1khkhPoHo74LSEw7pWZsswSUkni8yCybQ8MhzCZShst/B3FRAkBQBAh5A8F9Q8B8oQBXBXAgA="}
import { Hooks } from 'wagmi/tempo'

const { data: isAuthorized } = Hooks.policy.useIsAuthorized({
  user: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  policyId: 1n,
})

console.log('Is authorized:', isAuthorized)
// @log: Is authorized: true
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Return Type

See [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook return types.

### data

See [Wagmi Action `policy.isAuthorized` Return Type](/tempo/actions/policy.isAuthorized#return-type)

## Parameters

See [Wagmi Action `policy.isAuthorized` Parameters](/tempo/actions/policy.isAuthorized#parameters)

### query

See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook parameters.

## Action

* [`policy.isAuthorized`](/tempo/actions/policy.isAuthorized)

---

---
url: /tempo/hooks/policy.useModifyBlacklist.md
---
# `policy.useModifyBlacklist`

Modifies the blacklist for a blacklist-type transfer policy. Requires policy admin role.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/policy.useModifyBlacklist.md","from":174,"to":6763}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"8612238fb35eb7ea94d9d2808311c32ba32c9e01a54e93a2838af6a38747928f","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6INYQYCKczNCMAGYYAEIyDvwmIgDKGGDWiDx8ggB0bCbWGHkArnAwALJRsQlJKWjpmXkASjqlpGAAKl4APADCodGMChScpWD8kADuYAB8/iLiugAsAMyy8koqiACM0tTi2kGRUDHxidbJjGkZ1v4mZkgATDZ2pA5OSABs7p44eEIJHIGkCTFY7C4BkEi00um+6mMW2Uag0Rx0eGhRke5lewXenz8iGeAA4/tQvIDfCCAvRwWwOJxCoxirDlkgAOy7TaKFGIb5orQYvTM1myUy4t72RxEtYrcmYAF6IF+UF0vTRCaORihcYVapnWqXa63TIDIYjMYTKYQWZzAAUWHszB0ZDgAH5sliChAiiVylUahd6jdGnc8gAFZ2u0hwc1gYajcaTGbzACUXtycB9frK+qDdSuDSa1la7U6PRw8cTVpTtvmAB0wGBRC64E7rDA9YHDcGi6GS/4oBBrAg9NDONF2BEg6YFJxREzfSyMJwAEbGhp5JtNgByEBo2S6+BunFPi7gd3wpFCEHKnEIAk4ylEXGmokYaDgk+nyi7aA+MJPh1MAmzQCB1y7UxrBkUpYCgThdUXDcR34SCp1ILtMLQDowDnBdOEw9tQgqPJ/DEBQx2QZAQDoVssDkfwAAMWK/WgmxYBkuGAHJDE4VxJxvZhOAAcnfBRmEYAB6GgIREncEy1NAQM4ABBLAsHtNNOGAJtOE4EIwm4iJSjEGgxhuCN5DORR+M4ABeXj8lFf1817QsTTDTItIU/TsNwzh7T0/TOF6NdTPA0CwBCkLQn6Ip+Hs4AtIcuYTLMmB7R4lyAEkoGyZ4wDGUQoCgIi4GyESLFoPJapEsYiIAlkaHy59SFKLtXDTVxgpis44FEDcYCgJLLOsuceuikK5l6kLVNK58II8hpZt6KTwrQSKZqmtMm0mlimJAABdCgaKdD5mH8c7Wxjb8AFpOCjC7brIk6aP8zojEqUzXxUojShkNBXpOkAlgkRAORJHlthePFNGOPAAwNc5loHO4HglF4pQ+GVnBWXYFUpZVqXIsE9EM8JThRzc0cyTNDBzFc8x7amQ1NUs2hwis+kGBNLWTG07TZcHdhJRE5F5HZ9kFBG9Cpo02a8+5xSeRBEVsaUvksQmlR8YFSfVEBHRvHAOAwbTmB+w9AqIcRGEGuQKpndyafZyNoycONecTOYxggLBlJIz1OG+jKAHkA5AuNdKm/TctatcRlMNAAG5ZtKLAoFfMhsiY6qABJgBEUgJqYtPY4XawQgmNBc4LoumsUVwy9mxqS5lBO+DkUQwHLmLMM7RgA6PQCBu1UI2kHgPy/cTg4lECoAFFSBvUhKxgMZ5b7TyS3d57PerEZfYF1M0oAH2TWBhjMKBtPstKiAgRgoCHEcxxAY8u0tsyVM1TJA+ihgO8Bke4gJkDITg0xPz4E4LbEuDt4CLTaiMbQpBnz4C/lbFSPcEL+wAaIcBq5HyCEQtFEqZx8EQOsAQmQa4kiIUjiRMiaJKJIGoiAa6l0qBwPtkNe6nBP6wLtgg78EA1wACsYCOCQU6OA35wLoK7Exb+v1QgADEwBMVeqdDhzp/B4KjnkUIqRShV3gPw48p4/7j2ilA8Bk5GCYUgRg6Kf50qqOiqeOApjOxyM1BAnBkDGD2LXF2WRFQEJuJUQAkS35/qA20WdPRVADFMNCMvVenAHqWO/NYgBQT7HDCcTERR7j8nyGrmAT2C5opkEyYEuxEDQlMgXhE0pdT2CJN0RdfRjCwhGLAKkHQaA5AIWySeXJSkVKNIcU46YLjSnRJUqeGA0CyCcG8WYvxAMZCrmiDoWww1EJoIqXeKpboamcA6WgwJzTwlHNWX+NBbis5iGOVclenTjo6MwswcQMIqAPRytETgQDSgRFEPwTBgMh5yEIjAAAjh1EQcAxhMWMT48xTECkQKKV2UIuyFzRCcKUxINBwjUPsWCkSJAIWwG3GAB6ql7FuMpbQ+heSo6BXRYMzFcimJovSZ80gArOA8qGZtUZTFtLiC7I/Z+k4pkkWKmASJGD4VcxvkI2CXYZnNJGJATCUBgbCDhC8Cw4tkQ7AFIcIUJwra4BVuYdWBJcbmp1t4FUNIaCG2Nv7MgmAZWlXKtkBsIBqochWM8KAaxVD9GsN8b4cp+gWrWM8SQzxVCiDWGuEkKwVhxGsJIGAHJVCSFUNECwa5F5rjXGG4Wuhni7BtRLGGEMZbChAOQ8qGNVY2o1jjLWzwPVUn1mqIIfrTaBqXH6PK2RE4KGTg2l4HINhIklkgKGtrZYcOXMUPKvbzAcmxoSZww6PAUl1l6g2E6sAmwDebeFxdmrDWyABDqy7iQkgOK2vkuwrDbs7W3F9L8nWbpPW64kI7iZjtpEEFsbYOxdgpr6GATY4EGRIqh7IvM4CodfqOPAgimIobkNi04AMwk3iIM/RBF5OJwtgOFBQi7bKkf/HYLgXiWDBPEEgv8TYABSohbapGsCXAOmGwioYiFIuweE4DCTvcQWjCE1yrmmDANc64bzTAqLGBlTZBEUbhXQLi8jpgQXbFImILJMMQjMFUiqCkABUakxW4dQ9imCrSgnKFk8oaA35NkwIXmK9jeQZAQAUFpUVJGsNyDyNc2LNSELxek4l98nQUsvi4NQ6KzSAyRIgtMEuNAkE91XPuel4jgsARgK2BlbnVKcAUFFuhED0t4bI2eIyPdOxScTB0I5CjSufn/BBZATFlO+OzCIYcpkmJHXtPgTaWAKpSSkpAWAtWjFaCksOUcUkyXwDQHdIgzwVh5FoFJUQWBpIzfMXkVbzAZAAGJHtyPm3eNAMrVVNim59ubaBYAryWyttbG2tvQBgLt9gCgDtv2O9nEQ53LvXdu/dqSQPntoFex9m8s35t1LTHkAR6q2tiIIeFhLMBvOgMK20qBgXTJnghBwfCbimLbZgIgdj5HoCUcM2AAA+i5lzAB1cQeFFDi5F0eCn7XqfscQhIqRaBYkBcIFAb8srOBmDWWgimoZ5AjIwE2S8mRry3nvCYKFpS1y6f02pCMOV5EYNXERGAzAhpjENQuJxf5VzG5EKb3ZTYF5XhvJAW3jB7c0MQk8zg1WYB5Fqxs+rrZsycCGRxrsU3IDld1EDzgOUpJh3B6ttA63ECbZ53D/bh24DI/JWdi7V2bt3Ye4Tp7L33uiDuoXmAd1Qh3SB3dHU2kMJNkiMUhM7A/kAOF4vWg9E4XlE54rqnnX+eIAUgdWrTYItRZiyJDB4CSvsBkFAESaZy6bceiXJz2Rz9RcgVfqAYwFHfdMkf2nkXot7Qz8YAL9OAABSOAeqUSSzUga/W/e/KSR/ZOJ2V/S/WAz/JBH/NAP/DLVPZLMwaYTgDJdgIAiXR8dbMYPDF0ZQfCOhBCOwDSeQYaW/O/JsB/CMJ/L8D5TJNsAabQVLDPehACBwCbDPUHUgPfMAB/fSYgiQzgMgvgCgjZCAagk8WyOgh8O7HAG+NgxAmKV8TgZAGAW2GQI6NWPYVQXQmKBcLgMTCTIGdqMAHKboCZXmH1Lge0HnRAIgZgPYNNPYEkXaKQvQkKAwsONXRwPIRw5wnJNwwIQKLwnwxANYCwSQZIwIqw/QrgLw5OMgFsGQbHHvORKSOgKRUyECCGDkPYSQTI0IrgIwkwo6O6UrLQnOb4YkZ4Wo/SAw4wghOwoeDwnI85ToAhQokccxEo2gMogBCGdo74CwII6Quo/XGHRAXIkYgov5UwEokwkXZ9RQYkNYZIhSCmbIm6ByUSCXYJCBFoMRUwPDMAEScuCLLLMAe0JiAAER7lQU4ELgQxgFcAAEJOAvjFAyBATpUECkDn8QTvj1krj7FbjE5pMwBgTQTUFASv8rMQc6kmwDoFIV818uwN9bIudPMesfM5FJC8SWJD9MgSIuAfsLjjhUhM9mBUgVCYBCBpgtJniGTuDmSdBWTMJWwOSXRuTeScDKYMBySuxHICCpNutU9ZT7QfsxgSdy4Z8ZT/8T8gDUD390D4CrCODkCX8QC38YDr8sTEJf8wBmBtTcCADT99SICoCxIP8jTgjoSvwzTQDLSMCFEfstTZSkthVPCYBCDZDSDyDUVlDVDaCSpNDGCb4WCoSTSYTkBZDsgFD/ZYyqCdA1D5wNCGDtDhoTokFcSopTj9dzjHIRIESbi7iUSnjgz/9Xj3j0T1k/ibogTYSwTSAITWCvT0yfS+yfiGzOAkT7jQg0S4SBzrTKyDpyJRBWEUAaIKhHUQBkA8MOhOxlsq8a9NtF1lBSg1w8gQhmBocdtm8ed1p2spJ28McTA1wpIItas0xjoQYwZdA1hdhuR1021j1AMgh2ND0kA/yIMtYLBoM9ZVQ4M8B7RVDoBtIQzdTeCVyYBg5KsxhaojE+kCEnos9shKtkAjoMxYEn4EJ7QABqXYRCYEKLEqD8qgJvPAEc+RCCJiLA7FZnGBAgnEMnb6GFBiLsI4UoF0JzEBArMJVpYaMYXixRJsIpcIIrBcd3KjFgcQVcdC/gwJBPchT8ECanVSsLbxNcEQT8co0IdDAhZFDZHjRIZ5SbabTg6Ie0NYNMSvNbWvKSP5MADkPbBHR4UoG7PysfDC5vPytYQo5OaIPINYXHV7II+0NxMSiSrgvXBPe5YrQwpicomQPIDCRfWLfcyHHy+vbMeHRHI7E7VHR8zvLHfKxK97fKoq18Nqs7I4OANMUnffWkuAKUvLM5LgRyVQPkx03UkSSpWucAm/MYaaoc9gzgp2aa7IdQTAkHIM+kiawAqa4axAKAhatM5a7IVazgda7/Ta20/EqKXPXKpqjqkqiHavKHCqwK6q5vWqtvdHBq6SJqvvN7Vqhfdq4GzqrQbqn8NBWfKCefUgRfECZhQ4Vc9hOAaCTcogCwPIXYLGiwCwT801dkZI6WACvkNdeGTtE/MCvYf8gdU9TdGC69cdPAasreVGdmemZyPdVyFmBWfsN2TmXCdeQ+JMa0U+T9OUFYaGP9A4cmk4AsV2JWKmiC/ETWWUNYBmkmJmvQSdB9bSV5UQbIGOGKeOedJOKpPuEKDOV5HOMVeufYhQZuC27oqufa222gQue2x21uU7duFqedLuBrXub2qeGaroUeYCCeKRVZaePaTgC+CYK+CUUDEAVivQQRRIcITZWbfxQlIiX0EgBCfWyGxZLBUIYXIzdVDOrgLO8xHOz3eAfOo5IujCEun+MuhSCursKujZPlOAOup9Ruwu18RcFuqJUusAculwruheau3u/uvOmQAuzgZu38dVJZMu8W74SWkmnYbe2WvAfWpWmm11LWVQdWi9RUT1TW+C7W5TKdR9AeaO0O8OmxSeJ+8WjkADX9HYIC/evQR+gYo+yCokMtDW2DdwhCu+3WtqHuMeABbgBefAOud2huJ/B27FeO1VGAa+YaAjd+BBuAGBCAEFGg+RF+gBD+rdb+8CxEP+6gchkCAhlQMDam4B5wb4DkGCiifwf4vASmgm8GNYctKWnYADCBtOhh3UOwQh7IaqXYZ4OUVQDh79CwQaawK+eRxR5RyQVRtcdR7BzRlYJRyGHRtRjRhRox7R3R/R6IJWtdWmyDaCkGEIWAekSEHSJyb8ASaIISaAlcySGSb3NgeSKs/k1mhWksC470FyZmZGXmneO4HyKKB/foBPZRB1bFUwJ9NgMIUQgMG5GxQKVPBQMnDaSKAyBKMYIqnutcSSORECII8JxWXeaJTKI2hcYNcxSqCNKNGNONBNJNFYFNM+9NTNbNXNfNQtYtUtctStatWteqYKE2zgXYIqYKYDDuN9dqDePaIIqU1DJ0oAsO2BiO6KaRpBqAppvmpWPIfW90KIqOgYvIYQoCGxJhoI/wag0QJAUAQIeQVG0IPAL8EAVwVwIAA"}
import { Hooks } from 'wagmi/tempo'

const modifyBlacklistSync = Hooks.policy.useModifyBlacklistSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
modifyBlacklistSync.mutate({
  address: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  policyId: 1n,
  restricted: true,
})

console.log('Transaction hash:', modifyBlacklistSync.data?.receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `policy.modifyBlacklist` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/policy.useModifyBlacklist.md","from":7113,"to":7686}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const modifyBlacklist = Hooks.policy.useModifyBlacklist()
const { data: receipt } = useWaitForTransactionReceipt({ hash: modifyBlacklist.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
modifyBlacklist.mutate({
  address: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  policyId: 1n,
  restricted: true,
})

if (receipt) {
  const { args } 
    = Actions.policy.modifyBlacklist.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `policy.modifyBlacklist` Return Type](/tempo/actions/policy.modifyBlacklist#return-type)

### mutate/mutateAsync

See [Wagmi Action `policy.modifyBlacklist` Parameters](/tempo/actions/policy.modifyBlacklist#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`policy.modifyBlacklist`](/tempo/actions/policy.modifyBlacklist)

---

---
url: /tempo/hooks/policy.useModifyWhitelist.md
---
# `policy.useModifyWhitelist`

Modifies the whitelist for a whitelist-type transfer policy. Requires policy admin role.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/policy.useModifyWhitelist.md","from":174,"to":6752}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"7679b70c1a9955fc42af8bd9929c68a4bdb7d8b9fde73dc5c771f97554c0150a","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6INYQYCKczNCMAGYYAOr4jDQmIgDKGGDWiDx8ggB0bCbWGHkArnAwALJRsQlJMClo6Zl5AEo6paRgACpeADwAwqHRjAoUnKVg/JAA7mAAfP4i4roALADMsvJKKogAjNLU4tpBkVAx8YnJjGkZ1v4mZkgATDZ2pA5OSABs7p44eEIJHIGkCTFY7C4BkES00um+6mM22Uag0xx0eGhRke5lewXenz8iGeAA4/tQvIDfCCAvRwWwOJxCoxirCVkgAOx7LaKFGIb5orQYvTM1myUy4t72RxE9arcmYAF6IF+UF0vTRSaORihCYVarnWpXBo3Jp3QbDUbjSbTCBzeYACiw9mYOjIcAA/NksQUIEUSuUqjVLvVGs1rHkAAout2kOAWsAjMYTKazBYASm9uTgvv9ZX1wbq11uLXaaE6PX6Q0TVpTtvtAB0wGBRK64M7rDA9UHDSHi2bMv4oBBrAg9NDONF2BFg6YFJxREy/SyMJwZsbGnkm02AHIQGjZbqJOCcG4LzhwO74UihCDlTiEAScZSiLgzURJE9T0jP/BdtAfGEnw6mATZoBAnAAEZdqY1gyKUsBQJwuqLpBMgjvwUEwN+XakB0XRzueeHtqEFR5P4YgKGOyDICAdCtlgcj+AABqxaBwLQTYsAyXDADkhicK4k43swnAAOTvgozCMAA9DQEJiduiZamgIGcAAglgWAOumnDAE2nCcCEYS8REpRiDQ4w3JG8jnIogmcAAvPx+SigGBa9kWJoltYOlKYZeHll0nAOgZhmcH0kHmeBoFgOF4WhAMRT8I5wA6U58xmRZMAOnxbkAJJQNkzxgOMohQFAxFwNkYkWLQeQNWJZUyOhMwwEVz6kKUXauOmrhhfF5xwKIaHtal1m2XO/VxeF8wDeF6kVc+EFeY0819DJUVoDFc0zemTbTaxzEgAAuhQtHOh8zD+JdraxieAC0nDRld93kWdtGBRWRiVOZr5qcRpQyGg71nSAywSIgHIkjyOwvHimgnHggYGhcq2muGDwSi8UofDKzirHsCqUsq1IUWCejGeEZxoxuGN3Fmhi5iu+Y9rTob06W+GVjgCZJtaqZ2gsbKQ3sJKInIvK7AcgpI3oNNGhzPlY08iCIrY0pfJYxNKj4wLk+qIBOjeOAcBgunMH9B4hUQ4iMCNcjVTOnl0z5UYxk48bVkm8zjBAWCqaRXqcL92UAPIByB8b6TNhkFR1kGjKYaAANzzaUWBQK+ZDZMxdUACTACIpBTcxaexwu1ghJMaC5wXRcAaX5fxaILV2u12SQXwciiGAzfhXhnaMAHh6AcN2qhO0Q8B+X7icAAQqIFQAKKkDepC9Dg4wK323kDhGL13Z7fOjL7dZpplAA+KawCMZhQLpjmZUQECMFAQ4jmOIBHl2lsWWpmpMiBzihgO8Rle7gJamuJI+BOC2xLg7eAy1OqjG0D+ZQv8rZqV7khf2wDW4yFXI+QQyE4rlXOPgmQkCZCQQcJhPBUdyJoiokgGiIBbrXSoPA+2o1HqcB/nAu2iCTwQEggAKxgI4ZBzo4AnnAr+LszE/7/VCAAMTAMxd6512Eun8Aw0ieRQipFKFXeAfCjxnkARPOKMxGBQJGHhNcf44oYKyiouKZ44AmM7LIzUVCcHQKgdBJkS8KhIVcco4BYkTyA2Bloi6uiqD6LCIYsAq916cCehYr8Kk1K2PsYwRxMQFFuOAZweQ1cwCewXHFMgGSAn5KocEmRYSSl1PYPEnRV09GRwMUYnQaA5BISyceScuTdSNMnIUrs655AlMiWpM8MAYFkAvN4sxfjCGTh0LYdqyEfwVLvFU90NTylr2nAE5poS9nLIwegv8nAs5iH2Wc9enS8LMHEDCKgT18rRE4KA0oERRD8EwcDYechOB4QAI7dREHAcYzEjHrNkcxQJVCHFdlCFs0Q0QnAlJkNncI1gCEArvGJEgwLYBbjAE9dSUDXEkparQ6wmErHAJPA6JFYBjGmNRYi0I6T2DMQFTygZQzmK6XEF2F+b8xlAKjmVMA4SHlfS6Hs228EZl2KaTBBQkA8JQFBsIOELwLAS2RLsAURwhSnCtrgcUqt1YEnxmanW3gVQ0hoIbY2/syCYClRVKq2QGwgDqhyVYzwoDrFUAMaw3xvhygGOa9YzxJDPFUKIdYkESSrFWPPawkgYAclUJIVQ0QLCQWXpBSCoaRa6GeHsa1ks4ZQ1lsKEA5Cqoq3MNajWeMtbPHdVSfWaogi+tNgGhcbc2odQAt1etLwOSbCRFLTk7aggEPbu/R15gOS40JM4IdHgKS609QbcdWATb+vNkuf0hVO5JyqYu4kkgrCrtbTDG1ct2HLmKIVHtSAv39sPS8YdpNR20iCC2NsHYuxUz9DAJs8CjKkUQ9kascBEMf1HHgARzEENyDRWcIGXYr3EDfkgxccBuKQtgFFBQChCKEf/HYLgniWB2PEMgjBTYABSohbapGsCXAOqGwiIYiJIuwYAbiiXI0QSjSFIKrjapBKCN4ZgVDjDSpsAiSOQroDxORMwILtkkTEFkqGIRmCqdVJSAAqDSnBmKYcQ2iuCoToHKCk8oaAJ4vG2AXCeAjaG5B5HQgoHSIqXMsbyO00g0WalIVCxJ8L74uhJZfFwElcVgmBnCRBGYJcaDIN7quPc1KxEBYAjAVsNKnPqU4AodCtCqGpaw0R08Jle6dnE0mToez5HFfqMg5AzFyM+JzCIYc5lmInQdPgbaWBqoyRkpAWA1XDFaBksOUcMlCU0BEA9IgzxVh5FoDJUQWBZKTbMXkJbzAZAAGI7uyJm3eNAUrlVNnG296baBYBr3m4t5bq31vQBgFt9gChdufwO0StAJ2zsXauzdmS/2HtoCe69m8U2Zt1PTHkfhDyWuiNbrFsLMAPMQPy602xfnzKnghBwQirjmIbZgIgFjxHoCkd02AAA+g5hzcRxCycUCLwXh5SetYpyx5C4jJFoGib5wgUATzSs4GYFZP4qamnkIMjATZLyZGvLee8JhQUlMgpp7TGlIz5TkX+VcxEYDMFGuMA1C5HEYNXPrkQhvCFNiXleG8kBLeMGt6S/cf4fyVZgHkarF5authzJwVIMBWNdnG5AUrup/ucHyjJMOIOltoBW4gNbnPoc7b23ABHR2kenfO5d67t28f3cey90QD088wAeqEB6/2Ho6l0t+JskQimJnYJ84BAvl60AYpC8obPZfk/azzxASkjrVabHFyLDoxJ/jbmudgMgoBiXTOXNbz0S52eyCf9CZ/SAX/GPIj75l99U4ixAKLx+Ghn8ABSOAJqcSUzV/S/a/JsW/SMe/diR/QAorc/KAd/MzQHT7b/NLRPBLB0MwGYTgIVRLMSBIPgFbcYLDV0ZQQiWhJCOwLSeQdqK/aAsAWA+Ak8BLKTWRUQbQZLFPOhTqBwf8dAoHUgbfVgmScKIg7IUg/2BFC8CAKgxIeyWgh8a7HAe+GAyQluLgZAGATVE6NWfYVQLQ+KBcLgYTUTEGLqMAfKHoY8asb1LgPAyHRAIgZgfYVNfYEkfaCQsw18TgMOJXRwPIGwuw7JRwwIEKTnNwjw9YCwSQRAdYHw0wnQ7XVw5OMgFsGQDHTvWRGSOgSRcyECKGDkfYSQVI8KAIvQgwh6YrdQnOb4YkZ4SowyAI/Q1uSw4eZwmIzIroVuXIkcMxAo2gIo4BKGJo74CwXw2/NI3o45fonIz5UwAozVQXYuOcYkdYJIpSKmLgGDLsZyEgnVTgVoURUwLDMAMScuOLDLMALlAAEV7jQU4ELgONcAAEJOAnjFAyAPjJUb9JC4Dk4nYfiXi4gTizjE4JMwAviwS/i0CU9RCmwjolJF9l8uxV97J2c3MutPNZFxCUTWI99MhSIuBPsnJmsdBUhU9mBUhFCYBCAZgdIbiyTXlKSTgaS8JWx6TXQmSWSsDqYMBcTDjtcYACC4sRSHRPtxhCdy5J9hSf9D8ADT8ICL8r9AS78QTEDVSUDETMCwBmBFTsDf9/8n8IIQCwCJIUCNTTDgSH8HwkCX839kEDSjSRT4tzlEt8DCCvSj9ZDyCFClCaDyo1CGD75mDNT7SEDOBkBpDOAAz5DKCdBlD5xVD6CND2ozpkE6ldi2SDjKTjioEoSLjQhriFSPS7jHjnjVk3i7pPjviazSB/iWC2DtTGzfifwITizziYS4SmyPjETcyNFWIKIeDqJaIKgHUQBkAsNOhOwFty9K81smNlBShII8gQhmAIdNsG9OdNpWsZIW9UcTBIIZI4tqt0xTowYIZdB4iv0W0+R91v0O0WNAN9huR8RNYiQLBwM9ZVQoM8AHQlDoBdIPTD82xhptBg5ytxgGpDFelsjD5mAnZytkATpMw4FX4kIHQABqPYZCYEdCcqK8qgevPAaMuRCCZiT/NANFBnWBfAnEYnX6cFRiLsY4UoV0OzcBPLMja5VA7zWBXjGsOMLgArYLEpK9FgcQVcSCngji5VadfxCqJIECCnCSpeNZSCEQJIYo0IZDVuOFC8TjQldBCCP7eA6IB0dYdMMvZbKvGST5MADkbbWHR4UoS7Zy4fBShvZy9YXI5OaIPIdYLHJ7Xwh0VxTi7i9iH3DiqBFpIbCy5iYomQPIb8OfaLRcsHRymvHMGHOHfbQ7eAZvFHNvdHVKsKl7VKjK18WqpHY4OAdMInHfYkuAQUnLI5LgZyVQVkk05UypWuTgIAy/cYQa1soE9g7IQa7IdQZBWiwUxDU0o/GasA8aqMqa1DGuWaxEhakc5iJSTPHPFK1SNK+qrK0HCvcHPKtywqhvYq47Y88q2SSq7vZ7Gq2fOqz6hqrQJqycacKfGCGfUgOfECJhI4FhFASc2CacogCwPIPYBGiwCwa8k1dkJIptWGPkFdRGDtSLd8vYT8kDV1RAMkE9RUD1MmMdPAPY52dmfscMRmVyP9dyNmRWBmu4NobmTeGAE+ZMG0C+F9OUT8x86WQ4XG04QsV2feAmoml1LWdYdYP889amvQCdG9XSJ5UQbIGOeKeOR9JjKpfuQyDOJ5HOFzeuDYxQVwMueaBwGai22gQuK2hQG2425S7dTubuOrPueaQeZZEefhMeYCSeSRAO1OA6Tga+SYW+CUHdEAcivQARQlcIQLKbTZV3eAP0EgJCLW/6+5TBf+UIAXPTB5FOrgNOjZIGLZYibOvZPO78eZLBYupSUurscutZPlOADOqFLOmQHOx5V8RcRuiJZusAEu+w9upeCulFbu6uzOzrAehu6cUeou8eoW74EWy1JAVYDdPALW2Wg9Em1QJW8mkmf8r1CmI2cjSdW9f27o0eXuceYBKecOje580W9dF8oIe+gOQ+r8gdIkUtZWqmwCtWm+jWwQoCaxbgJefAOuJ2hue/V2tFaO5VbCOOnDL+WBuAWBCAf5aguRYO6xIWktLG6WRECWvAACJ+kOsAHBlQXdJAQmo+rWb4DkP8yifwA4vAfGtGyGdYdNchpAd9JwvDYhspOwXB7IOqPYZ4OUVQdhkkN9EaawW+ORhRpRlRyCNR7CDR1YRR6GbR3R6IfRwx5RiwVR2+AmldYmrWX8sGEIWAekSEPSFyE8ISaIEScAng6SOSd3NgRSWKWmnedGHySkn0NyVmVGdmvecMPyWKW/AYUlJRe1NFUwXukiMIYQ7sH8OhkKRPBQYnLaGKIyZKcYDK7S6SWRECXw0J6W8MPISJHKXWhcINMxGqcNSNaNWNeNRNVYZNE+tNDNLNHNPNAtItEtMtCtKtGtJqMKLdWdbIedGACgMKfWzgPYUqA6Xwxa8LZU7oCRtSKR+BsA+ppWfePILWj0UIsO7ovIGh6B4BBh3w/wKg0QJAUAQIeQGjUIahhAVwVwIAA"}
import { Hooks } from 'wagmi/tempo'

const modifyWhitelistSync = Hooks.policy.useModifyWhitelistSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
modifyWhitelistSync.mutate({
  address: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  allowed: true,
  policyId: 1n,
})

console.log('Transaction hash:', modifyWhitelistSync.data?.receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `policy.modifyWhitelist` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/policy.useModifyWhitelist.md","from":7102,"to":7672}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const modifyWhitelist = Hooks.policy.useModifyWhitelist()
const { data: receipt } = useWaitForTransactionReceipt({ hash: modifyWhitelist.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
modifyWhitelist.mutate({
  address: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  allowed: true,
  policyId: 1n,
})

if (receipt) {
  const { args } 
    = Actions.policy.modifyWhitelist.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `policy.modifyWhitelist` Return Type](/tempo/actions/policy.modifyWhitelist#return-type)

### mutate/mutateAsync

See [Wagmi Action `policy.modifyWhitelist` Parameters](/tempo/actions/policy.modifyWhitelist#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`policy.modifyWhitelist`](/tempo/actions/policy.modifyWhitelist)

---

---
url: /tempo/hooks/policy.useSetAdmin.md
---
# `policy.useSetAdmin`

Sets the admin for a transfer policy. Requires current policy admin role.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/policy.useSetAdmin.md","from":152,"to":6479}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"fbe0fb128f663b81203c3f14323f7bbd58a2ebdc7f33ada3627157b6f722bbb1","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6INYQYCKccDoAglDMpgDKGGDWiDx8ggB0bCbWGBkArpHx0bEJSdYZAEo6+aRgACpeADwAwqEAZowKFJz5YPyQAO5gAHz+IuK6ACwAzLLySiqIAIwATBri2kGRaDFxYInJ/iZmSOvBdqQOTkgAbO6eOHiEJOQagUys7FwGguOaulUAA55oplGoNlodHhfkYTuZzrZ7I4/IhVssHtQvM9fG8AvRPmwOJxsoxcv9JncpqDFndIVs8KTybJTAibJdrqjVgB2TGYJ56F5+d4EvTtPqORihXpFEr7Q7WVodLo9PoDCDDEYACiw9mYOjIcAA/KlYVkIDk8oUYMVdqUDuUMgAFPUG0hwJVgTrdXr9IajACUpvScHNloKsrt8sd1TQtQazTaXpVvvVmoAOmAwKJ9XBddYYDKbXKykcqFAINYEHpfpx2uwIjo0KYFJxlIXRPa6w3RCSLWS8pnMwA5CA0VL1fCMOCcaecXtwcr4UihCCFTiEARtuxcQaiRhoGf10jbwtoK5ha5SsCZtAQTgAI0LpmsMnysCgnGlvYfMkr/EfGBj0LUgajqFt504UC81CSIMn8MQFGrZBkBAOgcywOR/AAA1ww9aEzFgiS4YA0kMThXDrFdmE4AByPcFDiAB6GgvloocvQlZtpSiLAsC1ANOGATNOE4EIwhIzhmHyMQaB6acnXkKAIMogBeMjMiZK1Iz2UtrAEjjRNAuM6k4LURNEzgmgfGS7xvMBLMs0IWhyfhVOAATOFUkYpJk0QaC1UitIASSgVJVjAHpO32VJaIsWgMkS2iKIDVwLMc5S4FEX8YCgdyFKUls0ocyyRnSyzbU4XT7McpomJstA7LKkqA0zYrcOwkAAF0KFQ3UrmYfx+pzN0ZwAWk4F0BtG+CetQ4z4yMABZPzuIc6D8hkNBZp6kAJgkRBuWWGlwRWdRqE2aE9GtW1qoVY5WTOdlkRuRAZimPlsUFXEEI+PRxPCHY7vKYNDDDAcI2LKM9KqMCExwT1vVVP0NVGCkDuWI6TqWNZ6SuvaSwdMtjEexBzqRK4UWcCxPoFHxXl+0UQB1FccA4DBBOk2SYFSLUiHERhsrkOBUiB+0FWdV0nA9JNvRGHoICwNbjVSFbuYAeSV68PWEkrRJCsLHy6Uw0AAbnK/IsCgfyyFSbD4oAEmAERSCK7Dzb1+d7Ttx3nfPN2Pcc0CC0YJWJwvLLJVCaoQ6Vj33E4AAhURIgAUVIFdSEaHAejF6Nkkl6bpcRrp5dTf0fIAH19WBOjMKBBO8zgiAgRgoH8CsqzwSdCy5/zrzrLiB4wNcxNEBzrFEGQZE4QYD3wZuBaF+A23vf2FG0E92182SB/Hz9FbWqeZAwDcQy/BzO2Uo+Z8n6eHwcADD+1+CNiQpAUJAYbBqofnXeX8anAe6L3/jlGcEAHwACsYCOFXiSFOM47ynk4NhPua0ABiYBsKzV6l/PU/hn6wQyKEeI+RrAFjgIAycc5xTJDWrPRg086yMFArPfA8hkFoIHnOOAZCKFwHFDPfeDCmFPngZQ3KnDVrXlojODaW0cF9XwVQQhYRiFgHTpnTgE1qFHiHtKOeTDOisMYO0KRu9pTyBCH0aW84HJkC0cIwxM8xG6gkZ+beDj2CKLwQNAhWsiEkKbHIT8Oipx6LoQPZxzDWGDHYQ5beXDpRzhgPPMgEQ+HwAEZtE+dYdC2EkQ2Kxa4wC2PHpwLxJ5hGuIQZI1J7Yt7sM4NbMQX4TyVJ8aBZg4g/hUAmsFMxI98hSVEPwXum1myYRAjAAAjvkeAh4ejYRIZkyh2EREz2MYWUIuTRDtCcMgmQNtwh3xnkM2iJARmwAyJmCaUQmHb1OQ/awAFaFRzCGZZZBxVlwGwks0Imj2B/JQUExqITsKCXEIWFubdB6RNglFMAHimkLTqJI/mb5CzRLEV0SAoEoA7WEACJAywgTUmMAsU6tw8ZBDQbgFkpwybPUpq9ZYMxabeCFHiGgTMWaKzIJgSF3tODphAPFbkUxVhQBmKoFo1hbi3Hei0CwqgZirEkKsVQogZgPjJVMRO1hJAwG5KoSQqh2gWAfKnB8D5RXo10MsM12MIQXShEEaKpgHqMupRcF6XIOU4gZiKIIfK2aCr7JaUKqQHzG1Kfas4qgrAUrBEsEErqGR6ANl68w3JmWcmcKsAN30g34iCNmXM+ZCwAwtDATMf8xKwRrakJMcAa0d0rNWEAwDsLVrkOs5g0BNqFiwCuIgbcV4LiInIZpMAbIbwgr2s8O5ZwzjgCwRh4g4HtkzAAKVEPzeI1hXZKwbWEGtUkYF2DANOGiI7iDjs/A+U+gxZ2PhXIMSI7obn2WAQOqAQ6Km0GIogwY948wwNMWSBtXwzClJFhxAAVFVFBLaa3rNfAghhygL3KGgKushC8U4oMXRkP8CgBLAp7Y2uQGRKkUbsZ+KjZ6aN7jqPR5Q/kx4OTEdaDx95BiuxoHA8ep9RzXMgau88MAczfqQ1ETgCg/wPxnkx1tfbZwSXHgWU93paiSKQQJg8Z57zIGwne/hGQRAVhkthLqWp8CNSwCLJiTFICwAk8QrQTFO5wCYkcmgIgxpEFWFMDItAmKiCwIwJi5mskZAc8wGQABiWLlCrNrjQJCpFmZTOpdDFZhxtn7OOec656AMAPPsAUN5jtfnjloCCyFsLEWosxZXBZhLyW8sFYzgGDIQCmmKYgVPYj1GYDofKTxyIn4564ZkrOL4HAILb2wm5nmi7+2DpoxxAA+ghhDAB1cQ17FD7Z2xOQbSmRuLq/FAmBaBZE4cIFAGcULOBmDSSeAG04aClJPpmRcyRlyrnXCYMZyCHzvs/VVJ0wVEHsNPtBGAzAco9DxfOVh7ZT7fZEPINA/3syA9sCuSAoPGDg+Pl+BpnAxMwAyBJiIUmcyhk4MUJdhZTOQCE9KPLnBgpMXVkVhzaAnOIBc2tyrXmfN1YCw14LoXwuRei3l+LaBEtJdEGNLnMAxqhDGnlsaUpBLHkzAOkxXp2DdLWt+zMqdaAYWnYUZbl3hsqY24gDiHUJOZhI2RrUtF2HT34+wGQUBaIBg9i5yars4OpED3+WeIeoA9CQelmSPuxukYgORgPMAg+cAAKRwFoj0eiSfw+R6YtHk2IsNx54T6B0goeU9gbQNZtAGfmN07o2YQYnBAWkH9wdzcTnc4QH1MoCCD9Px2D4vIXK4eI+Zij06GPh4KkZwbLmLK2gGOM8fm2SmxnGewAzh7sAUfRID9SMPvgo+Ijj50FORQj5Owbkizgeuy+q+OU48gGAGKXUZMZ03+jk84XAh6x620pAfQwUDQ4SSYPKXAWoa2iARAzAKwaqKwQIrUF+P+lknG6sd2jgGQMBYAcBuiiBgQZkqB6Bb0Fgkgb0OBoBv+XAqBJsZA2YMgbWlYWSTEdAMCMk14h03IKwkgLBBBXA/+gBY0AmH+tstwaIqwEhoknGABU8kBocyB7BpSnBU8PB/C/BtAgha0h0ihtwFguBl+kh725WiAHBdQ+h3Spg/BGKO2LsLYaIMwb0HEAMbBI0XkdEB2jCM8lQECpgraYAtEHsJGrGYAWo2EAAIuPJvJwE7OWjAK4AAIScDJGKBkBZEQqV7V6x65EpHpLBFMJhExpnpgA5F5GbxZEt4n4OKZgdQcR24O6FhO4v4raobqYYaULn5tG4Te7JCwRcAZaBFbDxBM7MDxCP6ECDACQxETEb4njqQzFzELH6hLErGd7hDMAYD9GFjqS96npqZ04nFagZY9AOJL72RHEnFZ457x7B5N5h4PEr5r615vGJ4fHNEZam7HGZ5+65755F4l50SN6h4V6gGr415x717vHN5wJAlgBPGZ494wB94D5D4j5wBj4T7P6tjT7v5z71yL7FEImlHIDX6cC36KyEkP7ElT5v6z6f65Q9RwKtH2R+HvYBHqS0SVGhHhG1HRHAnPFxEJENHpLpEjTZFlH5GkCFFfFV40mHipCykngimcDVERGhD1HlEqnNG8kdQISiDvwoCoSRD0ogDICtq1AFh2bC6i4uYKDzz5APgZAhDMBlbua+Zrb1RKZMTy7NYmAPhMQkYSYBjdS7T7S6CrC3BppyAppIC5rpr4yLrZokpJoUz5pIA0weBYh0xcqMwhrEnQCCTPF+7b6WkwAmh2IYA9CJTEIBJcFTTM6pAibIBdRBjNytyfhagADUywX4rwf4nYsZ5YHaeAGpiC942EaeaA6ys2C8ve8I/WK0W0oc06mw+Q+ocGXGgE4i02PQa5p4mYxi4QvG848Ow6rs3SpAp8dZu+wilOV8B414I2t5RGvCD4IgB4QhoQdaU88yq666RyW8JmZma+7QWoMwAYQujmYuTE3SYA3Inm1WJw+Q4W6F+u9Zvm6FMwbWJs7QGQMwquiWuBWo28+5h56+b2lObi02cCpmQhMgGQx4VuFGLpJWqFEuoYVWNWVYMuCyjWCuLW0WHFVFyWHF3F/kClDWmwcAAYfWnuoxcABxXA1ipSgRqgqxXeLx/uulaAqQBeYePQplapJRmpDaNiqQ6gcCy5BxNaxltEpliAUJ1l1JPxqQnlnATlqebe6J7R9kbOnA7FzYnFSlvFxWIupWglWFIlvm/m4lYZiurWMlnWSW8lluil+VylWgql3YJ4Zuz4FupAVu14r8F0Vpn8a6yQdpRAFgGQywbVFgFgcZRKlIaI3IPqqZtIb0NKeAZGOZKweZHIVMSAQIRa9MwopaeA/JecekoMmk/YuQkMt04sMYcM2cMAJcPoaoFc8a9Bx0yaQ1uMmZ2whM90DK5gywk1fqzgMw7KxZ/InKP0waeAoaAqHMzS/kogqQusjkBs0asaZsFsVsNspAPstATsHhigrg7s5UHqYAcNCN/sSNKNnswcqSYcQCEcV40cMC+NkNYAlE1cfQtcrI7cM5XcegwCRygMPygiuS0EFoJAn4LSvYx45i/coQNuP6TSzNXAvC5CWSbNiO8AnNkiPNpV/N1uHEmYTNKcYtrNOS0tamXNANrSfNiS0igtyt8BhYotGSEtlCUtUEMtMgOt8t+tTSSSYAtVCZSAMwyw5Kg1p05KmgGaIAPN41j1ea01iAUw9w71X0813Kf0zMd6Ya/1eNWh4c48kca0McZNp1aqSaXtSwGZvt+MidSsgdT1LKqIqghaEdpZX1i1egv17Mgk54KdxNYA3AKc+AGNfsMeCgyNnAVNSKQEtN7aDN+gbdX4Zik+iCRN7ymdqwKZlKOM50+dQQjdl47yrdcAKg91uZwdr0Fhc1iE/gGRo12emdUw50OdhZ31jNU99CdgG9qQ8Uaw70qgtw3IQIkgFg2U1gtcT9Z9r979n9D439QEv9L9b9H9X9P9qwz9/9EDQDtcgdiIU1r0NMu0IQsAhI3wQkGkM4lE7Q1E0JlpzErEbA7EfJaxK1RM1ggRZoWkW1t15QBk9kUeLQlOqCq042Gm1tMEYQx+1oVS7yZkdOCg/WDUdkYkrkPQ3FGSD4cQlC14uBlDEsdKgUFkaNsU4qkq0qsq8qiqUwyqqq6qmq2quqUw+qhqxqpq5qlq1qD4JeFkYNnAywkUbUuBrlNGYJ9QN9A8d97dUJSjjoPNRopBpNWhGQK9qd1469+AuB/gE+ogSAoAgQ8ga6oQeAh4IArgrgQAA=="}
import { Hooks } from 'wagmi/tempo'

const setAdminSync = Hooks.policy.useSetAdminSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
setAdminSync.mutate({
  admin: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  policyId: 1n,
})

console.log('Transaction hash:', setAdminSync.data?.receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `policy.setAdmin` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/policy.useSetAdmin.md","from":6822,"to":7338}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const setAdmin = Hooks.policy.useSetAdmin()
const { data: receipt } = useWaitForTransactionReceipt({ hash: setAdmin.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
setAdmin.mutate({
  admin: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  policyId: 1n,
})

if (receipt) {
  const { args } 
    = Actions.policy.setAdmin.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `policy.setAdmin` Return Type](/tempo/actions/policy.setAdmin#return-type)

### mutate/mutateAsync

See [Wagmi Action `policy.setAdmin` Parameters](/tempo/actions/policy.setAdmin#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`policy.setAdmin`](/tempo/actions/policy.setAdmin)

---

---
url: /tempo/hooks/policy.useWatchAdminUpdated.md
---
# `policy.useWatchAdminUpdated`

Watches for policy admin update events on the TIP403 Registry.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/policy.useWatchAdminUpdated.md","from":150,"to":4753}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"c97041b0026ec81821f4e52786e61b498aaf99fd2e23ce80fa9483d396001836","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXGwm1hhRmroALLFJispIAGwamTp47Yyd/iZmSEUgtvaOfogjVdRetb4NAfR4AGYArmCOjBBgnCdwMADqomi2AIJQzKYAqlhQTzBQAB4AMJXI6MBQAPgAFFh7MwdGQ4AB+RCcYAAHWunGxK1MAEkoCjOGATswAEZkTgAHxuYFgYLMUAA3JjsdjMsjURisWy2dNOgSiWTwaYuDThQpRcgALrU4knGQyOVnen5Zms3lsk4/P6kIkAAwstAAJMARKRTApXPq5YaTWa0BbFNaZXKSYrlXSYAz/iyeZrRO9TAajabzZbrbbQw6nVb9a6ae6lTSVd61X7ea5ParGRm2UdSBBmAAhGQQaz8IUisBi2k530a7FXACipELetRUKhZHbqNb7YAlJwALwQzhECCMKBDlNen1QbNp3ONzjtGREx0nGCL+c79MrteWvE1shEUTr1Ek8mU2f1he3pcN/1XN4fMDfX40QmdqEc1EAdyeV4g3fHUvwAOheLQ4AoTgywUACgPwV8vjA/5wIAGQgBQh1HcdJ2nPdl39axQXBIkQTAMEFCIp9eXkUQyTkb9ODJPg5FEa4H13bj9zAVwB1RCcp0xMBRHhOBYWsbdbgeJCUNAz9/n8KBywQPQck4I52E4QDnnwS1VwgDoME4QM3xuNDOBgEgazgcD/DEBR1OQZAQDocSsDkfx9V8tA4FoTEQlaNFwkMTgswLItOAAckAhQPgAehoFoYsxTFTnONBLmuF4sCwKEh25bEcns/kMHA2THn0hSPz+KAoWKtkXxAuqv1/aCipXHErjgYyYHA+CoRigAFYyZlM8zTEspSoEQGLYI5AcV3cDUBPSrFSB0E5SGuAEoEYIgIWq2xDO00gzJAma/ns8DwIBRKDqOzFXExXz9RAaUKDc2FSmYfxfvEhFSDgTgAFpOBGuFgfsz6vpAaIJDSKxjGSYZEAKFHNCyPAqvk1q0KgOZ8kWYpVnKRAAEZYi2TAaj0Oo/EaQ49BhQscA4DAhxat82v+Ikuz/XT8d5wnIOg2D4MQmqCdmzDsNwsdhMI3jGRUtS8CBc8ZDJBx+E4NAIE4UwJ34bd/3weQzKMkzLosxhQe1OXuhiJB4nSOQhlSSnenGLRJj0HnUNm4mFkQAZlhKMp1gKWmdgZvZHKaVnAfhJwhyFprsXKglUQlUU82xJ3dVRO0w0dCN9ULu3TFL6Nw2dKuXpdpHJCWT2UiQX2Mn9oIOVD8wI5WUo1mcSm3A8bZ6Z8eok5ZkAYWh9O4Ow6XgNFuWsIUFvdEkAAOQZO/Dv2cb0eCB6QIeo9HxZVDj6fGf2Gh57EiSpO3UiwD6uRMTPC7P+/jAVElFAHq2sOpEAAAVS2nB9QAP6jaZg0AFTbiwIWIgU54DWzgCEOQnBYBkhOAoSUihODwLwcoJ4xtQY4I+DIcQBsjbKBgJiAAUqIM8ABlawFosBcHIdueEKwwAO2YKudBmCFxklMv+GAZJWKFn/HcEG4ENrQMEcgvBdBQj+QNv+I2kkYDWEYGCawZCixsDMHZRAG0ABUnAXiwJAQgsh9C4Cg3/IwZQnA06ECgDQk4tgzKgzgb1fqg1sKFX1LBUJX9wk9nYFEsydJYECPAoBXaSTKH8M4qxGSdwFyG10haGgjDkmmQAHLQAGgAKxoY6GA4lVFgHsY4hQZZdZKliYAm0phojnA/mRBQO1/hlP/CU7cRTkD6jQeWeA9kRCqROGgfU0ooT4DQGgLAcBECJUSpAWAdTwLsAUI9NSiV6E0BEGDIgBRejgVoIlUQWBGCJVmdJdx4ENnMBkAAYnefMxZEBlkZzpJiaZALPmLJ7Ks9Zmztm7P2dUo5JyzngIuTdNANy7kPKeS8t5hYPn2W+X8yF7i0CwDbAOcCnB1GcHaRATpqSwlyBtNYXJFIbgFN0l4wgyzjYtA4IZZhsCDlAIEYgzRA0NoAH1bG2MeLtS08qZWojpQyplAjOCMpqUYtAMVQa+OgKDcQ24zC8spAAh2NAawyAwJiOAGBzj4ELJAW4cFGBmwNjAskijlEOJGniUGzDTJbTuOSOQsFIAXVNd6mApkrUiHkGgO1mJRCOuda64FoMTBeu1tq5hF0qmwHAnUzg5pGnMHspwThMBJkwOmZAUpVxxFzPcZwPEiUADysKNlbJ2XssVKKtBorgBiq5WLbn3Mec815ZKvloB+b80QYMm0wDBlcMGZKwaXCHOdTESCtrGyouwZgTwcrNMxM2Wgnk8G3GFTAjV55mVxNZTYsAb1fJ1MxGkoaMVLaKiNvo0gMgoAxQHH6PZkMnT+VRABssul2CgdgkUoFyyf0soGn++DRsACkcAFqxWA6B8DkHErQdFDszgOHEMgagChgxFLgVoAw6+gaCTSBQjMP+Tg/ZEkxXuIQCA2zYJ9V8YZXWC47D5XkP8cDEHMRQZGjB0GHGfHzNENoZJC5ogVgNiPSZjHKWkHfVB7EfGTOcEE3wET5aiw6AMqQyT1Hnk4EZIp8jvIqHIBsueaUaQqaqA8wGLg3DeFoHAqQM4x5oEO0os/LgXHqmICIMwKmsQChUz3stMAZm2RUK7WSXVjhIvRbALFuA8XAicCS7AFLaXYgWEkOHbLwWvNcDFYgUUZAxIyAJW2sddAjHLJyogeI8QqaSDa/lrgPmzwyGlGDcZrmyAbAxgUab7IuC+ZkGFxgfCaude67tc8/WiWJSG9YEbVwxsjA2BYHLeWtvEmS8d3riUz2mAu/NmVDcEIFFiOHDaACOtAxHLFe4jAPQACVGV9KuDFP0aSMlgChPqAAIpxbQF1TSvxgK4AAhJwTHigyAE/1Ap3L5HlOUdRCT7HVmodKlh8KOJYAif07Jwx8tFKeyfv1Bta9t78kPu3PqZxrLXHpp2Rtd637zi9S4Mx8HWROENPEpw+zhB/yFSR4r6ybYVc6DV1tDXWuIA68pyDnxGAJfbmHMSGAPG0l26hMx2CPZKcHtt5hiJChho0eI2BynSmVNwZgIB2jyGynMe93bv3AeI8Ifw4RuKSHg9kYo9Y6jSegPp+57HsAzAfdsfAhxrjTveNtn49Z4TME7Piac4GFzMnGTyczzT7PyALOolr7ZsTDmJPN+k25/4X0yl84/Qrr+oP4Tg4E0zzgLP4dgER3H33KO0ec5x8APHhPidY7JxTjvYeD+k4upDmHcO2cc8P6QAn3PJ/vUcpplybk7i4CoMgPqO1pJrL7QinspKMoCcGSOBKRMwEiocmOmKolExIyolFOriiYGSIlGknUgOHDMID0EgJTJTO3GjKkIkD3KfMsJhhfIgN3MPNHM4L0PfN4I/HPEEFCEaoRPHkNBJHAJpjAESJxBgLBHdMcnwjlOeFDH9FRnwTKIJPhFODVgANSUzar1BliBiYFUCqTgJ4Cd66JFL6hoYrI8reLcbzADScAACyCo2UXk24mQpIyaoM7K1wnKsI7i/wsEni3izCGUjAIMXAskC46aca4iLA4gpknB3B2mZkHogYB02UVwz6/hwS5aoBIgXi12U+82W4NCLAUODCUyMyMGRwUIsQA4va8KiKZ6YA8QxyI68wJwjylRW63BY6lRsQBKooRw4EsQC6PyOWUIIqth8IdkZkR6+aLh3K+RI2Mg4E50Z6aAUS/+8KA6UBMAw6pyGhY6ly8Ak6OKM6+KUxPRfyUxsxTwJxWKS01KsuX6cArGIg5iZwXADuqgeupef6pEDxqIuGYGsE7xNYIe1Op+vxaAqI6gZS+htx4SbxwKNY80Px0JaA/xWesG9xMJnAoJqGTG6GYA70G0ta240yBxZxCxcK/aiKQ69kqKGx462x2K06eKryBxJKvyxxp6pxrJ5xnUWkOkh624pgZxF6L+zkSArkCMpg0k/gRAFg4ElM0pFgFgWBCMOBVMmMh86MEc2MAcxg2EFBVB18FM+B9Buws8zMzBqcwMGc0EXIB440Aoc0rE1YaA1cxcTgdc9of21o1cU0YArp5csYHpzc2Brs6WEcHc6M3cGpfc0EOpZMI8FMBQd88MpEsAzQOioUpUEUWkhYYicUmmSUKUbAaUU+pU4E5UlUdwJ0yEss9UjUGoQcik9UnYHIksCsI4Y4Wc5irxkSMUf4hGS0a0FAL0ahIAacogSAoAgQ8gOCVweA/kIArgrgQAA="}
import { Hooks } from 'wagmi/tempo'

Hooks.policy.useWatchAdminUpdated({
  onAdminUpdated: (args, log) => {
    console.log('args:', args)
  },
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `policy.watchAdminUpdated` Parameters](/tempo/actions/policy.watchAdminUpdated#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`policy.setAdmin`](/tempo/actions/policy.setAdmin)
* [`policy.watchAdminUpdated`](/tempo/actions/policy.watchAdminUpdated)

---

---
url: /tempo/hooks/policy.useWatchBlacklistUpdated.md
---
# `policy.useWatchBlacklistUpdated`

Watches for blacklist update events on the TIP403 Registry.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/policy.useWatchBlacklistUpdated.md","from":151,"to":4834}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"2b35d7c59b68fad10378a67e4629e5fec424fa0a78d71f66ebd0b164e0ee522b","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXGwm1hhRmroALLFJispIAGwamTp47Yyd/iZmSEUgtvaOfogjVdRetb4NAfR4AGYArmCOjBBgnCdwMADqomi2AEIyDvwmIgCqWFBPMCgAB4AMJXI6MBQAPgAFFh7MwdGQ4AB+RCcYAAHWunFxK1MAEkoGjOGATswAEZkTgAHxuYFgELMUAA3NjcbjMqj0VicRyOdNOkSSRTIaYuHTRQpxcgALq00knGQyBVnRn5Vns/kck5/AGkEkAAwstAAJMARKRTApXIaFcazRa0FbFLa5QqycrVQyYEzAWy+dqHNYIGc0EaTebLdbbfbI06XTbDe66Z6VXS1b6NQH+a5vermTmOUdSBBmG8INZ+CKxWAJfSC/6tbirgBRUilg3omEwsid9HtzsASk4AF4oZwiBBGFARxmfX6oPms4Xm5x2jISc6TjBl4u99m1xvrQS62QiKJN+iyZTqfPG0v7yum4Grm8Pl80L9/jRid2YVy6IAO5PK87xVp+34AlAAB0ACCWhwBQnAyBACjAaB+DvhBjA/Hqv4wQAMmhI7jpO06zgeq6BiGYAQgoJJgnRkJUS+/LyKIFJyH+nAUnwciiNcT77sJh5gK4Q7olOM7YmAoiInA8LWLutwPJh2GfLhX74YC/hQJWCB6DknBHOwnAgc8+DWrx4GaSINw6ZwMAkHWcAwf4YgKIZyDICAdDyVgcj+IaIVoHAtDYiErQYuEhicHmJZlpwADkIEKMwjAAPQ0C0yXYtipznGglzXHBWBYDCI68riORuYKGAwapjyWRpkE6VAMLVRyb62W1P6AgBiFVWueJXHAEByDBqEKDCyWtVpDn9VAiDJchXJDmu7hahJ+U4qQOgnKQ1xAlAjBEFCzW2NZpmkDZH4Lbq/VuTBMFAplp3ndirjYiFhogLKFC+fCpTMP4wPyUipBwJwAC0nAAAoIpDbn/QDIDRBIaRWMYyTDIgBS9OMWiTHoTXqb1WlQb+cz5IsxSrOUiAAIyxFsmA1HodR+I0hx6HCpY4BwGAjj1914UtJI9oB5nk2L2lLfBiHIdNGEtRT4vQURJFjhO0mUaJzJ6QZeAgpeMgUh8nBoBAnCmFO/C7kB+DyJwoh3Th9m4YtmvdDESDxNIONDKkTMABxE1keCix78vQTTCyIAMywlGU6wFGzOyc3sHlNHz4OIk4I7S11uL1US6JSuKRa4o9+rog6UbOjGhrV671ghmG9fxtGrot2u+3Rmsy28fxMCCQGri+5jTMWNjcjB0ghMZMTQRcvH5hJyspRrM4BSsx42wcz49Q57zIBwkjhcoWhqtgXLVOAlrChT7oM9jEHKRIEnmiR3o03r1/em29GYFDcAfdm3gub7BoGfOSCklK7louNOQ2ILy3SQRNGA6ImLINwFQfS1hDIgAACrO04IaDBcg7TMGgEqXcWBSxEBnPAV2nA4AhDkJwWAFITgKGlIoTglDdzKCeLbaG7CMrvFutbK2ztsQAClRAXgAMrWCtFgLgQjOCIhWGAXCzB1yMOYUuCkGBzIwApLxUsQE7hQxgrtUhu4aFQDoU5WgoQwpWyAjbRSMBrCMAhNYQRZY2BmFcogXaAAqTgcFyE4MwXaaw7w4DQyAowZQ2idCECgOIk4thXbQwoWNTBU00KVUNMhIpYBcEwT7OwcprsGTkKETBECR0GkiM0YJXiKk7hLhkUBK0NArY20EmYgActAGAMEABW4jnRj2YPYsA0TYkKFQhbFUVTcF2lMNEc4iDwSQkOoCEZ5khnCJtsgQ0DDKzwDciIfSJw0CGllDCfAaA0BYDgIgTKmVICwDmTBdgCh3oGUyu8GgIgYZEAJjBWgmVRBYCyrc5SKSYIfOYDIAAxKi+5jzQxoCLgybE1y8XoseX2V57zPnfN+f8qZQKQVgsIRCgE0LYW9HhYi5FmVyVuUxTi/llKOxDhgpwRxnB1kQE2c04pVDBHdKpDcPp5l0mEGebbFoHBrLKF3IaAFWChHUNoZNXaAB9SJkTHhHWtFa816JJXStlVomVMy/FoGStDAu2TobiF3GYdV1IkFaXkGgGQGBsRwAwOcfApZIC3BQowB2sjdwUmsbYmJ8MCTQz1WYgeMBKRyGQpAW6/rU1mJDSIMNEbsSiGjbG+NoZoYmBTWbTgEA9W3UmbAWZ8z9ryTcpwZRMBhFkOuZAYZVxDF3JSZwAkmUADy1KPlfJ+X8w1TKtAsrgGyqFaAYVwoRUilFpY0UCrQFi7FogYaTpgDDK4MN+Uw0uCOG62IaH7VtnRdgzAnglWWdiVstAAqcNuLqshzrLxyuqQkiJYAfohTmdiFp01ZrO2VDbbxpAZBQGSkOAMfyEYujCuiDDqFzLsFw8hGRBLnkofldMtDyVyM2wAKRwFWilbDuH8OEcysR8UPzOCscozhqANGfFoCeWgBjsHJp1NIDCMwQFOCDnqcle4hAIDfOQuNH11kLZLjsOVeQgJ8MEexER+GJHoaKcySk0Q2hGlLmiFWK229LlsOk32eDRHcTqdIOiLTfBdNsLLFkwzohjNIpwMyKzAn+SiOQM5S8so0jM1UAloMXBVHqLQDBUgZxTykNwkxGBXBlNTMQEQZgzNYgFGZqHDaYB/MclEYuik7rHCFeK2AUrcByuBE4FV2ANW6uxAsJIROzXstJa4IaxA4oyByRkHys99zMp0D8c8kqiB4jxGZpIOb7WuApYvDIWUMNBmxbIBsfGBQTuci4KlmQeXGAaJG4t5bR1Lzrdnbu7b1hdtXH2yMDYFgWttee6SarP3VuZT/aYLbF3zU93QnvROu0kELYhmOFK9xGBegAEoyr2VcZKAYWltLADCQ0AARQS2hbrmjgTAVwABCTgjPFBkA54aSzrWBM2aE+iHnzPOCE5J2T2DYAufi755J7zsAOyIcNLtYDoHekQf1fEhVST60/N2r9ZD5wxpcEJfjrIyiFnyWURFwgQFKpU/N05DsVudA24Hcwe3iJHfO7k/ZZgGA9e7lHKSGAqmWmh5hIS5CfZBcfpD4x0pM0WMwEw2J3jgvrO2bIxnijPGJNnMJUn0Pqf0MF/Y5x5CqUqN4Zz8LvPImq9Z+LzI0vYBg/l8U8pyPamOwaZCzppC4WDMCKMyJ27zILP8cE+EzgyBAvBe02F/TkWJ/Ran6Z5kAMzl9mx67tn+PNNE5VKT0UsvKdl5TzTunCuWfADZ5z7nTO+cC7nyLhfD/Jdn84Bf8nOXV/XnUgDnJXA/MAX6DyJzbyXyO4PBEAZAcaQ6ZSN5VdOlP5aUZQE4CkGCEMZgBlQFXdQ1TKLiGVTKTlblEwCkTKFpOZIcVGYQHoJAJmAoOeXGVIRIZeX+ZYRjABRAJeLeVOZwXoDOI+KBU+IIGEH1aAEccvNDBSOAJzGAEkMZZCF6YFDREqS8RGEGYTMZOUSSciGcEbAAaiZg7XqFQmiwYPwWNj0C/08RkUNDoxeTVQyRU3mGmU4AAFklRipApdxMhyQw1oZrAlV6FDdARkI0kMk9UCpGAoYuBVIlx61U1DEWBxAzFFDlCXNXYvRotTpiorhoMUiCk2EcCRB0kQcEMwALsdxxEWAidxAzkyUSMjgYRYghwV1aV6U/0wB4hgVt15gTgEV+in1lDd1+jYh1txQjgYJYgMVL0ZAWsYQ9VXYtAQjXINigivR4QUlTkZFrldsZAYIbo/00Byk0DaV11CCYAt1QUCFd1IV4AD1KDj1eUTilir0Tjzing/iD11oxVjckM4BA9NFQw6x8dVAXd5MmMylkoO46x0Q2M8NkIkSiVP9m8MT0R1AzlXDA8SlmMcSuMMTG959SNglO5OA8TaNpNO9fpdoR1dxjjipTiASriaU116VN03JmUni91XjD0uUPisovjBVsVfjf1/jpTAShoTIzJP1dxTAASANoCvIkAfJ0ZTBlJ/AiALAYImZDTZ5GD0ZmDmYChw4P48Zv4Jggh/48gE5BCU4d4WD05wFM5j5uYDgpD85IYi5EIeQjwJoZgMBy5eJaw0BW5a4nAu5HR0dbRW5gxIS0A4zG5ExEz+5XirQh4K5R5x4voX4WDegmZBhP4BCI4SYQA15HTzBnSGY05VBXA0YQxYBmgPEYpap4oTJSwDFUonMMpspC02A8pajaoYJ6pGo7hLosJ1ZY5fxOotRo47J5zARuwuRlZtYyIS5gk4SK9kpAIuN1ptoKAvpbCQAC5RAkBQBAh5B2Erg8AwoQBXBXAgA"}
import { Hooks } from 'wagmi/tempo'

Hooks.policy.useWatchBlacklistUpdated({
  onBlacklistUpdated: (args, log) => {
    console.log('args:', args)
  },
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `policy.watchBlacklistUpdated` Parameters](/tempo/actions/policy.watchBlacklistUpdated#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`policy.modifyBlacklist`](/tempo/actions/policy.modifyBlacklist)
* [`policy.watchBlacklistUpdated`](/tempo/actions/policy.watchBlacklistUpdated)

---

---
url: /tempo/hooks/policy.useWatchCreate.md
---
# `policy.useWatchCreate`

Watches for policy creation events on the TIP403 Registry.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/policy.useWatchCreate.md","from":140,"to":4682}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"410c78052455bb6978da5eacfc5719ebc1462a6449aaa6683f5090198fea83d5","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXGwm1hhRmroALLFJispIAGwamTp47Yyd/iZmSEUgtvaOfogjVdRetb4NAfR4AGYArmCOjBBgnCdwMADqomi2AMKkME8wADwvV0eMCgAfAAKLD2Zg6MhwAD8iE4wAAOtdOCiVqYAJJQWGcMAnZgAIzInAAPjcwLB/mYoABuJEolGZGFwxHI+n06adTHY/EA0xcUk8hR85AAXRJOJOMhk4rOFPyNLpbPpJywUE+pGxAAMLLQACTAESkUwKVya8XavUGtBGxSm0Xi3FSmXkmCUmAK1mcVzOuVU2meo6kCDMABCMgg1n43N5YH5ZN97v9bKuAFFSEGNXDgcCyBm4WmMwBKTgAXkBnCIEEYUGLpNlrvlPobfsVKPaMmx1pOMCbbqgvflSfZEClxvRsbIRFEHbhuIJRLrLr7A5bnquAAURzMMG8PjQsVngYzma2lRyMJi4YK+UOlTdVeq4QBBKBQd5wOC3pWYHBwzcdDAABUvC/dxOHDBQ4QAdyeV53k+AA6AAZCAFGLMsKyrGsV0TU9rD+AFsV+MB/gUHCPTZeRRHxOQD04fE+DkURrkXBN+1Y5tcLAVxCzhStqyRMBRAhOAwWsHtbgeWD8F3T5/CgCMED0HJOCOdhOBg558GNThz04ax4LQS5rhgEhYzgBD/DEBQlOQZAQDoYSsDkfxNTctA4FoJEQlaeFwkML1VKDZhOAAchghRmEYAB6GgWlCpEkVOc4jKuTgnywLBgWLFkURyCzzwQyTHi02SaGBXL6Q3LdOjK90jy0OActPVErjgEcYAQiDgVC/9t30wz3UQUKKE4RlC1PdxFR4xLkXeNATlIa4vigRgiEBErbB0tTSF0mqMAGvdjIQk6vmi1b1qRVwkTczUQBFCh7LBUpmH8Z7hMhUg4E4ABaTh13BT6LPuh6QGiCQ0isYxkmGRAAEZenGLRJj0YrpLquZ8kWYpVnKeHYi2H9vDqPxGkOPRQSDHAOAwYtqoAuq6OzY8NPRwaEKfRrRog6C2b3TqULQ0ty347COL7eTFLwF5pxkfEHH4Tg0AgThTErfgeyg/B5DGvaANV76DP5qBLOEHpRmkaGhlSOH0k0LI8Hp7dGcxhZEAGZYSjKdYCkJnY9BJ/YaHJkBQUBpxixZyq232y96JjNAvxVNUnGfV930/U8ib/fbgJwf1XG6GIkAADkSK2UiQRGMmRoJGVd8wPZWUo1mcApKg8bYagDvYrKaCn3ohCPwNQ3nSvZwWi4hyQPbka2kA9+2UeMVCG4XnGW7xgpNk7ondnqPuQ6EkSxJ7fCwHauQkSnXbz8vmA4WI+/JesJSQEA7XOE1O+OrNZhoElD2LAQYiDVngLrOAIQ5CcFgPiE4CghSKH0m1DqSs7BcEYN9SBUUZDiCVirZQMAkQAClRBTgAMoGUYFgLgP9oEQhWGATBIVgHEDAf2fEB0oIwHxPRIMUE7hfQQrND+PZ/5QEAZwOgoQPJKygirUSMBrCMH+NYZBLQzDmUQLNAAVOlL+T9f76VwR+DSjBlCcCHoQKAWCTi2DGt9b+KC5BdVQtlTUo0nEXw6ghXM7B3FjXJF/OhnUYJLQCcoJ4+lmL0QkncfsysNJGhoPgwJB0ABy0BOoACssHWg+MwYRYA9FPk4AocM8tpRePvmaUw0RzhnwIgoRa7pUlQWST2RJyBNSsPEh+BCIgFInDQJqEUwJ8BoDQFgOAiBorRUgLAXJCF2AKHOopaKuCaAiB+kQAovQEK0GiqILAMVenwAshM5gMgADEZyPyDIgMMyO5IkTdLuRZQZuZRnjMmdM2Z8yslLJWWs1+GzPjbN2fsw5xzTlBj6RctAVzblwvOZ89MhYEKcFEWUip05gnOJgGaawMTCQ3HiWY5QjyMEtA4DpQhX8FkPxCX/ABLjZoAH0dE6MeEtY0XL2VwmxeUiAlTkHeOgSK7JSi0ChW+lY6A31xA9jMOY7Wt82qYJoLGGQGAkRwAwOcfAQZIC3HAowDWaCez4n4YI9K650TfUIQdd8MACRyFGpAXaSrLUHTvpq+QaAdVIlEPqw1xrHnfRMBa2WnAICEN2pk2ACFcmcENAUiynByEwE6Z/bpkAUlpXeZwdE0UADy3yJlTJmXMxlQKtAgrgGCrZaAdl7IOUck50V3kIUuTc0QP180wB+lcH67yfqXGLDtJE/93iqxIuwZgTxjqzRTLQJy0Dbh0s/sK0V1Tf7aLADdNyuSkQhNcQoHq2spQq3kaQGQUBQqFn9HM/6NoPJwiveGDS7B72jUSQ84Zp6CXnsvTAa9nAACkcARphVvfex9z7oqvr5DMzgn6b0/qgH+hRaAhloCA+KzqfjSDAjMFBTgBZ/GhXuIQCA0zRrtSsTpeW/Y7CZXkO6R9T6kQvvXG+76xHLHnNENoQJ/ZoiRiVi3TpOHYDpgPS+lElHSBwho3wejqbgw6G0kgljaHjk4CpDxpDbIonIFMtOEUaR4aqGM0qKJlCjQ0IQqQM444P6YOIsHLgpGsmICIMwfGBR4YlwmmART9IomlvxFKxwLm3NgA83ALzgROC+dgP5wLsQLCSHdqFuzpmuCMsQHyMgQkZBdpRR+aKdAlHDOMogeI8R4aSAK5Frg5mpwyBFD9dpBmyAbEQAUAobWGRcAszIRz1CfPFdK0taclWIznJq7QOrqUwCNZGBsCwYWItjZxH5ub5XoqLtMDVrr7LDTGiG7Ed2s075FY+qWMK9xGBOgAEoirqVcUK/oz1hLAMCTUAARZi2hdr6mPjAVwABCTgoPFBkBh5qbj4WkN8ZQ3CBH4POCvY+197xYA4fY6R9h1NuHcxHs1CutdrAN2QKQfSzUhi5BEpMTM2at0T3nDalwKlz2sjkPycJchWnCBQWyn93nUj0wC50EL+CzBRcQnF5LgjIhLE7gJc9sjYr74IRZzAYEVLRq5lR9OrXhGQOhXQ9+u9D7Ue8f4x+sDX64NYdSVSi3hvre26gzB8KmGEN2Yx1otDruMP27J17sAzBLf6+I6RmA5HlM9TU3RuADGtPKGY6IVj/WqRccQ8hsPyBlOqdoxpxj2nc/5/Y1SB6qTKeHp5xfR7EJnvUbe9KT7PJCe/e98BgHQOScQ+AFD2H8OwdI5R8X0P76p+I92njnvBP2pE8X+DmHZPm+3SsiJ2y9k7i4CoMgdqi1xJjMrX8uZQplAnHxAhfCzAAWLMbYy6KNERXRUhe2kw+Jooz1clCwQYzZi54YLBy455K5GskYHY9AQk15EBq5m5vZnBeg/Zu4fAD4yYghgR5VsIfduoRI4ARMYBsRmIMBRoTplkaFjJpwAYXpUNKDRReJMJqw0sABqOGWNeocMPPEAqgBSV+PAefR1FWTUADEZClfAHEZPeYTqTgAAWUlCMmch7EyDxADUNhJSARDXiVGiglVUtSSkYC+i4Ekn7BDUtV0iNEXVIAOhILILEzGidDz1WnWzxUsIcVTQfxEHMXqyuGvmnG7CwRYDezwS6R6TfSOGBFiELArV+X+UXTAHiGWXrXmBOEORSNHTIMbRSNiEqz5COAQliB7URRkDC2BHpU0IhHMjGlnRjTBA/FaSiPqxkAQh2kXTQHcSv1+WrVfxgDrVWWEMbU2XgBbV/2hU7XaPKKRXaK6KeEWJbXGgxU52PTgHV1oUeVjGe1UClyt26lCnwjODQDhAgwfVGhONjEd3R2d2QVOLhHUFSSkPVx8SOOuLOJg0+NuJLwX0+KeLJ1eLAFulmizR7G6VmOWN6J+SrX+VrQsmBVGKbQmNbShQ7RilmN7WuQWIXSWLxJWMaknXUhnR7FMGWOOn3xsiQDsjBlMHEn8CIAsAQjhhZIsAsFALBnNnhltkGBgMXgmCCAgiQJQK9lbiQDhl9l3n9mwNJgODwMHk+kjkahPE9HPDjmvFjCTgfFTnSnTnOS/Gzn+lzhAiuinl0ElJLj5NhmriXjrkahFI3jQMWFUFcFBnwlgGaBkT8nykCkDGDFgxEyilildTYAShb3ygQkKjRnHn5gqkVCdlqkGigCzEZG5lQnQnLGjj13eLcVCmPBg3GmmgoCukEJACHlECQFAECHkEgSuDwA8hAFcFcCAA="}
import { Hooks } from 'wagmi/tempo'

Hooks.policy.useWatchCreate({
  onPolicyCreated: (args, log) => {
    console.log('args:', args)
  },
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `policy.watchCreate` Parameters](/tempo/actions/policy.watchCreate#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`policy.create`](/tempo/actions/policy.create)
* [`policy.watchCreate`](/tempo/actions/policy.watchCreate)

---

---
url: /tempo/hooks/policy.useWatchWhitelistUpdated.md
---
# `policy.useWatchWhitelistUpdated`

Watches for whitelist update events on the TIP403 Registry.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/policy.useWatchWhitelistUpdated.md","from":151,"to":4826}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"2c18a2554a7d5904a09f15c11717794915bec94d2536640e09fff9a27cdf3002","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXGwm1hhRmroALLFJispIAGwamTp47Yyd/iZmSEUgtvaOfogjVdRetb4NAfR4AGYArmCOjBBgnCdwMADqomi29/iMNCYiAKpYUE8wUAAPABhK5HRgKAB8AAosPZmDoyHAAPyITjAAA6104OJWpgAklBUZwwCdmAAjMicAA+NzAsHBZigAG4sTicZkUWjMdj2ezpp1CcTyRDTFxaSKFGLkABdGkkk4yGTys4M/Istl89knX7/UjEgAGFloABJgCJSKYFK4DfKjabzWhLYobbL5aSlSr6TBGQDWbytQ5rBAzmhDcazRarTa7RHHc7rQa3bSPcraaqfer/XzXF61Uzs+yjqQIMwAEIyCDWfjC0VgcV0/N+zU4q4AUVIJf1aOh0LIXbRHa7AEpOABeSGcIgQRhQUfp72+qB5zMFlucdoyYlOk4wFdL/dZ9ebq34+tkIiiLdo0kUqkLpvLh+r5sBq6vd4wT5oH5/GhEntoU5NEAHcnheN4PkYb5dX/AA6ABBLQ4AoThKwUUDwPwD8oJgv8ATggAZCAFFHCcpxnOdDzXANgzAcEFGJUF6IhajXz5eRRHJOQAM4ck+DkURrmfA8RKPMBXGHNFp1nLEwFEBE4Dhaw91uB4sJwr9oJ/WCAX8KAqwQPQck4I52E4MDnjeRQLMgrSRBuXTOBgEh6zgOD/DEBQjOQZAQDoBSsDkfwDVCtA4FoLEQladFwkMThc2LUtOAAcjAhRmEYAB6GgWhSrEsVOc40Eua4EKwLBoVHHkcRydyBQwOC1MeKzNO/X9/igaEavZd87Pa3Sus5ar11xK44AgOQ4PQ6EUra7THPwqBEBS1DhvXdxNUkgrsVIHQTlIa5ASgRgiEhFrbCtUzzJA/qFp1fD3LguDASyk6zqxVwsVCg0QBlCg/LhUpmH8IGFMRUg4E4ABaTgAAV4Qh9y/v+kBogkNIrGMZJhkQApenGLRJj0ZqNLuvDOrmfJFmKVZykQABGWItkwGo9DqPxGkOPRYRLHAOAwUc+s/AaluJXtgIssmRe0jr4KQ7zUPQzDWvJnSlqIkiyMnGSqLEpl9MMvBgSvGRyQcfhODQCBOFMad+D3W75E4URbJlhzoMWzqPOEHokHiaRsaGVIGYADkJrI8GF3D1cpvIFkQAZlhKMp1gKFmdnZvZPKaHmwYRJxR0lnqcQawk0UlMVCxxB69TRe1IydaMDWrl3rGDUN67jKMXRb9dTYgECAQrgSYCE/1XG6GIkAZiwsbkYOkAJjIiaCTkqYTpOVlKNZnAKZmPG2NmfHqHPuZAWFEcLtCSJViD3dj+DiIUKeMdnsYg5SJAk80SO9HQje5gt4p13osNwh9WbeA5vsGg595KKWUnuOiE05BYkvKQTgyDJowDRMxFBuAqAGWsEZEAAAVfAe4DRYLkLaZg0BFR7iwCWIgs54Au04HAEIchOCwHJCcBQUobLUL3MoJ4tsoacMyjIcQVsbbKBgFiAAUqIS8ABlawlosBcGEZwBEKwwDQWYBuZhrDlzkgwBZGA5I+IlhAncSGcEdrkL3HQqADDnK0FCOFK2IEbZKRgNYRg4JrCYNLGwMwblEA7QAFScAQpwA0eDsG2msNIuAUMQLvHwLonQhAoASJOLYF2UMqHjWwdNEiVUDSoVKWAfBcF+zsCqS7ekCThFwTAodZpojtFCT4qpO4y5rYWUtDQWRLSLEADloAwDggAKwkU6MezBHFgFifEhQlZzbKlqfg20phojnCQWCCEB0ATjJAqMkRNtkAGiYVWeA7kRAGROGgA0MpoT4DQGgLAcBEBZSypAWACy4LsAUG9QyWVpE0BENDIg+M4K0CyqILA2V7kqXSXBL5zAZAAGJ0WPOeSGNARd6RYluQSzFzz+zvM+d835/zAUzJBWCiFxCoX/FhfC3oiLkWoqypS9y2K8WCupZ2YccFODOM4JsiA2y2llJoZgvplIbiDIslk4ltsWgcCuvIhJQKcHCNofQqaO0AD60TomPEOlaK15q0TStlfKnRcq5kBLQClKGBc8lQ3EHuMwWSqTIO0vINAMgMBYjgBgc4+ASyQFuGhRgDsrYUJsYPexcS4b4ihvIixe07gUjkKhSAGD/WppgBYkNIgw0RqxKIaNsb40hihiYFNptOAQHkRg6ZsB5mLL2gpdynBVEwBEWm25kAxlXGMQ89JnB8RZQAPK0q+T8v5ALDUsq0GyuAHKYVoDhQipFKK0UlgxUKtAOLcWiGhlOmA0MrjQ0FdDS4o4zKkCxHQvatt6LsGYE8UqqysRtloIFbhtw9VpudVeBVdTklRLAN9UKCysTtJmilChSoba+NIDIKAKVhz+gBfDZ04U0RYcrBZdg+HULDKJa8tDirZkYcozbAApHAVaqVcP4cI8RrKpGxR/M4Gx6jeGoB0b8WgF5aAmPwamo00g0IzAgU4EOJpc1CAQF+ahCaPqrrm2XHYCq8gASEaI1iEjcMyNQyUzk9JohtAtOXNEasVsd7XI4TJ/siGSM4g06QNErw+C6Y4aWXJhnRDGZRTgJkVnBN8jEcgFyV4ZRpEZqoBLgYuDqM0WgOCpAzhnnIdBZisCuAqZmYgIgzBGaxAKIzUOw5stJa4Eu8k7rHCFeK2AUrcByuBE4FV2ANW6uxAsJIROzXWvsjEYaxAYoyDyRkAK89jysp0ACa80qiB4jxEZpIWbHIuApcvDIGU0NLmxbIBsPGBRjsuy4KlmQeXGBaOGwtpbh0rxrbnXurb1gdtXD2yMDYFgWtgH83NrgX3zw/dWwB0wm3zvmp7hhfeicdrINh+DccqV7iME9AAJTlQcq4KV/TtM6WAaEBoAAiQltAYLNPAmArgACEnBGeKDIBzg0lmoeCZs8JtEPPmecEJyTsn8GwBc/F3zqT3nYCdmQwaHaoHwMDKg5QpJSrUkNr+TtH6qHzjjS4FqscMqdCqKWQpVREXCAgSqlT83zlOz46yLbwdzAHcIidy7+TDlmAYD13uK3qnQkKdmWH6ExLUL9kF1+0PzGKkKFmmJ3jBHBfWdsxRr8VGs9K+JcnsPaeM8F441x1CaUaPZ4E0JyJonK/ido+MkvYAQ9l6UypmAanAuzRCzplC4WDM2SM6Jm7TILMN5F035AgXgvabC/pyL4/ouT9M0yf64z+zY7d2z/Hc0ifKlJyKWXlPS+p5p3ThXLPgBs859zpnfOBez7z8/3nGCpen5lxNOXn+zOHOSue+YAP0nkTmPkfkdwBCIAyAE0B0KkHya6DKAKUoygJw5IcEwYzATKwKe6hqWU3EcqWU3KvKJg5IWU7SCyw4KMvs08jMBQ88OMqQiQK8f8ywzGgCS8tMO89MvQGcx80CZ8QQ0IPq0Ao4ZeM0ikcATmMAxIQkGAqEz0oKWipUV4CMwMImihsoUkFEs4w2AA1AzJ2vUJWNFrQYQkbHoHPt4sMgaAxm8hqsoCSH3vMLMpwAALKKglRBR7iZBkhhpQzWAqqMKG4AioSZIuHyKFSMCQxcBqTLgNoVrGIsDiAWIyFyEuYuyejRYnQlRXCwaJHFIcKYEiDvDA5IZgDna7gSIsBE4yLDIUpkZHDQixDDirr0qMoAZgDxCgo7rzAnBIo9HPpyF7o9GxBrZihHBwSxBYpXoyCQ7Qj6oBEIhuQuw/odpwjpLnJNEGg7YyBwQfoAZoBVLIH0obp4EwDbrgpEJ7rQrwCHpkEnr8oHHzHXoHHHFPBfGHrDQSrG4oZwBB7aIhj1j46qCu7R7l4pQdz1hojsYEaoSwkkrv6i6hKdycDqDjKOFB7lIYbIkrRImgkonZa2EiYEmYlK44lgGhQ7Sjp7i3JvE/FnF0rrqMpbruSsp3H7qPFHo8ovHZRvHCq4qfH/rfFim/HITvrmTfp7imA/FAYQHeRIC+RoymAqT+BEAWBwQMw6lzx0Fox+yMHhyfy4w/wTBBAALxzmDLzbypzOAMzpwQKZwnycwHCiH5wQxFzITcjHiTQzAYDlx8R1hoCty1xOBdwOjo42itxBjEmRmNwJgxn9zYZDzLR8SjzjyfSvy6AMy9AMyDBfyIDLy/zEwgDrzWk8HJx0xpyqCuCozBiwDNBeKxR1QJSmQlhGJpROaZQ5QwB5Q7R1RwQNRNR3AXTYRqxywAjdSajRz2SPzDzDachKxazjiTglxR71IYbATcbrTYibQSSWEgAFyiBICgCBDyCcJXB4DhQgCuCuBAA=="}
import { Hooks } from 'wagmi/tempo'

Hooks.policy.useWatchWhitelistUpdated({
  onWhitelistUpdated: (args, log) => {
    console.log('args:', args)
  },
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `policy.watchWhitelistUpdated` Parameters](/tempo/actions/policy.watchWhitelistUpdated#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`policy.modifyWhitelist`](/tempo/actions/policy.modifyWhitelist)
* [`policy.watchWhitelistUpdated`](/tempo/actions/policy.watchWhitelistUpdated)

---

---
url: /tempo/actions/policy.watchAdminUpdated.md
---
# `policy.watchAdminUpdated`

Watches for policy admin update events on the TIP403 Registry.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.watchAdminUpdated.md","from":148,"to":5138}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"00763990b98b4efbcf9bd7321d9ba2c95d1dae5db8d2d85db9dc52b8f2ca0034","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGcNjmXgYfEVGQ1Un1JDNaitAEGEWMMV0nqIRnM06sxAAJkqCMwXJ8s1KNH5IASa34uM4wPs3CgzAsAFUsFAtjAoAAeI5ZAB8QQ6yVS/uSFGFjmYejIcFSNOEADoVWKkw78E6XWB3Z6aFAkwAFaOx0hwP3FJQBiJ7A74I4nYYXRRoG5oO6PLy5MDiGNwLBOGD2utZt0er1QUpQCC8BAGfYg+CcBLsYUQUUYTjiZ0WVbjmicGCXNBwJPm8RKOfIZAgOi9rAKUoAAxfJ9ygsKwGipBgXvDSkjfA0DQLBOFcZdSAgZhOAAcgAAU2JQXQAehiH8YPfTFP04GhMTAiCoNghCLxQtCYFQhwLDgDC8iwrgv0TOB8ISSDoPgxDSPYcjcLYGjciWOJK04ABeb9fxof8gmAXJOGiSjhFSZAeIgB54DQSw0AAXQoGScKGYQChPVJpLAWTZKUmBMSTRgoE01IgJAoIIh00ywJc1wIlyfjYlWDY6xEnhbRMFN11VDB0xHHcc33b1g0rSMTNkoRR2ivNvVSEIdDgSM5AgJQomEgNOESsylnXGAk1ypQghgwtQrFLcor3NKoEQGDI1aSJdPcXIPNyF8nxAbSbwHIZmFKEMlE4ABadJKzPYaQFG3tSmWmMRiY2bizG0tTyGigbx/dt7lMbhlxtYxTLQCBfLgFYACM4F4UhGHuocWMI1QhyPFsFu0soCT6axKnkOofkQXoKUVQIMxS3MJ3VSFoR1FxNV6I0kVNVELUCEIwkiIphEExJQzmkmclowzCc6URAYhvU9VBsk5T+KkDEmxGGWR4ZUcqcYOWNbwUV5HG8CCLBIJwDgMCiZKovh/MMs61JYflmKC24LKcrylXIuzBXvSTAAZPKCqKogIBsqcZznEA0lCOR7qcABrHCbosC3naHdZ8EULc1w3Rrs04RgmJWdWz1pyUIYhEGvllCG48pJUQDl/X1c5xA4+1HnRj1DGTWF810QMcWSxGKJleK3TZNTDAAElWs4e7kgsNAAG4a+ar1SFSJ9rFoAASYAxBe5RXCfTvXNk7dsz7gfh9HiwlAnqfXAlN5ej5pmE6T6G8E6zPs8GXO+nUAuhZ5YvLTLnaK84KrdZBOGI5NpQN/0XoAFYv538HGWToEKqR9uawiQHqCEF9phX3mIEHsfYBy8CHGVBQuQiCSEJnAcqYYTDlWtrOPADxfacCfCgmAT5ODMGgCsBQwpIJEBskucQnA4D5FobAe6KwlBKGXpg8qOEHBcFDiwlgjA5AYOugImAuQABS4h0EAGVnqMCwMTLBtCYzMjyHAaCEtiCMKgM3Tc6wYD3WbpBdYcA4xJi8o8YhVCoA0O+rQQyTE0DrBuv2GAvBGBJF4EUTElhjjxlsQAKh4CQo46jyHRHEXAJi6xGCqEoXoQgUAmJ3XsFuJipDcEKEqnlJyT5Iy5OEOVJMZBIKkCKVuMAhjSnRIivcGpqgtjRHEKZN6qwrGGMkesF6B5JEdM3AAOWgBVAAVhkk4v5mA2LAOEs6ShcpOzkCQshFCqISDAEg6myQ7jejdvaAZQ5JHICfHopB8SkxiGnCsNAT5NJBAclgeMyFkKQFgFMpM7AlDIWnLOZC4iaBiGmkQA0SZaDIXEFgRgyFLnwFPEBZgcgADECL4m3IgPcyudTcjnIxaeW5lTHnPOAq8xA7zPkwG+b8/5NsgVelBeCyokLoWwvhZBK5SK0AovRVyxFxLSCkAiEmTgRChzLIgKs9ZeSYm8A6c3IcKwen2iSYQe5Ic6K8K+iQ6liANmUOofk2xAB9UJoT9j3GXha01qQJWcClTKshnBpUTO8WgGCTF1ppKYpIIclh1VkEwaHGgxw5AYFyHADAOz8CQUgCqh+jAvZSPMRASxwbuCFnrm432m4fxWOYPdBQkZICkC3D+KRm4lihpbBG3I4QY32Hjdipi5gU0O1dV9ctYzYBJimSwmZvZTycAUTAU5xDzmQAPEIOhM5EWcHrshAA8qSl5byPnjNpToelgLgVqTBRCqFMK4WEqTMitF4hprTpgNNIQ01CXTUEFEFcpBchUMrRYV9zAti4nmbkM4tB7y0JVTq4hTrQiyrKQoJ8iBbEDSmd5aDFUqo1V9nIXK9p2ByCgDBCIU93mcELGPIynB0OYY8aQHDkZJFYvuUhxpqGYLkZugAUmopGGClGcN4YI8hIjJH4xkZgBhm63GoA0c8WgO5aAGPlMqewIIlh1icDOMKxTMFdiEAgK8yMWCfW8KdoYhwWAcCWFwxEfDuRCPEbbkxBT5a+xwAvEODphjyi8Fdo2XZtHpOVLg2AQjsk1NVL2Np3TLCoKpMM9uMjMKzPems/xsyW4uDICPKEOyX8IZfySyl1Lo7lGqKTKQNY9c7GhwbAETgSnxmICIMwGOeoIaEk8oF5LZk2nLvuu6/gJWysVbgFV+gNX9UNc1NYaQmpWt5ZS20/VbcyA9jkJy+d8TkJ0G8fc3E7x1AQ2kLNzraWMtyE0tNfp8WyBNH1HqQ7M8uAnaUS9VRo26uLfuKEVb3KNu0C25dd4jQmjWDa0Fo7nAFvHCW59n9FgNvoLkKapeyh9QQk1LYgS4PexDlEppsRayrjSqokIGCU8yFNLAEEJ8AARDpuhy3D3gTAVwABCTgNPlBkGZ0+Kz7WBN2dSOzunnBdh484ATluZSwCs8F5zyTg7YDCv6i+WxgHgPKtYcoVNT4onlQobwOJISwBK6fIhnZPlsVcFEm0BRQ7mAKKi4QdYTlSc+UqQFa3tv7cxkd87hjXBmAYB17Q0Sym+H5KDzAIIFvIyVJ5++wPcqCnVWYyJij2GLN8b58E+yqexPp7lxb+PEek9odz5wdj7VYLid43l2z2fhOiaw1RiTRzC9gAD8XhzSmYAqZCxprTEAdPZUiwZzXRm4umcUN6PDPObOCcUn33uwvwvD/09FsfsWTMJdsnLyp6OfKM4CrjjDYvCeS5J0XxPmxmnU9p8GhnWOWds7v6QLns/+N19IzL8tIuT/i6J1Ls/hzq/rvormAANOeJeEgNeGUOOqUMgFgncEgk8uupSshDwqoA9EmDEMwJul8nAHgeRMWtKshCymyuYPdKhInlMhEENP9K8J/I0PKDKODFDP8O0HKpnL/EyCfGAlnFAtyGaLAmLD6tAFEMXqhk5i5gAPypDDKRhJiKE6aXShDbTDpyFgAYDICaQ1icAWw2Q1YADUvQrqswuU24tBVAAKtsn+biN0T4dGDyaqySym3QFUnAAAsjQgIA+K5joCsDGMEu0p0kOAOPEt6JGIkskl9LkEkGWFwCqocuEKmhLCwJIJuFIboLUoYp2tuFAEkriJBokTkRkg9GIEkttkIGgqECsEuKwi6OIuWmchciRgkEEBCBEGuuSmgT+mAOoD8jut0CsFCr0Q+i5gQb0RCJym3AkEmBCOerynIG1kELqq0AES2H6pWp2mEaqs0dtnIEmN+lsEUigeShutStun8tYYyiCmgIeqysehyvsQsXyvsUcWgO8dNJ1JZv+uAS+KbhjjEGsJbpwF/C7shiXjBECccKkKxrhpGNCWgO/lnqRoiakL/Eco4XJvkkxmiZXoicibYakGiaCXLliX8U+LYmOkOOcs8e8ScWSiBOcVuqeHStcfusykeuynCs8Reqim8ewD+h8YKVsF8VlC+quB+kOF+iKZdJHAqFASgDeBrkgqUEQNYEmL0JqdYNYHQVHJvOoHHCwQ0AAvvAYMAmCBqNwTnHwb0PnALJjEXMIaXGtKWJXFlMZF3HXI3KkC3DwscFPCluHGlEvv3EPCPCcMvKvF3LPBYPPOGUjivJPL1B/H0ISNKGDA0HvOwQfFlFwaArqHqF/AIVjCLCXEyD5ECHWBlGbHoZbJOPqfoAzMwZmb8AqDmQYFWSCJnL0LYDwSyKjNYK4P9DELABiFTAxEFMIMxKxFXiRHCspDRB+PRHslNOBB9GxEmFQeTHxGbkTL5BmAFIxCFBuBFM/GrC1HFOTAlLpGnGOJeZ1NrPlNXNPGHihoUjBMrJXt8d1O5G1nlkbD3HptdKBBmMvLkF2fYE5KUOtOIEgKAAEIoKwkIHgCeCAK4K4EAA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.policy.watchAdminUpdated(config, {
  onAdminUpdated(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

`() => void`

Returns a function to unsubscribe from the event.

## Parameters

### onAdminUpdated

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.watchAdminUpdated.md","from":5348,"to":5576}<fsm-vh3gqscxm4e>
declare function onAdminUpdated(args: Args, log: Log): void

type Args = {
  /** ID of the policy */
  policyId: bigint
  /** Address that updated the admin */
  updater: Address
  /** Address of the admin */
  admin: Address
}
```

Callback to invoke when a policy admin is updated.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.watchAdminUpdated.md","from":5682,"to":5909}<fsm-vh3gqscxm4e>
type Args = {
  /** Filter by policy ID */
  policyId?: bigint | bigint[] | null
  /** Filter by updater address */
  updater?: Address | Address[] | null
  /** Filter by admin address */
  admin?: Address | Address[] | null
}
```

Optional filter arguments for the event.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.watchAdminUpdated.md","from":6090,"to":6135}<fsm-vh3gqscxm4e>
declare function onError(error: Error): void
```

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Enable polling mode.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`policy.watchAdminUpdated`](https://viem.sh/tempo/actions/policy.watchAdminUpdated)

---

---
url: /tempo/actions/policy.watchBlacklistUpdated.md
---
# `policy.watchBlacklistUpdated`

Watches for blacklist update events on the TIP403 Registry.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.watchBlacklistUpdated.md","from":151,"to":5213}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"9b1d65086b67741e13cb6c063a4e3c7d1060b98061ad9be94ac501be7904f5a6","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGcNjmXgYfEVGQ1Un1JDNaitAEGEWMMV0nqIRnM06sxAAJkqCMwXJ8s1KNH5IASa34uM4wPsACE5E4ANbmMQAVSwUC2MCgAB4jlkAHxBDrJVLB5IUYWOZh6MhwVI04QAOhVYrTDvwzrdHrQ3t9NCgaYACvHE6Q4EHikoQxE9gd8EcTsMLoo0Dc0HdHl5cmBxAm4FgnDB7c287x3YwvT6/VBSlAILwEAZ9iD4JwEuxOAAjF3Tgurec0TgwS5oOBp83iJRr5DIEB0IdYBSlAAGX6vuUFhWA0SkDAfrRkosb4GgaBYJwrjbqQEDMJwADkAACmxKMwjAAPQxEBSG/pi/6cDQmIwXBCHIWhd6YTh7AwDhDgWHA+F5IRXAAamcBkQk8GIah6E0bh9EkWwLG5EscR1pwAC8gHATQoFBMAuScNEjHCKkyAiRADzwGglhoAAuhQKnEUMwgFFeqTKWAqmqVpMCYmmjBQIZqQQVBQQRCZtkwT5rgRLk4mxKsGzNjJPC2iYGYQKKGDZpOh4znOxb+uGdaxjZqlCFOyWFqe/qpCEOhwLGcgQEoUTSSGnBZXZSyxTAablUoQRIblx4rAVUCIEhsatJEpnuLkAW5F+H4gMZT6jkMzClBGSicAAtOkdY3lNIAzUOpRbQmIxcStFazVW16TRQT5AT29ymNw242sYtloBAoVwCse5wLwpCMHu448RRqjjhenbrcZZQEn01iVPIdQ/Pq/QKv8gQ5h1s75ali5ghqWqDMMLiar0RpIqaqIWoEIRhJERTCJJiSRqttM5KxllU50ojg4gvR6vKMqw/KlJKkydbqpC0I6njACsEKEyaKK8qTeBBFg8E4BwGBRDlSUFkWC5FQNqTI5rqPayWabcCVZUVfriX5kb3VpgAMhVVU1UQEAuUuK5riAaShHIe5usRz0WK7rrjus+CKJw4j7obyyzie6M3mzkocxChLQ2SfTpwjVIGBrNspQuwtIFDTI47CSB6tL3iy+a6IGIrlYjFEeu1aZqmZhgACSPX7skFhoAA3O3Cd+qQqQftYtAACTAGIX3KK4H7D75qlODEaxoBPU+z/PFhKEvK92ZwQF784vd7hAjXiGAK+uBKby9OL0oww0pf84EA3F4gpfarjox6gJhyY0NceR10tI3Y6zdOAtStiCFGhcTaOyUA/fQvRGiMh5g0RkH88AtW/r/cuuo9TqGrtMMB8xAiDmHKOXg44GoKFyEQSQVM4CNSjCYRqHtVx4AeBHTgH4GEwA/JwZg0AVgKGFPBIgLktzRzgPkSRsA9wrCUEoferDGrEQcFweOCjMIulIIHbRMBcgAClxDMIAMqfUYFgGmbDJEJmZHkOAiElbEFkVAfcGB7QwD3PueC6w4BJjTEFR4/CxFQAkYDWglkuJoHWM9EcMBeCMCSLwIomJLDHGTOEgAVDwARRxHHCOiC6OAXF1iMFUKIvQhAoBcVevYKOXFBGcIUM1CqXkPyxnacIRqaYyDwVID0qOYBvH9NKQle4YzVBbGiDffc44VghO8U9e0X0zwbJvr4gActAJqAArJpJxgLMDCWAQpt0lDlX9nIARQiRFMQkGAOhLNkh3H9MY9YWzxwbOQB+DxdDKlpjEMuFYaAPyGSCB5LAyYsJYUgLAE5aZ2BKCwsuVcWEXQ0DEEtIgBo0y0CwuILA2FgXwGvBBZgcgADElLKngogJCluEzciAsZdecFwzoWwsgvCxAiLkUwFReizFnscV+nxYSyoxLSXkqwlytMNL6Vcp5aQUgEQ0ycD4eOW5EB7mPI6WU3gSyfqrDWfaGphBIWcD/AIZQJiBEisQE80R4jOnhIAPr5Pyfse4+8/XetSHqzgBqjVCM4Iao5qS0BIS4ntBpXFJDjksDasgrDUadjkBgXIcAMBvPwPBSAqyYGMFDs6vcQSQlGO4GWLuCSI6+NPo5A8MBYyQCMamkxviljZuOLm3I4RC32BLSyri5hK2+2jQDIxBzYBphOZwee5zrycCsTAf5/DAWQDPEIKRK4qWcC7lhAA8nyuFCKkWHLFToCV2LcV6QJUSklZKKXwRBdStAtK6XiCWnumAS0hBLS5UtQQUQdykFyGIoC9rEjsGYFsXElzchnFoK+SRqyNEA3DXc0IxqBkKA/IgcJ40TnBSI01FqbUI5yHKvadgcgoBIQiCvRFnAywLyspwOjDGkmkGY7GDZzLIWUemTRpCfHnoAFJmKxiQgJ5jrH2NYU49x5MvGYD0eekpqAwnkloAhWgcTgzhnsCCJYdYnAziaos0hXYhAIDwtjGwpNGj/beIcFgHAlgWMRDY7kDjXGB5cXM0Y4ccA7zjhvt48o04zJjmMRq8eQW1OqVsyMvYTmXMroQvUjz4gvNkt8/6NLx8o5cGQBeUIblxYc3FuV4+CybFfXsWmUgawu4RNnK2AInBLOHMQEQZgqc9Qc0JIFMAHHmtcDPXuWN/AOtdZ63APr9ABuupG5qaw0hNSTaa3ZBZrqB5kEHHIJVn6qVYToKkyFuJ3jqA5tIQ7a8qs1bkIZJavyStkCaPqPUr3KvnmYXIVrdiuCDdgIgU79xQiXaPZUm7tA7sPXeI0Jo1gpszaO1wE7xwzvw6QxYG7oPvV72UPqCEmpwkSU4NQ8cskHOMHo5wK4hqmJCCQivIRMywBBA/AAERvroIxs8GeuAAIScGF8oMgkuPyBem2pkLuTUiy9F5wXYLOHns73JzsA0uNfy4MyuozwyxpfnCehzDKyFFOtwx+EpjURG8AqXksAluPwUbeSFFlXBZJtCsWcocVj8uEHWF5HnIVhkRSDyH5gYeEwR6j+JrgzAMDO8kbJKzmjOlZ5gEEf3sZhlK5g5nk1XTWpSe0/xpj/nVPqdC+5Wvun6+m/9+XgvVfaOt84HJvqyE9MqfK6rnj0nGOCf08YzvYAM/d/C5ZmA1nMv2cc1fXLbmCtOs87x37fnWNK+CxpzSq/x5a5y6VPL7md9Fb3z5xQ/pjLGIt57331N6dDkZ8hbXrO9cG+5y70r02FmSFxF0zXFy/ylxl3ANIAVyPxVxPxgLlyMV/11w5wGUN2QNF0l1N1f3GlvHvCQEfDKC3VKGQDYTuDoRhSvSFSwnUVUDejTBiGYBvRRTgDYPogPENSwllXlXMD3FoioyXUiEmlBleDQXUFLiwV+BzgFiEW/nFlFn/hLjIW5DNEoQViTWgCiG7xo0i2iwAH5UhdlYw0xzDnMHpQgjohxNNdlkBDJGxOBXYXIBsABqXoaNWYcqIrCIbhL2MfBJZ6D8UTKFa1WpKzboJqTgAAWQkQEDfBix0BWATFyUWVsgtVHEqX9FjGqVqQBlyCSGrC4FWW+XCGdSVhYEkF8QMN0HGW8RnSKygBqVxAI1KIaKaTejEBqXuyECYVCBWC3H0RZxYQBSBW4wSCCAhAiEvQFToKQzAHUDRXvW6BWBJQWNA2iw4IWIhEuwHgSDTAhBVR/TkCmyCFw1aBSM7BTTgxnSyKtTGPuzkDTCgyQzQB6RoIFWvRFTvQxSxQ4KfRlVfQVWwieOON/SeNeK2ChLQCWgGgC1QzAHIzgDTyKE3ginFmj2EMkw3mOFSBkxY1jFxLQAQKbzVzRLxM4CUOSyM1n15xxJZTxMH2JNJMCNSGJNSGpJE1pLEyRKtzf03XHEBTBJhI+P5Sgm+NvWvHFX+KlTxVhL4LfUVTBNVTpUhMQ2hI1NhPhO3F3Fg3HAsBhJQ0IIfCfHtzoVKCIGsDTF6BtOsGsDEOTkfkJD1AzllE1D+FzjMAqkUOUIrg5irmASJlrk0Ibl2irBbhKmshHk7h7lSH13UWOCPjsi6lSnP0nhnjnhOH3kPhHnXkZK3gER3izIXgPmXhHlPmzPPnjKvgUBvjvlQT6GkCUK+HdPfkVE/hKl9LLhZDxj1HFjUOJjlnrkFg/yBGbCKmdmcLdgxjBhTj1AhGkNflkNwQMHHJBG/l6FsB7LFlGGsFcFBhiFgAxGZg4iimEG4l4iH2omwm0hYgdVqg+UWlgj+j4jTCEKyDEnf2WHXJaVkk4hijigSngVjjRgXHSgZkylMnziPFtnRmKnvAtkqjblXjz2o26SQj1kH3hKGn8im3K3tjHlcyemghzH3lyF/PwC8lKD2nECQFAACEUAUSEDwCvBAFcFcCAA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.policy.watchBlacklistUpdated(config, {
  onBlacklistUpdated(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

`() => void`

Returns a function to unsubscribe from the event.

## Parameters

### onBlacklistUpdated

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.watchBlacklistUpdated.md","from":5427,"to":5732}<fsm-vh3gqscxm4e>
declare function onBlacklistUpdated(args: Args, log: Log): void

type Args = {
  /** Address of the account */
  account: Address
  /** ID of the policy */
  policyId: bigint
  /** Whether the account is restricted */
  restricted: boolean
  /** Address that updated the blacklist */
  updater: Address
}
```

Callback to invoke when a blacklist is updated.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.watchBlacklistUpdated.md","from":5835,"to":6066}<fsm-vh3gqscxm4e>
type Args = {
  /** Filter by policy ID */
  policyId?: bigint | bigint[] | null
  /** Filter by updater address */
  updater?: Address | Address[] | null
  /** Filter by account address */
  account?: Address | Address[] | null
}
```

Optional filter arguments to narrow the events being watched.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.watchBlacklistUpdated.md","from":6268,"to":6313}<fsm-vh3gqscxm4e>
declare function onError(error: Error): void
```

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Enable polling mode.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`policy.watchBlacklistUpdated`](https://viem.sh/tempo/actions/policy.watchBlacklistUpdated)

---

---
url: /tempo/actions/policy.watchCreate.md
---
# `policy.watchCreate`

Watches for policy creation events on the TIP403 Registry.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.watchCreate.md","from":138,"to":5059}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"4175566a55e750e5214e1ba28bd900a36c6ad75d45fe9a2ac4e16980d28c414b","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGcNjmXgYfEVGQ1Un1JDNaitAEGEWMMV0nqIRnM06sxAAJkqCMwXJ8s1KNH5IASa34uM4wMOpBgWxgAB4jlkAHxBDrJVIe5IUYWOZh6MhwVI04QAOhVYujDvwaSdLujAAUQ2HSHB3cUlJ6InsDkmhCdhhdFGgbmg7o8vLkwOJQ3AsE4YPbi8nnTRSlAILwEAZ9iD4JwEuxhRBRRhoinjGBODBLmg4NHzeIlIPkMgQHQm1gFKUAAYnle5QWFYCz7swANKIP4NBoLCcVxj0gQZicADkAAFNkozCMAA9DETrfuemKXpwNCYq+76fj+/4bkBoHsDAoEOBYcAQXkUFcFeUZwPBCQfl+f4AahYEYbBbC4bkSxxHmnAALzXi6d5BMAuScNEWHCKkyC0RADzwGglhoAAuhQPEwUMwgFCuqTcQuvGcEJMCYtGjBQJJqSPs+QQRDJqnuLkrgRLkDGxKsGzFqxPC2iYsZTqqGAJp2c4wD6eZBipvFCGmrlil2LpQKkIQ6HAQZyBAShRCxnqcP5alLFOMDRrFShBN+QXTuxNDhd+QatJEslmWAFm5CeR4gNJO6tkMzClL6SicAAtOkeZrvVICNU2pT9aGIzEZ1GZNVmq51RQO5OjW9ymNwY42vOMEQLZcArAARnAvCkIwW3tqRiGqO2S6Vj10llASfTWJU8h1D8iC9P0Cr/IEiahT2YIalqgzDC4mq9EaSKmqiFqBCEYSREUwhMYkfpdQjOR4YpsOdKIN3Pb08oyk98qUkqTJ5uqkLQjqgOVBCIMmiivIQ3gQRYB+OAcBgUSBcFGBfTA4WcJFm6pJ9XnRtwUUxXFQueTe0YADJxQlSVEBAOm9v2g4gGkoRyFtTgANZrZwFjK3r7brPgiicOIk75YwxF7TeUBrpjkrPXqhIPWSfQAKx/FSBic9OPNQKTSD3Uy/2wkgeo094dPmuiBhM5mIxRKVymybxcYYAAknzW3JBYaAANyZ6sWBQC6pCRlAUBOnAcCl6pvHGjAqR5W5Tw4E3rgSm8vSVOHeMNOHhOBKVoeIOH2oA6MvSErH0w8gnlrJxNqecFlUsgjzctxX3+i9N7thfLKmp+0TWWT9Pke6gai/cma8yBI2zatrw7ZpQouREJIsNwOlf0Jh0pqwHHgB4FtOBHi/jAI8nBmDQBWAoYUH4iA6VHNbOA+RkGwC2isJQSgLBtRgTBBwXA7acCwUBOQf80DrVOrkAAUuIX+ABlPajAsDwwAcg0MzI8hwC/MzYg6CoCcC2jOdYMAtriI/OsOA4ZoxWUeJAhBUAkFnVoIpYiaB1jrRbDAXgjAki8CKJiSwxwIzKIAFQ8CgUcHhsDog0IbvaRgqh4F6EIFAYim17BW2ItA4BChMpxSMkeIMQThDpWjGQD8pBwlWzAGIqJjiPL3ESaoLY0RxALkOqsBRYi6H2n2jQQ2uSZwADloAZQAFa+JOM6ZgSiwC2KWkoWKus5BQJgXA7CEgwAf3RskO4vNDbrFKe2YpyAjzCI/g3aMYg+wrDQEeSSQQDJYAjMBYCkBYD1OjOwJQwE+wDmAjQmgYh2pEANNGWgwFxBYBAnM+Aq5HzMDkAAYheQ3JZEAVlp2SbkGZPzVxLLiWsjZT4tmIB2XsmAByjknPVucl0VybmVDuQ8p5wFQXRneV80F4LSCkAiNGTgED2wdIgF0npwSnG8FyeI9sKxCluNUP88h+EiGkPbEeeFiBenwMQSE5RAB9ax1j9j3CIZKsVqRKWcGpbSkhNLamGLQN+Yiw1vHEUkO2Sw7iLakH/nbGgxw5AYFyHADAgz8AfkgKyzejBTa8tkRAeRZAeBphzjoi2M566aS2goIMkATX6t5TOJYZrKyWtyOEW19gHX/OIuYV12tOAQFOia6psBoz1MoY0psq5OCsJgFMyBMzIBlKECg/srzOA52AgAeUhZs7ZuyamIp0Mis5FyxLXNufcx5zyPzzLeWgD5nzxDtWrTAdqQh2qgvaoIKI45SC5AQU6I2iR2DMC2LiFpuQzi0H3Mg1lPLTpKs6aEOl0SFBHkQMomq9TrL3oyllHKFs5CxXtOwOQUBvwRCbjszgaZ9qWP0jAH9609GkAA0GYpfyVlvrSZ+7837f0AFIcJBm/HBgDQGQPATAxBpSnBMOwf/VARD+i0DLLQKhmJcT2BBEsOsTgZwSWse/LsQgEAtlBgATqnlusxEOCwDgSwgGIjAdyKB8DRdiIsZNc2OAG52y5LEeUXgBsyxDKQ/RuJT6wCgd4lx+Jex+OCcoZ+LxonxDiceVJ3m8mSNqStlwZAS5Qh6W9s9b2bmPOedLRwrh0ZSBrBziou2RwIb8wFUQZgz0IR6meoSSypn3NqWyc2ra6r+ARaizFuAcWAgJZqYgJLmprDSE1BloLHnskCqLmQRschcVjtecBOghiVm4neOoZ60hGs5a8z5uQkl2oTOc2QJo+o9Sjd4tkib7D9pcIq7ARArX7ihE6/WhuPXaB9fnO8RoTRrCZbM2NzgLXjhtb2/uiwPXf5yDFWICDKQ9QQk1Moxit2mztjYrxxgP7OBXBpdhIQ34m4wPSWAIIR4AAiuTdAmoACTAFfjAVwABCTgKPlBkFx0eOTWXSNKdSITtHnBdig+6RDgu0SwD4+p8T2jhbYAkuqieZRJ6z0sqwcoN1R4HHpTgbwFxViwA86PK+wZNlOUOTaKwotzBWF2cIOsIysObJxOV3oVXKZ1ea49Tr1DXBmDc3pQ5dj/8Yli4UEETlQY4lk83db99oTsoYeg7+gjMniMU8gxRv3VH4M0cNpyj3juP1hN9zBzgOHio/gD0RoLimQ+Ub/RHjn0ewBW9j7E7jCS7cWZ43xiAAnoq2ZE8LsTFHZvSaA2ThTZGIzqXL9XWn1ma/Cfs/XxzjfJOKF5tJQ2cS/s2Wxw5EHYPGdQ7ADDmP9L4eI7ZxjrHgO8cE9R8T0nQfM/kY37T+n4PIfM9Z3v0guOOeT7ADVdcm4kDbjKOW0oyAAF3A/us9tsLgKEKqDbTRgxDMCdr7JwDgEYTBo0rAQYpYrmBbRoRe71IRB1RXSvCHyNCvTDy/BvT+zEzvqTy+wRwsiUwPxgz0yJzBA6rQBRBF6fpqYaYAD8qQFSQY0YnBAm84oQ40xabBYAGAyAkkhYnAysOk/MAA1L0JmrMLFI5mgVQKchrEfjoutEeMhqsuyvgLdjAOsN0BlJwAALJIICAHiaY6ArChiWI5J5LtitgNy8xBjrBGq8q5BJDZhcCspjLhBurMwsCSAzhMG6BJJiIZqOZQDuK4i3reFhG+LbRiDuL9ZCA/yhArCjhUKg60LrQgpkYJBBAQgRBtrQr/77pgDqCHI9rdArD3JlFLoaaQFlEQidZFwJDRgQj4qTpyCZZBBXqtBWGVh6rboZoOFsrTJHj9ZyDRjrr7poDhK/7QodrwrdrHLKGoqXJoCDqYrDo4qTGdFTqTEzFbBHGbGlSyZHoP4njy7/YxBrBcBsTey65e7oa3HHCpBYaAZBivFoCt4kaqGpDfGpC+yGyaFMYhIvH/JvEp7fG/HB7kaAmcDAmGYMay7KJlrtgzJ7EnHzFQrPhLFdqrhIprH9ropDrYogR7EEqfKHF7rHG0mnFRRroThbrtgWAnGHpP5bg7hC4fylBEDWDRi9CCnWDWDoEuz9yNAkiPQNCMhjx4BXw/RWAkEzxRxuwUHxzPyMxDRZhpxRQZzNw2xuR5ypAFyELHBNweYrAVxVw1x1yvIWlqStztxcxdwwA9wHx9CEh6iexnyjyKjjxRTEHkyzzRzezqnLyakGD/ZAjFgRSKxiEqwhzin6B6h6g4HSl4FykGAxkgiTy9Anwqm6jWCuBXQxCwAYhoyEROTCAkRkSp4oQgTCS4QXgETDJtRvjHTkTRjIFZD0QK5wy2SJgOREQuTTgeQ7xeQ+TIx+SySBxuTBwCw15ZRRApS8Rw7obpwp5nHlQmRVQy7k6yxVxCZ0IviJhEK5A5n2BGSlDDTiBICgABCKBYJCB4ArggCuCuBAA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.policy.watchCreate(config, {
  onPolicyCreated(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

`() => void`

Returns a function to unsubscribe from the event.

## Parameters

### onPolicyCreated

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.watchCreate.md","from":5270,"to":5504}<fsm-vh3gqscxm4e>
declare function onPolicyCreated(args: Args, log: Log): void

type Args = {
  /** ID of the created policy */
  policyId: bigint
  /** Type of policy */
  type: PolicyType
  /** Address that created the policy */
  updater: Address
}
```

Callback to invoke when a policy is created.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.watchCreate.md","from":5604,"to":5761}<fsm-vh3gqscxm4e>
type Args = {
  /** Filter by policy ID */
  policyId?: bigint | bigint[] | null
  /** Filter by updater address */
  updater?: Address | Address[] | null
}
```

Optional filter arguments to narrow which events to watch.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.watchCreate.md","from":5960,"to":6005}<fsm-vh3gqscxm4e>
declare function onError(error: Error): void
```

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Enable polling mode.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`policy.watchCreate`](https://viem.sh/tempo/actions/policy.watchCreate)

---

---
url: /tempo/actions/policy.watchWhitelistUpdated.md
---
# `policy.watchWhitelistUpdated`

Watches for whitelist update events on the TIP403 Registry.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.watchWhitelistUpdated.md","from":151,"to":5197}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"e8df301eda13d3e824a0f6ebe0befaea3f9f427a3290ede59f525defedbfdb9e","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGcNjmXgYfEVGQ1Un1JDNaitAEGEWMMV0nqIRnM06sxAAJkqCMwXJ8s1KNH5IASa34uM4wPsu3wjBo5jEAFUsFAtjAoAAeI5ZAB8QQ6yVSgeSFGFjmYejIcFSNOEADoVWKUw78E6XTA3WhPd6aFAUwAFWPx0hwAPFJRBiJ7A74I4nYYXRRoG5oO6PLy5MDiONwLBOGD2ps512MD1en1QUpQCC8BAGfYg+CcBLse3OqfLFazmicGCXNBwFPm8RKFfIZAgOiDrAKUoAAzfZ9ygsKwGipBgPsjJRo3wNA0CwThXE3UgIGYTgAHIAAFNiUZhGAAehiP84M/TFv04GhMQgqCYPgpCr1QjD2BgDCHAsOBsLyXCuB/ZM4CIhJoNgxDkIozDqIItgGNyJY4lrTgAF5f3/GhAKCYBck4aJaOEVJkAEiAHngNBLDQABdCgFPwoZhAKM9UnksBFMUtSYExFNGCgXTUhAsCggiAzLIgjzXAiXJhNiVYNibCSeFtEw0wgUUMEzCddzzacC0PX1Q1raMLMUoRJ3imci19VIQh0OBozkCAlCicSg04dKrKWSKYBTEqlCCOCsvzVYkqgRA4OjVpIkM9xch83I3xfEB9LvEchmYUowyUTgAFp0lrC9xpASbB1Kda4xGNjFvLKbK3PMaKDvP9u3uUxuE3G1jEstAIECuAVgAIzgXhSEYZ6xw4kjVDHE8OxW/SygJPprEqeQ6h+fV+gVf5AizVqEsLOd1UhaEdRcTVeiNJFTVRC1AhCMJIiKYRRMScMlspnJGNMsnOlEUHEF6PV5RlaH5UpJUmVrNGGQx4YsYAVghXGTRRXlCbwIIsGgnAOAwKJMri/MUeLfLetSRHVeRjqU24QritK7XYtzNX9YAGVK8rKqICAHIXJcVxANJQjkZ6nAAa3wh6LHtr2x3WfBFE4cQd3NhLOGndrcpLCU3l6CFCUhsk+hTuGqQMFXI5y1GwQ1CGmUGIXRj1cXvEl810QMWWKxGKItaqwzFPTDAAElOs4Z7kgsNAAG4W9jn1SFSF9rFoAASYAxA+5RXBfQfPMUpwYjWNAx4n6fZ4sJQF6Xqyw7kEr1jy7uIDq8QwCX1wE/0XphelKGGiL7nAl6/nECL7VS6QPUcY5MaSuPJq6WjrgdBunBGqmxBEjPOxYUzWyUHfNkjIOYNEZG/PAjVP7fxLrCP+6gK7TBAfMQIA4hwjl4GOWqChchEEkGTOAdUIwmDqk7ZceAHgh04C+WhMAXycGYNAFYChhTQSIA5Dc4c4D5DEbAZ6KwlBKF3kwuq+EHBcBjrI1CchGH3Q0TAXIAApcQDCADK71GBYApswsRcZmR5DgLBOWxApFQG7hge0MBnrd2gusOACYUx+UeDw4RUBRH/VoKZNiaB1gPWHDAXgjAki8CKJiSwxxEwhIAFQ8F4UcOxAjoh6LgGxdYLp8BCL0IQKAbEnr2DDmxPhbCFANVKm5F80YWnCDqimMg0FSCdLDmADxPSikxXuMM1QWxohX27mOFYgSPEGPWB9I8Bir5eIAHLQHqgAK3qScf8zBglgDyVdJQJVPZyF4fwwRdEJBgGoQzZIdxfS+3tOsscBjkAvlcdQspKYxCLhWGgF8ukgguSwImNCaFICwEOSmdgSg0KLmXGhPRNAxDzSIAaFMtA0LiCwOhAF8BzwgWYHIAAxGSspIKIBgsbqM3Ify6XnhBQMiFULQIwsQHChFMAkUorRc7TFPocV4sqASolJK0LspTJSml7LOWkFIBEFMnBuFjiuRAG5dzWnFN4PMr6qxln2kqYyrRTFVF/V4YKxA9yhEiLaSEgA+jknJ+x7i709W61I2rOC6v1fwzger9lJLQHBNi21alsUkGOSwlSyBMISh2OQGBchwAwM8/A0FIBLKgYwQOhi/EQACSm7gpZ26xJDl4v8gTmDPQUNGSApAw5/kMV4pYabjgZtyOEHN9h82MrYuYEt7sw1/Xbbs2AKZDmcFnic88nBzEwB+Twv5kAjxCHEUuclnB25oQAPLcuhbC+FezhU6FFRirFWlcX4sJcS0l0FAUUrQFS6l4h5rbpgPNIQ812XzUEFELcpBcjCM7RYcDzAti4jObkM4tBHxiKWbanhwbQgGt6QoF8iAQkjUOf5XD9VGrNRDsfB68TSByCgHBCIS84WcFLHPMynBKMlXtOwOj0YDEMrBSRiZ5G4KcYegAUnotGOCNG6MMaY2hFjbHEwcbzFx2TUA+MJLQKCtAQm+kDPYEESw6xOBnDVUZlqhAIAwujMw2NqjPYeIcFgHAlh6MREY7kZjrG+5sUM+2occArxjivh48ovAfathefxnTAyCNgGY4pczgy9jWds4umCNTHPiGc8StzvpvOKcPrM5AJ5QhOWFizYWRXD5hy4JYj6NiUykDWO3UJ04WwBE4MZvZiAiDMBZhCPULNCS+US8Vqyszj3PQjfwFrbWOtwC6/QHrDqBuamsNITUY3asla4A6vuZABxyHlW+8laE6BJLBbid46gWbSD21NrgZWGFyF0vNNZ+WyBNH1HqJ7K8uDlbkI16xXBeuwEQEd+4oQzv7rKZd2g13brvEaE0aw42kvPc4Id44x3YdwYsJdt7bqd7KH1BCTUISRI48HGOSSLVGDH04FcPVdEhBwSXvwyZYAggvgACJX10O26eFCYCuAAIScEF8oMgEuXxeYm0pvzqQZfC84LsJntzWc916WAKXau5dacXXFtVw03whOQ6hxZsjlClpfIUuqgjeClOyWAc3L5iPPIClakKbRzHHMHOYrLhB1huS5wFAZfu9AB7/EHkP5bw9Ca4MwDAjuxGSRM2otp6eYBBCtdGAZivINp8Ne0pqom1PUZ4x5hTyusnOSr9x2jmnPlWpL7n8vFGm+Se6vBDT8nau+Yb6pqjzfeNt8E2AVPneAvGZgKZlLlmnQXwy/Z7LdunMce++5hjiufPKdUkv0eGv0tFUyw5zfuXt+ucUL6fSnyBnU4CmLkKjPmc6/Z2ATnHey+bCmQLkLimqLnTpLtLkAaQPLvvopsPuxobu2prh/mznrgbhARLsbk/mACNJeNeEgLeGUOuqUMgMwncNQpCuevymhCoqoC9CmDEMwJeoinAIwdRM2nqmhFKjKuYM9JRKRvOpEGNMDK8PfOoEXOgr8JnDzPwp/MLILAQl/MQtyGaGQjLLGtAFEJ3uRkFiFgAPypBbLRgphGE2a3ShD7SDgqZbLIC6QNicD2wOQ9YADUvQYaswJUuWEQHCLssBsSD0L4Am4KFqqgOOC+3Q9UnAAAsqIgIE+KFjoCsHGFknMpZKaiOGUr6NGBUsEX9LkEkFWFwEsh8uEKWnLCwJIF4toboCMh4pOrllAC6LiNhoUTUfUi9GIC6DdkIPQqECsBuDokzvog9GymxgkEEBCBEGerypQXBmAOoMijet0CsISjMUBiFswTMRCGdn3AkCmBCIqp+nIONkEHaq0AkR2PGp2pOmkear8i+DdnICmLBlsJ0uQbyheoKteqiuiswfepKk+rKuhPcfsV+vcU8WgGCfNL1J5ohlgW+F7jTmvMcCFMLBHnwSJoiRvJwOJvRtGBidAfXuxhiakLIZ8gEfpm0uiYyscF1LiVSWgPiT4akESZwCSbFrph7iEmumOH8kCWCS8TymBO8VeueCKt8eKtimgI+tKs+nKkCUqtSqCewHBuCUqVsJCYVGBtuFBmODBqqbdBeC0LgSgHeLbtQqUEQNYCmL0FadYNYIIUzJKKNnqKnLKJqH8FnGYKVDIXIbqKzIofjFLDXMEFtJWI3IVOZEPG3J3KkD3CoscAfFZAeLlCfuPFPDPCcLvPvEPKvHSZvGmWTnvIvNmVRqfF3M9BfAoFfDfCgg9rIV8K6a/IqO/IVN6cXCyFjHqMLP6VXCoQYDTkCE2PlLbHYQ7POA6W8HqBCGIc/BIVggYAOSCJ/L0LYG2ZjKMNYK4MDDELABiPTCxGFMIOxJxP3uROhOpAxF+MxK8nNJBD9FxCmLwVkEJN7uTIFFmCFKxBFFFDFLArrPAslLNGlIZDnHuIlHHAVNeMbGVM3MvNnmRh0nBFrH3lCf1N5ONrVpbCPHZvdOBFmLvLkAufYG5KUNtOIEgKAAEIoLIkIHgGeCAK4K4EAA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.policy.watchWhitelistUpdated(config, {
  onWhitelistUpdated(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

`() => void`

Returns a function to unsubscribe from the event.

## Parameters

### onWhitelistUpdated

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.watchWhitelistUpdated.md","from":5411,"to":5710}<fsm-vh3gqscxm4e>
declare function onWhitelistUpdated(args: Args, log: Log): void

type Args = {
  /** Address of the account */
  account: Address
  /** Whether the account is allowed */
  allowed: boolean
  /** ID of the policy */
  policyId: bigint
  /** Address that updated the whitelist */
  updater: Address
}
```

Callback to invoke when a whitelist is updated.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.watchWhitelistUpdated.md","from":5813,"to":6044}<fsm-vh3gqscxm4e>
type Args = {
  /** Filter by policy ID */
  policyId?: bigint | bigint[] | null
  /** Filter by updater address */
  updater?: Address | Address[] | null
  /** Filter by account address */
  account?: Address | Address[] | null
}
```

Optional filter arguments for the watch.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/policy.watchWhitelistUpdated.md","from":6225,"to":6270}<fsm-vh3gqscxm4e>
declare function onError(error: Error): void
```

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Enable polling mode.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`policy.watchWhitelistUpdated`](https://viem.sh/tempo/actions/policy.watchWhitelistUpdated)

---

---
url: /tempo/actions/reward.claim.md
---
# `reward.claim`

Claims accumulated rewards for the caller.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/reward.claim.md","from":116,"to":5067}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"63fa687fe50fa183122469b6de0ff02764948fafd9737817ff79121a442b3050","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinKQwvDCMWGipACpDwsOCYABKaxtbpVAQvAgGO/gwnGj7cIdCK2ebDKLa+gAc/VqylUGhaOj0eFW6y+XQsVgAzANHM5Rn8JtQvNNfHNqAEmKx2FwjEdTOUpGNZED6qDqK0IQZiSZYT1EIiQPZkSMkAAmRrozBTAwzPy4hYGfKEj4Ad0kUFKZP0vWsNQUwIazVp4MCqxlpDl8jhSDZHKGKKNlX5mKF2NKNDFIASAFcwPwjtE5OIWABlDAugA8GUSyQAfEEOslUoGshROFhHMw9GQ4KlGcIAHQ62Vp3ge72+3hpgAK8cTpDgAeKSmDEVShdIEGYjDgMD9Oc9zB9LrTpzQjtIYAAaqFHTBg7kwOIE3A4+t3e3O7xLtdbiA0rnmHBOE5eI7mI6PTQoNLZZuEuwtx9eJtGIouOIwEeZYw0Kfz+HSMxxMYwGnbeIlLcyDICAdCTlgCilAABtBL65BKhTANEqxfjAUbJDG+BoGgWCcK4nAJPWzCcAA5AAAjKSiNgA9DEqzEXBBIIU8MAErh+GESR5H/tRtEwDRDgWHA9F5IxXCIamm54QRDacRRPHsHxNAEsJuRLHElacAAvEhMAoWhShBMAuScNEAnCKkyBKWwOzwGglhoAAuhQxlPC8BQvqkRlgCZJmWSxbBpowUAOakmHYUEETOd5uFRa4ES5KpsQfHA+5cNp4hPkSromBmMC6lA2brguYaVjGXkmWgEAANaKKkxHWLQ3LWLw1itW17UdZ1XXdb0xGxfFYDQZBIBOcBcZDMwpThkonAALTpJWv6jSA42TqUq0JiMm7zcWE2lnAS0UMBqy9v2pj3I8zz3q82XeVC5xoEtTllL8fS9JU8h1CCYxgm0ixFfmzIIkippcoglS9Jago+LMtp4gYIRhJERTCOpQYpAt6MMe5KOdD8FR9NyH1Ut9GraH9BjTUDRog8MLiIAArJDHgYtDwo4nagRBFg9Y4BwGBRJVNVgKk2QgA1TUtd10sy9LYvyq9iC9PCGqqtSjO/fS1DVYo1Pg7TZqINyUPeOzcP2hOU4zo8SwQAouREJIKNwHbMCRiYrtLjceAXZwkG2wokGcMw0D7o8PPEEF8AXnA+QKJwsAAEaOkoSgWDNAeXQ4XBNpwseNh6pBPBATwPLkABS4iO16vCkF8zuu8HawOHkcBERHRBR0eicYJwUowInnCJ/WUrNmWaYJWAvsh1AYecHQ7mbmgUol9OayMEkvBFASlhgB5k8AFQ8H7gYu4Hc5wJuUrPvgTeqNAm4pfYW6bv7HsKGmcgQAZESQTGb/CFdmmMg9ZSARSDveI8ACz4wDTLqMA4DS5fmiPeIejxHTNiPJVPudcaDFy3GAXuAA5aAsCABWj9ni6WYBPMAR9uCcCUF/ROoQ/aZyDoJCQLobaVj7DALBJcpS4MuiXZAkEI7rEvmmMQVxHRoEgg5IIYUsDJiolRSAsAKFpnYEoKiVwbhUQPLZWaRAiZploFRcQWBGBUQkfAA6mFmByAAMR2MvjIiAcioiQNyGItxB0ZEgIUUorCKjEBqI0TALROi9HLkMShMQJizEWKsTY/xaZHEuP8YE0gpAIhpk4L7JhEAWFyDYe/GAQdeCoMTugzBfcb6eJzqJdOpdHiQUiYgdhwdQ4f0ngAfQPgfAA6pIPIyghn9N2A8RhzDWGZ04CUshaw0DEU3JtQgUBNySEeJYG+ZBnZNhoHvOQGBchwHzPgeskAMGcHMDVNpQ8R5jx4IWAAkkvB4vdVjNmYInBQMZIBFx2W03uSwjm3lObkcIlzrmeM3Pcx4oQykQFUAckhsA0wULzlQycB1OBehgFnR4YjIB4PeP4zgbyqIAHlgnKNUeo0h0SdCxIMUYxJpjKjmMsdY2x9ZJEOLQE45x4hZpkpgLNIQs1/GzUEFEM8pBcgh1WJwCwirPzflobkAAorQMC8cMGtLRbMkprDoGu0gogSeQ0KGJUAR/L+BliIPDkF/Pu7A5BQGIhEAA3LkNRnA6wWA8pwV17qV6kC9TGbBHi5H2pgZ/b+QQXUwDdSXAApEJGMxFI1ep9f6sAgbg172TGGtNEbPVQBjavNAsi0AJqASA9gQRLBSk4Dq3JLbiLDMIBAFRMYXYbNaSwo8DgsA4EsN6iIfqA1USDXXUt88u1FynK8XQBCjzlF4FVVyTgRE4tgLk61Rb50mU7aA1IvaID9rgIOhseh8AjvEGOqxk7+Fzp8iZZByAYCOzkCFBmSsGafq/cgmudctgZmdG8qeT64CBk5pwVtpDEBEGYEreE3IlZ/AGoGsDXAaWJ2WfwaDYBYP3CbIhgIyHOnodZNYaQrJcOgZ8sgzpIayATjkPy649iqJ0DWHIo4iB1DqCVtIVj36uC/v/Q5WaQi31kCaEbbkUmtxcD/aECD9cUOwEQJx/soReOCoE7QIT35RONCaNYPDZ62NcA43vLjxnPwWAE/+/pYhF0pG5PCVkk81KcEto8bSPbGBus4McEpgkhDEULZnOBYygiQQACL3l0EXAAJMAELrgACEnB0vKDIPlyCs7T0LpDWW4rmXODDIi2U6LidYtgEK7V0rNbD0gNyENSeeqDV1ONTMyCp9LUX2TDa6CdqXRJSaVpRhegvS4o7A+wgUoIoJaSiAhbbRlvIVWwmdbm2E1cGYBgMb8dtJtobh/S7MAghNJjCAiryqLsVKTc68Ngiq0Fs/SW0N32PVRurfgppb37ufZTUDrNfUSJ5unYW4ti7AcVp+yDrr4OwDnch82sBN2L3duvbe+9w7lBDxfWGpTU6fUVeR9ViyhPSBXr7QOvOD7VDPtfROxQ/CnL4J62AU7wXJyhZIg1yLzXWvxYhx9+BKWOvZdy6LgrRWMulfK0j+dAOavq6LhLprMXAFtbVyV0g+WuuC6Gn+ACSAgJlCJaUZALs+zrEUQy8JVE06qEdInbMDYmWaLgIHvi/ySlUS5Ty8wicaIfYoREEaz0FR9GkGyNW30ajky1pnPWNQTR01GNYE2WJYbzC5hs6AURIdOqCGu/8MAAD8qR7wYBjGmdv/bvyhF2ni5vhDkAORrJwIgEAgrIYANS9EWbML+L6E9UH0SuHX+DIJxvkQ01QwW8rdFgZwAAsqlTY8dWi7lvJuap3lamxnCJgmM19N9otyEkMsXAMH8Jfo8nmLBJC9zrxuyBW4kWL6UAz4RwrCb+R44QecvuYgz4wmQgDsw40c+cEWTs2CfiKOCQQQ8Iv87uoSnun4YA6g2irK3QjoFihBMq9ewehB8I/KIaCQaY8IGSwqcgA0QQJqJ+CYS6IKyK1+l87+6BkEwmcgaYGqX44CeB2EjKkSLKuii+8SNAnKySvKNiIhLBIqIh4haA2hs0rQkQ+SU2kEM2QWMQzoaUnADMW2DqsCNexEZhe8qQGa3qMYDhaAdO2uKOZabhqQDMXWa+jajqya9hnijhcObhHhVWpaqQPhlh/hdaWOfWQuYAhKJKwhAgoh2hkhIS0hnushB0MSChHKaASS3KKSfK6hmSziWh7Amquh+hCq54Kqjw6qtRX4Rwv4LQtuKAwEsc3CpQRA1gaYvQwxrUie+M5ITUgI6eDQbIWegQTqueBsYMaILMAopsNoZeiwSU90XwuwLwbwJwnwFwC+y4PsMyV0Bwt0l4D0CsBMqmqsX0DQmedI2oxx3wZghoomyx9M8I8Ixe1opeooXMEcfMmAgsBxt0AAEuEPgKkJBA1Dlt5unK4MNKcd7AYDCXALfBAAkKXLnJcTdN+HcZMfCMTDMX0H4ZqBTNQJCd+FiWoAaCyHnoMAXkgBDACbSEoKUCFngIsRMfoNyEzJ9GqEgLYMCT7HSW6A4NiakA1L0H5pUAzI0OoH8NINYOIInLwLAAkAqWScqaqeqZqdqTALqYqQaWqRqVqTqXqUqSqZacaTqXrJSPnobEXs9DELAPiDjOJLdJJOxDJLmtxDYlZBAMJPBGJLjMkGxNJERMRGmLHujCpLNqjJwIhLsVsGxOlJlDwH6blPlIVPOPmCVOjGVC5ELLVCRBLM1LLLWXWdYH1LkHFIFh9nYXsNdIcVTrKXDhmY9ISYcQyQNKUJtOIEgKAAEIoLHEIHgC+CAK4K4EAA=="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const { receipt } = await Actions.reward.claimSync(config, {
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Transaction hash:', receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `reward.claim` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/reward.claim.md","from":5409,"to":5680}<fsm-vh3gqscxm4e>
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.reward.claim(config, {
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await waitForTransactionReceipt(config, { hash })
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/reward.claim.md","from":5707,"to":5788}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Transaction receipt */
  receipt: TransactionReceipt
}
```

## Parameters

### token

* **Type:** `Address`

Address of the TIP-20 token.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`reward.claim`](https://viem.sh/tempo/actions/reward.claim)

---

---
url: /tempo/actions/reward.distribute.md
---
# `reward.distribute`

Distributes tokens to opted-in holders.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/reward.distribute.md","from":118,"to":5766}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"68cfc834c7b00e507b2686e4d8050a386080048e317a40941faee9b9d01b80bc","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScAGYArmD8gmCcWJJwMACiqmRBevhkiJxipBZKFJzxjGgA/IUAOiAA7jCMDZwAPpwNSs2tIBGFAEaMShZodWAsbBwpaZnZ5FRQELwIBgDCQiQccJziRWglypykMFin6WASxskQ0Zx5ZJxoEJxgscxkjLyhnL0AdBMJgBaTgAERWcEK+DQaCwUIA9AiiIwYMx/nB8AjlqsEbEBOYBPAEalSOksvlFtRxEo1shkCA6OJWApKCApuwuMBZmT5pTOK4YqQIMxOAByFFosVAsCk8kLIJigAsACZrGKIhMkZxVdY9fqDYaDWAQABdU2ibT6JWaMyKFRqRAARls1J0ejwcr5fjMFisTrsDlITho5EQ0ncnhweEI2zZNHoeBCYUinF4Ji46bA0RGhU22ZGEw5MyzOaUbLEkn0AA4A3blKokAA2LSSXSBUsjNnmSxIFWBxzOMMRjzULwx3xUhMdjN7ZgQeJoIYjMZsnFrEAAFXyc4XV04UEYxUYg3xMCgFatSCdToArPJ7Y3EC23e28My9wx5H6kEqB8GhyQatIzHaMDFjH1pzwLMxBieJYFIQoAANrFoAASYBj2UVwkLXSE8G3GA9igKALl2VRxC4OIwFgKBnh3Q9j1PG5Lyra8VQAZgfBtHRfbQ3wMaiEO7H9ED/EB7EHUNrybEDMDAnw438RMDBgrhTl4FosCXThN2DYQQySAAlGBNMYbS8NWAid0OcQDMSIQTlMrSvxASspGdDi6wUHiNFbd1Ag0lyRN7MT/xDFxEBVJU5PHcDJ3jAImFYTkeAc4RWI8u9vMfR1bX4j0DCMJJTB7Kx7wkoMIrDYDR3k7wIKnJKDGLdSYEaSQL0tNjnVvWR6wdZt/IEkBTg60gut9UKKskgDpOdWS6rixTIOakBqPSg8j0OE8zwAZQwBIAB58zLAA+IJOyUPMhDLcpSWZPQyChNKbjgf4xs6/5GJ25iYAOhJ/gABUcT5QzgE7bpGM6Bk4IHhWYI8YCOn6Sj+gHeH+Ey0FiUgwAANVCWIYDOiYwEeuBUk0ramP2w7eEsjcwW2tGz3IiAAGtFHZzgIG089gQsThCDkBDdjsuiOqqXZonYNModIZhKKSf54xpOkGSZFlcCoJC9bQOAixSmZuV4U5KJgU6RnKGE4QFIURXFAABDqlERhF01OaVJmNrlnjRNh7eiBHndd93PZgD2HAsOBvdazhuWKkwg5DsUXZpcP2EjmgUu9iY1PlgslE4ABeNNzZoK2lCCYAJk4NNo+EQpkBzthN3gNBLDQC06+efTKc5F7a+SevOBbgOIH+RgoFNaFYSwIIIgoXv3AmVxNTAfPZwuWI5C4MvxClrgk+ED72q+1HdpoDHLqhsoE97j9F0KF0jTfo0wGXkf0izKAXurJsSo9Rf3ri8LmYBChilQmqXg784HwLgU6MUX914TD1rhC0DIHrMDZFdTgoIq6q0wSAbBbJsFPTJPguGoMKHvTNBQBkpwcZ41MIRPudk4CGUckFcyXAJYPBIPuKAlFxBEItG5K8C0Xw+UGs6cSBVAiX3RvTEK5VwqASihxWKClGqJRUsEUIjBwhRALldG6RcjbTEzHfTK+gnS1m4rIvibZCoSRsd+aa6j5ocVqlGBqCVlKBCCOcPmZBMBRCflcZcowri2OvNICqMinzOICu+eci5VFDUqlJSKMUlo6ICdQNayYjGpi9BSHIjxEIHCOPfSoNR6hNBaG0To3RegNFhsMGJ4wfZWJ5PKSkjM8D5m2AbPYNTShOXOPARQ1wki83uFU54rx3ifBKD8OQfwWiAk3mAUEEJVhzzhIiZEqJ0SYmxJCPEBIqiojgCSOYFSpzqyQPSRktBmRYFZFQeO3JykLBTo7CUZy86ykeQqZUaoNRagRDqNUCC34mnNN1DyaouIDSfC6Yarj/mDI8VYF8s1qrsW0f4pSRT9HBOFDgDgGAohgMUI06B1hYEIrZQghocSooqltEkx0FUFF4AZSafFflslzVyaSic5KoIGHJp8SmTgiIwQgAoCYRBJCFzgKqmA5jtXfJAOuayREkIqoUEhTg84oC7yIiElEsBxZFCmAoA8MBTxKBicXM1REKJcCPE6xGchNUvHojACYAApcQGq9pm14VqnVlrTIOEmHAUUdrp7nk4IMDAWzBhZuFI0dIZIdkTDYVam1DxaBWPIo0V4lNTKMBzLweWKVLBXChDKAAVDwTgSF8z6pgBa3gQa4C7EaFUfAibVDQF2HAWI9g9i7FNSYHV/w5AQGrhEJC5Rl3CFXWQYUpBF4Wv4bugd/xxpgGPfRSiaY7JZqIrEdIdEQ2NBKDQZZewwA5oAHLQBgP8AAVrOw4MBmQ7O7dwTgSh12DF+GenVFqY4SASMqu+uNM2vvfT614yAkIhM0qOjEaBlj4iQqaIItt4SICRJAWAwH/jsCUJc3EQaaBiGBEQaK/xaAInEFgRgJJhSEfejCZgcgADEBH4CjpIwuNAESaITDw9JojYgEKkHI5R+eJy6MwAY0xlj9y2Md049x3j/HBOqdE2gcTUnhMyfUweiI/xdI7hgxAODmyEPmrvckQYj7n1/AnfJzgrVJnZF7XpxA3qLXloUCWsAAB9TtnaADqkhJjKFS0lwobCPNefjS6zzgHTJoDFLsMGhA/57FOG8FoAKYLbVmXIDAEw4D03wMKSAT7ODmC5qG/NEBC1PG4EDAAkuRfIOaLhokGAocokBSC1Z9dNrVzWritYmOETr3WFy7H60RUImyIAAr/bAIDIHzbMHepwPaMBVtETw5AD9jlrOcHGwiAA8lpqjun/0GZ0EZhEJmONcaVDxvjAmhMrBk/8MTknxDAhezAYEQhgTWcFhAKIstSATHnHViwuOlY3ESxkD52sKhwAi+52D8HYuIBlOg4DW890JfXdXMU+Q5Drr+OwUWGoADcMK4ZHANtCGAPPXi1tIKLcoIb1PydZ+ejnipue84AKSx3KGKGXAuIjC7ANqeGYwXrq+l/zqA8u61yfxMr/dpBD1BEsI0TgGRHfsEVGlwgfM4DlG1VVyZcG6IOCwDgSwUANQG5Fyb9tDwPfLYVZw3QX66KVl4Bzdh1MFckYPYzo3sL67u8PYUb3EBff+5FHkIP4gQ/8fD+eEXo89hcGQDADVchZ63l6k30et6Y0lG0h9eI42wDbiPPmacnBnf/sQEQZgnkVTOmrBvbUzfb1fcGKV/gw+wCj/H3ASfARp/Rfn4gDi1hpDn5X73+ut7otjDIOTOQMORMIjoKZfESREDqHUM6aQt+LeY87eoQpowIb69eBQTY3KgBt6IBcgA+caM+sAiAj+eMoQr+Mm7+tAn+NwP+0BTY1gq+hefeXAD+VwT+GBSsFg7+HeSWWE10nE5+MoBc8qREZcYoaWjAPOnARknmMcQgYohu3qF6mWQQSEYIdkugy2GEbBrgAAhOCFIWQPIUhNHgXqLqboUJIcoE8FwTwXwcMHumAIoTodIfIdbgcBpmgnrDKOTp8i6k+jTiav2ohmmCOh2rsszobAkLOKFmXO2HtKBsyHtFXoQI0IvMIbOAeqXNBnoEEddqEZ8OEZEcrlwMwBgK4S6mXC7kVgBlkTAEEPJuUM5obvjpkSuuzhumrpLrznrpHuocbmLmbrURbrLlbp+krmABkQUWutUVzq0ZwFrsguKPUULjHs0RLlLnzu0ZYV0T0ZUQBgep7rkcXp7pwT7vCJXoHscMHsLJARHlHobk0VoWPGsdUmXhXkUFXqoDXnXmHooOeBaJ+geiwbOGwbEZwdwZsoYQIWAEIeUb0ZeuIWYU8LIY9AoUoboaQKoY0bCrHuLlCdIZwPoT8fwcYaYcoTCZYa8WAOgmrLSK8gyOkDrCAMgNqrjJpBRn9jRgiKMKoLEIMP8OmMwAiHpsBmyf+giPNp5siOZiDieB7IsZdhEGaOIu5PoCqAAo4k+PlC4jOGzqSWVNeK6EShotYFKvFDKsUlVtAFEL0arknjSDALUF+hgOUP8JaXzDcKECDMGDdoUHZBgMgKaLDEQBANPNPgANROi8zbDrq16ilLD4QGAIk8xISK5kbBaqD1aNBlSuYACyu8AgXyR2OgHwsyuwPw/mtq4Qz65Q46MZ2QEwOYZIXAT6ma4Qg25wLAkgOaRpKe/Cx2xEh4NpmyFZdEVZc6gwYgVQX+Qg6qRM8AAa3BwauG+GYu0QQQHEW61J88tJSsYA6gjGQOPYsQvGi5GOxp9yi5HEQmYw0Q/wHE8OtmcgG8QQkWbYGZcekgR2PBqQo6mG45X+cg/wxOlEx6c5xytJ7J70hm64IOFsYO/Jlm1y3BJ5dmL575aA0FwIbYkQLmTOesLOvhwg1ii4sRt4URipfRnO6Yz8Qxke5Q+FVwcJmh7ahQJFOk94n6kZPSIhquYoVFiAIxVFZFYZlFn4hQNFOepGPS6CMo92T2SEL5b57AJOn52m35tGAOf5QOAFoOaAZmEOFm0OolCOEmUF4llEsF8FOOcsBORERO2lpOBJGsbkFgmkbIRA1g/wTodleoYpKKkp0g4kfKSA6KgqBgHOmSzoqpVUGivioEZKq0+iBckSOkXSq4wZVkBgbCEVNMv0Z4k0EpHll+MpvE2KgQEVvlWK4qxKmimp1I5YVAbBeAPlzlHlTovKuUSArosqhg6SUSnAr87KhoIqU0/o/Y+V6prg4i6YsAyUfSic6UuwgowcQKYcgmrcEAccvsCc/S3oy241qckozAc1w1hcZYgKooYo/wQpRcoKBc3IEV5QQkZA5QPC2k9sJcj8R8r0JUZ840UA30LMV8/09Mt8Rc5Qw86+TVOkuKOQYorVGoICo8wqkCzKrKbVMNBoyCK8G89uVRnO3A/1LF5QEVG8bIYM4gSAoAAQ3MSQQqCArgrgQAA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { parseEther } from 'viem'
import { config } from './config'

const { amount, funder, receipt } =
  await Actions.reward.distributeSync(config, {
    amount: parseEther('1000'),
    token: '0x20c0000000000000000000000000000000000000',
  })

console.log('Amount:', amount)
// @log: Amount: 1000000000000000000000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `reward.distribute` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/reward.distribute.md","from":6113,"to":6604}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { parseEther } from 'viem'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.reward.distribute(config, {
  amount: parseEther('1000'),
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args: { funder, amount } }
  = viem_Actions.reward.distribute.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/reward.distribute.md","from":6631,"to":6827}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Total amount distributed */
  amount: bigint
  /** Address that funded the distribution */
  funder: Address
  /** Transaction receipt */
  receipt: TransactionReceipt
}
```

## Parameters

### amount

* **Type:** `bigint`

The amount of tokens to distribute. Must be greater than 0.

### token

* **Type:** `Address`

Address of the TIP-20 token.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`reward.distribute`](https://viem.sh/tempo/actions/reward.distribute)

---

---
url: /tempo/actions/reward.getUserRewardInfo.md
---
# `reward.getUserRewardInfo`

Gets reward information for a specific account.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/reward.getUserRewardInfo.md","from":133,"to":9603}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"2817cf8eb4e4b47b5f84b40187d076c43f7a53bee576d8d38d3d92985fa42e8f","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinKQwAO6SUABCoeJgvDCpAEbJFgyi2voAHP21yqp9AMwtOnp4qxuk27v7uPIWVmeIHsjmcoyuE2oXmmvjm1ACi1iK3WmwACmQACoQADWimOpzA5zKlxkzTu9T6lRebXeKK+6NIWNxYC6AKQQJBQzBSAATI9IZgpgYZn54QsDEsuB9NgAlGC8RhYRiKNCpAAG1loABJgGJSBYlK41aVylJEL1ejz5HUHuaAKzUt4GaVfOUKpUq1k9RAcwbDFw+8YeKFCnyzUo0cUgfLsLhGQTCE0k82VWzk201bQ0gzxkxeqxU4F+7mICHBwXeEVwyOBGOFF1QJMVSlXa33BpkrNOkAN/NIQuc/2jXqNAXQ4WwiMIgwJACu+2MYE4bQAqnAyHLPlAAJKJCAAHgyiWSAD4gh1kqkj1kKJwsI5mHoyHBUrnhAA6Bvv1fr0ibza7gkEDvqiD5PqQcCHsUSgnhEqSoqQEDMIw677m+cCfnSUDfnoa4blhgHAXKaCzqQYAAGqhLOMAnrkYDiI+cD3gcy64b+/5fIRpRQBAvAIAYADiehwJwqgwMiW6cBYQGkMw4iLpwMmcOInBMfKjBJLwym8DE85oO+EbiEo/HIMgIB0AxWAKKUaq2WgcC5HWXDANEqzyTA17JLe+BoGgWCcK4imIcwnAAOQAAIbEoyEAPQxKsoWOawsacC5NDJQFQVIWFkVGbF8UwHFDgWHAiV5MlhQuehmUJMFOVRfl7CFelbBlbkkpFMeSicAAvK5MDuZ5ShBMAuScNExXCKkyAtRAGLwGglhoAAuhQY2iUMwgFPZqSjUu42cDNMDJe+jBQMtqQ+X5QQRGt+3uLkrgRLk7VItJEC9cpGyMHG/AJhhX4/vhW6Eee0G3nt41oDieJhZqPLWLw1jIyjqNo+jGOY70oV3eNTi6YSqShZq4h2jpjxI480jSJUAAiWx2kc1hQNI3B2jAACiUC0701hpOIRziFs1g3I8jTqFc3BpDjj3PWAtnGqtZn3kMzClBe3UALTpNBBlKyAKsMaUhuPiMIna6BqvgRhID66sJFkaYGL4OJs6/qFIkNlJe6yfJCacEEqzusqhK3g2DJMooYdYTsch7AcER66txLNvaDrpg0vSZq03ZA3+BF7n2iADsWIy8vy5bjmGoo1ngIRhJEnXLBrV7QUl22dZ0Fyp1nQIKO2SCdjn7TQUXJegmXxe9GOoZVlOUZBFgiE4BwGBRPjEB6akQQatqupoPqyhGpwAA+PA6ZvhKn5w86wEklhQFEABknC7zqeoGka3G8fxhgX3pylfJOBdlAUSH0xLRFCHIAOzA4BKHfOuMAsBSCJxemAXIztxIbwAeIKAUBVhwBEtDTgABHaipAMASU2N7ICil2BNjNL0K4NR+4UkQNnV4gRsGEiLunQcJZKgz0rJOeYgRF7LzIJgKI0NmTqk1O/A+n9jRUB4nxPAmDOAYm3KiBGYDmTKTwQQ0wpp9A8kqGSVhtp05dkCDIxQRcyT8MnoIyus8RFikCPRRizFxJLAgAoXIRBJBN38YcHWwhQnfzUQYDRao/EKDVJwZg0BZwKDvIhIgZ14DKVUvkNJsAjiziUEoA0IS0mqHklJEScAWCMDjqQMBokXa5AAFLiCCQAZV4PqLAcQTChKSfKBweQ4AhSXsQLJoCjiULWDAI4nAjiITWL+DCaCNHJKgKk8SdBtpELWB9NSCpNJFGSpYQkL40EACoeCvyPHAUJiTeBx0IZwNYP18CDNUNAaps57DKREnE/pCh3xyAgMNCIapbyAoicCsgiFSA3USXsUB0L7nAs+GARFTTKm8D2As1265QHELWPqGgjS9iUIAHLQBgO+AAVtUg+A1mDvlyNc7gy5QWC2gaih53tyi/E7skUiMAiUfRJT9cSxDkBqnGQcQhCC0A8VnGgNUy0ghXSwC+GKMVICwAZe+dgSgYqqLgDFOONAxCayIGY98tAYriCVDFOV8AMI+WYHIAAxC6whYhlVoHXkg3IMqfUYT9XCtVGrfJasQDqvVMADVGpNT/c17krU2sqHah1TrQ3vndV60N4bSAoPfJol2nKIDctfvEmAjy8VHAJaK157zN5cCcqUiBap42IBrYkjZWzWXoLAAAfUuZcgA6pIPIygx3DtSBopQXLQhlPEpWul8o0Ae0+YQKAIlJDiUsO8sgTcUI0EJHIDAuQ4AYH2PgRCkA3acHMLiJp4lFkQGWce7gqJtxEJdpQghx0jgKFvJABp+7X2UKWKelUF7cjhBvfYe9m8RLPqwXIaBEAxINOpbAeljK3KwNLR0mAUry0ysgGSoQ6TeKus4NuGKAB5SNmrtW6ppYmnQya+KpstWga1tr7WOsYM6xC8q3VoA9Z68QmtKMwE1kITWobNaCCiDJXIyTVg0PYHJRcg7cgc1oJZNJbsO3lsXZW5dvKEmIDQQrBlr0YW0tBcNUKLsMPivYHIKAoUIgAG5cg6s4AhM4L5ODudBa8rzUBbzEL9a2xzaLnNgqCG5mAHnOAAFJSq3lCvs0g3nfMBbAEFkL5zLrpci/l7zsWDlKoS/sIFtK4XsCCJYNYnAObFta6FcdhAIBatvPc02+BSmC1AQ4LAOAH6+f84FmKwXD72U4C1hpjE4BGSwUg1SEheDYg2k4KVdXkGkFsyVhb40uvwtSH1iAA24BDaQnoUbygFm4PC466bor5sHTxlwZAMAglyAunae0P3fuVK6T0/SpB5y7mdihI8NYA7dqIMwc0jweTmiuHLILEOuCMaOOu/gn44dgAR3AJHAQUc0sQGjn01hpA+hx+Dg6lTu1nDIPROQonaOEJinQeUKqEzsPUOaaQrO/uHUB6EZamsSWfbIE0RAPIeSS8AStoHUPFRcDa7TznZFQi8/EwL2gQvFzsMaE0awuOLts64BzwkXOjdyQsALoHw6P7KBV48H0aCOpePEn1XrdToEykrSVIQoVis1vfBinetM9i6AaTqQPrgACEnBE/KDIOntUc3zuLdC6kbPyfODjtD5wcPJwIlgEz6X3PtWdsndyArNBhnjMErM+JNUdy+VPPCBcod9mHKNeEFwVtn02gdKZQxDpT3CBrBujHpEcKp96Bn4R+fj5F/L8S1wZgGA+9pL6u1ld75j8wCCK228cKC8aaP01kFKW0sZeqz5gvpWlthYi55grMXGkGtD9L9n9XNf8sscswp38isfsysdpwtKs/8atACVUH8QDVs2t1hOtusEVet+tBtVIntVAxt3tJsvsP9P8Fs4CwtkArt2Abt8CHtCCRsSCJtFcH5VpGk4V/ckRA9PoQ8MMq8I9a9o80Cn9481QG8U9gA0968k9c989isv9i8s95CGkK9BDq9I869VCc9SB08m9uD5ZbJDJjIkBTIyhSNShkB7lSIDh1VWNY0YoSlVBZwjh3wYhmB2N9UzV40YpgNK0YoM0s1zAjg4on8GUIhbZk4TF2RrB05LEGgOFsxgQmsi5ZAiwJ4AxrAhEYRwxRE64RtoAogQCXMgh1tNsAB+VIClW8d8eogbRcUIS2BiMLClZAZaOCTgIgCAM6AOAAal6E4FhFBVwSiJUR/jwGoMaTVHixVUSTeVUE4Ha26FpU4AAFlUkBArIsEdBZxHxzlIElwG07xB9RVbxFiPkxJcgkgIIuA3Ym1whX10kWBJBKEKjdBlJtsoEDEoAfoExl0HjQEni4A3CxAfphchBAkqJskalkJ6lGkQ0lsEgghHgIUHDo0nC5IwB1BDUuNuhZx7VsSlNNszVsTHhRMzgEh3xHg81JM5A5YggIFWh9iVQ90tMfj7xCEm1pU1Rhc5B3wZJdNEUMS/I2N41ONjVTVeMFoBNM0hMnV+S6SpN+ShT5I1T+NWhIhUFh9bIHMx9m5L4uA+o7QV8nNQDUsCZVQssfNbwrTKCi9ysigt5OAHRGk5i0BEtQkLTQorTEAcZnTCQHTqDUg/TXSm8PTW9bI0ESNxIZUlSNSRSo0xSnCJSMIk1pSLVZTgiFSRMlT81PVVSdN1TizNSdBG4lJNNxJ3pfY9NTCTIzIalfhSgiBrB3xeh2zkZoju4zRHheg+4bQGggQbE8AXN0iBgsjwRciJx8iPFERx8qFXR1IPRCZX55F95D5DRlEU5ezHhWwM4+hrFh5aQtw3RFQQ4iRViZAJyuRJ5HgK5JhhFZza4DBA8mJDsV1oSGka1W4nMolf5Yle0kkUk0lxlMlYA91clWB8k5kikSlXsa1sU21qlakETiFriwA2lOlukdcV1BkQQRkxkMlJkFkZk5kFklkVl9Nydy1+00kdlYw9kDkcAjlGAtJPC2Azkdorkble8mtHlnkRJLjt1vlVJfkPknjrNktwVIVq0n8MCIUviUVY949FKKk4h61G0xVXlSUjsviqUaV8MdtCNB12UK0q0pLEkSoJBBUNYRVtKJUyVeTc0PSWNo1xSON0yuNMy01+Mczs0RNc0CzC16sVVA0oBg1ZUxNXVFUTs3KUy41PK8SpSU0sz01BMArjcYrgrorfUlU79S0F0l0eUgLcVjitLm0vkVUpIKoBBXtO1u0gK6LaU0FR0J0p0DRZ151zNiq8K10N0t0ijd1lItND1sMT0xBYNL1hBEM70hAUMn1GAX0IF31P0Glv1f1INkR1xmBgMYBQN2ARqyMYAoMTAYNz1pqENb1kNH00NlJBCsMXYcNDKGVjLmUMJOBYzniKMsNV0lxQ16MmN4qY1EqfDkruMzU0q/KMrhMsqFUCyZM5MFMwAlNcq4AVMIA1N2ANMmptNayExqKO9oKu96qerLMSr+Kzsoy1R9TY8yjX8qtosYDC8QyEC39osIzQrPSDTvT6bwDssAy8smbgzv8Kt2b/9Ob/UvTYUcDMCOs6DcDbt7tHsWDXtxsPsptFBRVZslCqDv8VscDBlCFNslKdsnB9sD4Py4t8ri0zs8dsDrty9GCVbntWCNbyD1dKkAcgcQcwdC98dPqcLelScwB4dRtKchBkc9dYA6d0d+yscmFbdfsNdCdicYcycKcqd6AacY76dHhGdmck6A7HcRhuc4azVBdeBISwBRdxdPb/sZdgd5chhNbTsrdVd67NdQhtdekc7DgDcy7Q1TdzcRd1ArdGgbdO6S7ncedXcStG7PdFFvc+Q/ch0A8GIg8woNCw9hD7kwBRCeb0Up0E81DOBU8N6M9dDk888RaVCpDy9K8tDa85C9CDD3SbbSBqb28jNiab4mzupO1L8BLB8qbjCabR8OpJ8+pp9Z9mBt8YBd8C8Oo19oGN9YH4HEGzTlhgCmtPoz9Y9L9r8VVb9i178wAcHzS+bECot/9mblCnTwD38m8gDH9KGX9+bIChbaHb6GHqGmGUDuaKGkt3wMCz8FbUslaCDhtXa1bSD2DtaIgeH4DaCcCGC7spGiCXtup1ayCtbzpDDi0eCFy+Dg9t6hCa896D6hHvSJD77z7HxL6pCb7dbHT4D76zGn696X7r6DHP6wH6zzDGyrCqAbDN5SB7DkyQbnD3k3CPCkJvCE1fCaV/CuUgiMrQjwjzTIjuydz9BHg7QEjByNBHQR4/z/hvReYbyhwkAcjXFvAJAlBShA9RywUGE8mCm2w2E0wXyQAOJQEg5zyVRUhNR1BKgeQoB8m0heBGhGhHhKg0h4jMdpAeQ7RxBHgjgrhKhKgtheBpAYB1A7RpA7QEhrAjgOYjgjgi5KnMjbzsjpzq5qxpxgghqSin8yiPiYBqj9K6iGjekAS5AWjYEaiwAMAOiuiei+ighBjhjZhRjH5/ypj9biFZiuaFj3llj1hVjS1Ni5Bti0kWSDjlsyr8VTjuSADhKMLbjlggT/lnil5XiKEjaNtPjkV7roFcE/imjoEaWQSwSBASJFxoS5BqIUL4TglnLkTUT0TImsS9hcSk0CSiS9gSTdAyS9gKT6XCRqTaT81GTmS9jCX2T0NoEuTCVES+SBABTEzpXHDQbEnwafK+M5Ss1Yb8z6TCzLWNSNTNYtTFHqKR999AzjTXSsHeaX8wzMtbSg2lGwswy3TrapbD7pLLSjT/S7SjSY3QzU3wz37E228h0vr4zLXBTSykzbWEnJSIaZT0r5TMq3WVTPXSzvXfW6E1tcaazdMCaAmUBGyLADgWy2yOzeZrAcnYifRZnOnbRhzjyDAxzymrBrmnEAwyxHy8ia4nmOoGxY544wkTh4KiQx29yLEimMcSmTzNht3mz52+g0wl3Rg+z7m54CjXyN73yWIa0vyV1fyksEWYly1LLgLNlQLiKIKck4SdjOACk4LSlEL1KqkoK6lxXwFmlML2lxAe6+knN8LhkUIiKJlYApkyL5lVqqK1laKQLtlaBdlRJ9lVIWKNI2KTlOK2TQGzK+KnNgGXlhKhqfk/lJK6aUsIUoVY8FKkVtspK49j61KHANLyq/6eTxVdLyUQXOBcNaVXq9RmVTKbkLMLKgLrKd2hUlB7LGlHK9KkS+cw1UXRSom0yHXUrfLnXczy7lSC00aPTwrIqXKP7gaPKwaMyHOnX/LYagr3WQqTtE4y1xJdOrNSrNL5PQFLjJ921Sae9Gr+LAOB1Wqx1J0yJOrLk50ovzLl1EL+r+BBrntRKIMxqnqJqz00A4MZrrr5rbqlrjqKKP1fweAf0/0TrtqgMQNljDqIMxJTrhBzqGvLrr1muH1UM2u2Xhjxq1OjLNPWjiNSNvqu1frhj/q0bAbmMbO/P7WAueMoanPMrQupNEbfrkbUbLOMasa/Gqy8bO2hBCaf6IPTNUviuKaOPQGA2k2fTGHhaXHWbgeJbc2GsBOwDqGBbctoDM22bGaIeE2of5LZaxHZa8D1GmDpHiDZG2DNaZtFHQf9bVsmWTbWXyg9sDsWIE24U7a7cFa1HlbmCZHtG5Gifvt/b7dpcfbEBQdeg7RO6MOQ6w7EdI7qdo7Dh6d47sci7efU6N0xeaKJends7pfY6Gcmc9yFepdp7Dcech7K7q7a7egJceepdvbZdm7Fc26Vc1dLeNdG6MO+7EAB6jdjezcq6Lcx7rc9eNcDey6573dQhF7NyfdV7A2TGt7H7d6o9Q2j6yIT69Cz6ZCL7vGFDEf3G4+LGhBM/9DJajD82DMPuTN/7nj2OktOOh9qbaakQoHWI0BN9mUMGP098DSuAUGm+W+58F92+kGkRrGT8MWOsCGmsiG0ASGUFisxC2GYfxbCtEfwfkDiEWHSj2HYfOGEfSeVCV+AC1/UDyHWHhHRGsDxHsfWe8etG3tCfyCdbYDRbDpmenaceXb8eOe7+9HODiEjDo+N7+CHjePvvWKzD9aUtjU+vYxgCOM1CzjR/nfVPpAC8+OhJxr42prdsLC64P4CAFCZ2EYAh3Jwi4XwCxNPCFbJJrABSaBF/KGTWPNk2WgxFkwqYW4IkWKbUAZ2qRMpmYDZDmhbgd7GpvcwaZNMN6LTRpj2SqDWBmBJ7bpk8z6ZvY44vwVIMO0xiYwWQ17HgVUxLC1NV2M5ddgvBebhJhG7zV1FUWBYYAfmhqP5kIGaIPg2iILMFqkAhagIoWQxEYhADGK/sQA0xZFq5UqofIViAIbFlsUVD4sDWbJI4iS1NbnFfBr6G4owDuIJdaWECelnJEZYfNTaPxDlv8SsHcszWvLI4OCQFYJghWIrBDmhQ+hIkqSUrYGrKxxLg1FWMUYkveFVYND1WlJLVjSVc56ty0BLMIRBk5JnFtKRbOpCW1rJlt3KqZJKid0hqOdguipYtgWSLK1lm25ZP1nZj1IQMkQVpT6KaWlrJtfS2bSNgGXtK78nScbSWmj3n4pst4RwjNicPgJnDIeR/EvmAELYWthh1rXzhMP87eVAu2ZGGnMOGELDG2Sw0sj6xWGttgKWmDtn7De4YDe2V7EAK2XbKdkR29AsQf2EZyTshyZ7Wdq0zUEWgNBk8FdiGCfK6DSmywcOJiBhg10FkBIA9owLmZYjKQOInsFhAjjUirmvA0uAGHvICCjIQgx8CILab9g7QaYFgTYGfa9MsId4Y9HYhpF7k7QVwawGYkaDSB+yio5UeYjVH5NVBXAipr6EnL8Dk4MQWAEwFqqpRz4i4ESIFFqjZQ8seUETLNDKhOQLRGsGqHVFCjvhMmWQNqJ3wtFbsfgBwaOFuHZHMhgxsoZcheUyg9R1o4gb6L9CtGYQtwOENAHhHzggw9wYMLqBDHWh4x/4q5YmLQFGbjNJm0zWZvM0WY8hlmqzdZps22a7N9mhzY5qc3OZHAZY+0KGNSKJjwxEYygvsf2IxjtjxoT0IxoYJfyyCBmK5VUAGQbBnkpxcsaHqllkHcod2abRct8HkEJxdhPpWQSvD0R4gZxbIqkcyDlilBTY4gJAKAACCKAakQgPAPZBACuBXAQAA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const { rewardBalance, rewardPerToken, rewardRecipient } =
  await Actions.reward.getUserRewardInfo(config, {
    account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
    token: '0x20c0000000000000000000000000000000000000',
  })

console.log('Reward recipient:', rewardRecipient)
// @log: Reward recipient: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb
console.log('Reward balance:', rewardBalance)
// @log: Reward balance: 1000000000000000000n
console.log('Reward per token:', rewardPerToken)
// @log: Reward per token: 385802469135802469135n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/reward.getUserRewardInfo.md","from":9689,"to":9971}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Accumulated reward balance claimable by the account */
  rewardBalance: bigint
  /** Reward per token checkpoint for the account */
  rewardPerToken: bigint
  /** Current reward recipient address (zero address if opted out) */
  rewardRecipient: Address
}
```

## Parameters

### account

* **Type:** `Address`

Address of the account to get reward info for.

### token

* **Type:** `Address`

Address of the TIP-20 token.

## Viem

* [`reward.getUserRewardInfo`](https://viem.sh/tempo/actions/reward.getUserRewardInfo)

---

---
url: /tempo/actions/reward.setRecipient.md
---
# `reward.setRecipient`

Sets or changes the reward recipient for a token holder.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/reward.setRecipient.md","from":137,"to":7724}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"fbddd9bb5f6273cdad3f5a5527a9ec016a6ae4f6251d0c70ea8374e2f635bb69","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinIRysKSpAAbWtAAkwGKkFkqum6VQELwIBgAq+DCcaBAA1oorEGtknOJQUKTwcE4AHdCJw4HpHvdGKROP8gZIoLCYLxGFhGIoGKJtPoABz9WrKVRIZrUVp6aYfdZdCxWADMA0czlGOIm1C8FNmpRoCwMSy4/14MFRaFSNyGwmGgjAACVkUKsJiQBcrng7g80OK4JKhEjBcLSuUpIgcbICfUNC0dOSDAL5YrunSGUMmX1GqzMFMDDM/NQAotYrrUeiwCLONs9gcNcdTudLtcQGqkfDSIiBUGMd9fv84ICggAvMgQTN/AGcCxQRi8cQ0QEQBUAWggAFc0BEDdiZDj5HUiWNLW08Gm0RjqT1EPSQPZGSMkAAmACs7vZXt8c19PJA+XYXCMUtMhv0vV6XbNvZq2gHBl3JlHjsng2GLkQlUXHjZnp8nPmgS3hThCPbCo+lnEkFEJBoSQva0QH/FNbyQCcp2dGdEHnWklw/b0125QIEibMB+ClME9FlFFhxDABlDACIAHgyRJkgAPiCDpklSeisgoTgsEcZg9DIOBUmvYQADpYKgETwTQUj00o6jeBEgAFXj+NIOA6OKJRGIiVJFNICBmEYcEaKkmTyLQKiCJE2U0CbUgwAANVCJsYEY3IwHEPi4B4wViOk5FZIs+TYxVAwKL0WsYSnZR4EhB5xMDczOASdhvkeF43lWdZvjARF4UYNBARSqLilIZhqylESuXEJRrmQZAQDoTysAUUpNnawrcl/LhgGif5qxgDjki4/A0DQLBOFcZL9OYTgAHIAAF4SUQyAHoYn+OautYbdOF6mgdsm6aDPmpaarWjaYHWhwLDgLa8h2wpeuEwEpoSGbTuWi72Cug62Hu3I+SKBilE4ABePqYAGoalCCYBck4aIbuEVJkD+iAbngNBLDQABdCgEceTUCkK1J4bARHEbRmAdpExgoFx1JRvGoIIgJinJvZ1wIlyQGA2zJs5C4CHxHyndCJMMSYGTCTTIC8zLN4FjNK48nEaHYNQzmnZxHnXheFpXhrFpaRpEqAARAAhecACNrCgaRuHnGAAFEoHN3prDScQbfES3rDxWlGnUHFuDSOb2cRp5XjAVJtdoWdrCN6wU9TtP04zzPM96CPcm53J2rOfGGp4oZmFKVjQfrdJNKq4uQFLzzSkbviRkBavlLL1S4DrigGv+Wz7NMRMNXECUJYp21hRyxEYBIENOCgatxDr/Gyg7RBelpCcwPNTfILJQI5bIzXFfg8cnUfUZGmsDDvCwrk/QMEIwkiYHlkr9jNO2kngc6LEgKb3nLYU8EF+zQUrufRCD4XSIHUOoO+HIfQ4TwEELA+kcAcAwFEDWGJUjZBADsdQlRZxQFpPONIvBGiNFpJUNI1g0KzmkAucQtIbY4kqJUS2vBpAwHUPOaQ84EjWBti7G2NsCGASNL0Ros5uzgRkOAwIuCQzn0qJfWBs5EEri/OuQIaCMFkEwFEaOih8GEITknLO1ibE2MkQAo0s5Zz4l3r2ecSi8CmLAOfdx95pxPi0W+D099VyPw3B5LyPkHhLA+DAXIRBJDv1iV/YQsSQrxkTJsGJChNicGYNAQWDx0HEHprFcQYJ8gKEXjAG2TYlBKGOEkqpqhqxlkBHAFgjA5CJKeHFXIAApcQCSKK8COAqJpDw+LRSMrNYpRBSmIhthgYENTOA230kCcEakRK8zAImfJUBCmcDoCTQEaAgRFm8gFJIvAig7UsCGQSuyABUPAwz0TgLE3JvBuk5mBAVfAeS9CECgO0ps9hviAiySYWJIk5AQFhhETYXFoWpIUCJMg+lSCs1yWPREqLPnouTGAHFkJWlVgpjbB4TZwSIl6UCI4NB0o5WWQAOWgDAESAArdpGoobMB2WAV53BOBKHhb7OQYZskwFybdCQBFomaTsjAOlRYGUFXVEWZAmximChzJJNAFwWybFxkEZmWBBKrVWpAWAPKRLsCUKtZUcBVrdJrGgesRBZyVBErQVa4g0SrV1QCESo1mByAAMTBpzGII1rYZ65G1dGnusbMUmrNWNC1iArU2pgHah1Tq4yuoGmIT13rfX+sDcm0NaBw1Rv0nqnMhrMURBEpwRMYqIASqlTCnJ0Qx5rOpbS/5qhmxcG6o01QDxNi5sQNK3JBzCmCtyAAfWec8gA6pIPIyh10rtFPcUV4rQgTM4F2rlyI0BzUBK3EFgJJAPEsACr4SwjI0BDHIDAuQ4DyXwPpSANLODmFeHFNZGytk8EUgASTOfcZZ2YaY2wUFxSAMIH1xWWa+sQGJP25HCL+/9zZATAYeKESVEAp0wnZbAblvL+rMB7pwcK6pD3asgEynUybOBQdWgAeXTeay11qOX5p0IWq4xb3Vlp9X6gNjAg0NpDWGyN4h6zsZgI2MA9Zk31kEFEYquR8n/DLIkdg5VjBgGXWAF2tBmpVJpZOw9nbu0Eq+YgXZhceV8zRZy+FsM5r3DkPC4E7A1hzQiAAblyFazgekLCkxWDAILarQtQC4r02NY7vOEt8wioIAWkvBYAKR3S4nNC5pAwuRei6tWLRxHlM0KylyraXmWZZbNl2FmL2BBEsECTgLtSBYvyxuwgdY4BcU+bexpvtEQOCwDgSwUBwvVbADFuLjzjlDdSl5LUugZ5ggkLwZ4RMnCasO+sDYNXKaDaxakUbEBxuTYMsCmbPwVgBsWyq67lNvhcGQHPUIjN5xAJ+5TVpIyxloDEvhKDez8BGXojhTgvWOWICIMwTetJZybxxDzNbtXfutN4zbC9/AYdgDh3cRHQhkeo9gOjzHtJrDSHHHjsHiNWmzvi2QDycgFOXABKtOgyIWxSjgeoTe0gOd/c4ADhJchcb1gZZ9sgTREBOJl60wHchIfT3pzARAPP7KhAF424XtBRcWbgY0Jo1h8cxaJ1wbnIZeem/KhYYXCuV2HGOBr2k45dlAwiQ8CGc0N1dMldKLtt0hBzSiwRXtnLiVBE2ObMeugYT7BD64AAhJwdPMVSC582Kt9b9WEuF8z5wCPQXODR5trHsA+eq9kFz+ly5zahsF3arsmzdmh2OenR8r50RflPLAD3zYXnE/CC4GO8Goq9AUT5Z5CiL3CBAlZgnoGmLF9tBX/R9ffFN/b+y1wZgGAR9VIhn1iZIlr8wCCGOriLaE+Gav0nuFeWCvJZCy18LBPcveLQSRLP/CrNYDvM9DrMAS/R/b/fzQLYrUreaCA5bMvWrDbBLJA5rSA5lLLWAz/HzDFbbbFO/W7HrcPMbC1Z7abZQNZd7ebL7dAjAurEA1GCgjYGvagibMEF7VQN7ObVXJbfGZlTFIPAMEPRfcPSPevGPVJMAePD/eAlPNPDPL4bPTyGAPPAvdQ4vUvIAzAivUA1vGEWvKPeQz5ZvXQovdvMQ7vMAQuaqWqJAeqMoGAXAKgZAT5OyQUU1QTbNVaBpVQJsG2ESGIZgYTW1F1XNVaJDLtVaL1GTV1RgG2daL/HlNsXGNeA8OcEOeRPec8Q+f0Hzc+E8JCK+JAW+IJZcT8ZBJ+YIW9aAKIeAvzIIXbGqGAAAflSDHgwC4hEkGLrAs1CE7k8lAL6OQFxh0k4CIAgHphRwAGpegz1Zh4Ufg2wqBnU8AsCzkixNh2s0BckgQAVOA+sHQ20ABZQWAQFqUjHQJsPiTbClQdbicIWlLiE41QPpBiNSLgGlFVSFUDdBFgSQZZDo/bPFb4OvH4CsEYyVAExEcIMEUIsQAqMXIQeJZyWKDpQybpGEXpJNCvBIIIWkJFfwzNQI8qMAdQe1MTboJsP1ak7TTol1ak2kBTeLBIESWkGtcNfHIIKdb4B4p4wqYU0jOvHiHMQEwkzYMXOQESYqczHFCk8aITXNUTR1Z1STLGaTCtOTVaeUvkyNeUpU6sM0j1VoSIVtDzdqGfIGGIfCYWTgecHfL/NouaR0kMVIIrZbLiL01sQwtghrIoJ01IdxNrQ1Ag6VBA/LAMxACOUMkMVg3Y1IeMl0qAw4qfXZZjOXOUgQBUi0lUjNNUwIjUnuAtbUt1XUpI/UwNI05TCNU0szc0lsy0nQN+YqPJH6EzC0yqZwuqBqDpBVUoIgawESXoCclOEAbIhxfQWcHEUCHsBoCcKCQIPzMojRFCFkGozCUJb8Eo5YLKNXMMHYfYX3ZQGMLYuMVUQ9Lxd4T4NDLMUsEES5CEKdaEJMBERKTWKRfQZnFxZc4kDxFcR8zcvxZCAJdCXckJXRFBAwEPbyM7CZLEkqHzFJHLdJW86dedbsw5KpOZUpe9CpVgKpWAWpepRpaVMlcddpTpfE5lKdAZIZcQPXcZaiqZBwPIOAWZfSeZWARZZZIEVZdZCATZASKzfZApKpE5bcM5C5MEHAFEG5O5NgB5UmF5N5TYR/b5cfEdQFJo0FFEiFZE1zdFNopFFFGM7rbFJFA7My5PbdUlFpOIAdKlTgRE5ldVJlXpPozgajTlHlQ7ejQVYVI9LtE9By2VOfMeXySuZVVVYERlc7IkwXfVQ4gTTNdUkTCssTKsktD1Ws2TKtRTfVRs5NQ4qIPFRNHVUqlNLvUgTK0snNHKukrUotas0tIqyteTatcquq1NIbVtdtJzY9SVKK/tSlIdQEr4wgFsMsR6AQegoUmdNHXCxddFXZNdTdbdY4PdA9B4ZzE9ai89S9a9IFUdIy9DJ9Sjd+N9HDL9YQAjIQIjIDRgEDIU0S8SmEbgaDWDGAeDeARDZDM41KdDKdTDEwe6j9R6/DAiP9F6wDEjaE8jW6gK2jYK/lRjXMoUtjCjB4TjOq7jPjJqrNFq6Itq8TF1Tqwq8tYq3quq40iNVTdTTTbTOq3TCAfTdgQzHsiwPsoQKzfvUiwfZa0aiK8a+ddzSfRwu0uATrcyn/HA//KrIM1MsA4LNAzMqMmAmMj05WkrRM8rVLQA67dW5WrWyMuNBWzlGy3raWAbUgkbHg2g17eg2bD7BbRQFVFbNW4wrbLFIFHMTog7coY7U7XyDLBq6Wx3R2u7bgx7Ggvgug0GD2pg72qALXf7HXYHUHAnX7WXNi6HUgWHeHGnV3egFHWdDHLHHHY8B3QncHLgEnMnYu0u6nOAJHAIKutHGu5nVnWkdnfOp3UGhnY3PnM3IXEXXgDE2OeBKXLOuXHO5XIYL2jYW3TXYepu45BXIunuse13E3fnZNC3K3cXdQW3G+BugurnNHce93cQT3HXH3KMZQf3QPGW4PLQ6Q8wuQxvBQpQ2fHLESVQ0wzgTQviHQ0wkvFM4w1IMB3+hvJvFvPQuwqOy7bMmW4Wu4jy4c0GFanSsfd46Wqfe0gMBfCGA/VfZgY/GAU/VbXfIbffZfah2h+ht0ufPJIgnLRfO/GMx/Z/FsV/Ia9/Qg1opWprFW9Av29gjW3A1rXpAguA90iRv/Q2srNA02/O82yRy2xRmA5R4gu28gp2qgxO3gqbN21Oxg4Qn2iIWB2R5ATg+7F25OqxhgoQr2kQqA8Qz+yQ7+sPRBywuPBPQx4B0BvQ8B4AHPFB2wgws2uBmw6vIJ/+qw2JzPNBosXxpwloFwlAIcjw0obw5sUgPwkssmoIgFUI8IgyKIvNGIjlOI8VRIumlItImMzImcnIjefugos8ECycJPc+U0Co2BaoyYbwCQJQUoEPPADcuchCFnPphoEBeCkAAACUpBPJ2ASBNgADEoBGgYB5xehxAfgcQcQ9nGg9nKhBRGg/YLnZx1AnnpBeAEgEg9mbZmEQJGhhmtynxxn3xYL6iNx2jgVmia5iC2iITujeiwB+jOBBj7UFQpRRjeIJj4WpiZi5iFighljViyB1ioBNilQbyDBdjmUDidajj9KzjpYLjOBrihZUQqlWhHiMRAQXj3KpSPjaWmLfjlhPLkShSQTypSBwSAQQ6oSyNiwCpUWETh1kS4BUSBBbILMsS5AXI6K8SektVaquTSTyTymqSx5aSC0GSmSx4WTdA2Sx4OSQSQxuTeTlMBShS2XRT71jMZWeWZS9WjSiyjWAjyb6nKb8qpNuqDSGza0TSCyLSLT6wrT7GrNPN5agG4hmwF4IZXSbbYzPSM3QxfTEyAyHGQz0yIz0HoyVH/N4yi382S2Esy3tbrbZbNgcyPC8z/W2ziyg26nNSqadSurWnI2CymbmyypWzx32zapuaYQjMHh+a2z+zcnByygLBBRRzxzJzPZrAumFnxxegahXEVyBn5mzAaRFEILKjjRtE6jsIGigYVFQxwxzzX6TgzhrzQoExD0EpH3ixsxcwCx9I/3SxyxKwS0z0Gwx0SXcjxxyFlmL21zBx5Zfz5Bz2+xL3NE3QYLPEaoZmtC5mEU/yEJKglyFEbADyDAzJNZUgiESEyEKEqEaE6EGFsdmF5xWF2FOFuFeF+FBFhFRFxFz4jx/nRhb414YhYAmBFq9oeAJ5XpjpZpytzp5N0Z7puoZPK4jp3oTo5oRJ0iQYAY02ZPjzSAuIp4FQzPkOMwpoRYxZZOLMe5xJJISIrO5ICJlYQZVZCZH245aPSFyFKFqFaF6FGE2OOOOEuEeE+EBEhERExEbZc4OYvFfPLFk5bF0v0vEv84/GoWf9NnHyEyRotnSB8c9af8qO8FEzH38dShW5xAkBQAAhFAOkhBPEEBXBXAgA=="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const { holder, receipt, recipient } = await Actions.reward.setRecipientSync(config, {
  recipient: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Holder:', holder)
// @log: Holder: 0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
console.log('Recipient:', recipient)
// @log: Recipient: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Opt Out of Rewards

Set `recipient` to the zero address to opt out from rewards distribution:

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/reward.setRecipient.md","from":7902,"to":9934}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"352385a25dd040388468da70eb96fdefa557efcc59a10ea4590405622b87794e","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70TKzsXEaCwqXlUojqsrXKqhotOnp4qyZdFlYAzAOOzqONE9Re075z1AGLBVykMADukigG20+gAHDUFPsGs1qK0TgZfgDSED5JckDcQPY7iM+pUnpgpgYZn4PgsDAkAK5gfhrThwPQAJRgvEYWEYijQAGUMNSADwZRLJAB8QQ6yVSAqyFE4WEczD0ZDgqTOwgAdIjAar6WgmSy2RzudTVQAFOUK0hwfnFJRCiKpY2kCDMRj03na3Ws9lgLk83iqploCmkMAANVCFJgQtyYHE8rgst4MDpjOZnoNvtKUAgvAQBk5ejgnHY0QcyngnFUSY1yM4vz1Xq4CWL4grEAA1opOIQ5LBSJxxGAoJwAYw0IWm32xaRmOJjGBVaUJEpc8hkCA6LGsApSgADPdj3L5ZacYDRX6zmCS5LS/BoNBYTiuTgJR3MTgAcgAAgClM6APQxL876HkshSnjQSyPs+r4ft+4i/owAHsDAAEOBYcDAXkoFcKeKqFk+L5OrBP7/oBKEQWwmG5PEYhFIKSicAAvGeMAXleShBMAuScCW4joakyAURAAAq8BoJYaAALoUNxFZDMI3xKiesk8YJMBLKqjBQJJqS3veQQRDJYA8e4uSuBEuTUbEtbwBSchcMx4gjisNImOq/yau6qb6t6hq8KK1rSlxxk2fWHKpO+1i0OIACsvC8FcvDWFc0jSJUAAiABCMUAEbWFA0jcDFMAAKJQOlvTWGk4g5eImXWKCvRXI06igtwaTvkZPFoO2igRVFABM1hJdYo1jeNE2TVNU29J1ZkWWAe47iA0lrrKQzMKUYoMQAtOk1oLqtIDrbGpQnfKIyFntpobeacCHRQa6/IGwamMJ+BJmg8lwMMtJ1jArJcAOQ4wCQ3qcFAs7iId0llCCMiVPIdQHIgvQwtobR4F5YW+RmqI9IgGJYkM9xIANvT4i8RJvIunwGCEYSRHRtHbRK1ogd8dGdKI8Oo70/R7PUSDo3C7TWhcBNE4MwwuIToKU4SPizLTZLBFgjo4BwGBRHWabeqk2QgFF00m6bZujYbwIVH0A0YpCQtjEcmMIt5DYS1YiOYtLpOIANCveMS7w0KrQTqxAmuYFEPUdmABtG7QQ0jebyem5bPPW6joIDUjUJIDFTvwtQvVgO7ee3CTOK+64sMxLAXzHrhrnCFBhFvu+JGIUJmFHmBXPJC3MHvqqSH0VRMbOTwTf3dWUBaimOM+tSAX0UFsm6z5aD9bQKc72bc0hdHfUfoNw272f437+ZpQXeISCgAEihwGseBjiAriuEAA"}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

await Actions.reward.setRecipientSync(config, {
  recipient: '0x0000000000000000000000000000000000000000',
  token: '0x20c0000000000000000000000000000000000000',
})
```

### Delegate Rewards

Set `recipient` to another address to delegate your rewards to them:

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/reward.setRecipient.md","from":10046,"to":12138}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"47f5abecdba9b37d942876b7098a742d3423c65e8a06c57e478266e3647d4535","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70TKzsXEaCwqXlUojqsrXKqhotOnp4qyZdFlYAzAOOzqONE9Re075z1AGLBVykMADukigG20+gAHDUFPsGs1qK0TgZfgDSED5JckDcQPY7iM+pUnpgpgYZn4PgsDAkAK5gfhrThwPQAJRgvEYWEYijQAGUMNSADwZRLJAB8QQ6yVSAqyFE4WEczD0ZDgqTOwgAdIjAar6WgmSy2RzudTVQAFOUK0hwfnFJRCiKpY2kCDMRj03na3Ws9lgLk83iqploCmkMAANVCFJgQtyYHE8rgst4MDpjOZnoNvtKUAgvAQBk5ejgnHY0QcyngnFUSY1yM4vz1Xq4CWL4grEAA1opOIQ5LBSJxxGAoJwAYw0IWm32xaRmOJjGBVaUJEpc8hkCA6LGsApSgADPdj3L5ZacYDRX6zmCS5LS/BoNBYTiuTgJR3MTgAcgAAgClM6APQxL876HkshSnjQSyPs+r4ft+4i/owAHsDAAEOBYcDAXkoFcKeKqFk+L5OrBP7/oBKEQWwmG5PEYhFIKSicAAvGeMAXleShBMAuScCW4joakyAURAAAq8BoJYaAALoUNxFZDMI3xKiesk8YJMBLKqjBQJJqS3veQQRDJYA8e4uSuBEuTUbEtbwBSchcMx4gjisNImOq/yau6qb6t6hq8KK1rSlxxk2fWHKpO+1i0OIACsvC8FcvDWFc0jSJUAAiABCMUAEbWFA0jcDFMAAKJQOlvTWGk4g5eImXWKCvRXI06igtwaTvkZPFoO2igRVFABM1hJdYo1jeNE2TVNU29J1ZkWWAe47iA0lrrKQzMKUYoMQAtOk1oLqtIDrbGpQnfKIyFntpobeacCHRQa6/IGwamMJ+BJmg8lwMMtJ1jArJcAOQ4wCQ3qcFAs7iId0llCCMiVPIdQHIgvQwtobR4F5YW+RmqI9IgGJYkM9xIANvT4i8RJvIunwGCEYSRHRtHbRK1ogd8dGdKI8Oo70/R7PUSDo3C7TWhcBNE4MwwuIToKU4SPizLTZLBFgjo4BwGBRHWabeqk2QgFFsXxYlyWpRl2V5QVRWleVlXVbV9WNc1rXtYbwIVH0A0YpCQtjEcmMIt5DYS1YiOYtLpOIANCveMS7w0KrQTqxAmuYFEPUdmABtG7QQ0jdNRfF9NHs817qOggNSNQkgMWB/C1C9WAYd17cJM4jHriwzEsBfMeuGucIUGEW+74kYhQmYUeYFc8kI8we+qpIfRVExs5PBD/d1ZQFqKY4z61IBfRQWybrPloP10VxQlSUpWlWW5flhXFWVFVVTVdUNU1LVtR1XWtmzlfAuJdQFgOsHNMA5lSgXXEEgUAARFBwDWHgMcIBXCuCAA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

await Actions.reward.setRecipientSync(config, {
  recipient: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
  token: '0x20c0000000000000000000000000000000000000',
})
```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `reward.setRecipient` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/reward.setRecipient.md","from":12428,"to":12921}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.reward.setRecipient(config, {
  recipient: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args: { holder, recipient } }
  = viem_Actions.reward.setRecipient.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/reward.setRecipient.md","from":12948,"to":13196}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Token holder address who set their reward recipient */
  holder: Address
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Reward recipient address (zero address indicates opt-out) */
  recipient: Address
}
```

::: tip
Rewards are automatically distributed to the current recipient before changing. This happens during any balance-changing operation (transfers, mints, burns).
:::

## Parameters

### recipient

* **Type:** `Address`

The reward recipient address. Use zero address to opt out of rewards.

### token

* **Type:** `Address`

The TIP20 token address.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`reward.setRecipient`](https://viem.sh/tempo/actions/reward.setRecipient)

---

---
url: /tempo/hooks/reward.useClaim.md
---
# `reward.useClaim`

Claims accumulated rewards for the caller.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/reward.useClaim.md","from":118,"to":6057}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"9473592640bf3f33afde9fa50fd54b096479002e7102d5dd65de5dc109750e9f","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6INYQYCKc1jKiLADKGGDWiDx8ggB0pDAA7uJQqQCucDAAwlGx8dapAEo6eaRgACpeADxFoQBmjAoUnHlg/JCZYAB8/iLiugAsAMyy8koqLhri2kGR0cxxCf4mZkgATDZ2pA5OSABs7p44eIQk5BqBTKzsXAaCo5q6qurGc8pqSy0OjwbyMO3MB2CRxOfkQAEYAByXaheG6+e4BehPNgcTgZbKkKAfcbnOGzRT/RBnQErPD4nLbUwQw72RywvYTZGYa56W5+B5YvRtXqORihHqFErrTbWFrtTrdXr9CCDIYACiw9mYOjIcAA/ElQeksjl8pLShtyqkAApanWkOBysAdLo9PoDYYASkNKTgxoJuQKxQtMqqNTqjRwTpdivdKuGAB0wGBRNq4JrrDAJcHpeV/FAINYEHo3pw2uwIhbTApOA5rHlmHkojQoHiTYS4LWwK3sow0NWyxWQs7GKRmKJ+6FUv4xApi8hkCA6KmsHJ/AADTdoOC0JMsHFcYDJQycVxl0gQZicADk2QUzEYAHoaM9r0mk8KEpOwJwAIJYLA1U9ThgCTTgIlCcIj0bMQaCSNYygSU9OAAXmPNJ6UJM0c0Q6wgPfH82zQWofzVMDwM4JoACM8jQNBxVCEpGGsfgUOAIDUKGStcwSNVQMIijOHo/h5CSa8LFoPYLGsCxZLk+SFMUpTlLhN8BNPT1XCGcjBKlFhOGqAM4B0yjHxoujQm0wjPSTVwk03dcQAAXQoRdNWOZh/Hc1N7U7ABaThbQ83zpxcxcMmIuojAAWVoicxR/DI4CbNBQpckAxgkKkEXJeYkDhSFNFpPQgz0y0tlkJl9hZY42WcKY4S5VFeXRGdHj0YdwgQ8rEnQv1MMDc0eIqapIoaZpWhHV0lQ9EZhE+fKzh+OQKQWaRqGWYEOpDPNKt2RAflsVlTksJqeR8O42sFEANQvHAOAwYCYInGAkjVIhxEYUQqLkOB4J2hIbTtJxHUml0hm6CAsG/fUkli2CYAAeWhhLHW60NRpIgA1UQZDyGBugAIVEQoAFFSAvUhIwJ7jcKB4KQejToIbdZVVU4AAfN1YA6MwoGAlCuKICBGCJKgCyLPB6nwLNnu/MsRXljAIDyCJRB/axcZkThMj7fBOA+0gvp++AhIgISjYUbRSCEmXODlhKu1bKHvy1jBOEIE9xVEKAoD7BLcbVmQZCohx+E4F3UenJY5yQBcQG8zyqEN43fs4ALpazFPvrTiAqIAKxgRwzc4TU4E7ejbazdcHdCAAxMB11C1yE61fxI8g1JQhiPJrEzcv084aXGE7T9RXFXXg7LUcs0yGWf2UWW4vlkfOGSvv4DgYVtfVntGCnqiszLwpW0X+3l4S69OySlLm7ctuqA7sIu7AcnKcH4fR8Vx3J+1joMk4IwNoVdz6wUdvIEIvQQZdk4GQd+u8db721ofUuJMT4gLgewO+rcPLtxRp3buOg0ByFbBnfAq8x7y1/tPABc95AgNrj+VeMA9ZkDXr3fuW8mwyHdm0HQtgYDOxthAlWYBoHq1gRTCsCCUHH0EbA1hNsz5QAnKICOwipGkGwRkccpB3hUACgASWAcrVW44RLnxkP2VcWYMgAEd8YiDgN0dc3cOGb3XIgqe/8syhB4bWNoTgQHNngFwTWU9THXhIPbH2MBUhJgCr+KeZ9wkhzDgrL8qNOBqlcWAHuG9y7rhcaEN+7AimcFyTEIhJD1zAXEFnEWrZKGo26Ags+EUSLyI+njWeSDOAoM6JADIuRnLpUyroOEAB2ZafwFjUg2kCIIctcB7XMIdaEdV8oWDOt4PkGIaDXVulDMgmBgLCVEpwBMIAJJSRkspe5Dz7lXOJFlRE8yVp5QOjSLa1ABDyEZPteZR1aonT2DstEl0BRBBTGmDMWZOoQDkEmQ2EEwiItepwSacB0X5kLMWEAmcKkIrkJ45g0AmxHwvEQUWps1FwH3HITgsAaJWwHMSrMygJyAM7PSh8UQlHm0XkmAAUqID6MRrBG2hqi7FjLtRHTACPK8WAqU0tbFRd2mQYBUX6ReTIhQHTxLAEmQlZKoAUtgbQA8FdMjm3TEXIBzEILPDMGIv6BEABUf4KlYvRZ4tYA9dbKHtjoQgUAeW931iTIlkF0WpBkBABQQFynrnZakTBpBk1OxjWiuQqQCRgCzZysJEiUFBlPubTIRsaAl3Vu7AActAOJ+ceVoAyKmI1XrfycAUAm0O2tU2xpJYAsIYgEjwvlAoWo8jK5Vr7By82yB1wqsLJvVIIgCy0XXE5NU+A6JYD+o+R8kBYAtq7loR8Es4CPhCSIPyRAOSpFoI+UQWAnwrs4akPdzAZAAGIP2bw3SrNAdTuxJiXQB8u660CwAptu3d+7D3HqbWe9gChL14pvS9O9D6JhPpfW+x8kG/Tfr/cRjdcDPSpCHnbXtedA6DtzTAf1paszlsQcoYDgDngcAHGfdcJ7XrstJeSvNBEAD6HqPUAHVxCKsUFJ8TSRCV0f7TK9FEcC5FzQFfENnHw21gAWYRRMqR40DETwpMcByj4AvJAAonATAWLPlRPVBq/zWkMRXGW7skowGYCbboQzDMcp86ZkQ8hiEYCTCTGzdmVadic1mLWEdF420bbAVILa15tpgKmP0nAqmhazEuyANbxTEc4IYx8iN4N7rQAexAR7BOoYvVerDNAcOPufa+99F5P2kd/aIPyZWYB+VCH5YjfkxTAXLKQJMZKAGmDm+Ob8Rqkyk1oCuRlBQ+O0b7Qx4TiACIORbUmNNCak3XhlsHSt7AZBQGvJ6AA3EmI9gUjZuqSDdhNOt7tQG6JXIDtFztDriZdtU12YC3c4AAUjgNebot5/tPde2Ad71pPvbm+9D37trSAPcB3amDwHQdMfTZotUZhMicFKZm680nPYHu6Ni7UygByh1bHYAC8hBFPZe29x8H3TDbkke/NMcBRDaGzWMFiFsHALpy7B0gx30dC/AnTpIjO+DM7XpeUNHOfYe1fTgPmgvBK1i4MgGA3SnIHXhKoc3gkuUSqlalUgvRDENHIXASaByuBU6bYgIgzB4RTD2PCBENk1cW65YjLTjh0ie+9yPP3gRsmCeD6HqYFhJCICmFHp3FEuWZ5F2QFMMgiP9c3o+OgRdaIJUQJMyZ8JJBF/Aly63tu/JVpN2QKkiA9h7Hb5b2B3TXeMGlYH2AiAy91FxlX1d5da+0Hr9+JvZwqQWGj+953XBS9iPLwv8cpha/dPEyIT7ChB9THzwRTq++fKoRvNJvplQ86mGxWAa8aO00FpyQACLqzWycAAAkwAMKMArgAAhJwEAYoGQNAbUmjhjljn9HAcAWwq/lPO/lRJ/qELAfAdbNAUTkrnAvZJuARJtttmxvSooCAuuL6sOgGu6sao3JuGdgkJBFwFxmhCsDELlqmDEProQJkEBL/twWLs/vwYIRsCISqOIWTuEMwBgEwVmGhNTupnmmoWqMBt0JRmjgtqoWDvGompDj9ndgTo9gLjHpjiLugRYX9lYaQaTmACoWoaYVdo4fDojjePjg9qjubnYV9h7LjpYYTiXK4e4SYRmlTlkLTpTgzkzs4nrmzuQvQZzsbjznzPzigULsEdjpwMgJrpwNrlDCkazgbhkUbtzqboIi5CXOQWwQ/pwJAc/gzm/h/mit/mjtEeTv/uuEQWwuAZATARgQgaQEgTYagfYUkEMTbNgdrLgfgWAIQZgZMaQU0Q5DOFLvOIuIUCsiAMgNirUJmDuvVo1kegoHrHkFRKkCEMwMhqeteoJmZH2o+LhvhiYFRI+Gmi2p6KMvNCSIPtMLlJSJMt8qsGDgCuYOtMCjCM4Nsh4CiOdHsldEEGqGkdAMBB4RDhLlLjAAaF2BgN0KkGSU/LjEFPlkkHWsgE5N6AbI0tkgANRwgRx3AJo+wAnix4p4AFEVzmzrjA5oCeJBr6zU7gjUaxRWKT6MrLANiRadiaw/iyJoKCLdBilVwfijjhDsbRpnwqosDiDuz4nS4IIpY+x+yuzax6kRpUQiB9gN6hDIq4yOJrwsD7ziAlwQZY5tBqhTCeh1b7pNaPjjhgCTLnroY7B5DPphmTYEnXphlTBV4i5tCpBTBfpoA/rR5qhnzynahuoha1hTxyIVpFHrgN4yCpArYTjJrnGIYhktZ+hoYYZFgdahL3rdYEZPiVmZk/q/qVk1loBDl+TLBwCehUYnYcHGRcGjoQRQLP6qASHk4Q7XiQJiJJCw6PbdDrkgZ5HC4hG7lJDqAlzClKFxqrlHm+G7nTH5FoHwSiJoDHmkFnnsHrgERFblm9lDl1kIYNZIZNmRmtnXq3poCdl4Y9aEa9mDaDnsCrYjljmzYViLZZjLZwXxRTg7GxwoD7GmCZj+BEAWCpBwjEWySAkZQLSD6qBki/CrRIAzALLFTGCJowlSA1QIlIBIjInci7KtRQp4AtHozlA+iGD+imilQAwjThjjRRhgwKisyzQvK6B7CTLvKzJsWMU/JCUVTGBVSLBQjHSwhTBTDgotSQqYgYkrr3SnJMqqL/TDRhhjQ4w9KczcwwC8yCK4qSx6CEpRDhDrycLbz+JJSIokCtgqJiCDhKJ2yMLrZsG+UkxcABWbxBW+bwChXyIRVqJzYMIXxTgEQmp2x+VJXuLlypVtiyphW2WRU5VnyxUFXe5ZjFXsIFJcLBxpWVWZWqJRW5VgKYVAlZR7AIhqV0WIATCQl4BZWsX6XwmbJjUmXcXNQXT8gWV4BHLWWPRtiZiT5PlDzHBhAnAJTVDbXQxeX4qEptrqyS7jyJRFwsKnUDXKWSCQgfLgkTV6AZAnUMCrIaWzUnQTBuCLWol8WrV6DrUnKbWXUHU3XcAkz4BJDrgSTgGX7ViuCeJcy9A8xMhiwgBXoghw0RzALs4Vz7XXXfhKX0WyRgkLBwg/BFQ/JQ1k0JSw1wAqA/UzUbInSqCTKmUbQKD+CQF4CXYU355TLU1IBWCg0Eqk2HXih2Cs1JASQFRTATCqBnCTIIiSAWDfTWA8zK2q3q2a3a1US63uX61q0a1a061617Aq0W1G3W3uXTVwg0V/WwjbLpQhCwDYgvAgR9TIRtAXhXi3hS4PjPj+ZsBqRKFhKSXP5GgDTYRlQyj4RsHvZFApY1zLzMYjoVVsBhCK5Bg2yy2kRxIKDUbmT0QawmAsTdArbsJUQPjlwJTR7aUVDLJ8TkTnJgBiQ3LSSPL90D0WCI62TR7nl5qrn1Ay03XG4K3XmSWpBZV6jGhfWpCM3F0s34DR7+Bs6iBICgCBDyD0qhB4DbggCuCuBAA=="}
import { Hooks } from 'wagmi/tempo'

const claimSync = Hooks.reward.useClaimSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
claimSync.mutate({
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Transaction hash:', claimSync.data?.receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `reward.claim` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/reward.useClaim.md","from":6397,"to":6757}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const claim = Hooks.reward.useClaim()
const { data: receipt } = useWaitForTransactionReceipt({ hash: claim.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
claim.mutate({
  token: '0x20c0000000000000000000000000000000000000',
})
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `reward.claim` Return Type](/tempo/actions/reward.claim#return-type)

### mutate/mutateAsync

See [Wagmi Action `reward.claim` Parameters](/tempo/actions/reward.claim#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`reward.claim`](/tempo/actions/reward.claim)

---

---
url: /tempo/hooks/reward.useDistribute.md
---
# `reward.useDistribute`

Distributes tokens to opted-in holders.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/reward.useDistribute.md","from":120,"to":6547}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"59eb218042188d5a1a816d7393c55eedf583a5a887465c49947319b9a1e69626","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUoiaicACUnABmAK5gjowQYJxY4nAwAKLKZME6+GSInCKkpgoUnAmMaAD8xQA6IADuMIxNnAA+nE0Kre0gkcUARowKpmgNYCxsHGkZ2bnkVFAQ1gh6AMIpJBxwnKIlaGWKnKQwWOeZYGJoyakQMZwFZJxoEJxgccxkjNZhnH6ADoplMALScAAiazgxXwaDQWFhAHpkURGDBmEC4Phkat1si4ncTHd4Mj0qRMjlCstqKIFBtkMgQHRRKw5P4ZuwuMB5pTFjTOK5YqQIMxOABydGYiWgsAUqlLYISgAsACYLBLIlNUZx1RYDYajcajWAQABdc3CTS6FXqYzyJQqRAARisdK0OjwCoFflkpnMLpsdlIDicUncnhweEIu38NHoeGsKREnCgjFKjGGRJgAGUMIligZBEDzs1xFAgXFMpCM8cszn84kgQAlHRxUhgAAqXgAPNswDExpUEvxIM0wAA+fwicS6ADs89kjuUSBdKo04m0QXTmezNCb1n8JjMSAAzMH7I4/IgAGyR6heGO+WkJoJcubFoyziQuDcOxRV0Qe1NG3PAv2PANz0vUNr2cNUzwfTBoz0WM/QCRM9A/LgywrGcbTXA1l0A51b03T0glw0goEg09EAvEBbCvcNEDVNwPEfFCfDjDRAjweJEjuFIqhrOsyn3PMC2sfsUiHCoqjAMcIAnSdggpNkdDIOB6h4PgSyoytqxgWs90bKSgQABXsH4nDgGTB2HBSlJUoZdMMUsYHLaiq1E0yD3Mts0A7bs+wHOSR0U8cpymMANLgdJrBgETjLEht/MSfx8Q2fQ9Nidg01S/dyjOTyK32UQwCgQFRBqYqYny5MHNIZhRCEsAgXjelGWZVl2VwKgAAMhrQOBaCmbDOF5L8hRFMVJXLBRmEYZEaFYCBZTAKYBKSYSAEEsCwYJomAKZOE4RrU15ZgiVamBil3esJMPGaAF43P00rvKMkzHrMxIjrlM7ziCztOGCU6zs4Xt93eB4wE2ExrH4F7gCOzgXsnAq/Mk/6TtSSGzrZCAEjQYo3RNCmTTACgIYJzJGqgWFOAADlvFUiNpyH3n4eRiglCxaA1axKZF0WRZdCUafxs7XEiVxJ05s7cxtTg2y8qBOd7ZEYZSBX8e1MBXCmIaBotChmXU5h/EtzTKU4CErNDGytI6q1mWB4KjAAWRutqSrgOIZDQV2rRAH9dDdJcAKdNco9Ar09G+wq/qPf06IYpjYJYs97w45DvDQ18+L0C6uAe8SU6LPS4A89WfJS7HD1bdtOx7HB7PCpyouna05yQDVpGjoD13IsC9HLtKcdT4woLvGCwxvCwkKfVCX3jYuQkuCAcA4DBomu247rBohxEYURhjkJmJ6e8zHY02yO7GSdKm3trtOKH3D4AeSwN/e2vlOzcQZgAAGphDiDASoAAhCI2RSCilIG3SBWNfrpWsJZayts7JhSfhFZyU4ugKVgEOMwUBogY04EQCAjAaIrBhHgLshROAH1avcWICQdqpAwMTc6FVeEyBkICGo+BKGn3PpfN4Hx6wKG0KQN4TCWF+wqlVV+9wwgyAwJwQghhODCVEFAdMbUAT/AEcMBw/BdG/3uDXTqDIkBMhAJbfwJ8yjiPgPbTgjCkouLPhfdxEBhgACsYCOEkfMOA+x3jyKSgNRR9wABiYABqu3No46y/hVEpiBCkXMcRrCJQiR4xhGZ2GCTYc0RgAjYiMHOICQoqRcjMN9mwkpAd8nwDgPEQRyihFVOGEldIESYBVUaXElIEp9hXEDsHM2Ft0lUEyWAGuKQsjwPyhCYp+xtp+wqVUoctTGBPFGc04S8hkwky0gcVIZAEFXKqrswR/TwmZBGUwm57AUlzKdhkqxWSck6DQHIKqGz8AlO2eUypgj9lJWaPU6JTTbgtP2G0JYJQ8kFM6YHDRsQdC2GGbouRZziY3EuXw95cielPMGS854wjXiNKgK1Q4+VyWfJAOcFqpBBD+AhAASSeNwuIzDRA8yaUHRgWA5AlQAI4QJEHASoA0cnoo6QNXpUKalJRSNi0QMQnDwpkLdVMJjBGCqlElFqsAQRgAhLtKpjSTVmKRqUzh+xghKrALk9pESBqKpWWs0gvrOAetzACoFA1ojiG8dQqq4KUyVB6Y0j2nZ8UnxkBA9VnAnljEgOcSsFpQ7h37mqf8cgSJIDIh6MeIBFH9RnnRStmcF7OBdKoZeXFC7r0wpvUUO9MCRuYMS0mWaxgTHwn3ViZ57RlpjnPKtCcQBExJrRcwUcm1wX7u2gua9eLdtCOEKIfJFQ0nyEsYomZFARRqDpJo/QOjdF6HewYIxR03HGmtOYPpqToSyngAcuwRoHCOCcBQJVLjwHkIi4SjxnioqiV8H4ZQTGAjaNa8EUIYRwgREiRAqJpRYhxHiGEhJiS1TJF+pYtjuosloGySVdaJq8go4KYUMRRTiilBiZgG0pjMbyKqDUWodTIj1BqMWFMzSWl7r+EtDEZ3D3dPHIIfHaQnlXfPDdrol55xXtxdCb48BqV7WQftkieZgEaCAAWQtxO2fE00cdMnbzTpXM6ECW4F3c3kCupAzMNMsTVFu58PEMJBFij8eKDgkoXQgHIKYLjzopli0fAccBkuZXoXoLxwaYtyDVYOqAgcBminRLAcqJQZhStgNmGRxVctJWUK1TgrSWCVPEGE3IUwABSogT65msGUX+iWlnJeYSEuw0w4Dii3qV/FwxNGtGGFm0UzRMiUjQ92BR0AivPFoLMQDaBmgfHiiEw5fxEtrTMDcWEcoABUnBdrBtS8ltV1hDWFIqcoMbyhoD7DaSIiIOWktyCBDICACgjpBoGvVoE5LId3KByNkHXkwDw8a1wf4qQnlGRGR8ZoZQaBhIqpogActAGAQJAl/eODANk1r7uPYUGDsxgjofA5gGq0ws5EjRdkmMDs+Kon45qA1j4yABpbwxdiNAqwiQDXNMEeEiIUTIkgLAKn2StBEYJIamgIgwREBLUCWgyJRBYGWpLjpQJ4TMBkAAYktxEkQsu0CRsqlMcXjua7O5ufLxX2GVdq5gBr9gChtdwGRLr+AaADdG5N2bi3oopc2/t17n38DIhAk8UwpnASARs6Rxz3hWOko46ET9okzWP13FOI0gaQfED1fy9tkHcoAD6t3bsAHVxDTEUJ3tvxRsu55Z8NtLUqAnBMcBM77hBGYHFqWYOlciLp1kgxoqYcApL4FFJAasnATCisacMFba2HsWV5ZEwomiriYj8ZUXNC+GvX7H2vm4G/Ypb8SDvlIxN9iH6SnUV0VRTJytSp2A1p2YBrk4FDWfySnF0gEJ2Ei904F5WRC/j9yVxw1RCDxDy1yykjyNRj0NxVGN1N3N3JCTytxTzt1EDBEQJgDBBSDBC9zBGSGiHqlICmEHQOUHHYBajag2yyFoz6hEmKkaRH3zyb0QDlBNipymBhzBwhwlEKAETx3YBkCgC1AAG5hNOALITgRo4QYA1DAQNCoBKgolndiZJhEh2dQdwdlRVCwdOAABSOASWeacwnQvQgwiYJmZw9Q0gTQyw47GXGwhQ+wuHMwZoTgVZBBZULvbRJESoNLGyUFU4MxKqOwA6eQYZLUSIXQsAXUPw67Z4ANMbCJekQAyqI4cxN4WCUXI4WAeBGQ4okTM6eI9gYoJIvgFIkoMUAoYqLIrRM3HAUhPQgmJrZAGANNc0YCV0VQSYyGJrfrQbYOUgBIXlTbDMAcN8MGBvIgZgV0M8NUV0ZmA2XUKYrgL+IJEJDYrYnYuAPYwIA48nRAI4+iCwSQeiC45YwmLgBvCYMgWKGQSgtYDpZEOgEJIke4RARcV0SQf4g4LgGYuYsEfHMYooW8ViNUZEprWYsINYiVLgYIIEklTsMIcEjFKE2gGEtqeEnE28CwS4jolYwE944EyksElqUwKEtNNvC9BQSdeiOUUuT4DSdGSULvSFVWAJLncZIomHFHd1SECqWRTgAAEmAHCxgFcAAEIoR1SyB9SI0iiSjDCmY1TFBXgZSqkWx5SRswBDTrTZF9TQjmibljYho5RhC6MpVqxxCmEBpns8tzp3sbtNokkhp5C7ClkuAbCpTtxlZzg2RcxBjCBmgjolSUwuAbkkydAUzID0yfhMzszIj4zmEMBQyko3oYix9ksgQazggbDKgblCi5RmBqz7ClCnCTCXCjtgitCOz2j9DLTjDTDByQiwkIiwAuyayHDlDAi3CPDKgJQpzhzzSRNSijCtF+ygjpyolZz5yoiA0yTPI4izyJRejt4FUBj0jhj9FRjcjSECityxz/DihkAujSAejki7y0ihjMinycjxjhkrQwkvSozxTdSpTrzZSHTRgnSJQiiTzC8gQVSBpXTXhtTdSDSjSbTSBTSRyLTPyCKNS7TBFEKFTnTyKTSPSoKTYqN7FmRMg61kA0sOxEoFcsCVdxhlA4hhggRkxmBVdycqcxLYBtZmc0Q49I8sxkQYcqdIgC1pNdBTi1RiJZ044PMgh6sfNXQgxGIQxm0kBtMoxt0QsDM9Bgh0joBogFzeyIs4BqidJidKggRPLFkwg74oDihidkBzRXIqEaEwYABqF0XRXYMHfRFSuhdYPAHcyJD4AaawuXcvERGItTLPH2cVejBfBQb4SDfYTHLNAZCIF5SoT7ERTrJqVMMvQHRpS4FgcQTRZy6ohHIA/RQxNRQRBqv7QSkQGoWElIeLcBdxOAVrQ1ORKJT3QwmIYIM8SITA7DXDZEFqMAecTXMPE8OIE3Dalg6oiPDas8SgiYGIIEM8a3NAW3A2YIRpLcIqsoqNA4KpalQXMXAaWEmQIETggQyHHigPNa3A5ZfA4jKPfXEgsghPEjSpa623O3b6v61qZGmPLcKITPWQmMuACs41IdKU1QHM9C3siUc5G4YoVwrQyoMm13d8pK4oGm4odQMJNK2wxQxw0modRATwmmki7c8cxLEmJmj01m70gaOUWAzgcXb636/g1qAG/3ZXYG8S0GsPAgiG4guSmGmWmgpGuWtAVGsEdGjg/KHgpKUwVG+4DqTcOxFAVi0wRKZxCwIEF0F2g0VSsOAieiM8d0eTZ0BiJTPAJQgyl0Iy9dFiZmILVeKyjecUgBNBKudyAyeuH6CuNBIBYKJBR+eSUcbuRzdSu0LS4ef8QO8eZONBEOsOkyzTBCKOvTIuPdLePtPeNMJle6cuqeDOzsMBdNJKboBIYhAMWhEAX9LLJhd7LgNpDFLpbFK4WLEgKqRlMQPKGahRE5dqOUKYbLCetFb1TFARG/eAee/FJew4Tg+FMZDeqMre8eiISelVCJGew+8fBe1u5e8+45KDK+uUbeu+3e6erFZ+4+xeplFei+9e62z2idHOX21zJAEu3SvAU+yu/zG8M8SOnTDtHdULQzJukzFupdcmkdcYG4QhAemAEhYZDLBKsewAwdEmFBNOqhtS88W8StP2itUeBdQhhgNOQMKu5iG8FUFUOusQBQfwXUoO8HfO88ecUtOBywXdIIXaehoh8mOzY0M0PhtcDOauliJeUOZMWAJgavSad6fYVjdjeaekJaFaTENgDaRjI9X0ORSxuaTjGUMU3MxhyeZ6N6L8WuCsFOjuw8AGKM3UTYIA2JX2IvUwf2NgJZJooyClThMGCnBQLPHWVIN7P4fgSoP6tFYYJaCJe4A2eOzu2tYIPGQmVR4dFTZUdRrUKWM6LzCzSUazCwYWDR7p40SWKYWWLx4mjmlRrmzw8ppuU+2oIEHhg2fwGyUQJAUAQIeQSalIPAEaEAVwVwIAA"}
import { Hooks } from 'wagmi/tempo'
import { parseEther } from 'viem'

const distributeSync = Hooks.reward.useDistributeSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
distributeSync.mutate({
  amount: parseEther('1000'),
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Amount:', distributeSync.data?.amount)
// @log: Amount: 1000000000000000000000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `reward.distribute` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/reward.useDistribute.md","from":6892,"to":7487}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { parseEther } from 'viem'
import { useWaitForTransactionReceipt } from 'wagmi'

const distribute = Hooks.reward.useDistribute()
const { data: receipt } = useWaitForTransactionReceipt({ hash: distribute.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
distribute.mutate({
  amount: parseEther('1000'),
  token: '0x20c0000000000000000000000000000000000000',
})

if (receipt) {
  const { args: { funder, amount } }
    = Actions.reward.distribute.extractEvent(receipt.logs)
}
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `reward.distribute` Return Type](/tempo/actions/reward.distribute#return-type)

### mutate/mutateAsync

See [Wagmi Action `reward.distribute` Parameters](/tempo/actions/reward.distribute#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`reward.distribute`](/tempo/actions/reward.distribute)

---

---
url: /tempo/hooks/reward.useSetRecipient.md
---
# `reward.useSetRecipient`

Sets or changes the reward recipient for a token holder.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/reward.useSetRecipient.md","from":139,"to":8799}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"6ec8763ed98425976535a0643a503c69b548f0ee8e4e50dad055f48586543f87","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6INYQYCKccDoASjDWjFiM8mgAyhhg1og8fIIAdKQwAO7iUDkArpHJ0bHxiWApadY5MWilpGAAKl4APADCoQBmjAoUnKVg/JAFYAB8/iLiugAsAMyy8koqiACMAGwa4tpBkWgxcQlJqen+JmZIAEw2dqQOTkg77p44eIQk5BqBTFY7C4BkEc00uh2D2M62Uan2Wh0eFBRhu5mhtnsjj8iDuqg+1C8318fwC9EBbA4nHyRVIUHBCzeAA41oo4Yg9tQDki9DTitdTOjHljXohllsCZgvnofn5/uS9P0xo5GKFRhUqmdavV0r0BkMRmMJhAptMABRYezMHRkOAAfkyKLyhWKZQ1J2q5zql0aAAUrTbSHA9WBBsNRuNJjMAJSO7JwZ20krlGCVD1ai4NJo6Vodbp9UMGiPG00AHTAYFE1rglusMHVqc1NUzVyoUAg1gQelBnH67AiOjQpgUnGU9b5dOpnu1nFEYCgnCKjCHil7/ZChdIzFEQ9COX8YgUXeQyBAdCrWDk/gABre0HBaOWWJSuMAsoZOK5e6QIMxOAByIoFGYRgAHoaCBf9y3LJV0l3MBOAAQSwLAzWjThgHLThOA3cI32YUoxBoTJjlOZtvQaT9OAAXnfXIJ2Td0yK9HVrDQ6CEKnFo2k4M0sOwzgugAI0ItA1VCHoTGsfhqOANCaOmAd03I1izUwziBKnDM6kyf8LFoURVGsaxlmsCxlkkSRFgAEQAIVUISLCgSRENUGAAFEoGsrYLB6UQhNEWyLCZLZlh2AB2JlEJ6f8KH4zSxP4eRdP0u4LDMixMqy7KctyvK8q2WL4s/aNXGmYrsLTThmO1YqulAkS0DEmZ+OjctXHLW9rxAABdChT0tZ5mH8Qaq0DOBOAAWk4f0hvG/c+tPfJuLCfwAFlCJ3VUEPyOBShkNAFr6kB5gkRBwvUGE2U2LZpC5REghTNMapbawBVuXFhWebFnGWJlJSJGUSQPAE9FwrhSOnV640MRNXSepsWJ9bMVs6HAQzDQ1IxNGYGTOrZwruuRrqQXYEUOPBIe01j3vMS7MW+0ULAB6UfF+EGFRAC0fxwDgMHQgiiJgTIzSIcRGH8uQ4BIxHtWR2axqcYMCzDaYRggLB4PtTINqFgB5TXtuDKmVOR5pcwANVEGRShgEZbNESJ3NIH9SDRu2lJeij0hyBXrSVjGhjV4so0UgAfCNYEGMwoHQ6jFKICBGHpNsOy7EB2nwetBa2tVYJVNUMAgUocLnUuZBkRdl3wTgxdICWhKl0cIFHeuFG0UhRyzzgc/g2d504DX4OtmQME4QgPzVUQoCgZdtut8uZAC6TB8N0IEwPUQjyQE8QFG4aqDrhum+mzP6yPyX4EHoSACtYi4MTOEtOAJsfsdOGvXvtoAMTAa8Fv6nvK0/gh5GxyKEZIpRjLwAmqffAjAJr5z7gURgFdeyMHyIuLOCF35fzVAgiIUC6wvyVJXOcC4UFoKEvWZ+kQFy4M2vBf8E1dr7UOr1QB+8QFrzCOAsAztXZTU4JnAhSDtpVzQYMTBjB+hd2zow8R8gQhjCVv3TgZBBHkIkZXahT9HZ0Lkeol27AAEDWAVQUB68+FpjQHIBccDRHKmQagyuUj6wFGwYYvBCECEwGrmQQh0CSH7VHr2HQtgYALn7Eo4udRbRqI0f2LRujaGRPUf4zu78oA7lEIPTuiTSCmJAPkbcpAwRUGmgASVkUXEu24ko9zYfEOQU4ACOtsRBwBGNeCBRCYHXm0egzBoRQmiH6E4QxMgdzwC4NYEenBan/hID3aeMAcjlmmohNB785kV2XvwXsTija8R6WASBQS4DXm6aEAR7ArkfwgYOOx150LiHPknBcYj14jC0e/ZauY0lixtu4lxnBdFDEgPkEovVjqnV0LdTkxMNhvHJjyEAvdcCyEFPCYITwXg4gJizbwspSQ0E5tzDWZBMDoXyNTTIpYQD6XCosO4UBliqB6NYHYOxliLB6BYVQyw7iSDxKIZYQkmSLEWLZawkgYAXUkKofoFghLuSEkJBleNdBpXCqyZFLhUVBFpSpWmKLcUihxHcIlxJ2byiCBS3m1Lm5JTAPSxltA0oZXyt6n1+VNXCAhPcbler2SXU0BTPQiV5CmvOl9fFzgrUeEJKzElHMgiVmrLWesuEIByHLHXHC69c3C04AWOAxb/Dtk7HgM+H8c1yAGcwaA+0aE/iIMnK+uS4DPhabAES7dhyFrCMWruO5OAEO7SBKZmSW5jnLAAKVEGLZI1h66ayHeWlp1pMRgAQX+LAbaO0LiEmPAoMAhJgp/AUSIQZ1lgHLLWptUAW3qNoC+V+BQW41mqIMawhagRmDqNLDiAAqJCH8y3FoGdYKZL8q7KB7joQgUAJp7VsLOCa1561rJkBABQaF7lYaLXIHIBSCP9wXER4dJHaRgHI8oMdcyEK6JTPQluBR640Gbv3MeAA5aAayb6obQPkKsd6wOIU4AoXDAVK5Uc3TAAZph5jpGzfqBQrQ0mPw48uesj9kDXgPR2GBOQRDtkIteHqZp8BNSwNLUCoFICwCE+ArQoEq1wFAlMmgIhJpEDuIsHItBQKiASKBIzxCEw2eYDIAAxBFmBZni5oFefOcsBmEsv1M2gWALtLPWds/ZxzAmXPsAUO5tOXnpm+f84F4LoWwKZai2gGL8WfyRbMxo6MORhHd2kxAWTdbiOKdLsx+srH4OEEIuOoEHBB3v2vE54W2HG3NpIxxAA+iBkDAB1cQu7FDbY25kWt/XBvYevnfRwzDEPKGgBNN5nAzAZI3QgmgdRR7ljgA0fAP5IDlE4CYBp78hJXpvUhX0lTX5ZzHrtGAzBG4e0hbOTBY4x64Te0kT7lZvvpF+6EYuE0gf1nmRAMcnd+OwByEJiIImYBVgTJwSoenu4GcgFxtUTXOCVNAnrfLNm0B2cQA5pbpW3Meaqz5tAfmAtBZC2FprORotxdEJNdnMBJqhEmk1yaqp0J9lIOWJt0jQzsG3PBO95Z3IGVYC08o82+syYXvJqDiAOJdSE+WbDORcP4f/FnCu7H2AyCgP+aMABucsDmZr1yA5kAPuHFzB6gCMR+SXCJe+Gz7vDZp/cwED5wAApHAWKAFP2kBD2HyPYBo++lj/eeP+fE/l5D6nr9OXkuZ+o2ssjZgCicFuaQXPO2J52ZGOW/28DVwBQXHYFC8hIlh4j1H0CMfTD3iMYI6scAt4k4HvMFeImHB6fb7l0gbua+r+woPzII++Bj4iL+JDg6Z/j1CzgGOK/NKzi4MgGAQKepEBVBthVAv9NIx0V011DpSAxhKkOh4E4ACwyUuAzQltEAiBmBtghVtgmQ2pL9v8x09Zb5748hYD4CEEkDAheI0CMCxQLBJAxRcCwCBIx00D18yBKwZBwt2sYFQI6BYhCJtpzpwpthJBmDsIx0/8ADJoON38yAORcQ7hxCf91EgVID4gUC2C4k2hrZuDjMX4+DaABD4JzodgOQLA8Do9wCuAtCnBODQJtxTA+CgUNsRBY8FBcRlgxQOJwYnsxoaIAIdtQUogBtlNQh/xq9vdaMzRrxrI5wO5OAAASYADNGAVwAAQk4DiMUDIHSJeWr1r3r2liyPiICSCLQRCKEjCLAEyOyI7nSLb1pzP06lvA4mtwvDt27VXAW0gwbRwlg2A3vT/lvE93SHXi4GSwCMOGSDpyrGSCf0IAKDQkiPGM3ymJ0BmNE2YHmOtEWOWK73CGYAwF6PrFoj7w3WLRyBOLNGSxGC62ryN2OKz191zwTyDwr1D2X3wLr3X2KLeKTw+MaM7zACOJOOzz93+OL1L0AmTyry/x+Lj3Hib3eNb242BNBKz170KAH2MSH3/Dvw1i6Uf0nxf2njf3nxjiXwKNXwRIb04GQBv04AJIfwn2f2nzJLnw/0iT6m4w0R8NWNSICPxOCNCOHTAAiMeLBOiNiNKM7mSNSIyJKJyNIDyK+MKN+MyDqLKJFKqLFNqNlIaN5JdhaO6n2G3hQFPEiExRAGQHLVaDrCswFyFwcwUGrlKCEhyBCGYGK2c08yWwahk1AlqzlxMCElAm9yE2jBhQDUZDFDuFWCun1V1XugjWCGGxjR8jjR+iQGZiTSlGJWBjtTwDNEn2gHQjBJeO313wdB4xGByHrMsU4L9mKLnAwGQB6ljFrg+V4gAGothB5fhcNp4ozU5q09BaTX4W5rx080ABkUEEM+80QesNoDpmkSctBShrQgNRswUaF9FIkRh5ya451NxwgJtHZDED0WBxAx4qztAKNZw0Fp5Z5h5K5zzUN3SRBlxBDQh81rYOkIgWBUFxBuMMt69+gzRlhox+dbNhcHC5xwpXNysbhShgttwwBtdd9PN0LlhuD19+gchlglcWsZA8CzR34DhNykgHtMF5lUk2N6TrxBCZAcgDdzcCNHTCs4LRcEwysKtOxJcZkZc6t5cwJmLiLWtmK2KdxpLpcDg4Boxut3cRi4ADjZlYkuBaJVAVju9wTc9lEdIi9Q8RgDKUtqS19ETTLMh1BuMZyDjLiXj/wrLS9TK1SaSijMgrLOAbK08O8M9hjrwOJmdGLxLZKOKCtBciseKkL+LPNvMhLgz6swtxLldYspKzcZKMq5KtAFK1xO5jd6xTBZLtp9wzTjxLTTA6x/AiALAcgtg6rMpoyTpA0xRxQQ1NgEzw00VfcMyrBzVGYcR/o8zAY2Y5QyQghfCTYkYGgYZ6IXQ6Q3RGxlJpqfZzY2h3ZA5wwjRQ4tUkBeVEVYQbpOQuqjhZZXpeqszRR4zrUgZbVxriyjNHV+ZOBskxAZZlq5Ysw1qwArZgVOAI4xgo5BQU4QAPMa1u5YMIY+lgkK5Yd4Bc0SAFxXrckDcvEFE9wOIH0IbHYoaLlSFQldoEa0lka8q0aiISrMb4D6xIbAlIt8a4bN1EaXqclSaGFyaMahisbqacbaaYF6apxGbiaWbUa2bc4wBSrmrYywoEykV2RFhDU8BkaLr+r40kBFhczPgCy7rkCHqeYqVnrCAQ95CP59Jki3DhxXABkAb5wYBo5IlK005waT8XVx5c1ctZwZ5doJoPEv0dA5EMEpwkwtITUYyzowoiZDqzUTriQjbSQ0RSY+qGZVbEBFh3hhqU1Cz7q9BUiaxj8Li80wAC1sNMgTiHaxyM5u4Xc+in0X0jN21YAHtALbd6w+1SgB1VwLsGMuAJ0gLp1uMTzF1l1V0ND87s5Yg7Bd04B91D1YBj1T1z1L0TQb0EwOJH01t6w6B31RxP0IgcA4hf1/02BAMG9QNwNrwTjoMBjJtbtkMPz0MLyq6cMc9oLulvcyNoKHzH6choiP6u6dyWMDFtNOMT8eNOBKdBNhMtjxNwMztncVtx0wgxBVMh0wxNMGKdMuN9NDMeCssZyYLIruKSteLxdKt4qatZckrGscHmtWsmsZzUsoB0tsH9CExOs8tOKCGRciGYqJcyHpdErRK9DIsJK4s6GcsusetTsnc5N4GmNdyGwKFq5JjnxgQHd6xFsBNEB4Ga71shittdt9thwjsTtHcBsF4LsBsrs0AbtSyUMUd6xntydXsRAscMAvsfs/tCdAdGBgdu5Qcl6AlEJIdocYAGb4dEcRhkdHs0dnH3tbE3GccPGCcAdidHzK4ycs4KcBNqdIH6dmBGdgr342cyd6xOdqHuded8HnSfSYAxdyteHqt+GKHBHFdUrVd1dNcMKdc9c8qjd2BCrTctwxbLd+EbdLxxsuiRx35YGZHhtrwL8TTRjvdHL/iW9PjzKJzG8C81nGi7KxjdKVnkSi8S8RgYSPi4TviPKkTtnk9dm/K0B7KSMsT+9B9h9R8iTWTlBSTZ85DKTFKNmijN9+w7y98FwD8Dkj86xbLxGXYL8rCcTXZb93nx8n8vn2SfmKTIllDJD/9rZADgCthQD8DrCmdh7NZSCwA4CRFEDQhkDqDNHaDQo7gcDLCr8WCuAiCrGKWqWEDKD6B6XYB0DMDlh6DGDWWCCbDNH2CdCuCmtDDjChDwoRDbpsXf9cWZAeoZDnh59z8zC7glDiX2XVDrZ1D11UCpXtD7C5X+DrAfzXVwozCdgLDVWnsLW7DdDHCa91XXCRNhxPDvChjfDBTaJhSKjRTy1xSdKFNv79sYitS5SUixpFT43VSAWNSlSEjyjK5Kjqj9TlTDTfLmiAq2ixnOi1GIM5n+j9EFmAqlnVjJjaJpjZjtiFiTR9j9nwgNF1iUhm2diYA9ivjfCMTu8AjzjvdrjbjN8vjJTnic888bnzm3KLK6TVnbm0T/Lh3o3DmC8oTTm1mLn1TETV3AT12HmQSnjdLnmEX2A3n78PnUWp8RxX9OSF9Pil3Nn6TGTmT72ST0XySuSoAeTH4+TA2BT/CQ2s3qpw3wjq9N3LjpT42kjE3rRk2DT8j4SrnEPIOc29SM3cjGiQOupN5zTd4rT/BbTi5SAHSIrqnXTlB3TPTfwamhMamAyBsgzmnQzwys9Iymq4U9qlX2qkBkzo6wZ0ysUPotgthLqcQNbk1vBDx/BUi8AerQ7dBlhBPEz2Q+qdbuw3bjb9J+gLJv4oAdgYBVAthRBp4mQmRv4dhv5Fg6wdhAobO7hwo3PJBrB+h+hv4hIRU7huUMzpOVbszLAbrRrSVQYuZbHyzZ38MQWazWy6yGyeFrZmzMhWz2zOzE5k5ez+ySQhzY4y704JzuNpz7m5zq4ntCglzOAVyhxxmUcNMtyN85GUl9yU9r6TypEzyDELz34rzSlbyYFd8Hz5lny55QgF53zCEhIvyWh4I/zgVUNe6QKsGry6gIKoKqm4L0LEK+KUK0K5xMLtBsK5xcKNu0ACKiLlcyKKKNyWuaKSc0F6LQKmKhwWKwroKOHqnoq+KGmpdhK5cGtQIUqSK0qPvZLZLJp5LFKRmPdVKO31KVEAjtLHmn6/cvLC9jLC0VF32rmvKfLT9gTlm53nKTKNL8f03Ce7nzMz2uogqYB6wDNQqsrwqnSoruH/vSHGmgfKHQePuRGIfUEoesqYecr9dgX+mEHiq9xiPyqTpKrrSaq6qGqLA+OWq/pLpZaOqFa9BVPjBsVthguk7QuhrNabUxrdO0zEHPYoZvYMg6IEwGJFrnp7fWIUZcwNqVYixtqcZZg1O1bzIhPthjruRTqPrzqJPzApOZOE006LfbqreouHV9b0Jkb3qvYPfvrfrbZ/rI5bbgbiunbAcea0M6aQkGaiakbhb+xRaLdKba0aby++bK+Bbq/maxBWbu5vERmubS/wgW+YaCb4aZAmaSaRae/0bxbG/sbB/oa4B+bCax+hau/J/5F2bxbdqU60oQ/5aUy0Ulbo/SYTe8VQuVhwvU0iy9BU++YaV3fMhrxTbgBzbFBLb8/AbC+Y5i+9Ba0GJg6WIHtKAF7V4gAAvMgC3GfIgDTAs8OZD5lXjS5ksI5SWmdBZQHUSYBqA/kand5Bc4+atNwOnQU5bwlOY0FTnhm34rBkyOvHMtfxABZ9MgTKFlGyg5RcoeUfKAVEKhFSqAxUEqKVDKjlQKolUKqNVEJAzIJlTeTMVwMdBCCwAKQwIDCE7yoj9Afwf4QCFvBAjgR4cbAKCKB1t5TVPq6QAIk6Bd4IxI+DvdiEMWjx+Q0En8RhCNlMAC0j6kQbjCmE7gvBxEZoNZAoB6yNRmo/RRgNJBGBsVZuIEF+NtDwL6DXoOQDFGpH4jGoWIKUWgMylZTspOU3KXlPykFTCpRU4qSVNKllTypVAiqZVKqnVRFROIUaV1ABFSjpRfUdQ+oRYHKGuA8C6PPSv+F4Cx1EApeSIQ7xyDI07QSufTqQDwKk8/c9A7oWdV6H9DnQ1MPAv4H9iiAkAoAQIPIG7ShA8A94EAK4FcBAA=="}
import { Hooks } from 'wagmi/tempo'

const setRecipientSync = Hooks.reward.useSetRecipientSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
setRecipientSync.mutate({
  recipient: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Holder:', setRecipientSync.data?.holder)
// @log: Holder: 0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
console.log('Recipient:', setRecipientSync.data?.recipient)
// @log: Recipient: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `reward.setRecipient` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/reward.useSetRecipient.md","from":9146,"to":9747}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const setRecipient = Hooks.reward.useSetRecipient()
const { data: receipt } = useWaitForTransactionReceipt({ hash: setRecipient.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
setRecipient.mutate({
  recipient: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})

if (receipt) {
  const { args: { holder, recipient } }
    = Actions.reward.setRecipient.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `reward.setRecipient` Return Type](/tempo/actions/reward.setRecipient#return-type)

### mutate/mutateAsync

See [Wagmi Action `reward.setRecipient` Parameters](/tempo/actions/reward.setRecipient#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`reward.setRecipient`](/tempo/actions/reward.setRecipient)

---

---
url: /tempo/hooks/reward.useUserRewardInfo.md
---
# `reward.useUserRewardInfo`

Gets reward information for a specific account.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/reward.useUserRewardInfo.md","from":132,"to":9792}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"b99d265574b0d65166a26926a44acc97a9953933b2ed8abd0b6af7abb3256072","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6INYQYCKcUKJiiJzAADpgnEmcpDAA7uJQAEow1oxYjPJoMQAGFrQAJMAipKYKriUA3AnJKemZAApkACoC8jEARowKpmjNicmpGaRQAEKiMqJg1jCDw6PjrpwAPpwArmCwAGamMFD+UBDWCHrd+DCci+Fwe9YrcHBHezIyGG1wEBkJCgESiok4R3YnGUDwAjnsyBgAHT+ETiXQAFnUxnkShUiAxGnE2iCkTE/hMZiQACYbHZSA4nEgABzuTw4PCEEjkDSBJisdhcAyCVGaXSqQk4xTKNRErQ6PDCoyU8y04L0xl+RAARgA7GzqF5Ob4eQF6Py2Bw2tNzsIxUgAGxWKV4x1ykl4KaZCmnGl0+yOLXUgDMBswHL0XL8vPNei+yzQjFC+zgMAAqqnSDkbQBJMCQgA8AGFQicFBRYi1Ju0Zjk8gUiqVylUanUGuNWl6Zl1SL1+P1OEMRmAxlWkl25gslis1sPR2BXAA+AAUWHszB0ZDgAH4YkqkROkXtUxmyNnMnnIUiOuvN6Q4MXS8MK/EJuOa9lcvlCiOm5VqmgtSKO2Y7Wp0PR9GAs4bKBE7zIsyyrIO6wjpsi4AJR7nwggHh+R4npm54zJeEBIjkaB7KQYAAGoLAiBavp2H51t+jacGU/6tsBTSwR+PZ9gOQ4wW+YEzPB05IUJqEJEuCRgKIG5wGuKwpumhEfiRFxXDc+jYRCUIkomijQvcokgqYkKkMwURJoklmcOCSlfic1gOW8EAHGgKJEgoNzIMgIB0ApWByP4JThWgcC0AkLCWlwwA8NhcCcFsRykBAzCcAA5BkCjMIwAD0NACllCQJPGji2ZwACCWBYMu6GVhMIRhPFoJiBWjBwAAMhAohQHUKWcAAvIlhi4Ta+FqWeGn5hAy6MckaCQTEWXlNSFjWBY207bte37Qdh3allFCgQ4ISeat5SiKobzBltwaSJIGIACKzKoAwWFAkjVaoMAAKJQC92oWEWogDKIswWMy2rBg6urMtVRYnVWrjoWVEyMEcnDLl1vX9XUjWpBRVGcAWA1EIu+MDYoSJ0wWBUU4uVbE5RiTLqB5OMJToFJFzlMsQ2v6xGSojbhNmSCz+aCuAzTO82TTNESCOCkNCK0i2C4sTvxkFIstADKgF1A1suM9zzMiXzSsfoOU6ITEwCi9rH7iYh+sQEbQEKKbcsW5z5s8xM6MLgk4UlCAAC6FABWuDLMP4ccKXeyUALScDe8cpyi0cBazVFGAAigipB/KkLwyFwaSMMoZmcBZ7DWYmybLqk9bSxWOsQf2YCd679srOhOfRyAaISIg8OyLiMo6rq7oKnox7TVms2Qj6VKIGqtgBkyiDBhYYZGpGJr+DQsYgKu6Wq5gjXnR5I67jjy4cS2xvcTsNXuZ5H8HMcpxQI1AAZOxZsAFvYNEarsX+MAThmFtCAS41w8DVS/iOByaAxC2DOOrEyDxrALBkDjZgcAFBIlTIcMgQ8MYJDuA8O+39+pQHLslZanB4SIjrg3fSpox66GZNIF0M857UGJAvEA9CRzr3MMGf0DJAzOGpIfCMPhuSnz5HoS+EBr4YEastHuj8X5gLbCUH+FDYFnC0kg24plug5g6BtdWPcHJQCYfAIwvCkDagxA6Ke0p8TYk0B6PQej5BSKQJKbecjd6KI8IaZRUZTRnyCPJRSyk8GhABHIBIRBxCcBapkpCJYwiAlwFQRBOlaHsXySUkxzBoDfAeFgdKRBGCwGSo5WKcgIgwAGHsBQw4FB5IySUkyUR67JTgCwRgiw1asJhAkAAUqIHJBtrC1CwFwapXSNzbzAF1TKTTiCtOwQMP4aQemDnSmkTMcAkQY0qXUqADTOB0DiiwtIEBOBOTyC5IZAozAjjgIgDGAAqGq7EikFJMdYJ4yVq61w3MoaAEzXj4AcslEoWyYBIhkBAH26ESgVkxcMuQSIyDpVIA1ExSwQTEuKaS6YYAqWjM2UsQcDwl4glYWkWoNAcFLD+AAOWgNigAVhMwCMAFJ3LAGC6qnAFC4ohoQulUL66tQkkM/MwxKLYO5byh4rDkAlEOe8W5IhLh7DQCUSOy58AYKwECgqBVICwHFUidgChGbaQKosGgIhU5EGpBiJEtACqiAKAVU1bikT2uYDIAAxNGj4FqPJoFvocBIxrk3mrQLAUgpAbV2odU6l1Ir3Weu9dcX1UR4BoEDcG0N4bI05tjWgeNSb0pmoteSoenBKmKogMqqpJKYDQrZQMDlqYQTwsIFa+uAoOCDRhOxV1qwsW1PqaSjGAB9EFIKADq4g9mKH3TumIA6lULC1QUzgQ7RW5DQFlZKiLCBQHaakTgZga73DVvkrqNARy/ASHADAyx8DpUgMeR4jB+y4MuRAa5ZAaodBzCw+4Zd4AwGYAMOQFZIBq3EIajDN6ANFGA/JUD4HIMeWSiYODBC70wjVsK2ASJxVfMlQpW5nADYwGIw8Y1kA+XJhzZwHMBUADyRb7VoEdYgZ1a6K1aCrXAGt/r61BpDWGiNhVW1xsTaIVOwmYCp1CKnHNqckyNUsgkOpn6G5WRsqEGVCR/q0GCl048y7TKDuHaqmpwKwBh3CuKhIWKcV4uXFle4PxPkfNIDIKAWV0LjGdRnICkUYixdxZwBLSWKysNTVa8Lo7Is+xizAOLnAACkcATrZXy8l1LCR0sdEy0CzgOX4vsAKzg4raBSv0uxeS9gy4zBpE4P9AtY2soHsIFouAFYASvsGhDEEdg6ryDOCllrYA2sdZeTNtWik4CiG0A5Q4nGHD8GhHIw1nye0FqC+lpI02KUxHm3wR1y2Mo6HwGt/qXWI04Dga1gqrR0GcGQDAHJMhI6IFUDqVQ4PIdjNWesrypADh5juF1IpSScZrsQEQZgOpgzUh1MyEOr3khjMkwMB9jgDw47AHjuABPAhE5FSTsn+9JB72p6j1oYziejDIPJGQUau1uIKnQXIVrbKIF1LqHUkhhd064DDuHkdU48pB2QCem9qQa6SGM2HCwMf5C4ONnn4uqILGl1cWX8vrCK9CMrh0E8LA04hyLrgYuRwS8d9ZUwcu4c7q4goTewY94Y3yQH5OI1soHumYQrIQ7TAAjAFlcYEXGXPxeksbQasqgpJgK4AAhJwIvigyCV5KHtg7oxOu15L5wVPPxOAZ6GMUsA1e2/18K49vN5KQslAxu5zzU6fMPBKJCmpeTYVBfH2F5YGSuBpuTySL2UrmAGz+4QNIDU88b6O2rUaO+uP78P4hk/Q3wjMAwAvrpo0Js3pKUiF/MBlxporL28YOzZ/MrXFCrbrPLXrZrNLCHdrFvbLKrXLJrYfO9ErMAJ/b/craLcAurBrHKSAlLaAjLOArrBAnrRLKAZAtNIAjA0bSld/d7WbL7RbX7VbYydbYHLbOBXbQg2AwFGIZABg0gT7BbH7L5P7ZQQHDbA3OBaOHBMfYLdfVqL9JPUaObNPbvTPPvXPagsrAvEoQfUvYAcvKvGvYvevRvHgjrGIAwjvdQnvLPUIAfMw0gSvZA+Q8OU+c7PyAKVMUpEAZAAESiFYW1WTeTZ1EYZQPYAYJEEIZgMtN1NTNdAqXDIdAqLTJtEwAYAqCLcVdCKOEeDxTeCwGRQRfEYRQJMRLFMJZXWRTUZwA+WJcMbwBJNRc+ZcV9aARqDA0A9otxc7GAR+AVCsOmD1DZWyBYTObjGIAVZASOTCTgIgCAVpHGAAam1DvW5FxX6jyLKW0jwF4MihwRKAGxMVnS/XSBVCRE4AAFlvhEwQo6EtA9gNxAU8kJ1GlRAPgzgKwzj5ltV7wuBOV0V4MmkWBxA/hTt+jLsQRGNGEa5xjCEgTPivkoiRAa53cFC4cEQJkpkZkcFs1MsjhlxgwCUQiHUFMCprIwBdQPUVNKQ9gw0qSLN+i1MqTgxpdRgjgkRgw2140Q5lwV1iRniigP06Eu81wviuVPljVFcZAkRLIm4qUyS5NS0lNblK1yl1M60G1tNm1CpZTeTE1ZSFSogTT61iQ4B0IqEFDw418E8hlv5RpVBT9htMCsoLphYatksKwPT01LDiDfSYh1B+s80qDFCCk3TAyGtfSm8YCrCHThZgyitQzUDw4MY+NBMSgDSzSlTi0VSKS1TaSvVNS/VtT0idNI0DSDME1jTG5TS6zzStBLTuFOB7MHhHMm5bJvIRFfIkB/JR5TAVh/AiALAkRtQxztp8i7R0QaRtRtRfFXQ9554ghQDqjhFIk6iWQlFmiT4Ywgh7TRZHZeIbQpY2JDEo8QIRIu5ewNYpJ5wmIbQ3YZxkI5xNhTE/44FLEKlTInguAXg3g3EvgfhMNMlgR2pwR7IV12FS5uzCiQwfFSjwlly8BRY1zaj5EkBgxQxGij4VFowzQghNFtEiZmIvwhZigQFOI356gTEoEzF/5RQZzN4MQ1Q5A/FPEAlREggJxTzJFZBfQaj1Qd4tRHptzjRVE9y8By8lIHB0lhtslcksUYhv8vy8BKkAs5BN0nkulDkWk2kHIvlOkHhYBel+lBosUWVxlDL8o8S5l7hFlllRArcNkP9tlcg7A9k4ADlmljkQRTk8sLkBgrkblXM2dTJHlnlXlBR3lHscAflGBXJYi2AAUstQVwV59R1oVYU8sf1Wz/tkUUTbBgSNLsUeiCUiUItaDmUaUR1XSC8CVLL8FEhJ1VIpS8sDV+UwAhURV2MJVUhpUEg5UFUr0VUN11U0REItUyxdU2qeUa4HtocTUZcPgyEUzrVlSwj4iYBlNiyfVSyA1yy9SnczVDTO1ncU01qM0oAs0lrzrc181C0NrVTy11SVMSza0DrG0Ky9Nlrblqyc0ntSA+1L0h1r0Srx1mqp1sFZ0t9YpBRZ9V0ecxqIrt0FC91D1j06gz0L1fMRrXKHh71H1n08qkV30HJP1v1mNSMRByMMAQMwNbAaNoN6MBMEMkM1ZqpUN0MYAQLsNcMYB8MoQiNcE/h/0aagM6bKMGaINQhaMYMGMu8IAqbWMxU+q98eMMz4MhMlaCbEgxMJNpMnqCyXqizVMtTPrdTdNjqY1qyjMTMzMwALNfqrMIAbN2A7N2B2y5onNm4wBQqp9WAvNJljIV0/MwaN0V8wBbS4AH9P8ejKtqsmsCDUcDjOtwCkCQzLVBtwy46osE7cscCKw8DyDk79s4ziD07IDkCBtY7SUqr6DjtosmDRCVt/tJCODQcdsrT/TXjaC8qPgoSaq0RrBbtAJZLM7yUXs/cptjthDvslsxDWDBl2DNtO7rqy60ctcLd4dEdkdTcodnKsdWd2dOd6BudYBedydKdtQhcN7/dOAGcmcj6wBccAcOdQhCdbcL7Sc94LABdgxb7aczcA87cg8Hcpcc05daAFdfbldVdtR1c77Ndodt7dd9ctshCvdqQTckHgGXk4dD7z7Vh7dJdraPgoGYGlddQvcnRfdN6v1QGnBSHQ99tt7I9qKY848FD7Ty9k81Cu97CtCXSIy9CbCy9k4TCDCG9YyiC+DTC681ZO909NDs8nCFHXCJ6C1x9J8PNA6Z8Q7TIMrhssrPigUMZo6H9N951L8dBd8FID8Nwj979wyuByVt9bHr8HGYAnG9t7T0DR1k938Itv9f8rV/8C09sdDXT47K6S6ZHU74DE6q6cEwz/Hom87sD6si6k74n4zYm+tWFUngDXT670gZ6KUm6RCF7W6JC2CgdV7ttmtcniCBDZ6O8qmWC266mpDOCzhZDWF5DLHlCNw+GlGNDe9s9tC0DimRHj1C9nDOBxGNxJHnDpGe6st5H28xnBHVHNmh85CtGo7wpPDeyUAfD+N/AAiPJSBgi8zNqIj8AoiYiMotrxUtrkilU0ivrfVGAsicjLSpzR57RN5VABE2LFzyiuK8Aqj+KN5mR0Ld4Gj2RvAxAFB/By88BVzpzx5qRQWFyZ5nQkk8BlY2h242JyhdQWKoBgxVAixrAHQHRgwMQiwLBVAKdJBcXRBgwBhmQMQMRZhrBJAYBdRQXVAjgLABh/oBgBhqj4WhKoktQkW4kdyJKCK8BejSauiQCotITtBBiurhi6YtFfaJj1xOsZi5iYhFjljlw1iNiyAtiAFVK9BU6jiTicra4JtLibi7j8gukhSXjDimr2VOAJTp0fjcq/iTgATWrgSV1QTrJS5+6zsLsarYSXF4TQhr0kSUUBg0SKJfaFKZBsTrLplckjUlrOTiTSS7mKSqSaTK16TGSlhmTtBWSlh2TQSRwuSeSDN+TBSnjA3RSHJxTTG9VpSszEw5Scya3QjnqEjTb3qNMdSm0raqz20jSp2zSzTU4LSrTQqLGXGEyuAnThHc6KtAzatvTj3mm5HL2kyR8s7a7Sq86oyfT74/SU74z73q61rtGFDNaZSp35SGzcy53jaF2NS9qPrNNvm13gPqzayfad292Wy2z1UzSuyTnvCBzEJhzRzxyQYLBAW4LJ5EKlyRF5QVy8VZWEWtRWQcL4ldy1W9ADywQjyrzSKyXhZzzqLLyHzwIbye5oJpJOPHyB5JIUJ5wtg6KPyLFdirEQBKlfzCqzUgLfh/hAQwLRYWyoKS5kRGKcXJBnRwWZ5JQKjSQwRaP5XNy95tQxLj5VWiWNFDliKzInzJO5x3yYEGLsXdBqRJAELTP8RYZkK9A4IJPrONyMK959RGOVX8LnPwBk4ZKVIsUFK/1R1lLR1nWlPDHkat1GkfL9KOk9HulTKBl8bLKupS3bLPk/ilkVk1lrcqudkPL9lQ3iuTkzlArgqtxQqHlCuXlaA3loQPkvk4qsYEq/lkqRTI6hqjG1UYVTGPW0UOiyb/y0VkSSrMDyraqIyqqGqaqdv6qTFlAxlg2WqgT9V5rOruq2MOMag98ZUhqw7RrMrxqxBJqWpprUhZqOqK3W0TijbFMTaoPq19rYPLaW1frTqAbLroSbqgfR8C0ZMS0IPtrXrdqIeYOV3vqyG/qN2zru0UegariQb/MxrLuoaZ0f1YbF0jJBkV0ShicCvtLsVd190j0qIsaQVz1+1cbQbCELLCbHBib1vh3Kbf1qbAM0AKMqNGbZbmbYNWagrENMwUM0MRb/g+a8MGHCNP0YRRaMkyMJaEhPjpama6MVeR3CElbpeVberON+riErjNaV1taRM9bfrxMpM0f8zQfIO3roPl3Dqrb9Mie7adaHana7qXa3bSAPaHNvbOyXMdHp8UwEa3v9vAtzHQsY6c7SUYnSCIC4n1m06S+M7kyn3C+X2wCS/C7Gt8Db2Nn8mKDM6wzKrG6G6Km5sOnF6unl76npCu6W/ko+7dW6Erth7R77tNGhCNdBC57mCB/amh+em1796xltcFgEckdtQUdcGD7muNkWcX6wr8cP6ucv7Vgf7YZr7AHp68HH7H0z/X7L+g8z6b/L7+dBc6H77A8TDR3JA1dwYk4GauLflvR1x64GQGDI3Ng0gH4NLcJ/G3IAODwQNfqFDN3LA2obe5/+yDNAeA0pKiAw8bDKPJw2DDx4z8vDVQtsxUahApm+eOZvoQWZLMK8ajEvGsy/bEEbCdAiZo4T2YuFf2D1f9m5l0YPFM+BjOfN/hMYfBI6h7e0lvhsZoA7GN+Rxnfl8Zn43Gyg1QV4x8bCMuAaTW9G/jKbBNR0oTNAOEyBqAFpm3RDJpX2b7l9EmiBZJoU1QJGDz2WBBvlkyb5l9uBcjNvpQXcEzNP8pTSbIIUqbz1Oma/O2Bv0abcF/BGzVph9naZRDV+AObph3Uab9NPkgzI9jQJTx2F6BOecYB4IZTMCxGRhCRhwPMJj9rCCzPgQ4X7yCCNGAzQ5h4R8g4dfClzQIjcxgAg8CoDzJ5rEVeaJERUHzVIodUyLZEysuREjsC2DBzl8WZRMLsEBy6wtzAAiaLoiwc49l0WycTFjRz86YUlh5HQluohAAktlUEkGIER0OiHQwA1RLYRqBi5Ksmi4lRLhcI1ZvotW6TH2JP31YYBDWoxE1jIEmLEJpiXVWYvMWtYghbW6xE0I6x2III9iLrQ7KwmOJrVTiuVL1qcCuK3FK4frR4goGFKvFqeobMdu31+L2V/i4QHNiCVqCJsISfRVNldnTYDRQRsbZEi8DzaJgC2tkItiW0mQ2Vy2E7LtmgCJIkl/eWAOtksAbZ0lTADJYgY7TXBttlRnbQktyUNL9tTIAbEUuTTFKEIw247RatmVA6zt0egfTHouxD5lk4OlZBDkTyQ5NwUOTZfdnnxKB2kz8vpZPM6WfaRkP2MQL0tGQ/Z1Dj2QZYQZ321YXtAxIYzyGGJ/Yd9Uy4UdMvxlNHAcZ20o+dtaPB5qZIeePI6uuw7TOj6yPtXdm6LQ6e0MODZLDp0L7I+FByfhEcmOQnLEdI4BRBYQg2WGYVVhWLYwAJWeHCVnADHZFh8MSQXC2O0QJqAJ1rBkVpYf4V+OAh4hidBOAkKCC+WEgzjJwCEZ8neTfKycfOn5BTt+QeAqd/yanb4Bp3LhadsEOnSCqZGgoGdjhe8Plt2IJCrDUKGwqQHR2cBYVdhLRSSi5yvhkAb4ZkXWMJw3FoIDx5ieBIURpYmdp4IXczlC3C58Ru4oSL8S4B/GYU3A8XPAKi32EbhDhaLZ8XDCC6ISkA5w8+CS1ViOIBwADVQMyAsDBoHQkgWGIxOYneI2JNLR4ZhNOHbDFWrgEeCEFgAWhBQsQMaIICGhpQMojWc7PlCKjYY2ApUbhmfgSg6ctgo0fcIeCXingV4uYOaAtCrASIKKa0WgJS2pDUtaW9LRlsy1ZbstOW3LXlvy0FbCtRW4rSVtKxRgTAQk64syRtC2j3CgpwU/aN5LRhUC/h0WElm3FYi/gGszsCWLOO47pp/R8dK4RJ0QDxStYiU7cRJBDgRY0ptsWib5MykVgEp15NcSHH8CIpRASAUAIEHkCTJQg+EhAK4FcBAA"}
import { Hooks } from 'wagmi/tempo'

const { data } = Hooks.reward.useUserRewardInfo({
  account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Reward recipient:', data?.rewardRecipient)
// @log: Reward recipient: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb
console.log('Reward balance:', data?.rewardBalance)
// @log: Reward balance: 1000000000000000000n
console.log('Reward per token:', data?.rewardPerToken)
// @log: Reward per token: 385802469135802469135n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Return Type

See [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook return types.

### data

See [Wagmi Action `reward.getUserRewardInfo` Return Type](/tempo/actions/reward.getUserRewardInfo#return-type)

## Parameters

See [Wagmi Action `reward.getUserRewardInfo` Parameters](/tempo/actions/reward.getUserRewardInfo#parameters)

### query

See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook parameters.

## Action

* [`reward.getUserRewardInfo`](/tempo/actions/reward.getUserRewardInfo)

---

---
url: /tempo/hooks/reward.useWatchRewardDistributed.md
---
# `reward.useWatchRewardDistributed`

Watches for reward distributed events.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/reward.useWatchRewardDistributed.md","from":131,"to":4875}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"802abf398fe8f0c7b5d0b17bdfce85c29d28ef5e8d8bbd8b8bebd7ceec8598b4","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXKQwAO7iUFGaugAssUmKykgAbBqZOnjtXaQ9eWZIRSC29o5+iGNV1F61vg0B9HgAZgCuYI6MEGCcZ3AwAOqiaLYASp3dACKMIqSMACMzjQoAAeADCNxOjAUAD4ABRYezMHRkOAAfkQnGAAB1bpwCWtTABJKCYzhgM7MAFkTgAHzuYFg0LMUAA3HiCQTMhisbj8VyuecmWRyQADCy0AAkwD+pgUrjF9M4EulsrQ/0UiuQAF1lZSZDJlRdmfl2Zyua5jSKWTBzQLOCdSBBmAAhGQQaz8ckAmGmLgMk0wW32wU3ACipGdpHJ8PhZGjWMj0YAlJwALywzhECCMKBpwM2s3W02sjkOtiG8kas4wEvB4uF0t28uCysmRTEsBOIiiGTkynU2lNhus+sh1tcm4fOZQH5yoEg2PwnlYrqvfAz76/DWA4F2gB0AEEtHAKJwPQo1y93p95vPd4vDwAZCAKNOZ7O5/Pjs2TgloAI8jipKMpylqSojhOFqElCMLkpCYDQgov5ljBnDyKIAJyGSWIAnwciiLcUGNoyzb2q4KZYjmeZ4mAogonASLWHW9xPDem53nOO7/E+CwgFAnoIHoOSOuwnDrrY8qcLM3ScFAPF7iCGEkN2cAHv4YgKMJyDICAdAMVgcj+GKploHAtB4iErTYuEhicFaToupwADkXQKMwjAAPQ0C0Ll4niwpXDcnBHlgWDwmm/IEjk6myfMB5sc8G5bveil8fC0VcoB/DyFiLmSgUFjWBYpVleVFWVVV1UAIwuRQ6HTlxD68fuUArqeUXobBYBwBAcgHpe8IualUDyelbWIPVnA8im6HuBalEBfi7RoGcpC3KCClELCyVSYoYmkDJXHjQubUqfI5kHtdoJedtsJ4q4eKmWKIA6hQelIqUzD+F9DGoqQcCcAAtJwAAKyIA+pb3vSA0QSGkVjGMkoyIAU6SaFkeBJRxo0tUpdr+B2hTFOs5SIDVsQ7JgNR6HUfiNMceiIs6OAcBgaZNbO+N8cuq4SbjzUTSCx6nuel7XilQtnSLr7vhmWY0T+JGsv4gnWMJIDgn2MgAg4/CcIBnCmDmuUSfg8jHbOQPiHWCky4evQxEgAAcSNyCMqQ1dIGRaNMehc9uDv8cTSBDKsJRlJsBTU3sdMHJpTTM39KJOGm/NZQSwqwKQWKqmBu4Qf+M3MBAFxoHhfrduWrhOwjNUWCsHspEg/STH7QQ8kT+Rh6TpQbM4BT9LHtM+PUidMyAiKQ2nF5vpLt7c8LL5vnXugNy7wwt4g4eY/7xir4s5jh2s/fk7ElQeLso/04cNCT/RjHMXW1g3H1ch4r2R2v71/UwFiiF364CoOrTWAAVC2Kof5AKVKXKAZw5CcCwM6IgeZ4AzU4HAEIiDYBAgUAoaS0C/6GzsFwX4mCWCMBkOIQ2EASEwDxAAKVEL2AAytYf4WAuBEMQSiNYYBfjMCQSgtBY0AQYAkjAAEnAATOg6A8QGB5loQLrHAhBdY6ChHMobDodCmIwGsIwaE1hOCvxaGYNSiBloACpQoqkAX/JU1hqFwCBh0RgyhOCp0IFAIGcAzi2BmkDMUPCYCDTfJFMU54Qlvz/geBM7BIkzSZFA2JA05hgCScoF4piiIyNYg8MaRsOj/BoLQ5JEiABy0AwkACs/EahgAxJRYBbFHk4AoD0esjQxN/nIJUphoiXBfnBBQ607TlJKR4usRtkBimQZ6eA6kRCCWBGKHU8J8BoDQFgOAiAvJeUgLAepB52AKDukJLy1CaAiGBkQIeB5aBeVEFgbyCyWKuIPFs5gMgADE7ylkrLLmgdOTI8RzIBZ8lZCZ1mbO2bs/ZhyaknLORcjWVyXjwDQHch5TyXlvOdB89S3y/mQtcWgHOpAUwHk4CojpXS+ypL6TAJxeSaR3EKRJDxhBgTGxaBwaSyg6xiiOf/UJsDoDqJaXiAA+tY6xzwNrynlTKrEdLOkQG6aYtJdZNW1IMWgFyQNvHQBtu0CkMBuW0mgTuS6MgMB4jgBgS4+BnSQHuBeRgZshUyLkQo0KYNiRAyFRI9oDxqRyHPJAI6tt6ESJtSIO1Dr6JOpdW6suQMTBmx1pwCAQqjrVNgAeepmDGkMXUpwVhMAZmQLmZAMpIUyWcGJF5AA8rCrZOy9kHNFSirQaK4AYpudi+5/RHnPNeV5MlXy0A/N+aIYG9aYDAxuMDMlwNrhphOOwPEpdzWmG3aQZgLxrhgGlWAcMtBDKIPuIKyBGqtW9JgVYsAz1TL1LxKE8JChhoW0NHQ3RpAZBQBcimcsBzwaanMliP9HoJLsGA+eI2QLgSfp1d+39MB/2cAAKRwGmm5BDIGwN4gg2DKDezOCwYA0RpDeiKXArQ8y+JUZElmA6JwZMiSXKPEIBAXZ54+reOknrMadhwryDtKBkjYAyMUYwqxo6jE4CiG0Mksa0QvSG37jM+jlKX0QYJFx3OnBeN8AE5gl0Oh8AidEGJl5OBWSka8oKGaXBkAwF7DIHUaQKaqGc65nJ7DOFoAPKQC4XYIG/EQvfLg8JRWICIMwCmsQCgUxdnNWTLnBQ5NbQCfVjgwsRbAFFuAMXAicHizUxLyWL6SB3hlgLOWuAJf9GQeiMgp2EqWV5OgBjgSnsQPEeIFNJBNa5DkjzXmdTAxKQ5sgWw0YFHG9yLgnm+zBcYFwyrrXuztb7F1xZrjeu0H62gQb8QxhbAsJlwzE2WvVbaxtA7x7TC9a8zK8CV4CixB3staBLX/oZlco8KhRo3iasGTcFy5Yv0ZPhGKL4RFtBHRlI/GArgACEnAkeKDIJjsUMm5P+ko7jlHpmwecAh76X+YBsdk/x3R0tlK31imWpe69BS73Cocf00xLi9nLReh+y4b8uDAuB1kVhZbmCsKs4QDokVYdi4U0ddMHSdDS/aAxOXKIFdK6YyILxGBed1nV+x7VzHTfwmBeeBMMnd0m/Q0NFy1H4NAeI+Blz5GScwaw3BwDiHymMbAMwJ3zGXdu7wwRwPnuAs+8sVR/3NGPdM5D2H03LHozxc6JxxTw0zP8bPJZ4TB1RNUfm6yaTXvIO+84MgYzWJC8WaE9Z2z9mJOsneuUhM/2Vfo+Bzxyn1OodgBh47zP8PEfI9pGj/6WOccz9IATon3uKNYgZ0dUHhoqeQ9p/TpfmOme97AC9TSqmdJ6QeMAkAyA+rrRYhsztCKDkEOUGcAEB4zFIuOYO0VXlsJNUvJR1x0TAAQvIv16kUwYZhA+gkAaoCgm4UZUhEhfYsY9BQlu4lhEA24I4yZNhh4r4aZvBb4J4gh4QTUfxM8hplNVMYByQiIMBzxrpTkuFT0+wIZvpKNGDdQqIvw8xKsABqGqXNeoD0OzaAkBISPABPbRI2MUFDNAJUdxTxdjYmGlAAWQQXOyMjrEyCpEuiBmsDZTrCRFcTtHPBUPwHoUCkYEBi4DYjGlEGDUgWQRYHEAkVoLUyIicJ3zswUnOxuEZUcKCUwQ/xEA8QGxuE/j7FrD8UoWoSOlmXmSgxOHhFiBTA7XhURWPTAHiFOX7Q7DOCeVyLXToMHVyNiC639BOAPFiBnR+Uy3hB9X0JRDUhmnNRzTMM5WSIGxkAPEPWPTQEiSf3hW7R/xgD7XOVASHSxRxTHTxUnT6IaL+T6MGJeHWOxVmmpSF3fTgEN24TLm7GB1UGVwjwiRclfnLixBwxA3PCuO7FX1r0TweIrk4HUHKUUMNziRd1eKmnuKOJBRr1kMoz+PeKZy+NP1MmWirTrDmWWM2JGLhS7URV7XUlRRmOuTmJAMWO8mWJJV+TWPYCGM2OBlmkOi8XYDrAPWJJPRuA0kmG0iQF0jhlMBYn8CIAsAPBqm5NKhgLhjgJS3dmQN7jQP3kvCwPMFwNPijmcAQJHhIITkZnIJTgBnTlPD5HQmzgWxVFAnVE1AVDFGLgYkBMrgIWrkejXngMGC3lRlwL3k7lPElNbj7llOWFUAVP2HHmVLwBZn4zIEwDTBymAjzj1K+0VFQkJikI1jwDpTAWJDBiKloVyluH8LDSMHhnXlUAmGRk9jUHbnQOoCAjAGdK2FdIHmWFcFhlflgGaC0VsligckdGdCETclU08h8hgD8mWlijCy4kSgeD2k4iXmDkygtEDjSmDixA6m0nFjfA/CzEzktyAQwxclXGmlmkWganxGDLAHykKmKmqiPOPOPPqkekkJAFTlECQFAECHkCwRuDwHMhAFcFcCAA"}
import { Hooks } from 'wagmi/tempo'

Hooks.reward.useWatchRewardDistributed({
  onRewardDistributed: (args, log) => {
    console.log('args:', args)
  },
  token: '0x20c0000000000000000000000000000000000000',
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `reward.watchRewardDistributed` Parameters](/tempo/actions/reward.watchRewardDistributed#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`reward.distribute`](/tempo/actions/reward.distribute)
* [`reward.watchRewardDistributed`](/tempo/actions/reward.watchRewardDistributed)

---

---
url: /tempo/hooks/reward.useWatchRewardRecipientSet.md
---
# `reward.useWatchRewardRecipientSet`

Watches for reward recipient set events when token holders change their reward recipient.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/reward.useWatchRewardRecipientSet.md","from":183,"to":4993}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"28f0780d1d18e58ea2ba233fff27ee55459d9d43aeb92be79062c38ef7f6b813","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXKQwAO7iUFGaugAssUmKykgAbBqZOnjtXaQ9eWZIRSC29o5+iGNV1F61vg0B9HgAZgCuYI6MEGCcZ3AwAOqiaLYASp3dH9aMWIzyaAAyjoADwAYRuJ0YCgAfAAKLD2Zg6MhwAD8iE4wAAOrdOPi1qYAJJQDGcMBnZgAIzInAAPncwLAoWYoABuXH4/GZdGYnF4rlcwgyWCkMkAAwstAAJMARKRTApXOL6ZxJTK5WgFYplcgALqqikyGSqi7M/LszmCrntH5/AESqWy+WK5Wq9XOrWu8X6w1nY2mpkwFkwS0CziuQPm1kc8MnUgQZgAIRkEGs/DJVOhpi4DLNwYtscFNwAoqQE2LMXC4WQK5iyxWAJScAC8MM4RAgjCgzbzQZDUCjBZjVvxbGNZK1ZxgQ4Hs8Lo8445MiiJYCcRFEMjJFOptL70dD85H4ZuHzmUG+v3+6+BaDJ1Z5mK6r3w56+MDtN6BOgAdABBLQ4AoThUwUZ8XneT55ive1bz/AAZCAFGbNsOy7Htj1DIsuTQAR5EdDUXR1FUD2HbDF2sSFoTJCEwChBQsLDQV5FEKk5FJTEqT4ORRFuMi5wEhcwFcRtMU7btcTAURkTgRFrBne4nkgt9oMvT9rwBO9/CgNMED0HJOBOdhOBfWxFU4WZuksjS4K4B4uBgEh1zgX9/DEBR9OQZAQDoGSsDkfxxWCtA4FoXEQlaLFwkMCMjITZhOAAci6BRmEYAB6GgWiS3FcXOS40GuW5/ywLA4Wbfl8RyVyrPmX8lOeV93xg2zvzvOEqtw/CwExJKpQKCxrAsEbRrG8aJsmqaAEYkooRczzU2D2p0OEeUqxcCRuOAIDkX8wLhJKWsHW1NPXTgHMQObOHWxd3CtUS8rxdo0DOUhbhBKBGCIGEmvMxQjJMuqTragELp0TgnIBVzf1/EEMq+n7cVcXFgvFEA9QoHzEVKZh/BxmSUVIOBOAAWk4AAFJEidcjHMZAaIJDSKxjGSUZEAKCYMi0aY9EalTjuWrTpkWQpinWcpEGm2IdkwGo9DqPxGmOPQEQTHAOAwZtFovIX4PvKs1qAiDmqW0H9YAoCQLAk2oN182fzQX8kJQ1t2wkzChNZHS9LwMEtxkKkHH4Tg8M4UxO34GcOnweQbpsi8bK/MHGBJhy3OEPokAADmm4YUmWFnNCyPAdY/ZP9f8FdzCGVYSjKTYCllvYFYOdymlVgnkScZsnyxRdhVFTEPU1bUlXFHD8VOuzh6dUfvVjVxehiJBposfp8/ZjfuZLvQeSr/IkFrtZSg2ZwClUZv5Z8ep25VkAEWpnvQOQ23VPtivHed5Dl6Z6a183qkWuxdebGB/qLI+4tT6S1iNNK+3hFaHBoPfaSsl5IziomAHachcSblIJwTB2CYCYjokQn21h9IgAACqxzVIQ3aMAVTMGgP6GcWAExEG7PAeOcAQhyE4LAKkZwFAKAsvQ/hygXjhzTiwRgMhxChwgKHWOuIABSohNyAmsAqLAXBxEzmRGsMAqdErsOIFwwcVIMCmRgFSTgVIEwdAeMTX8T0aEGJYfwugoRQqhw6EouSGkoTWAIYmNgZgXKICegAKk4P+NUpCGEqmsPIuAJMOiMGUJwbuhAoBpzOLYG6JNxT6P2shCq4oQIlO2gw38tZ2AVJukyOhNS9pzDAI0yRei+L2MUg8QcYcOgKhoIopp1iABy0AYC/gAFZpy1DAGSriwCxPiQoVMQcTTVKwUk8OWCxCXAwdRBQb0jyDOGTOMOyBxRmIUmk38IhdJnDQOKPUcJ8BoDQFgOAiAMoZUgLAOZv52AKARnpDK8iaAiFJkQAo/Rfy0AyqIP4GVbnwFch85gMgADEaK0mPIgM83uTJcTXLxa5R5tZXnvM+d835/yplApBWCihEKXjwDQDCuFCKkUovJb+TFOLyWUvLI2X8nB3GcHWRATZLSdlyGST0mkdx+mmUyYQZ54cWgcAssoGc4oAXEP0Uwzx0ynoAH1onROeO9RUVrzWYkldK2V+jOAypmZ+NASUSY5OgCTcQM4zDqtpIQ1ONB1wyAwLiOAGBLj4ATJAe4oFGBR2UTOBxEAnG0n/BTIkJM9XWPaA8akcgQKQHwQGtN1jQ0iABJG3EogY1xoTYSkmJhU0BzdXq/BkzYCzPme0GSrlODAkubQ65kARk3CXAmO5JMiQZQAPLUo+V8n5fzDVMq0CyuAbKoWcthfCxFyLMr8sFdi0QpNJ0wFJjcUm5LSbXGbMZUguJmHtD2S+5gLxirLNxCWWg/l+H3F1bQ51W45VEPFFEsAqNgpzNxKUg6SVY7GiUf40gIokqNljH8ym2pQqYlQ6mUy7ARQgTDgS55iHWnTOQ8RpRABSOA10UpkagNh3DGV8M5h+ZwBjpHMNQAowEtATy0A0fldM+ppA4RmA6JwBsDSkqPEIBAb5IEdo5IskHQcdgyryFDNhnDuI8MUwIyTGT2T0WiG0E0wc0R0yh1Ppc0TopSAwbw/iJTHnOCqb4Bpi6iYdD4B06IPTyKcCslM9xwUUjkBOS3HqNIUtVAxetFIrROinakAuGuGhqc6LIK4HJqZiAiDMClrEAoUts6NnS3Frgi6qQescL+XLYB8uhbgEVwInBSuwHK5V2IFhJCIFiHVhrXIpGGsQDmMg0kZCotneijKdBPzPOKogeI8QpaSCm9yLgCXNwyD1KTIZkWyBbA5gUA7N1HInay78Ers35vvS3MttMq31vWE2zcbbYwtgWHq2ALz02uCvfXAtj737TBrZO+a4i4ECixHG09QhEPCatmSo8ORJo3gytMDtMASVYylPaXCcUAARPi2h8GylQTAVwABCTgNPFBkGZ+KEzoPuPmd45idndO/N484ATrMOywCs6F5zkTF0xO1jg+KJ6AGgN9NA/qxJCqCGpJ+U9NGCHLjbS4ISrgLYpU6EBAsmSgJguEA6BVMnxvIblmx1kK3g7mC2+RPbx3kmRDZIwFrmc5v5OhKk7+YPcJTcgVrDzt9QfaNlIUIdATGGsM87MxZojMA0OCfI6M03Cfg/J9T7nkjzHWPp445nvn2f+Pl/Q+xuXRewDMETxHmTcnOiKfLMp/z6ngJBe0wDXT/HLusmM1xnjkTODIB85iAfgWtMhbCxFgzrJMajMV7Bo3+zyRY/Nyp0X4uic3FJ8XpPFPqe09pAzwmLO2e39IFz2vM/CNP45/g3HAZT+S+l8/sznLjvmjO5LZl5D5A8LgFQMgDtG9ApG8qunSn8qIsoGcFSL+FRMwAyoCruoahlOxDKhlIejyiYFSBlKUnMo2HTJnCvFLHCoAkgIkDvKAvogfEsIgNvCfA3M4P0PAvsLfMrEEHCL6phCXgdLJHALZjAGSHxBgCBLDMCrosVFuFTLjHxnIfqGJOhN2P1gANTTRur1CpjhbUFUC6QUJ4D84uSjLihUYvJqpZLybVzioACy/oRUAUM4mQlI0MBCSqbCja/SIEGSWSeq+UjAxMXASkg4jaaaM6LA4g1ikh0h9mN0AY4WX0RUNwEGMRRSF06BIgmSf2u+J204Mi6U8i+CVyNyBGJwcIsQjYK6tK9K36YA8QwK26K4ZwiKbR960hu6bRsQy2OYJwv4sQAqaAWKIOcIeqN0WgvhNhlanaiIaSZySi1ym2Mgv4X6LwFSiBtK66OBMAW6oKFhu6kKHKXKR6vKmUWxkxWK2KWxuxaALxpM60Yq+u8GcA/ueihK505uqgTuEeyGVEFwaAmIjGHGIEYJ64b+1hH+sJEJnA6goy9h/utSoJ/xEJ10SJ8J9eSJmIqJlGYmreaMT0o6c+4o9xLx+xNKa69Km6rkzK5xe6VxJBx6KK9x56zx7A36rxfJLw7xQEz6Jk76M4pgLxv6YBnkSA3kDMpgCk/gRAFgv400apI0NBDMWcVWKwcgIwQCkwPMQQYE7B5gXB9cZ8q8TcHguw18iCd8whXcRMvcxs/c4Yg8V2aoc8SOyok8ScZ0yJI8vpE8yMv8ug00/Q6Q+pBcnBRpu8IA+8ECcZdcEsjcl8tpcsCCbcQheAas6mZAmAzYeEUcYAhEnoY8boXsoY5ClCkqVCRIFMg0iipZN0UAUARaRgjMEZqg2cjBaQ8ZoCJZ8gZp4wUCPBywrg9MVEsAzQPi0UNUcU8YiYyUqU6UWUMAOUT0NU7WakDUDwf0785cgZHUXUZcrUn8d4VYPI1syEqE7YXUW0IJ5SSUT410t0eI90eIw5vUyUA0Q0U0gFQFQFc0yMZhIA3cogSAoAgQ8gvCNweAoUIArgrgQAA=="}
import { Hooks } from 'wagmi/tempo'

Hooks.reward.useWatchRewardRecipientSet({
  onRewardRecipientSet: (args, log) => {
    console.log('args:', args)
  },
  token: '0x20c0000000000000000000000000000000000000',
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `reward.watchRewardRecipientSet` Parameters](/tempo/actions/reward.watchRewardRecipientSet#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`reward.setRecipient`](/tempo/actions/reward.setRecipient)
* [`reward.watchRewardRecipientSet`](/tempo/actions/reward.watchRewardRecipientSet)

---

---
url: /tempo/actions/reward.watchRewardDistributed.md
---
# `reward.watchRewardDistributed`

Watches for reward distributed events.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/reward.watchRewardDistributed.md","from":129,"to":5308}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"468089c03999f8f886d48f18ae80edff227a04649f0e95be6e2f75637d974e5d","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGcUgwTakKD4ioyGqk+pIZrUVoAgwisUSsE9RCM5mnVmIABMlQRmC5PlmpRo/JACTW/FxnGB9huaoAIowxKRGAAjFY0KAAHiOWQAfEEOslUkHkhROFhHMw9GQ4KkacIAHSqyRQNOO/DOrNuj3e30wbMABXjidIcEDxSUwYiewO+COJ2GF0UaBuaDujy8uTA4gTcDjvBgDub+fFhZOxb9pSgEF4CAM+xB8E4CXYwtFWc4UHds59fs4MEuaDgaYt4iUK+QyBAdCHWAUpQABh+L7lBYVgNERVsMBRkoMb4GgaBYJwribqQEDMJwADkAACmxKMwjAAPQxCKCHfpiv6cDQmJQTBcGIShN7oVh7AwFhDgWHAuF5PhXB/qmcAkQksHwchqFUdhtFEWwTG5EscR1pwAC8/4wIBwFBMAuScNE9HCKkyBCRADzwGglhoAAuhQSmEUMwgFBeqSKWAynKRpMCYmmjBQPpqRgRBQQREZ1lQV5rgRLkomxKsGzNlJPB2iYGa7uKOaTtFUAzp6x6lmGdYxlZyloBAADWiipAh1i0Pq1i8NYZXlRVlVVdVNW9AhXnKUIU4JYeSUllAqQhDocAxnIEBKFEknBpwGU2UsEAKGmfVKEECHNfurVzqWiD1ZwrSRMZ7i5H5uQfm+ICGQ+cZDMwpThkonAALTpHWV6HSAx1DqUj0JiMHHXRWJ1VpeB0UA+Io9vcpjcJutrGNZWXBXAKxenAvBJeOXFkao45np2d2GWUBJ9NYlTyHUPwGvqfxUgYubNYlS3qmY9JatCuouFqvTGkiZqopagQhGEkRFMI4mJBGN0CzkzHmbznSiNjiC9PqMoEw0CqUsqTJ1nSmraoMwyMwArEaHImt4KK8hzeBBFgsE4BwGBRE18WU8lHWcF1t6pOTduLQ7abcN1vX9a7cWuh77VpgAMv1g3DUQEBOQuS4riAaShHIXpONlhEQJwFhR7lDr4IoO5qhxkjjgeRae5Kby9BCJLy30nxK4EtuB2X7Vq1YeNMprsJIPqLOmkbFrogYZuViMUTrZZxnKTaYCwKQqRvoVAAkwBFsorhvgA3FPa3MBAaxoKkXrJBYaDb2ArgV/ovTazXZJIB3Dd4OtbcP/TWujPqvf66zA/zJzL0qxRGmv7EEFMg5+lDv1K+bJtb43vnTRU/xAjTVfogDuOoP490JH3Q2PJB5WkHMOUc45xoKFyEQSQvM4ATRgJGEwtDY7LjwA8POnA3xkJgG+Tge8oArAULGWCRAnIbnEJwOA+QBGwB9EoJQFgLqcMIg4Lg7pxEsEYHIKhkMUa5AAFLiEoQAZXhowLA/MaECITMyPIcB4Lm2ICIqAnAvQYAdDAL0zjYLrDgEmNMAVHhsN4fw1GtBzIcTQOsDOI4YC8EYEkXgRRMSWGOMmfxAAqHg7CjgWK4dETRcAOLrEYKoHhehCBQA4tDewa0OIcIYZNaaHk3wxjqcIWhaYyCwVIE0tas92GcNivcHpqgtjRHENZL044Vg+KcZDdYnoaDp16a4gActAGAaYABWlSTiyWYH4sAGSQZKD6inOQ/T6m5IYhIMAY5xbJDuKWJZ8zinjkhsgN89ixwFLTGIRcvo3z6SCG5LAyYMIYUgLAbZaZ2BKAwouZcGFNE0DEJdIgho0y0AwuILAmEvnwEvGBZgcgADE+KCl/P3mgces9cgfPJZeP5nTAXAvAqCxA4LIUwGhbC+FcckWAVReiyomLsW4owgytMRLSUMqZaQUgEQ0ycFYeOE5EAzkXLaQobhvBxnOKmTMh0xTCC+kzixeRSjxxvi5YgTh3CgmTX8QAfTSWk/Y9x5GuqdakFVnA1UasUeqzZMS0AIQ4q9cpRcRScEsMasg1DDydjkBgXIcAMC3PwLBSA0zODmBzijTxEBvHxu4GWAAkuEvOriRQ+OYF6BQMZICkDWtGlGriliJuOMm3I4R032CzfvDiebxxJ04BAFGza1mwC2TsgCzBLycEMTAN5bCPmQEWUIQRS4CWcDLRhAA8iykFYKIXrJ5ToPliLkU6TRRirFOK8WwW+YStAxKSXiEuuumAl0hCXQZZdQQUQtykFyHvaNFhgPMC2LiA5uQzi0GfAI6ZFqC3+tCJqnJb5ED+L2tswKWqNmNIQnnOQfUHTsDkFABCERz7gs4GWT0KTXIwFIxnSJpBKMxkhpS30+GclTX6rNEjZGACkjEYwIXY5R6jtGML0cYxZTgwm2MUagFxqJaB/loD4+0zp7AgiWHWJwM48r9MIV2IQCAoKYw0IjRalOTiHBYBwJYKjEQaO5Dowx0+HE9PNuHHAG8I6+nlF4GnNsdzuOac6dhsAdHlIma6XsSz1nxFwTKfZ8QjmcUudLJ5uTNk1pcGQGeUILltbS21vlwrRXF0mLMRmNYZaAnulbAEJ2NqiDMGlhCfU0tCT+TiwVmyoz91emDfwRrYBmusNa0IDmHX1mIC61qaw0gtQDeq4V0ZNrT5kEHHICVT6CUYToDE30uJ3jqGltILbI3iulbkPpS68yctkCaETO7ylRmPeMZ6Mxi3YCID2/cUIR3t0FNO7Qc74N3iNCaNYQb8X7sxqWyDg7GEoMWFO5QuQTq14pH1BCLU/ixIxqHOOaS5mNHnKuOqhiQgELnwGWKMAQQ3wunGboZtK8iEwFcAAQk4Jz5QZABdvg80N+TPnUgi+55wXYNPOB0+Pm0sAQu5di/U+I6L8rdofn8fBxDBqUNsLfNk2hOr8mpLAPrt8eHblBSpWFNohjdlDkMelwg6wPLM6Cp0l3eg3dzs9wmb3vu+NcGYBgC3AjpKGeoe02PMAghUpjJ0yXoGY+XIEzNYjLGyNSbc7J6XTGlMF5UxxtTSyqVZ+T7noTFfOBidWpJ1TMnqvebL8p8jVfte17ANH+vfmDOimM6Z7p5mUs9TS3Z5QzistKbe656jkuvMKeTJwZAiX2DJYgFZmftmMvz4c0v5zihSyGSWZ00nQU+dhWp6R5X9O1dM7rzn1n7PNc8+AHzwXwuucxcJcS8u9FNv8FclcVcGd1cADRdSABdtcb8wA9prxbwkB7wyhl1ShkAaE7gxwgVj0OUMI5FVAYY0wYhmBT0oU4AqDaJ611UMJhVRVzAvRqICMZ0IgDpMZXhr51AFRZRCYKQlR2hLk0E4FO4WRGY9ZJg8FzR/5TYI1oAoh69GkAsgsAB+VIcZDAGMNMPQqzcGUIT6IcTfbQ5AfSRsTgKOJyJ2AAal6DHVmD6iy04KoARXjlAPCQzjfB4zQG4SKRKUM26A2U4AAFl+EBAXwR0dAVgEwUkxkJlxw4wClSwYwAj8BLVcgkhqwuBpknlwhLVBEWBJBXE1DdBeknFR0ssDxDDzk8jKjKkYYxBikLshAKFQgVgNwJF0JNFm13lPkFMEgggIQIgj02UiCoMwB1AYUL1ugVgsVJi/0gsaDJiIQjtT4Eg0wIQpVX05BBsggC1WhYjOwo0R0n9kjDV+iLs5A0xIMtgmkCC2UT0uVz04V3CBUUU0Bb0RV71xVridi31ri7i0BgTLp1p3NYNkCPwHcycYgD4wptY/d2CiM4TjhUgRMqMYxUTqUQCN9UhsTUg4EllfCdMGlBMEICTVpsS185NPD8T940TOAiSostM7d/El1xwPl/jgSHjWUIJniz1LxeV3jr0hU70xVMJ/jpUSUgT2AoMQS5StgwTuogNtwwNxwINFTwYrwWg0CUAHwJFblcAqAiBrA0xehzSyouDJYpR+sO4BCGhGQn4DBUENQrBxDMFu5pZv4ZDph8F5Dh5AEx4W0XYRod4Z454F5l5V5Zx14t4d4hwGTD5nET5jhz5L4bTK5pA5YEFH5hDn5uoxD34vT9RtZcE/S5C+QAELYyBMAogspcowAozaAV4CcN4mF45fUHgy0yxip05Gy1ooAoAa1TAeCe5ehbAvg5REBxDnTqAcpFA0EahPS9QfTORZD2Yh4VY+ZgpcxOoI4rDo5qYxyDRpB+gpzBCSZlYgRmw0FehzyVzGZrBXBMYYhYAMQxY2IIphBOJuJEI+JMJNImIfxWJ7kLpoIkYeI0w2CsgRJHcdybyQQwp2Ioo1RYowF3YW4/RUphZ0pjIm4CwIEUp1pfYBowzvJlIBkiMJ5VpwTNoGp+y8pEJCpipSoap2KOL2L6ptpBtqsQ5AJSAbMspIJcx5FchEL7APJShXpxAkBQAAhFAJEhA8ALwQBXBXAgA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.reward.watchRewardDistributed(config, {
  onRewardDistributed(args, log) {
    console.log('args:', args)
  },
  token: '0x20c0000000000000000000000000000000000000',
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

`() => void`

Returns a function to unsubscribe from the event.

## Parameters

### onRewardDistributed

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/reward.watchRewardDistributed.md","from":5523,"to":5720}<fsm-vh3gqscxm4e>
declare function onRewardDistributed(args: Args, log: Log): void

type Args = {
  /** Total amount distributed */
  amount: bigint
  /** Address that funded the distribution */
  funder: Address
}
```

Callback to invoke when a reward is distributed.

### token

* **Type:** `Address`

Address of the TIP-20 token to watch.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/reward.watchRewardDistributed.md","from":5897,"to":5978}<fsm-vh3gqscxm4e>
type Args = {
  /** Filter by funder address */
  funder?: Address | Address[]
}
```

Optional filters to narrow down events by funder address.

## Viem

* [`reward.watchRewardDistributed`](https://viem.sh/tempo/actions/reward.watchRewardDistributed)

---

---
url: /tempo/actions/reward.watchRewardRecipientSet.md
---
# `reward.watchRewardRecipientSet`

Watches for reward recipient set events when token holders change their reward recipient.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/reward.watchRewardRecipientSet.md","from":181,"to":5370}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"7c5c4a80757b69fb0cc9e78c15e065ab4f7f1e8dca7ffc4ca8ae3da467de30df","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGcUgwTakKD4ioyGqk+pIZrUVoAgwisUSsE9RCM5mnVmIABMlQRmC5PlmpRo/JACTW/FxnGB9huapuvEYWEYijQAGU9AAeI5ZAB8QQ6yVSgeSFE4WEczD0ZDgqRpwgAdKrJFBU478M7M673Z7jr60KmAApxhOkOAB4pKIMRPYHfBHE7DC5em5oO6PLy5MDieNwWO8GAO5t58UFj1ekulKAQXgIAz7EHwTgJdjC0WZ7dumfHThwPScGCXNBwVMW8RKZfIZAgOiDrAKUoAAw/F9ygsKwGiIq2GBIyUaN8DQNAsE4VwN1ICBmE4AByAABTYlGYRgAHoYhFBDv0xX9OBoTEoJguDEJQm90Kw9gYCwhwLDgXC8nwrg/xTOASISWD4OQ1CqOw2iiLYJjciWOI604ABef8YEA4CgmAXJOGiejhFSZAhIgB54DQSw0AAXQoJTCKGYQCgvVJFLAZTlI0mBMVTRgoH01IwIgoIIiM6yoK81wIlyUTYlWDZmykng7RMdMd3FbMJ2iqBpyLH09FDOtoys5S0AgABrRRUgQ6xaH1axeGsMryoqyqquqmregQrzlKEScEpgfckpLVIQh0OBozkCAlCiSSg04DKbKWCAFFTPqlCCBDmr3QsvSPPREHqzhWkiYz3FyPzcg/N8QEMh9YyGZhSjDJROAAWnSOsryOkATsHUonvjEYOJuitTqrS9DooB8RW7e5TG4DdbWMaysuCuAVgAIzgXhSEYWGxy4sjVDHM8vXuwyygJPprEqeQ6h+A1GUpZUQBzZrEtnAENUhaFdRcLVemNJEzVRS1AhCMJIiKYRxMScNbuFnJmPMgXOlEfHEF6fVCWJsl5T+KkDAuulNW1QZhhZgBWPX2dNFFeW5vAgiwWCcA4DAoia+LaeLFbOC629Umph3WsWp3S24brev6924pdL2D2S0sABl+sG4aiAgJz50XZcQDSUI5FhpxssIiBOAsOPcodfBFHW7c1QWsPc4449S0lN5ekqWwvjlA1G4pwJ7ZDtq6YYBmkCJpkddhJB9SN7wTYtdEDAtysRiiDbLOM5TCDkWBSFSN9CoAEmAMQkeUVw3wAbkX8ukvXred5OCwlAP4+wFcWv9F6Rp+ib0n+7bvANs1qx+51XXRj6ghKPaYPIJ5Wmnt9WenBppBxBDTUO7U9CpijkoR+bIZQkwaOTJUgRpo/z7kzABw9xgchNGPMB8xAgDiHCOMc40FC5CIJIAWcAJowAjCYdhiclx4AeEXTgb4GEwDfJwZg0AVgKBjLBIgTl1ziCPPkKRsBYYrCUEoa+rD2GEQcFwRgVcWCMDkCwqGGNcgAClxDMO9Ijd0Qs2FSPjMyPIcB4KW2IHIqAnBYYYAdDAWG3jYLrGPNWVMAVHgCPEVASRmNaDmQ4mgdYOdhxeySLwIomJLDHCTOEgAVDwQRRwHEiOiMYuAHF1iMFUGIvQhAoBVxWPYdaHEhFcMmtNDyb5oytOEOw1MZBYKkE6etMAXienFNivcYZqgtjRHENZFGqxjxeKhusJGNBs4jN8QAOWgDAVMAArKuJxZLMDCWAfJoMlB9QznIQRwjREMQkGAUcUtkh3BgCsnOayqljihsgN87jRzlNTGIBcKw0Bvn0kENyWAkwYQwpAWARzUzsCUBhBcS4MLGJoGIK6RBDSploBhcQHoMJAvgJeMCzA5AAGIKXlLBRACFc9Rm5ABQyy8YKBlQpheBOFiAEVIpgCitFGKk7YsAnigllQiUkrJZy1M1K6Wcu5aQUgERUycH4WOa5EBbn3LaSU3g8zvFjhWMsh0VTCAQtzixTRGNBHCsQA8sREjJrhIAPq5Nyfse418fWetSDqzgeqDXCM4Pqg5rU0AIQ4m9OpHFJBjksNasgrD9E0GOHIDAuQ4AYBefgWCkALUwMYAXR1sMgkhJ4GWAAkgkouviRTHmYLDBQ0ZICkHWiKHRMBfFLEzV6HNuRwgFvsMW5lHFzAFzTpGjG3bdmwEOccgCzBLycF9H8gRALIAbKENIxclLOB1owgAeV5bC+FiK9mip0OKrFOKdL4sJcS0lmFFXKtpeIK6e6YBXSEFdTlV1BBRE3KQXI4je0WHA8wLYuJzm5DOLQZ8UiLUOoEWG0IhrekKDfIgcJ+0jmBVw/sjpCEi5yD6g6dgK8EIRDvgizgZY94WU4JR6jSTSAr2jFDJlEKSMTPIxxnOABSRi0YEJcbowx3ITGWMWDYyJmj3GoC8eSWgcFaBBN9IGewIIlh1icDOOq/TCFdiEAgHC6MbCE2aIzl4hwWAcCWCgPR2TYB5OsY4np7tQ44A3jHPMrx5ReBZzbK8vjmmBkEc8xhGyJnBl7Es9Zo8cFan2fEI50lLnPlyfizZdaXBkBnlCC5PWcs9b5cK0VzdtisCllIGsOtET9GtgCC7Z1RBmBywhPqOWhJ/JxZq7Ms9sNo38HTM11rcB2v0E63sxA3WtTWGkFqQb1XCuzOdYpsgA45DktgsCuAGE6CtQhbid46g5bSE2zZWZJXmFyH0ldNZOWyBNANPqO7ylZmlbkDYpGDWFuwEQLt+4oRDtHvKad2g52IbvEaE0awQ2mNba4Dt44e3IdwYsKdp7nrd7XzJlqcJYlOA0LHNJczRi7lXH1QxIQCE77CMmWAIIb4AAi8zdDdu3pT1wABCTg3PlBkEF2+DzXnFNJhFzz9NuxaecHp7DRnYBhei954L9TR5ovqr2h+cJyHUPmrgBhscb4insNEbwMpOSwAG7fMRl5QVmVcGkm0b0JzBzenS4QdYHkWdBQGWFT33vmC+/jP7wPgmuDMAwFbqR0lDNaMmonmAQQ3fRgGR5yDCejVTX6rNZT0m3NS/iwp7JrkYBUe+bRtTmy3d5/T4XmaFGa/UfE2tKT9f6OMYr956vteVM8cbwJsA8eW++YM6KYzpmhnmZSz1NLdnlDeKy+x97rn3P9+Y4PzgyBEvsGSxAKzy/bMZbXw5zfznFCfMMpsgZZOgqU7CjTqjyuGe9LAMz5vBexTs5c7y587AAC4a7AES7l574y6pCa4K5K4q5q7gFi6kDa6P765gD7TXi3hID3hlAwC4BUDIBsJ3CjjQpXqCoYQaKqBwypgxDMA3rIonbCoYTtr6oYQypyrmCwzUSkYroRCHS4yvBPzqCKxvzkiqyUzCIEKIB6xEJDyIBGhkIczjxULmwJrQBRAt4dL+aBYAD8qQ8yGA0YqYphVmEMoQX0g4suRhyA+kjYnAccTkLsAA1L0JGrMH1FlgIVQJisnJXheJsm+PxpClatUoZt0PspwAALKSICAvhBY6ArDxjZJzILJjixjlKfLRiVLVJmLCzVhcAWqfLNJ9rSIsCSC+K6G6AjJeJzpZZQBVK4jYbFF1ENLwwCDdgQxMKhArDrhm7oTGLdr/KAqsYJBBAQgRCXr8qUFwZgDqCor3rdArDEpzFAaBYnZzEQiHaKYJCpgQhKpoA0pDZBCOqtDJFehJq9pzqZGWojEXZyCpiwZbCdLkH8rXrCp3rop+GSq4poAvqypvpkoPGHE0q0oPHPFoCQlXQbQRCaqEYfjO7k4xBrDu6cB6xB58HkYonHCpCiZubRg4loBQEBGy5EmpByGbIhE6btJF4ITklrREkkn77knok67UmYGG4O5gBboH5vggmQmvF8oQQfG3qXhio/FPrSqvryqYQglfoQnsBwZQlKlbAwndRgZbhQZjgwaqkQxXgtA4EoAPhm4vKEEgBEDWCpi9DWllSCEyxSgDYKiyikw4L/B4L9QyFyEDwsgszywgLcjmhqFTyvRVhzzdQLzeRLwTSrzny0DbxE77xHwnwihdy4mCIXyJk3zJn3zoI3YkhYKEKKjulfzdRenyF6j6iGzKHGyUJ8g8zuLWyYBRBZS5RgBxkJlXxJk8LJwhoPB1pljFTZxtnrRQBQAtqmDCHDzyxKzNzemfwGCtmKAyE1D/wKEjw1kUJBn1mLBBRAjNidQxyOHxzqh4yOn6jSCMgukSHFlqwgD7kggyG9Cvxrl6jWCuC4wxCwAYiSxsQRTCCcTcSIR8SYSaRMQ/isRvKXTQRow8Spi8FZAiQu6CzBQ5hhTsRRRqixTwKexpnhypRizpTGQdz5iILdyuzL7TRRCjTKSs7kbzxrSwlbQNTDl5SISFTFSlQ1TcU8XcX1Q7RDbVYRyASkA2ZZSQQ5jXy5APn2AeSlBvTiBICgABCKBm5CB4AXggCuCuBAA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.reward.watchRewardRecipientSet(config, {
  onRewardRecipientSet(args, log) {
    console.log('args:', args)
  },
  token: '0x20c0000000000000000000000000000000000000',
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

`() => void`

Returns a function to unsubscribe from the event.

## Parameters

### onRewardRecipientSet

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/reward.watchRewardRecipientSet.md","from":5586,"to":5840}<fsm-vh3gqscxm4e>
declare function onRewardRecipientSet(args: Args, log: Log): void

type Args = {
  /** Token holder address who set their reward recipient */
  holder: Address
  /** New reward recipient address (zero address indicates opt-out) */
  recipient: Address
}
```

Callback to invoke when a reward recipient is set.

### token

* **Type:** `Address`

Address of the TIP-20 token to watch.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/reward.watchRewardRecipientSet.md","from":6019,"to":6161}<fsm-vh3gqscxm4e>
type Args = {
  /** Filter events by holder address */
  holder?: Address
  /** Filter events by recipient address */
  recipient?: Address
}
```

Optional filters for the event.

## Viem

* [`reward.watchRewardRecipientSet`](https://viem.sh/tempo/actions/reward.watchRewardRecipientSet)

---

---
url: /tempo/actions/token.approve.md
---
# `token.approve`

Approves a spender to transfer TIP-20 tokens on behalf of the caller.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.approve.md","from":144,"to":6264}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"ac90d56fef4b8b0bb0fdd99d1f3d9e38719b2c463becd75cdc590e023c1e0813","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScAGYArmD8gmCcWJJwMACqYIxocEFEobEwiJxipBZKFJywvCyhcCVgscwARmQRJS2MShZoADrZrOxcqaTpWTmmUBC8CAYAsrFyAljm8JzipWjlypykMFj76WASxskQ0RucTa1knC0YVz0kyXRsliecF/fhMJwAjNZOEFAW8hIo0BEAHQDAYAWk4ABEZg1OPg0GgsA0APTYoiMGDMKFwfDY6azbGxATmATwbGjcbZXKUajiJRzZDIEB0cSsBQslhsDicYApNKZJlwTiuGKkCDMTgAcnxhMVsLADIlkyCioALAAmayKqrSCIDXGcA3Wa0221gEAAXQdom0+l1mjMihUakQgK0kl0gU1E2Z8gsVn+dgcpCcNHIiGk7k8ODwhBI5H89DwITCkU4vBMXALYGi3RKAGEhKWlANBcN81XuiyxJJ9AAOSOe5SqJAANn9Oj0eGL1ZZ5ksSH1UccznjiY81C8qd8GeoAWHhb2MF4MEYWDQJQAKjHhLGkgAlbe7/cs8lzEDH8SnxJCLc7vdoKHN11If7/ACs8hej2iAetogZ4Ps743mGE6ILq04xrOSBtkmi4pgYaZ+GuWYGHWwpGEkpgtlIvoAMxkUB3Y+mBAZDgYhEmGO4ZIAhID2DOcaTr2aGYBhPjpiyNC4SA+FcGgEAANaKN+ra/rqnYKNRSCAayg6BBJ0n2rBVhsRxSFcYgZG6rxS6YSuQnrgYcQJGcGxYIcvgAMoYAkAA8lYlt0AB8QQjmWnCedWVSjLyehkKijHCFCmmKFC4gOXKJAuQkUIAAqOMw4VjB5jZKN5HScGlcrMIw6RucAAycNVXwAO6WKQJQAAbWLQAAkwBlBUrhNQA3FVNVwDgYCwI1nAte1nXbN1fUDdVvIQPEB73N0vT9ckNVQdey2Ps+ZyXtBaDra43kDGAYVDU4fwJY5yWubwt4ong3CJb4UqbENiijZwEk/SecDRHch4AJJpYaP1SYoUqvm0DhyJc3yqH8vChAopAwmAAwAHIQDQR74GVnCEx9934HKkCxO9L7JKo4hcLV4iTDE7A/fgfzbE+cBnq+EkDG0RMJHIsSwFAXzJJsLRyDMkn3DA0TsH8+xoLEpDZLsmxHO86Rfv67JIJy3K0Lyqy4FQTXm7ktZDMKoq8PsdMwEF3RVOimLSrK8pKgAAgzSildiBb7GqgxClwoo0EM7vRCV3u+/7gcwAHDgWHAwdiSKPDU1KMrR57io+2y8cK9iEdsMHAzFmIDZeUonAALz5vbNBO0oQSVRtHEpyUyClxAzoDRzwih6i7c1ZwPeEmwUKMFADolK7WBBBEFADe4AyuGamMJJuRxLFwDfiAzOSZ2ccAxZDYDxa9d0JH5eVVKPpTDaNJSKq1UIf8aA0LUtJSAtYYAV5gA3gMc2TVHQUC5KFZgLJ/K1wRC3L8zooGZRZNA7KUoEQZRjFlOMZ8IFciVirYQLJDxsz+pzbmyQtofg2CNTgMAXhcCgHTcQSDnQgBIvof47oqLel/J2cC9EQA3SSjAFKD0dKsUQrGFw8FrCmX4lhVcwlAg5kYOEKIlcix5QrHlK2odq6jhdHJX0/5ZBdn4YgfsakIIGDgcxOCeloyyPjP+fUijvDKMsiJIIjkcAcAwFEH+JxOirROLJUi/x1CKWAj6GxQjAghIYFIxAql9KuMnJ45cglMxqNCBovMwZJT5EKMULYOxKjVG3HUOQqIbhtFIIVLoPQTgGPrMUyYj1Zh4EWMsPcax3oVIqFuQ48AIR0ySF8S4mwGl3AeE8RgLwGG0HeBCaZPx0gAiBCCawYIPiQgxvCJEKJ54YixIgXEKoiQkjJCiSk1IcgEjgPScUIZTASD1igLkPI+Sm1EtbMOYoxhalyFHGOyoCTMHLhqN5JS9SGmNJwU05psSWkNLaTF9onQmKieoCxSkrF+lscIzpoYzAsTSTI5CvoFELj4l4iyeTsz+LIJgKIn0RpkBKH0EArV1AGigGRf85ZeC9l7MZcs1h/xkX1NIfU/5xBkRaG2XUuoABCvBpAwHUOY/80RrAtAAKItBaLyyJ+hDRsUJSBWi6k8CctGo4qwNiMk0o8fSsyAlsKqJZXKAJ7KIZaR5Xy2ghpeCYsjVG6NMbrTmtxZa3ssTlJUpJRpC+zqNDUsMh65MjLck4UCOdLKl0dzVzgBABQAwCikHLZW8pnkK38ioHePAZC/hNUrvWpqnBmDQCWH8W6M91gfUFAoapLRYhKFabXLt47aZcEJnAFgjA5CSAhqzGAAwABS4gChOTtrQudfwsocWyHABUQ6Rb3EeLVGALR7hylqukMYRywDtt7f28dYIOBSjQLVCAT8amll4A2IYByGjqgAFQ8HGo27t+Y11wClLVHI+Be16EIFAKUcBYj2A2FKTtJh61Qilq3CITUqhEeECRsgcpSBLx7U+UW1Gm0wChAzVWjHWZ03zE+WWnBKYwFFr9Wq5QaAbqfI8HGsAoQACscPbBgLyDGMHuCcCUFLFooRxrHp7SnCQCRkZ5RVsJjdYmcjs0A8gJqjkdzIeJGgaYVImoOiCAvHE2JICwAU1CdgSg7kUjXTQMQcIiD6l1FCWg2IEqMHpHKezZ90TMDkAAYjs/AZDTnFqQjoVAAYNmMsObEKNUgrn3PnM895mAvn/OBZecF+AaAwsRaizFrAcWitJbQCl9LCXMslbo9CTgH7NMQG03IXTxGFA9pRskfmQnRaodUDlomgKRlI3GtVxAenP1QAHW+gA+lBqDAB1SQaslAncO/jP4Y2Jt1vHeNuT240CKilLgrD719jXF3EjWtlcyo0BOHIDAAw4Ck3JotKU5hpKbsfRAZ9dxuBpWBn+tmjwjiEkljAKokBa2SHZhj8tQOISg4GOESHQhoecFh9dOQk3cZs1rTJ9jCmKnKeYGfTgTkYBE7+DZyAEnXxdc4MDbEAB5crHnLleegDVs+dW7zYka6F8LkXouxfizMTLUJktpfEHCIXMA4RCDhF1uEggojy1IAMPtP2LA2+YJMoQb6jVGz+YJ5duxNv3Z06x7tiB1RgIUxXab7GyM6jZgzwDAHSByCgIqCI60LTFV6KiaPUtOBx4T1UX6JWcth5owoUjEBW6Kkz4BgApKnKoioc+J+T6ioqOxcjzxgDH7P7Bc8boL1SIvbGoR0fYEESwtVOBGtIPRnUp3CAQCxFUCtn2RnadFg4ByihhNJ6b2AVPrepTD9rSWrmug8tbCcDLDmZb89Obo0H3faLqqT/oyUWfEB59wEX/KTDK/xBr5upvvlg/mPBsFwMgIwqEHPP+GYs3mPLxgeuUPuFCKQPEMDO+gTHAJ5KosCNtkQMwORPqL6G2JvBaHAVwBLi0C9vwMgagegWVFgQEDgfLogHgUZNYNIEZMQbATVLxttr0GQOdHINroltiHQNuFSEkKBOoL6NINwfNGARAXIA6HCGJgAY1L2IgPqPqHIaAQwgUHIAgbQqPswfwarKEMIZlqIbQOIWcKBBob2NYCQY/jwVwHwScAIeYc7hYKIfoYdl1MoJoWREZOqNotcGFPXEqKdqupNueONinEIIqOtMehxhdkEE1IiE+LoLWh1MWjAK4AAIRIiZFkD5FNQ7577p4lAZHKB3BREM6cCxFdA0ZgCFHVFZH5F56AaDZT6gLmzqju7GzjqUwbbkJNTwYzaIbhCQZbwh5wAD5cCrYNyBhORKa8hOTf6EC1RLxJGbh0YRHLGrHMDrFZSbHbHzG9oYDjF/ANxj6PbsZXFBA5ZVBDbrR26XHh6l7l6V5d7x6N4p5opp4nAZ4d5Z4N6dFfD95gDMDvHF4R5l5R4gnV615KgN5J7/Et6VFoiIk/E96/SF5QkwmD6H6j4wDj7P4j6Khv4f5f7L67Cr5ogAGWCN7lEAn77dzkljRUkL6lDf6qC/7/4b5MnOgbp0YhGbi5ERGUnRENFxHNGJFvFXEpFcbpHFHZHAC5EFFFE1GkClEskYlAlVGqmcB1ExGykVotFantHgmilgBgJCRsgchcjpD/LIAVoqw7huYy64g9CqCxAtBQgFjMBy4+YvLVbYiSzjZ4itbRbmAtABwfEKYRCOgcJcJIBkT/Bth8K2oDh2LsTh6Zq0rZpyJ0p5o5I+pWTBCfbQBRCKmR7H5sgwAAD8JQUmVQH8fm+4SQoQ2CvIqIUmyADohURAEAM8wIAA1P8F8OmFLH/kmS2k9AYICWCr9E1H3mgD2stuhmPuOOxpwH0isOOgGM0BCFKHNgJqkMhsJlUJuZugMKWGMFwItgRvDocHUKQI8PWafsxhsPUX/lAE8kIDpk+eEKUH6WIDkBIUINWmUjhiumurWr9IVq3tEEEGRBRp6ecrLs7mAOoH5joCrhYLENFthebg2S8thWRPFr0NEFCGRHrj1nIJvEEJtkeVlECRsD9qjGKJeSJtZk1BIXIFCE7nTIxhhZiFVvLrVvhcrqrs1urm1lrgJfRb1gJcJWgGpXCAGJENCMHubKHtvMIDoktBEf+DsbCZ8TqAWL/JwFXonlUFZScHqUuaiA5ctIBL3tlpCckZHoqK5YgEiq5U5WyQ2NZe5Tfs5v0LaX0VvLzgLvxdSEJewM7mgKJRVuJbLtVlJQFjJQ7GrtGe1nFkpfrqlqpUlXTBpVpdbizPbn8I7mVWcDrKyF8gbN7juCyEQNYFCP8F1daMmQmmmfqDYjaj6JRGmngGRgWcSm6oZKhJ6kokyoWhuIZW+NtEeP9FQgdNtN0veLtFzNTCtR+I1amUZP+MmlYnarmTQjBBSnBFNS4jShRNkuZAWr6gYH4v6mykEhQntEkAABLhD4DNStQdT+FKA9TbV4D/UkgbJ8l/rrXUwWppnmJZk+gAQ5nCKDx7VnBQ1qCpJ3WcRyIKRPVNUsi5HjVl6I1GTqBDVxJIC2CLUGC7VUIMkkglCtT/D6jGT/i9jqBtjSDWDiAtC8CwDRAc1c08180C1C0i1i26jc28382C3C1yyy3y2S1K0i2TVTjsT3WGQKIcIFiwBMCAoZxRTZwewKj16Fxxa9xpwm2ihkrm25yW3XJ22GK2x5Tgp5xQjxk1wwqhGihXVcAygHxHxcBm3nxaRXy3TiL3R3w1wPzfx9rWWO06iAhQj/hIq9jLwDSOrcpKj8qCrCqiriqSrSqyryqKrKqqoapao6p6oGrGqmpfwbSxRgCvytThqxrd0922gt0gJbzeXwmKhM37UOCs1IpB0xTw3Y0A2bwsi4LiBICgABBQxJB4DMiuCuBAA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { config } from './config'

const { receipt } = await Actions.token.approveSync(config, {
  amount: parseUnits('10.5', 6),
  spender: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Transaction hash:', receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.approve` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.approve.md","from":6607,"to":7131}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.token.approve(config, {
  amount: parseUnits('10.5', 6),
  spender: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args } 
  = viem_Actions.token.approve.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.approve.md","from":7158,"to":7395}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Address of the token owner */
  owner: Address
  /** Address of the spender */
  spender: Address
  /** Amount of tokens approved */
  amount: bigint
  /** Transaction receipt */
  receipt: TransactionReceipt
}
```

## Parameters

### amount

* **Type:** `bigint`

Amount of tokens to approve.

### spender

* **Type:** `Address`

Address of the spender.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP-20 token.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`token.approve`](https://viem.sh/tempo/actions/token.approve)

---

---
url: /tempo/actions/token.burn.md
---
# `token.burn`

Burns TIP-20 tokens from the caller's balance.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.burn.md","from":118,"to":5918}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"e5eb311ca3488bbee0e7931eefae4e3f14d1d9b3f00dad2aa580098254b3ae39","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScAGYArmD8gmCcWJJwMACqYIxocEFEobEwiJxipBZKFJywvCyhcCVgscwARmQRJS2MShZoADrZrOxcqaTpWTmmUBC8CAYAsrFyAljm8JzipWjlypykMFj76WASxskQ0RucTa1knC0YVz0kyXRsliecF/fhMJwAjNZOEFAW8hIo0BEAHQDAYAWk4ABEZg1OPg0GgsA0APTYoiMGDMKFwfDY6azbGxATmATwbGjcbZXKUajiJRzZDIEB0cSsBQslhsDicYApNKZJlwTiuGKkCDMTgAcnxhMVsLADIlkyCioALAAmayKqrSCIDXGcA3Wa0221gEAAXQdom0+l1mjMihUakQgK0kl0gU1E2Z8gsVn+dgcpCcNHIiGk7k8ODwhBI5H89DwITCkU4vBMXALYGi3RKAGEhKWlANBcN81XuiyxJJ9AAOSOe5SqJAANn9Oj0eGL1ZZ5ksSH1UccznjiY81C8qd8GeoAWHhb2MF4MEYWDQJQAKjHhLGkgAlbe7/fN11If7/ACs8i9PcQHu0gbw+x3e4YYYnRBdWnGNZyQNsk0XFMDDTPw1yzAw62FIwklMFspF9ABmTCX27H0PwDIcDBQkwx3DJBgJAewZzjSde0gzBoJ8dMWRoBCQCQrg0AgABrRRb1be9dU7BQ8KQZ9WUHQJuL4+0AKsSjqNA2jEEw3UGKXGCV1Y9cDDiBIznuWJSDAABlDAEgAHkrEtugAPiCEcy04GzqyqUZeT0MhURI4QoRkxQoRaYyzIs3goQABUcZgvLGazGyUOyOk4CK5WYRh0ks4ABk4XLZXlEoAANrFoAASYAygqVxCoAbhyvLeQgeID3ubpejq5I8p/a8WuPcRT0SIRL1/fcOtcOyBjATy4FSHcjJM8yEhZck5hAAAhEKpUPABJCLDU4ALhHyhVVD+XhQgUUhFSlFpQn6ncYTAAYADkIBoI98Ayzgvs2OAwvwOVIFiKUzyEA6HC4AB3cRJhidhwb+bZ+rgUHkm4gY2m+hI5FiWAoC+ZJNhaOQZh4+4YGidg/n2NAQoqK4jnedIoVYtkOS5Hk+VwKhCt53JayGYVRV4fZxBoVzuiqdFMWlY6lQAAWhpR0uxAt9jVQYhS4UUaCGWXojShWlZVtWYFVhwLDgDXOJFHhBqOmUDflI22RNqnsV1tgNYGYsxAbWylE4ABefNRfFhKgmyzrqMtkpkE9iBnXqpHhC11Eo7yzh48JNgoUYKAHRKaWsCCCIKHq9wBlcM0noSTcjiWLgQ/EaGcjts44H83jAuChawschKqgzjZmCak4SkBawwHLzrDpKRUSqhJfjSrmvecKx0KC5DzmBZJzA4RCWlBZ51t+ilkd9iqUESimMYrjTvN65GnNpZQ98ERk8UftrcRq4fr8YwBeFwKAYtxAn2dCAdC+h/julwt6cCA4vwGF7qFJa8kKIgVjC4IC1gNJMVgquNigQcyMHCFEX2RYEoVgSgLLW/tRwukEr6R8/YuwIMQGwz8REqIJTIoBRS0ZsHxl1POZM3hCE6XYkEQ4EAcAcAwFERqzVOhtROAJDC/xextngW+LhhFAjKPURgxAEklLCMnPgiR2lMwkNCGQvMwZJT5EKMULYOxKjVG3HUOQqIbhtFIMlLoPQTh0PrE4yYy0UR4EWMsPcawQbuPpvsQ48AIRiySF8S4mx/F3AeE8RgLxOBgg+Fwb4t10gAiBCCawJSITQnVAiZEswi4YixIgXEKoiQkjJCiSk1IcgEjgPScUIZTASHZEgTk3JaC8lWNzDigttZijGFqXI+tDbKgJMwb2GpRnOL1IaY0nBTTmmxJaQ0torn2idEwzR6g2GiQ4X6SSyCQARNDGYcipisFgV9HghcjFrEsVsdmWR8jMBRDnpwPoIASqGl4FcpFyKUWoutLCjR+hDQiVfD6CS3DpLdzkl8wCbDzF/P1FY5cIL4KBCmjFGaTgzomAgAoAYBRSD+zgKytxNluX8ioCtPA78/iFV9jywqnBR5QCWH8WR+JYCJLgIKBQXjgpKBCYHcVqrVBi2+lKZV6U5CSAOhABGAwABS4gCimRFn+LlPKpXbgcNkOACp5X5xgPjfJkMYAtHuHKSG6QxiPQGCKqV0BZXFNoGnA6kMzUzW8aWXgDYhilIaOqAAVDwTghU+USvzMauAUpIY5HwE61Q0ADWxHsBsKUYqWUKChCTJQpdCpVAbcIHlUIyBylIG2jYYB8adv5TAKE0MTIDt1UWfq5NODAy9aazgkNyg0CXf1R4r1YBQgAFYGu2DAXkj1s3cE4EoEmt05C5u1TASVlsJAJGZQHYyi7uLLtXYjM1yBCqyJ3MW4kaBphUkKg6IIxccTYkgLAPdUJ2BKF6RSY1NAxBwiIPqXUUJaDYnEFgRg9I5R/s7uiZgcgADEv74DFsA01SEg6oADG/RR/9YhYCkFICBsDbSINQZgDBuDCHhlIfgGgVD6HMPYdw/hmYlGoTEbI0xqjrHAlQk4OG89EBL3Xsbbe/Ms7MYLvxqWytVJvpLPpqdXNPHEA3sldK2VoawAAH1M2ZoAOqSGyMoFzjmPp/HU5pm9XwWg7u3Gga6FbCBQBBvsa4u5Tqct9hlGgJw5AYAGH9BIAMhBNSlOYPiCMA0QCDXcbgEVtpSlOo8I4hJiYwCqJATlkhEYf0eIlsQEJUsDHCP9QGOXOB5b+BdL48XOBbrHXu9xh7mCd04KZGAzW/jfsgGusGCnODbWxAAeQ4+BjpkHoC8c7vxla2IhMobQxhrDOG8MKdk2gEjpHxBwmWzAOEQg4QKbhIIKIlNSADFHjFiwv3mAZKEA5gAorMrm87lW7As/50IWmu0KEKogdU6890+2082iArbFQfzkCTZd7A5BQEVBEDqFpUq9FRATon8bSCk6qG+ljNGsfI7HS2nUdOzUAFIrZVEVAz0n5PKfnOpycWnMBCdmuF1AZnCbqNUnZ6OntbH2BBEsJDTg4P1f9sVK5wgci4BVG5ffT6uxbr4wcFgHAlgycRAp2clKOx1m9vhgylGug6NbCcGTJGc0WeAd7WjsAFpcq677SUQ3EBjem/lHoC3gcrdohw3br1zvM56uQEA0IhdHwsMzw1Lgtryj7ihKQeI20wDvwyjZYhwIrNEGYFhfUvo2w13D8Xzgm3guhYr1Xmvn04D14CI3g7iBm+qWsNIVSHei+5T1VZ3oZAppyCk4R7EdBtxUiSO+dQvppAL42FwHPBQ5AOjhCutPZBOGIH1PqY/erc9yFL/azXE+V8mVCBvyjW/aA75nDvi9icLWCd7nJZ5cDL4nCr4/4g4WBb7n6OaVTKD36YSqTqiULXCeTBxKiuaMCE6cDngaaWxCCKgdQ3rjoeZBCFSIj9S6CcrlT0owCuAACESI9BZArBhUTuYe4uruqIdBygdw+BhBxBXQXaYA7BQhDBrBCuWwSmAw686okOcyqqwM5mH8ua+aKOha4QGatcGOcAKuZSJmIcgYpkB6vIpkCehAkMpcFBm4vauBFhVhzANhMUdhDhJhUqGAOhfwIcWuDqTa/hQQNGVQvavB/2fh2OXO+O0u9OJODuYuLuNORcCRsuSR8hbOYAzAMRHOOOeOPOnA/OxyQuSRouzuEuuQ6RMuxOjO8uS6OReR/haufamuMA2ukeGuBuRuWI8e5u9MKeNu6eDuvBVOAhcc3RpA0efRJupQCeqgQx4g1uN+9uzoS6vamBm4zBuBBuBBV64hpBYA5B0RrRE6YANBMhdwTBnkbBHBwhpA3B4x/BaRDxDBnAohhxJBkh0hnBTx8hWxYA68rMkyKAXI6QCyyA3KxkO4oGu2uIPQqgsQLQUIBYzA+20GwyPG2IxMGmeIYmWG5gLQqs2Oe6EQjokC0Ck4j4Oi7Cb4BEUkG4HO/CVgsgVEQifyAK4i1KcExC2Y5u0AUQrRXOnubIMAAA/CUBulUEvLBvuEkKELfLyKiBusgA6MlEQBAPnMCAANT/BfDpgkwrEUmCrRIGDVEVZmqFSs7AbLplqxaQzjhjqcCxIrCqoBjNAQhSjnTJCYypDFpepVBGblqnQDClhjBcAGZ1oFaHB1CkCPBine4AIbCEErFQCDJCCI7RnhClAoliA5C75CDsquIGosAEEmpvqMau7RBBCYQRA7ZtJ7Yg5gDqCwY6CnYWCxBYYtkfbinDItmYT4a9DRBQiYR3YkY1xBAWaekxSS4bAxZDYBnpD4xVmFS75yBQjA5ixtrwlcZ7Y8Z8YdknZnYiYXbibXb9IEETlkYbnbloD3lwgBiRANKGG8yY51zCBULNS4GPiOEFFxEFgqIlFk5VBAUnAvGpGS4lDgUtTPhLq2n9Cfmq6AVjwHjHKwWQWWkwVoUlDwVB5AZIXKG1xzaLbrnUhbnsAg5oC7mcaYjcYHZHnwYnlizCaiaXYSZ4Ybk3mkZ3lUViyPnPk/Ye5UxYz3lJAsz+hgnTKw47gshEDWBQj/BKXWiUl3JYq9iPK4pIA4SvI8ItqskyC/IqQQSAqaTMR8m6S8Jfm/w9RHhfyozDQ9SYqTjSA4piTvhII8LdR/iGUJjGU4LYRUpaQ0r8kGAyJygQqKIHQOX2wAAS4Q+ARUJU5UKBSg1UUSsweACVJIWS4MX0Kc38ZwLl9+0g7JTyb4T4Xl0ksVZwOVagJi7J5KKkwkwVrISgLIzBeABl6lOlWiuiPotgtKwqtVmSDgJIJQJU/w+oakrC6gbY0g1g4gLQvAsA0Q01s1vY81i1y1q1FMG1uoc1C1S1K1a1B1R1O1p1FMflD4AV8YeCkCBYsATASytsvkUojsmyxseGCc1sr1ooHyH1csWyqoYSQsDC3QGyzsioUIpJAcuyWBooPl+4sszcrcXA71XcskQUIUi0vAA8AcQ89URiLUgNOogIUIj4xyvYZcycRK888K1giKaKLNrNNoK8YA1c2xAFuOOofUA0hk41SVxyyNaA/ko1Qg9VNcLI984gSAoAAQigyqQgeAzIrgrgQAA=="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { config } from './config'

const { receipt } = await Actions.token.burnSync(config, {
  amount: parseUnits('10.5', 6),
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Transaction hash:', receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.burn` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.burn.md","from":6258,"to":6719}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.token.burn(config, {
  amount: parseUnits('10.5', 6),
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args } 
  = viem_Actions.token.burn.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.burn.md","from":6746,"to":6934}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Amount of tokens burned */
  amount: bigint
  /** Address tokens were burned from */
  from: Address
  /** Transaction receipt */
  receipt: TransactionReceipt
}
```

## Parameters

### amount

* **Type:** `bigint`

Amount of tokens to burn.

### memo (optional)

* **Type:** `Hex`

Memo to include in the transfer.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP-20 token.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`token.burn`](https://viem.sh/tempo/actions/token.burn)

---

---
url: /tempo/actions/token.burnBlocked.md
---
# `token.burnBlocked`

Burns TIP-20 tokens from a blocked address. Requires the `BURN_BLOCKED` role. [Learn more about token roles](https://docs.tempo.xyz/protocol/tip403/spec)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.burnBlocked.md","from":232,"to":6337}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"4c6f4c6c8a9a3012b0d32258ab141ad46f5a27fb53da72d2d92aecbf86789fa0","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScAGYArmD8gmCcWJJwMACqYIxocEFEobEwiJxipBZKFJywvCyhcCVgscwARmQRJS2MShZoADrZrOxcqaTpWTmmUBC8CAYAsrFyAljm8JzipWjlypykMFj76WASxskQ0RucTa1knC0YVz0kyXRsliecF/fhMJwAjNZOEFAW8hIo0BEAHQDAYAWk4ABEZg1OPg0GgsA0APTYoiMGDMKFwfDY6azbGxATmATwbGjcbZXKUajiJRzZDIEB0cSsBQslhsDicYApNKZJlwTiuGKkCDMTgAcnxhMVsLADIlkyCioALAAmayKqrSCIDXGcA3Wa0221gEAAXQdom0+l1mjMihUakQgK0kl0gU1E2Z8gsVn+dgcpCcNHIiGk7k8ODwhBI5H89DwITCkU4vBMXALYGi3RKAGEhKWlANBcN81XuiyxJJ9AAOSOe5SqJAANn9Oj0eGL1ZZ5ksSH1UccznjiY81C8qd8GeoAWHhb2MF4MEYWDQJQAKjHhLGkgAlbe7/cs8lzEDH8SnxJCLc7vdoKHN11If7/ACs8hej2iAetogZ4Ps743mGE6ILq04xrOSBtkmi4pgYaZ+GuWYGHWwpGEkpgtlIvoAMxkUB3Y+mBAZDgYhEmGO4ZIAhID2DOcaTr2aGYBhPjpiyNC4SA+FcGgEAANaKN+ra/rqnYKNRSCAayg6BBJ0n2rBVhsRxSFcYgZG6rxS6YSuQnrgYcQJGc9yxKQYAAEJyDM0lQAAyhgCQADyViW3QAHxBCOZacP51ZVKMvJ6GQqKMcIUKaYoUItA5zmubw7leQkUIAAqOMwsVjH5jZKIFHScHlcrMIw6Q+cAAycM1sryiUAAG1i0AAJMAZQVK47UANxNS1vIQPEB73N0vQjckLVQdeU2Ps+ZyXtBaBza4gUDGAMVwKkO72Y5LluTAnnebwt4ongTnpVKh4AJJ5YanDJcIrUKpsLSZe5GxQFARxwDCYADAAchANBHvgdWcLDmxwJd+BypAsRSmer6qOIXAAO7iJMMTsG9+B/NsT5wBjyQSQMbRwwkcixLAUBfMk32/fcMDROwfz7Gg6UVFcRzvOkX7+uySCctytC8qsuBUO1Cu5LWQzCqKvD7NjMARd0VTopi0qfUqAACeNKLV2IFvsaqDEKXCijQQwG9ENXG6b5uWzAFsOBYcDW2JIo8C+H0ys78qu2y7vc9iDtsNbAzFmIDYBUonAALz5hrNDa0oQSNfNHE+yUyAxxAzqjWTwi26iectZwxeEmwUKMFADolHrWBBBEFCje4AyuGaoMJJuRxLFw6fiHjOSB2cwPval6WnVl505bwIVlVUNefSUipdVCe/GqN42TSUgLWGA3fze92+7/vF/9wMCvtY6FBctFzAsqFKcItnX7Oq/hUsjfsVKUCICoxiKnGYGz8uS83uiyQ8JM3ongpkHN8S0NhgGZjAF4XAoDY3EL/Z0IASL6H+O6Ki3pfyqXAvREAaUTq/WXpdZicE9LRljC4eC1hTL8SwquYSgQcyMHCFEBORYyoVjKsrW2SdRwujkr6XslEuyUMQP2NSEEDCfxYbpRCHD4z/h4guPi3g+GWREkEQ4EAcAcAwFEI+JxOgzROLJUi/x1CqSUqo9RNDAgOIYDpFSejkKIH1Dw0xFlMyCNCMIvMwZJT5EKMULYOxKjVG3HUOQqIbhtFIJVLoPQTjSPrPEyY11Zh4EWMsPcax0YpIFvsQ48AITYySF8S4mwcl3AeE8RgLxOBgg+Fwb4LRfgAiBCCawgyITQnVAiZEsw24YixIgXEKoiQkjJCiSk1IcgEjgPScUIZTASHFigLkPI+Ry1EirO2YoxhalyE7F2yoCTMDjhqI5CS9SGmNJwU05psSWkNLaUF9onTyLcW2ZRXiQJ+g0bQ0poYzAsUQKpfS+jfzcOMWZAS2EBHZisTYzAURQ7MBKH0EAXV1AGigGRf85ZeC9iUbqcs1h/xkX1NIfU/5xBkRaG2XUuonK8GkDADx0h/zRGsC0AAoi0FolLXH6ENG2ChIE2K+LwGSnRfZgmGTCTi3hkScKCKJWQElb0pKKApVS2ghpeCgqdc6l1rrrRKshSq3sU4VEgWoXRDS1rtIorgh6DFITDXJgiYJKJeA9pFQOk4P4CcIAKAGAUUgSc4CpuSf5bN/IqB3jwAgv47UU0KHapwZg0Alh/CsfiWAdS4CCgUOktKShCkp3LaTBwXBYbNtqnISQVriYwAGAAKXEAUDy6sPxZpzVW7cDhshwAVPW5u517iPBxjAFo9w5Q43SGMEGAwS1Vpra2sEHApRoBxhAUoOBaill4A2IYQyGjqgAFQ8E4O1PNObK28CHXAKUOMcj4EXaoaAUo4CxHsBsKUZaTA5qhK5HOER2pVCQ8IFDZA5SkE7pWp8zNsP5pgFCPGjlCPE2xvmJ8HNOBo03RJTgONyg0BHU+R4ENYBQgAFYwe2DAXkINv3cE4EoVyoy5C/u7ZWn2EgEjJrKg5Zj962M5FJve5A7UrE7hA8SNA0wqTtQdEEduOJsSQFgAJqE7AlBbIpEOmgYg4REH1LqKEtBsTiCwIwekcp9PA3RMwOQABiPT8AQNGYmpCDBUABg6ciwZsQsBSCkFM+Z5ZlnrMwFs/ZxzBznPwDQG5jzXmfN+YCzMKLUIQvheS9FtLeSoScDPZJiA0nZPIYrXR5ItMmPMzA1BqkcNbkC1UKW3LiA5PnqgLWk9YAAD6n7P0AHVJDZGUKtpb0M/gda692r4LQ+PbjQIqKUEDCBQHRvsa4u5JuZoTnVGgJw5AYAGIjBIyMhATSlOYaSo790QEPXcbgeVHo3pJo8I4hIfowCqJATNkge0wEeM9sQEJ3sDHCEjFGf3OAA7+KEGTkMSaZp4+RgTKThPMGBpwDyMBUd13apADjr5GucEetiAA8plizqyrPQDy8DArd5sTFdc+5zz3nfP+ca3VtAoWwviDhGzmAcIhBwka3CQQpL2ADGrXdiwXNSDMFaUIRbsrpZXMY823Yk2JNSdCN1nDFbEDqkfgJ+OPXyNoZ1CTOQrlWPsDkFARUEQ5oWmqr0VEgfg93tIGHqoLHUuxZ927v3EAc6Knj/egApL7KoipE9h4j1HoFMeThx5gEH9ToeoAp/vWnqkGeyNQjw+wIIlgcacFlelrvio1uEGsXAKo2arsC1GczBwWAcCWHDxESPgKqo7CeZ3zNCaKa6Hi1sJwkkkFJpHalvDHuwAWmav3/DJRh8QFH+P+UegYa7Gn2iXz8/zor9rrR5A2DQit3/F9H/C/zGi4BnXKH3ChFIHiEejAAQTqn8gEWBGmyIHJX+E5V9DbAHgv1AM4B5xOzOygJgLgJhjgEQICGQOF0QFQKMmsGkCMiwJAOalo2m16DID2jkGqyC2xDoG3CpCSFAnUF9GkCYI2C4F/wKDkAdDhDY3fzIDUVCX1FENoz/zkHALnW7yoLYMclCC4Kix4NoD4LOFAl7DUWsGwKBW/y4FYJOHYN0PNwsB4MkKW36mUFCTIiMnVDEWuBijTiVDW0YCD04HPE6x9iEEVDmm7Qo02yCHakRCfF0EzV6njRgFcAAEIkQEiyA0j2pl9z9K819UR4jlA7gAigiQiugcMwAMjijEi0im8thmsH4FZ1RrcZZW00YJtEE/1fdANgMP1B4vc4A29hlRt05AwPIhNeQPJH9CAcZO5IjNw8M/CJipjmAZiio5iFiRiq0MB/1W104e950FAoR9iYAghYsqg8M8jDc9jfdUNs8A9a8E8G9y8V8q9cg25nj68k9G8R108wBmA7jM8Hic889OBC8/kS9Xi8jo9Civi68Q9fiGiASgSziO8B8CMjir9B9b979ShH9VAp9xAZ85CF8I9YSCjY8i4cTSAb8R8sQH9J8X8SS3859FBzpnQR08MvDNwUi/Ch9AiZMKiwiwAIjbj0TKMwBYjai7hkiYp0jMiSjSAcjKTV9qSlTEjOAyjhTQiqiaisiVSGieSwBH4hI2QOQuR0hrlkBs0HIdwzMBdcQehVBYgWgoQCxmAhcbMDlctsQfpOs8RytvNzAWgLZ7iBMIhHQiESEkAyJ/hZBfUaIBxNF2JfddVfRbB2J2EQlsUo1lwY1TVswrtoAoh0T/ct82QYAAB+EoLjKoPeOzfcJIUIMBXkVELjZAB0SqIgCAZuYEAAan+C+HTFchJKjMLRugMA+JvXvXahbzQErWGwgx73HHI04CqRWFbQDGaAhClF4Ho1plSBA3OiqGXNHQGFLDGC4EGwQyB0ODqFIEeErJ32Iw2CCJJKgD2SEBd1vPCFKDdLEByH4KEHTSSRgxYECOHRYySzX2iCCDIgw0dOWUF3NzAHUDsx0AlwsFiG8zQu1yrIOTQrIgC16GiChDIkV1CwHiCEdx3KKmrw2DuxJzFBPOZhgvan4LkChFN3NzQEI2QsxBy2F3yywvF0l1K2lwqzlx2UCKovCy4t4uxiUtKwDEiFmUGIVm9yHmEHEUmj8P/EWJBP90VALGPghPDyqDMpODVJnJKGsqmkAmPxi1bx0vbxMocsQD+QctsvhIbHMqctTxcv6FNJaMHkZz+B0y4p4vYD4oEqyyEsF1y1Eoc3Es1il2DMq382ivqzC0UtiuUoKtUp0DzFN3PWNxLCKqSFFlZDOUlntx3BZCIGsChH+FautGjM9TjP1A9FhR9GUS1QMDQwzPhXDUMlQiNWjXxSsjTN0rQQ/CPGQUpnWiWnKXvBWhQTskWg/BqtjKMn/B9T6o0BTNoW2pghDQjCzLGs4QonCQLOmosXNVsSiArk2qSAAAlwh8AOoupepXClBBo1q8BPqSR2liZYZXrKZlU4zewsyjqgCTqNIlqg4Qa1BAlMz9VOEFI7qDBTkWQUi8BhquqjJ1BergIfQsyCUDANrKY38SQSgup/h9RjJDF1A2xpBrBxAWheBYBogmaWbew2aOauaebOZ+bdRWb2bObubebxbJbhaZbOYRqfVrr4xuEiECxYAmBbkA4EopQQ4Xk3Z/MS4/YdbRQkV9bDZXlVRilVZZFuhnkw5FQoRwzk4PlvDRQzquAZRx5J4uA9akog154GEzoLoEg15k4N5D5q1zKLadRAQoR/w/lewu5RoyVr5aAaV9Q6UGUmUWU2UOUuUeU+UBUhURUxUJUpUZV5UWgD5L4g0M6HU3Vm6W7bQ6775B4oiTKabUEHB6a/kvakpkazhUaB4WQIFxAkBQAAhFBm0hA8BmRXBXAgA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { config } from './config'

const { receipt } = await Actions.token.burnBlockedSync(config, {
  amount: parseUnits('10.5', 6),
  from: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Transaction hash:', receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.burnBlocked` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.burnBlocked.md","from":6684,"to":7213}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.token.burnBlocked(config, {
  amount: parseUnits('10.5', 6),
  from: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args } 
  = viem_Actions.token.burnBlocked.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.burnBlocked.md","from":7240,"to":7428}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Amount of tokens burned */
  amount: bigint
  /** Address tokens were burned from */
  from: Address
  /** Transaction receipt */
  receipt: TransactionReceipt
}
```

## Parameters

### amount

* **Type:** `bigint`

Amount of tokens to burn.

### from

* **Type:** `Address`

Address to burn tokens from.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP-20 token.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`token.burnBlocked`](https://viem.sh/tempo/actions/token.burnBlocked)

---

---
url: /tempo/actions/token.changeTransferPolicy.md
---
# `token.changeTransferPolicy`

Changes the transfer policy for a TIP-20 token. Requires the default admin role. [Learn more about transfer policies](https://docs.tempo.xyz/protocol/tip403/spec)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.changeTransferPolicy.md","from":250,"to":5483}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"782fbb9e3637fb97aaa75c17e78a39fa8f7ff7754db53d7b3ab76722d9c43fad","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinKQwvDCMWGipACpDwsOCYABKaxtbpeVSiAAc/bXKqhotOnp4q+ubDPIWVgDMA0czlGNwm1C8018c2oASYrHYXCMR1MV300lkD3qz2orTeBiRJi6vyQAJA9iBIyQACZGmDMFMDDM/DCFgZ8gjOGgIABrRSXbT6XrWGoKR4NACsLzaeC5vLARJ6iFJ5KGwJJlTpEMZUNKNFZIASAFcwPwjtEHMoYHtxMIEmQAAoQcy8DAAZQwJoAPBlEskAHxBDrJVI+rIUThYRzMPRkOCpAnCAB0ssUifJluttodTsYLvdJsT9qjMdIcG9xSUfoiqXtpAgzEYcBgnuAuU47c4hqwUHEI1SAANrLQACTAMSkCxKVz9gDcbY7lgA7o7nRgAJJQVIAI2SFjQc7AHZWZy+u32cEOQlOny2B9cftyYHE0bgkfW5ptukzcDtpBXubdD1eFKKAIF4BADDSC1dDgTl8BgTlz1/CMcxdTg1wAEU4BJ2E4cROB2Nd7SpaxOR5VNclyAA5CAaF2fBG04Rj8LgID8DrSBDVgy9D1UXtOEXcRGDQWCcNIOCELQc8eLI3ItwQixeDkQ1YCgTghDwzgtzkMDuS0mAxIQ1Y0ENUg8mUTTVlfEwYETXVxCUCDkGQEA6GfLAFFKftvJE3J2UKYBolWXsYFDZJw3wNA0CwThXGwutmE4AByAABQSlAbAB6GJViSvz4QCzkYHhWL4vrZK0ocrKcpgbKHAsOA8ryAquEChNYLihIEoq9LqvYWqaHhJrciWOIK04ABeIKYBCsKlCCVtDw/BrUmQQa2AAXQoecpJtayODjThFqPNbirYRNGCgDbUki6KggibalvcXJXAiSiTViY84ENOQuCm8RBOEnhTRMZNyLANNoKtJDs1XfNeEDCtw2Osi5VSJKh0TLGkse9s2FXDdUl6MBHte3JvP7EAtpcyMhmYUogyUTgAFp0grOzqZAWnn1KbnoxGWDWaLOmSzgDmKBc4zTOEUodngxC9pkj5zi4G01JgEgwC4HsJA5raygFPpelJUUsUQKlKilPEySh79f3/PMgIVf5AVVSlEEqaxNQZHxZl1WEDBCMJIiKYQxt9FI2Yj/KCnDzpRENxBjZueQ6ieJorfaCtnZJV3hhcJpxW97wmWhPVAiCLA6xwDgMCifGAMJrTdy1/kKj6cVbExdOU5xV5Agbl0Nxzj287Vc3i8hP35grquIBrzAohTMBUmyEAhxI3hrG3nfd73/eD8P6w17b65ekaZpu4lTOZXBkfJRtikC6pSftWnllAifF83wQpYnRgXIRBJChzgP/EMJh/4gTAhBEAcsEL9j/gofsnBmDQB+ghOeRBLrwE0nAfIChOCwC3IaJQShJwgP/nBfijE8ENjkMArkElcgAClxBANdLwCcWwKEEOjOmRsiVMHYLUluDAAkYBbi0nWRcTZSyJnenAlBaCCF0FjrBNAi4ICcFfGsRgSReBFHhJYLWcZ3oACoeCcH7D6UBSDoj0LgLBRcwl8AoL0IQKAsFvr2DwrBBBECFCJh0vNCI/Zwz+OEP/RMZA6ykHusgtWVjEG2UEmZeJVC4g2n0p2JsalGGLgnDQMieEwBiJorARMAArLxUkZrMHkWACx3BOBKB0luUISSAkwGQQ1CQJpf4VlMjAPJWiCnCUklo5A/Y57rEcYmMQoFDRoH7BtIIt0sBxkyplSAsBqmJnYEoTKoFwKZXoTQMQzMiAW0TLQTK4gsCMEyjM+AYtIrMDkAAYmeY4hZEAllRDVrkKZ3yxYLJiSstZUUNmIC2TsmAeyDlHOgackKFyrmVBuXch5Ty6yzNeWgd5XzcUvLBaQUgEREwEXlq0iA7S5CdMiXY3gWT5I5OGQJFxfyuD+QEBZVQ8C4WIGScg1BUB0ENNyAAfTMWYgA6pIcySgZWSvoghGldKeEIVpZUtYaAkqwX5h47iqxOCWBcWQEBjYaBazkBgXIrETTsSEH82C5heQSSkRAGRFruD2jXOo+CYirLFW0jAcMkBxKSEkoGy1YhFBoFtbkcIbEOIus4G6hCoR6W0XguJcptlqnaNqc+MWnBXQwGjQhKZkAikaRBehTKAB5CF6zNnbOgPCsWiLjlwBRectAlzrm3PuY8kFiY3mfPEMzGtMBmZCGZiC5mggohiVyKgk1FgxLMF7EcCVYAACitB3IEK4uQ/lLS2kdIibY7piB3oU2qSNLpQSIDzSSvBOQOkBLsDkFAJKEQDxbM4LWPch0P1fs0aQX94ZGG/KWU+xltlglBHfTAT9WiACkjVwxJUg7+/9gHMrAYnCYm6aGIM/qgDBrRcG0AIZvdEsl7AghLk4PupjcSkqysIPPOA4ZQGGvIe0tSDgsA4EsH+iIAHchAZAyYzgMTcIvgvLoEpalyi8D0rtd8sG0CwDJXesAQH2zsdiakbjEBeP8frO4oT4gRP3PE8MmTRGjz8WQBrUI11xRJ3FC5o8eEuAcK4WgRMpBjRrjAHLRsPpy6cBYx2xARBmBJz+FSJONw3pGdcx2fijatw6v4GFiLUWGJwFiwEeLgrktKmsNIJUmX/Nua4IKvcZAnxyBxWBF5mU6BrCWUcRA6h1BJ2kE13LXAPNALkBtZmBTHNkCaObKk432z8U83IYLXwquJba2ZUIXW8W9doP14wK91CNCaNYLLxmJumt21rdrB3t0WF69NyV45Jzmz+Eqd6o1TXPgQlNLjjBP2cGOLShqQgkoHmSYmVJYAgj9gwp+C1o4v4wFcAAQk4Cjy0pAsf9mk9l4joHUh490OJWVoP6UQ53JEsAOOKdkCx9Rot+nSDk28u9Q9x6EKnr5fLaxXTkFKXCKYsAXP+yPo+mHdSSzJotL0K6YtzBXQ2cIIue6sPPoxMV20FXwU1ca69dr+jXBmAYBsZQqarG4fW4UEELl4YYnE7XVb59yHUPoe/VByThHSekc4OB0ZlG2dcvdw7pDr6UMh84FhnGyU8P+/83JkSZGffJ/D/BsAluo+MdiSxmAi42McZQxZqz2ibOqDsw5sTihhn/uJ7Jkj6fODIFM+wczPGNnWcExZYTweFsSa2sUmJf3PoY8VyDsHdOodgBh5H59COkfM/EujwH2Pceo4J0TgPafDpr84NT2fkOGdM536zsfZKpf2UckgZyZQK2lGQKA0y6xVmtphZlMhqhDRbjTHrHbV2V7ThUym0lpUynRUxXMC3GymfWqQiCpn1lRGpCpBNjTgaBqG0GlAMGSRHl7hVHzlGC9g8HBB9lLn9n1CCENWgCiHz2Q2UwchgAAH5UgbQMBwwsZ9ktgjhQhhYS12DSlkANpqxOAiAIBLp4sABqXodSWYHSezJAqgHtPAA/YpfsWjZBZxVQU1YvboWyTgAAWR+gEA8kzR0ENGjHk2ZUPFZUjEcWGXDB0NcX5VyCSFLC4C4nZXCA9SrhYEkDESYNU0SSzTwigCgGEj4PpW8LUl8O+i3DEGEgGyEEAVCENBwVoVBwYUmWmVbwSCCD+FCU/yhW/23TAHUH2R0FOQsENFuXKIXWYN7XKL+BxT3ASETD+HHQJTkCyyCHPVaCsPjWNUzTBwcNyWKSmQGzkETC3V7HiRKOijbThQRWqJ7T7XgAHWgOHWxWmO6MJWmLmLQCOOZlaEiApXvW8hl3+xiGND+k4HFB10QxfTfVuK1lSAwz/XDDeLQGbyIwP1SB+NSElGKVo3oyiS9yBMTx+L+MDzbyBIeLZzBLAApnenLSrX7D2KOIWMhSWO/xWK7TWORTOU2MHQxR2MeT2InQ+UOPYG3WOLpN7FOJ0BDjEiUQ3USEZLOzshaHvxQBcjwX6VKCIGsETF6DFO3mQITnbm+3uFNnTlJBwOtmCQILHndlBDIPpBLh1BnkWE+mVlPAImkhBhOBPAuGlOuCpHFEvnlKwJvgMANPNLMGJFuDVILj+D+Ffl9mZHLjwErmrjIEXgVgOBNIAAlwh8ABwhxRxPtlBpwoFwI8Bwy4BXEIAEg4JGJdoQyztT59AaRLYr4O57TqBjSztky1AfhFRCDBhiCkBKhegvSJAlBSgMc8AVSLS8y7hU4xQkAu5fSDBvwZIHAUzUghxeh0DKhrT1AbhpBrBxAtxeBYAEhxy/hJzGhpzZz5zFyDIVy1yNy5yFylzdypyZyDztyEgR4hQ3SSDXB9YYhYA4RY4jpgYzsOoypEpcMqpHl1oIAmoeVnzGZSoupyokpEx4CI5hpZdlhApHSuA4p/pAZEQTSxZl5IZUc7ZYYAJ4ZEYI5kZ5xB51xNxOBiZcZUZFB0YN5rAt4j4aLaL94cYXostwTAkvdByTSh8RzE9YLkxSyjhyystSh+ZxAkBQAAhFA8EhAZQEBXBXAgA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const { receipt } = await Actions.token.changeTransferPolicySync(config, {
  policyId: 1n,
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Transaction hash:', receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.changeTransferPolicy` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.changeTransferPolicy.md","from":5839,"to":6281}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.token.changeTransferPolicy(config, {
  policyId: 1n,
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args } 
  = viem_Actions.token.changeTransferPolicy.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.changeTransferPolicy.md","from":6308,"to":6510}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** ID of the new transfer policy */
  newPolicyId: bigint
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Address that updated the policy */
  updater: Address
}
```

## Parameters

### policyId

* **Type:** `bigint`

New transfer policy ID.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP-20 token.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`token.changeTransferPolicy`](https://viem.sh/tempo/actions/token.changeTransferPolicy)

---

---
url: /tempo/actions/token.create.md
---
# `token.create`

Creates a new TIP-20 token, and assigns the admin role to the calling account. [Learn more](https://docs.tempo.xyz/protocol/tip20/overview)

## Usage

Use the `token.create` action on the Wagmi `config` to create and deploy a new TIP-20 token.

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.create.md","from":307,"to":9752}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"bac950d77bf219845f78904458b22c83c87e562f6ef3fc715d1a2f1ce5643b37","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinOJQzBapAAbWtAAkwGKkFkqum6XlUogAHP21yqpIAKwtOnp4q+tgXRZWAMwDjmcoyuE2oXmmvjm1ACi1inFIMF4MEYWDQqQAKkNhMNBGAAEqI5Go0pQCC8BAGTHibH8XHwwkotAAOnO2n0Vyu8jqD0QNW0bTwCKRjO+PUQ/xA9kBIz6j1BmCmBhmfmhCwMSy4aAgAGtFFsdvtDsdTqyKjIagp7g1ntRWm8DFrdV95D8kBKpUMgUgAEyVeXgpWQ0o0NWSuGOxQASSgqQARskLAxRGy+tZKlyrRoXgKHTqo1BRX8AZ6ZeLev7FT5ZsGYQZ8uwuEZcaYLvpet7vRn6lnba9Ak2TIW3cXhi5EJVxh4wZXlVCQ4F64UI86yinEL1frY7t3EDb+fbqHmV90i5LBqPRo91BXvLOa6GEgBXMC0oTRBHiGgAZQwL4APBkiTJAAfEEHTJKkgFZBQnBYI4zB6GQcCpAOwhMsuTK8B+36/rwTIAArwYhpBwABxRKMBESpPhpAQOscAwH+wC5JwrGcMu+p7AcaBHMopwANwsWxy7RnGCZgGgglgGxnBgOICGpEayhSTJcAYMwsYQHIik8ccKlsbwj6kAiL4YDpvFKPprEAI6PhANDokenGGrpfGbFZKxrBsnDbFxSknO5QmsUKRJopwVI0sY+IMqiUmuMBuRyQhcBwUi74wJ+MA/i+JJkhSIBpNh8ArLJMAAO7hZG+HetY7FHkyuS5AAcvZMAYvgjBwJwnUlWpL74LRkCPl1OJvqon6cGV4iMGgXUJOw7H4DA7FYnAo3SVquSxstFi8HIj6wFAnBvuInCxnIZLamdMDzQi9JoEZeTKCVCIpSYMAsi0SgUsgyAgHQ8lYAopSbKDs25IuXDAOlmVQckMH4GgaBYJwricAktHMJwADkAACU1KOsAD0MQItjEOsA2nDQzQlOo+jmM4/j4iE4wJPsDAJMOBYcDk3klOFNDqFdWjGN0UzBPE6TnO02wfO5BqRRAUonAALwwzQcNKEEzHSdE3PCKkyCyxAAC6FBCTx1JvRwyHU0FnDGzAlNMowUCm6kiPI0EEQW3r7i5K4ESNS+cKvY+chcOr4hTTNPCvmhGFYRlOEvmB5EwbrrFJW1OMALIYOFR7Y37rFqRpWmpNjefogA0iXQmGcZii8GZOMAKpfgAIg3YBB7koNnObf1wUMzClOBKsALTpORLLDyAo/yaUS8ISMXUz4RY/EXA88UH9CIPaQwilOiS0rdb630sKqIrGAR0wCQEmcFAn7iPP5urma66/M0248r0Lc+52hFWyrwIc4oRxeiaL8G8EJqzzECCEMIkQlbLEnpBciFMChxHIqaS4vRqhdh5H/YBsJlYQPdOeaB6g/RTgVLeIMiC8BBCwLRHAHAMBRA+N5bIIAdi0O9FAX4jw0i8EaI0X4lQ0jWEeL8b00hvSPHEL8WMVxKiVAAEK8GkDAdQjxpCPASNYWMABRWMsY+H4LbAY4h1pswHh4ceV044oGlm9HAwMCDVRILYRADhmAohNxMq3cyxxrE+kIXYpAnJew5klEZEJGAIE2g9BeH0niqwqnnCwvxASuGyXkrnfyETEDel+BKS0O50xxIPDnCBf80nQI8fQgMWS5y1mCHksggTODl00tpPprklClKUbIf+DRSF2kCP0rSECahNPcZku8zCDA5xSk4ZaSwtIwFyEQSQaCdmYOEDs3K5I8Bn2WpsbZChNicGYNACOy0/FEDdsVU6cB8gKBfjAWMj4lBKGOIc7540uA9U+esOQBytSLV2WAAAUuIfZX4sKMmBctBCUo8hwCxi8t5R1YyFzKr8s6tEyoMRIg1MAuRLn3Med8ugOCupoDKhAPpOBeCMCSLwIolNLASWQiHAAVDwHygE4A7LuXtcIXUyozXwPcvQhAoBdTgI+ewKwurXJMDspkF1tYRE2DBbVJyFBMjILRUgPs7nUiOiaiVZqprH2tYtCavBqTXU4MNGAR0YVlSODQOqd9C4tVgEyAAVqqniGVmBUpFdwTgSgLqxlCD5G5MA7k8wkC+LZ5EjI+qDf6may0YXIE2H4pEcBd5iFJI+NAmxTZBC9lgZCRMiaQFgJGpk7AlBE1JOSImUKaBiCnkQX0TJaBE3EFgNmFb4C70RswOQABiOdVaa0QDrdw++uQy1rurWgWAxkG1NqRi2xAbaO0wC7T2vteVB2ZRHWOyoE6p0zqJvupki6V37prRaiITJwrnyTRAFNcg006tudED120vUMSOnK1Qm6wUCwEM9VQVyr2IHTXch5UAnlUtyAAfSFUKgA6pIJ6ShSNEfastEDYH0XHVjOGxEaBsZdTXsqkad1LDyrIGgzqNAJJyAwLkPq9hBqbq6uYXUsLSUQHJQJ7g+FIzMqWoXV6ztzowBgpAUgKw7oYcLksITig0CidyOEXCA0hDSc4LJ5aoRwP2SWgZ0NH1I1DI/MwXenAvwwBLefMtkBA1vn3ZwSMRMADyJ7m2tvbdAa9u9b39rgA+4daBR3jsndO2dtFK0LrQEu5d4gp6hZgFPIQU991T0EFEW6uQHl3QsLdZgn5cSEbAKY2ggNvnDSBRhxNybU32slYgEOg9I0K0gx9fVQRsZLTkBdSa7A5BQGxhEKSbbOA0UTHbJbK3WWkHWzBGFG660zdNXNiA2tFswGW2ygApLzGC2Njvrc29tomu3eKzU9g9o7a2oBnbZRdtAV2HUfQtewIIlgKqmOMrD7GZHCD+LgDBCVXGgUpqOg4LAOBLAbYiFt3IO29sCs4DDgzyU1q6DvkdcovArpWzSudw9FqJtgB26xRHlrUio4gOjzHdElU49WJwfHhOfVk5+zJCayBH6hA9o8dcjxZcyRWFwFFRxURMlIM+SMYAz6dUAvOTgcOkuICIMwH+3p1xXGDtzuXbEJrRZY2x/XhvjcdTgGbgIFusM2/FNYaQ4pHca/l1wLDiYyByTkB+gr86iZ0ERHW3EvJ1DrmkJH13XBFf7LkKbKe/rp0cKaGU70ufWITSV3IHXaLLewEQLH4+oRE9kmT6nwyUVeSNCaNYJ3PO8+ySt63+PRN2sWBT4Xoj/kym/HFCHRWOc1Y4zI4wZbnA8SgZ5kIbGUl01MidWAIImwu7Ul0AZ/YOdXAAEJOAX+UGQO/mxSfO9+/t1IT+r+cA31vnfeME5MAB/H/F/UHIZI9UgAeUGEOHrPrZaAbdDc+TYcVSVaIKFKtLnGAzYabUOYQLgZDNfNoL8aNeSL8UXQgMqH2Q/OEC1YgvQUgnzCghCKgmgyHLgZgDANA75dWeHdFJkHgmAIIZDGCf9KSJrbg2bPVW7BbQ7NlD7Ynb7T/AVAHR7VbE7EHINZDSQoQmQu7eQzgF7EuHGRQr7DXCnf7SXQHBQ4HCAnQsALgvQ6nOHcqTgPnZHQXYXPpUXVQcXPHMvRQH1Tbd/cnP7O2ZADw0gAXNHFtEXbHZ6XHSXQIonc2INC1ZfOEVfdWFHTfcDQAvfMAA/XQ6Qk/M/MA6/YAW/UAy/F/N/ZQywu2Cov/PI7fXfYAmo5/UgO/CAjIsAQeYMFmH6P6BiXAKgZACVIyJERteLC9ImQFVQR8WMTCOiRLTtdLK9Imc6UDImZ9V9cwWMdma7CNSIEAU2T+VsH0dQcZKpHkPkaZchKHCBQBNxMcawZZJhHxFhLjaAKIPQ+bWnFmGAAAflSGpAwBgiZChP8SilCC3nkjtnBOQFNiok4CIAgDdgtwAGpehjpZgLpVgIgzl8pGig1Nhwc7lEMFV4cTxAM84I4BAgYnMdBHwEJKd3VpJYM4Iq0fUYIqTYVcgkgSIuBvUjpwh5M2EWBJBC5AT6dbUVgt9VgoAZpcRU1RTNU+klixAZp08hA9lQhHxioIVN9oU2U90/sEgghfhDUZiz05j2swB1Bu0dBB0LBHxJ0HSasgT0sHTfhE9EwEgmRfgv1is5AncgghtWhWTzMeMnMt9uT4Mg0y1085AmQ2tPxrVbTkYEsr0b0XS0sMt4Ass9jct30UyQySsUz0y0Bqyp5WhIgANJtQY8DFYYhnwo5OBHhaDjj5tsY2yJJUgnsNsYJ+y0BQiftGjUhRzUhngg1wdIddVezpyTDRzxyVCrDpzOyID5z+jYDqUwAAtlpkyBBUzqzMzT1sy5jcyUt8z70h0izssX1Sy2Zyzv1l0qz2B2sazPzPw6ydBUFbo6UWtEgfyopPpbRvokBfoyhdoxiQAiBrAmRegkLrBrAziLi1xvQrgLRuQGgJQyEDB9VnitxFkxwQRWkZxPicl1RwwnIfIDRuILITRkxv5NxKlcKngHFAhlxiLXjRhfQPjvFqLwAikNk0p019SDN01jkniqA0sLkUCcM6V8Nvk8VYARo+kvllpYA/kAUgV01XUwVVUWATSDMYUMNchEVkVUVb4DLMUHBsVcVaJXlDozoiUSVYwyUKVd4Q5aU8MnkqdaAmV2JWV2VEQuVGAeUYg+UYzsCwB40xVZspVMDZV5VFUkMVVNSNVxSxszV5tDVjUj8XDDUGcINjiyiSrQVoNOTEDEy/UA0S02VwTOAPMTjvMY041RUGNRslKs1qRxK80ERfUFCGqkzy0k8q0mQKSszz1L0ks8ze0Cz7yn0cs318tO9Jq3zf1D1kNt0oBd1xqNqD0oC4sz0cz5qbzFq7zH1izVq8sO9CsKyf0Jqq0OdjIAMgN6MRtwNcqM1qrPV1SqSiDIZBsUCsMlL/KzUQ4SNyNKNjgaM6NhtQNU0DLQNWN+AON0ruNDNlo+MMMpKTAzMRMxNhAbMpNhoHNGA5MhtPLFMKUeBVN1MYBNN4BtMFA9MFpJAgtmbBMxBzNLM5IJNbMhoZMqa4yXN8aWqks2rDgY0/NDz5MQtWpjppIIsotYsZrzr1jnSrqB1lrbqny1qHr50nrStytWoqswAasXq6sIAGt2AmsOZuoQLSAvzOs4DetWB+tPlkCvrkafqcM4qps4AFy8rZD7t1CzC1zJzrDI67C5ydrLt8Cod9C5CbCjDXtTDgdzCP8Y7DDFDtzE6Idk7dUXD+CoiFsvC4ifCEiVYkipcgjido7wiqckcad50gTSqmcWdPRGrIDOdc8oiYihdq6scxdEiJcG6idq8tdHY68Vc1cZ6JoG89cDcwAjcTc/chBzcm82pg8Nx7degI8P8o9OB3d0bmQ16N7fd/d6BA8rdg9Nww9fhj7h8a9o8x8JI492990U9aA09e91As9egc8T6R8C9lcS8hgCcyAK8Owl6uA68V6uBd6W8v628E9f7u9dSwA+8B8h8Xd37R9m9x928p9uc6859hkF8l99yV8ik19ciAD2iJUijuyU6yjz9ajKjqjH9uHX9m6v8+GuiWjmGgDWHOir8eiE6oCcCPaEC4NQarkhDkqZUg7myQ7k7CC60GC0AmCY0WCYA2D39FZ6D1YSCyDmBDHjH2HOCpDrs19+Cj8hCRC60xD3qJDHD7GU7ez87s7BHVDY6gdND7Ck6nDpDfH07jC3so6Gjwi1DgnTttCwnvHS627XCEd0mUdYiMca7x667J6UjgiSc4mhHIi27h7vCx6/CJ6AiYHUjejjJMiCDCkEJGH/98iWH98pJwnyrKNyjuHOAb8il79hGpH6iLD4mxmBMOm2jxGhBJHwD0imndyzgvphiyhAtSgJjN1SBpiLzZr5j5UliVjmA1jktzmtjk1djVqDijiU7I0iTziWLLhfgXiJkewCKwxrtnjbhSLRh3iKLvAJARkqB6lCLbtSk3mtxbiGggFOluAoAoBXo7YdgapeBULMWsXsWcXcW8W0xfm+KkBAXJhGEhLOkggfioA/iInZDZSQSwSwAITOAoTu1URVS5B4TfNGWMBkTUT0TMSggcS8SyACTqXiS8BSSYVySi7KS0qaSfg6SGSURvkoy2TZp/quSZVeTJo0qLKgJhS4MC1xShtJT2tSAZSO65T74FTwMlSVShA1TEzxS1VYxtSHoop9T9ojSTKoUzKzTxqAyrSbSDn7TqQnTb1uh3TJ9qQvTdAfTqQ/TJSJJAzgzv1wzIyWT1XYzbXYJtXhrHZNhyyzyQ3Zi5rtbUtrrMtHzX17rXzQz3yTzqzaz6yScutg6OCih2y18uzQ6bs7tNyhyVzN0JIAmNyR2wpZz2da1i6j8lyJ3EBh32yx27ZNyp2wci65H9yFbjzN80zQLzyy3zmFq709abqa3nyiZ63Kym3QKW3/z7aacnbWtQLOtBjIKUARjYLSgEKkKUK0Lnmv5Xmj7olIFalAgiKXQxReg/nqFSxyLSX4FslOlFYnFnJGLjQ1mgP9AKlOwPndwuL3gvJnFoPYPpQxwOxBLkPQx1lUpc1rtJL0UZLTk5K8oFKrkIb6VnlnK3kNKIUmSfldLAVnoDKqrwVfXTSBSEUkVxBkGmN7LqROonLiB8U3LJoPKvKkIus/KuPArgqWUwcOUIqoq6I2B+V/thVRVUCkqMCZVdXVAsboBVV1UFUcq53ZCCqyqU7iqbUbXfrj9+nKqHA4gYNaqC16ri0g1mrWqvNZb5JOqE1uqA6bO+qc0lYsh80C2i1A1S1DrHrpqDmtbksdbT30t9aL2jbP0tqXrwc9qDrP0/1j1NaryLqSulrz2SzKuXrTbtqoCPraUkuvP0COSAbEygadGQbfafJwabPIaPpobSMKNj54ahVaNPqkbGNUaPcMbOMlUnOcbSp+MCbhAiaLMSahbybRbqbz5aalMDMVM1NYUWaGINJ2bR8DMuanvebhMzurMLu7MKbHNc3XMBMYuo0fN5bAtFbNgKsVbYIXrIsYtTrLzy3ivK2z3q3Ov7qquG2ysKtLbrajrbbH3HbgLqz3b9z4CvbaqlGNueqkr1HcDNH3ODD07YnJmhG/GQmZGHCWe071Doms7NCc6wjOe2f47p3efpCy63CK7smR7cnqmOpankj6nimV3W7LVFUq1O75Tu6L42cN2oCudh8h6/8cn4j8mzpCm1f9qwGiGIGi9dxF77fZ7kGvd16fdTdt6A9UH975EHcCHNc3dtvL7vdN7b6UGg9bcn7w8g/T6Y90GJ8sH/6e8M8gHs8EG57C9i9S8YHoj+94HXfa9C85PUHSHMGXq/6AH0/+9GhB8s/E+RgJ9yGZ9QgqGLIaHfhmnlhsj19WiCjgDiiS7HV+muGRHhmEJRmKiBHSnAnmjZnB+JHpnujC7ZHVn5HqfFGpvrPrtVGsCmymfO2iDzHGDLHrHFN2CtHNfdH9HyDKDL+TG4RemodHG3DnHZtXG0B3HSB38Siezw6XPT7CuwSa2FueMKBwi/0XKACommdd7P4zn5WEgBWhCASk2cLpNy6WTKuor18LK8CmdTaXE3UQEREze2Ay3jU3wGq9CBaRGFH0U7Z98mGnTeZmw3/4cMx+zRSfjAGn78MJmudKZgvwH5dMQCK/aRrQJWYDF1mUFEYls3GKTE9mMAZrm2gWL4ATm0VY9hsSSxXMdinXO5kfkeboUXmOHX4DcQ4q8hCONFH5lBysDtgiWNgTJCC1KDgszAkLQwW6GMGgd4WoYRFp8FSACJKgQiERGIgkRSIZEciBREohURqINE2iXRPokMTGIzEFiZ4nh3+bEsqOHSUMJSz27UtZ4AA7WPS1BLBpIS0Jdlo605bwRESTLPlqkAFZHQhWuJSEGKyJKsdzkBgKVmyhlYzs5WDnBVpYCVaRwVWzJJQNGXZKhc82PJLQvyX1ZCllg6pE1ufDNbSltedOJzDa2cyeRlSsJcDHMOc5usBAHrXEF60NLGVIUknc0kG2tLI8sAYbR0iVyjYelY2cEeNjGzABJsLSQZJ6hm3PhqsYyB3dYQmXC4Bti2B7UtmdRa4VtbyGPB8ljzLInlTaH5V2p+HvbfQ22h/FsnCFHI9t2G0AgdguyMLDku2o7YgVOTxHrtICUvPIQtmXIjkJ2IAwkZOzX4OFB4IcHdkWzhElsrhRXE9u10x53VYRe7N8giK/LIiAKC0ZrDtBdpu0hA4FEFhsx9pIgf2iFZCoAgA4YVWKRCfDvhQeIQtQWZgFxDYLPDkdgQ6Q+8O0FopOhRIZ0cSEmGw5uhHgsSWFp821GHgLRBYKwX0BSFwcxwIDewSzEcFFI8AkHW0eKEaA4VMwNgVZCAEjBdxUglQEjtYJqSpC7Bn8GILACYCoZqY8cKKCLAZjix3sLMYmCbD5iQxMxk8emGLCxjYwmQRxLIPLGv7QwnEMEEKIyFBxOhWx+YemNHFjiNgE4u8JOKAlwjpxlYmcISGhxxh+CAhoicRJImkSyJ5EiiZRKonURaIdEeiAxEYhMTmJYwvcViMEhbhtxsYncHuKXFaa5xq4hcDIKwGapHidxfSdSAMirhpAbxfsfuHQ1pZ3ZEWyLedIu3bFgAncfPbGN4I2AmEnE/498QtmjE/i6orop3KUDXjiAkAoAAIIoE+RCA8As0EAK4FcBAA=="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const { admin, receipt, token, tokenId } = await Actions.token.createSync(config, {
  admin: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  currency: 'USD',
  name: 'My Company USD',
  symbol: 'CUSD',
})

console.log('Address:', token)
// @log: Address: 0x20c0000000000000000000000000000000000004
console.log('Admin:', admin)
// @log: Admin: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb
console.log('ID:', tokenId)
// @log: ID: 4n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.create` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.create.md","from":10094,"to":10575}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.token.create(config, {
  admin: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  currency: 'USD',
  name: 'My Company USD',
  symbol: 'CUSD',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args: { token, tokenId } } 
  = viem_Actions.token.create.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.create.md","from":10602,"to":11085}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Address of the admin that was granted the admin role */
  admin: Address
  /** Currency code of the token */
  currency: string
  /** Name of the token */
  name: string
  /** Address of the quote token */
  quoteToken: Address
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Symbol of the token */
  symbol: string
  /** Address of the deployed TIP-20 token */
  token: Address
  /** ID of the deployed TIP-20 token */
  tokenId: bigint
}
```

## Parameters

### admin

* **Type:** `Address`

Admin address for the token.

### currency

* **Type:** `string`

Currency code for the token.

### name

* **Type:** `string`

Name of the token.

### quoteToken (optional)

* **Type:** `Address | bigint`

Quote token address or ID.

### symbol

* **Type:** `string`

Symbol of the token.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`token.create`](https://viem.sh/tempo/actions/token.create)

---

---
url: /tempo/actions/token.getAllowance.md
---
# `token.getAllowance`

Gets the amount of tokens that a spender is approved to transfer on behalf of an owner.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.getAllowance.md","from":167,"to":5783}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"39248a39ac64c814f65ae5d23e0ffb2fb9d2135d90759bdd100c74ba402498d5","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinKFyEADu4mC8MKkARskWDKLa+uqytcqqMi06enirG1s7XRZWAMwDjs6jjRPUXmmvjm1ACTFY7C4RkEwlK5SkYxqCiuDRq2jaeGhJlePUQnxA9m+IyQACZKv9MFMDDM/KCFgZ8pDOGgIABrRRw059awAVnkdWuiD51Fa9wMLPZYBxHy+Qx+SHeJIpgOpwNKNHpIASAFdtsYwJw2tw5GtNtsYAAeDKJZIAPiCHWSqWtWQonCwjmYejIcFSWOEADoJYoA0aTU9zQGAAqe72kOBW4pKW0RVJR0gQZiMOCW/1wINskNh03PGABgBKem1pDAADVQtqYLbcmBxF64B6doa9MaS+bSlAILwEAYAOJ6OCcAAqAEkoyTrMzCwbHmadgH1eIlCPkMgQHQ21gFKUAAZntBwXKMwrAaKkGDiGgu5Ju/BoNBYTiuTgJDPMTgAOQAAKbEoWYAPQxPeAFXhCN7MjAEJfj+f6ASBW4QVBMCQQ4FhwDBeRwVwt55shv6ZmhoGYew2E0BCBG5EscRJpwAC8d4Pk+SZBMAuScNEuHCKkyB0WwAC6FB8cyQzCAUF6pLxBr8ZwImIWwAaMFAYmpG+H5BBEklKe4uSuBEuSMbEKzhmuMBsSsmyMFC/AwvmwZgKGPbWaWDpJm6in8U4MS6mgqQAdYtABpFAGGfxHaKLApCheFkUBtFJlmWAZ4niAEl7h6QzMKUjpKJwAC06RJhuuUgPlbalLVXojJO5UxgVcb5jlFB7veaDVrCVBTvgtluVZfbrjlEllFyiC9LN/Ion0JK3BiBjFhGLzyG8CqysMLh4gAHMqVI+LM6pggYIRhJERTCMxNopBV92wXJN2dCcFSLZU831EgzQinc7RJtK20EoMu2jDyvRHd4NIghqgRBFgGY4BwGBRIFEDBakJ7hQAJMAYikBYSiuCenAAD6cP5ym8OYighekdNgGgFpTjJHaQm6aSCRTnC6rASSWFAflScpyniFAUD3nAvo8JL0twAA3KLYucJA5oALJbFuZAAPypAAckIOxa62uikLz/MwILMBQMrSmq5wcDJGA+ucEEiOxk1Ckq47/EOHA+CpAAEuE+D237X5RKxtqcOmmbZpawd0CmltgALbxQGnGdCxHfvO0oYDcNqqjsIwABej4wm7HsNe1fol4QROV/qlYAI6NmI0ex/HWY5haADKLvF6XzdV0Ila9TWU5eKnlNWzbWfz+n1uZ3njsF2AGvwHAOupDxnDtrvuhfj7DuR4fO975wQ+F+IewKNvMs6+vqumWxPd/onFrJ7Qtqv2LFKnBKiHxopwFKADlKUl2JwbIZghyhDga/b8lMABScAJ5YF4HwIKzNs6ryFv/FWQCSQklAfecBkVX4YOrDsN2C814mV5kA3oi5mBgKAZTHixCqFMIAGScBxrQfGhNiakwiAOIcI5DC8FwVwR8Eh7C2yXMyIa0RVju2YHAJQAYcwr1IBEDc70ES9HeH9ZEP1EBolFIEDGwVgaIC+qDIke0lQeABMdWGZ1NSI2RmQTAUQ4r6OxnjAmaAibKFJpI4cmJ5Y704BABIqjbJBISkYqaH0ZrSHxBYwU1iAZ4FSbSboVhhSEjlMSRAbjJgwzVPMBGSMIAowCUuSUqQpzLhnFAAA8qQbgcSZbROkf0qW8T2CcBnAAEQSUk1QtlZzzkXG5dJ8J9Akh5LYS4ljhTojFNQZcDi/rlPBqSaGQJTr1LwK2dsnZbJLAgAoXIRBJA3QwQoZ0JgHm4CoIOGJBhBq2RPPchQZN2FQG1Aod0GYiCaXgCsJ2+RIWwD2NqJQShiavK+aox8nBswIqzHIF5LJkm5FQeIZ5A9eBEywHdN5tkvSEjyHAf8jSYWwCznsDAnB1gwD2JwPYGZ1g5njAGcyYAAWgPBZCugclJxoHWBAJ2OBeCMCSLwIoEJLDM19GKgAVDwQR1o6Vk1puESc6xHL4EvqXKAk44DansCsScQLPkKADGsJQ+kTxuhdcIL5AYyAZlIF6lY6dBHArLJsGsIbVA4t4FsfltltQ5izsS9YRMaAqK2Fyo2sAAwACs7XhIfMwUVYB9XcENGsPYoRw2upgGTPCEhzSvWSNWZRaaM3DUVcgE8jSdgy10WgQcJcTxiSCLpLAvpwLgUgLAQtAZ2BKHAr8uA4FCU0DEKVIgZIAy0HAuILAjBwL9p3gGN8zA5AAGJT0yzECOtA6N065F7be/M97A1jone+KdiAZ1zpgAupdK6pHrsfPANA27d37sPcet9560CXpvRmAdMth2BsMdONRShq21t9ca9RBo9hJpTdyy1mMuDXgEMoZJgiAOIAjaC6AEKyxioAPq6t1QAdUkHkZQnG2PtOw7huQmLIUQD2PmmA/AAKTkaoQW1KwKGWEtWQV52YaDMzkBgXIcAMDbHwBmSAybODmHZLRgVGxhU8CjDOOVQ0uXS0Qg/GAbpIAW0kMNBz6mxD0207kcI+n7BGcxpOMztkNEQDmRbXNZZC1O2LW2fMN8YBedsr2yAmahBQqHPEmc4FulfsndO2d0BAP5mA6usDm7IM7sqHug9R6T0obPRe694hSqZZgKVIQpU32lUEFEBI7BcjsIoRYYbpBmDj3cmKgAorQQ8kLk0YrmVWiTeHGOIDFVlQtFk/Vuo9UEACQ1wzcvYHIKAAEIj2xnXHCJ8lOCnbWOd0gl23TEvvRR/bdL3UQE9SdmAZ2ACk+E3QAQVW9q7N3ch3fTEcWWz3FWQ/eyor7Jcfv+sDewIIlh1icDm6QINx2uOECaXAN0GD5MYprVnBwWAcBC2uzDsAcOHuTmxxbI+OtQ1Z3KLwVk0knDdoSwlRKsPwLKUJ0G1IpOIDk8p5mPQ+AacSye4exntsJeqxxcgGAzy5DaR5DNHk2uxY4spdStAAZSC6hnOKlXcBrTw3dvRogzAZqKhmvtDKd3zdcG6ZJ6T1vbdgHt4NbMzuAiu7K4gd3eJrDSAOr7yX/u1ax6OGQVschmu5ZluBOg0mS4wiseoLJZvxZcD1wbsSpV00a7IE0KpJIK8BS4Pr0IlvGA0pj7ARAmeayhFz6hgvtAi/6isY0Jo1gU8664PRgf2fwLTYsAXg3bHRHKCqe8PEYqmJqzbLZdiAEuOMBNJwcsEm8JCAAvbCNAYo1gCCCeSZWxzacHxtcmArgACEnBX/KBkA/4ngs5s4I6pAAHv6n7n6X4HB+pgB/6QFAEfaKofpE65BZTzaLasDLbOw0ZrYnhGpfImqEoyzbZgAYFnh7bbCWQUZ2RtADyJbMADxK6EDrD6R36WSBr0F6CMH3htgsFehsEcE/ZcDMAYBEGQrsR45iZliSEwBBAUZugYb2yjYSH1p/YA5I6vaXbXa3aS7w7ao6RA4vYo7CwqLfZgDiHyGaHHbaGg7RSARmF6Ha6GGPbaFmEoEJIY5WHqEHZlic644wD47S444n5k5TqK7U40a07q4M6KC2zM76H3bgEqShGJScBy4K5OxK6qCq504N5CwSQqKBp76WRf52Qn5n6iawHX5gC35qE2GP7P5IEWyf6H6/7/5v5AEgHJFuGyytGZHVEX5X7wGIHdGkA/5eGlGZRnibjbhIC7hlCpalDIA0KkA7DjrFZ/rgToqqDah7ABgxDMClbzproAbgQPwSbgR1YNbmB7CQQaGFoSJiSTSrIKjWBIgCiojLR7IRoOIXDHLyg2BnKqgXJ0gIzybQBRA2FHbc66BuzZpugpRNL6ihCtRJapDZrIBiSpicBEAQCaTuwADUvQCSswawEsEiPyUieA/RKiJ46OaAZMFqqgaswRJSAYnAGsEKAgR4EWOg2oXo2qhGia7oZqtsborJVqcyuQSQ8YXAyayi4QtGSMLAkgXK8JEWYaGiEsUAjkMItaSpWcKp9qewYgjkxeQgTyDYcKzsBKRKPafaD2CQQQ7wEQRWP6Ox02YA6gi6Og66Fg2o+6PpfWOsa6Pp7wzWRwCQAY7wCGl6GUQQa2rQQp9Mk4nmo04pMsHaTpxecgAYk202aAXqWxP6JWAGQGAZVWG6EGUG9WMGTW+ZCZ16+ZRZj47ZkGrQkQhiO2VBl4NBt0RQwUdkPInB/hthAEciqQwOV2bocioBBh7OqQ05nAfIaOw6lh9+R2U5mMzMiAjhC5fRy5w5+5a5XhTJlBJ4YqA8qWKkJ4zZnZpZ36H4FZZWVZy6NZ4GW6txjZx6zZbWV6bZ7AxZnZpU3ZQ24yY2tkE2IFM26SEgCxKAe4eBG0IARA1gAYvQWF1g1gE0xi+g7wvQwouSDQ+IuygQHqAJO0wJh07i0C5ytI8Miwlkq4pY+whwzMnImS7wvF30goFwFFDwXk/Ym0uIgJYMwJJIfw9FKoIoSgpQX+eAVFBFColQTipFSAmyzFBgvY60MCrCGyuFuFUoYlVgc0ziFSe01grgk0MQsA4IL0JEzkJgZEqEEOGEx6okEABEVGVMraJU345E/4AEAYjx90DEg5ywbFLa7E4gDkTk+orky4HkaAelNkPk90IsSkdiZ5YUtA6glQJIUA7wPIaQvAjQjQ7wlQaQvIio0g6y4g7wew+06lAAQrwNIDAOoDyNIDyAkNYHsHNnsHsGlEpEUhkfleoIntIOcNNWkJDPtL0MVbwO8NwNYKwmkOoFABtXsBsjANYFAL0NtbwOcGkPtGNfxG5ElLQAuLwMZQ9Y9U9c9S9Q9WNaZGUROTuelexY4TFTsBlKUI1OIEgKAAEIoM7EIHgBeCAK4K4EAA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const allowance = await Actions.token.getAllowance(config, {
  account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  spender: '0x70997970C51812dc3A010C7d01b50e0d17dc79C8',
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Allowance:', allowance)
// @log: Allowance: 10500000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.getAllowance.md","from":5869,"to":5914}<fsm-vh3gqscxm4e>
type ReturnType = bigint // Allowance amount
```

## Parameters

### account

* **Type:** `Address`

Account address.

### spender

* **Type:** `Address`

Address of the spender.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP20 token.

## Viem

* [`token.getAllowance`](https://viem.sh/tempo/actions/token.getAllowance)

---

---
url: /tempo/actions/token.getBalance.md
---
# `token.getBalance`

Gets the token balance of an address.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.getBalance.md","from":115,"to":5464}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"be2aaf71065dae41e98187e9334b07b0203145c233743016fbab053ac04a5f67","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinABGoeJgvDCpK8kWDKLa+uqytcqqGi06enhrchtbXRZWAMwDjs6jjRPUXtO+c2oASYrHYXCMgmEpXKUjGAFZ5HULogato2ngISYnj1EG8QPYPiMkAAmYk/TBTAwzPxAhYGfJgzhoCAAa0U0KOfWseIU5waCOorRuBmZbLA2Ne7yGnyQL2s5L+VIBpRodJACQArptjGBOG0AELrTYwAA8GUSyQAfEEOslUuashROFhHMw9GQ4KlMcIAHSixQ+g1GrY+gAKrvdpDgZuKSktEVSodIEGYjDgpu9cD9rIDQfuxp9ACU9BrSGAAGqhDUwS25MDiN1wF1bPV6Q35x5UKAQXgIAwAcT0cE4ABUAJKh4nWJk53V3B4wTgJdicDarqBQUjwLMq8RKPvIZAgOgNrAKUoAAyvaDguQZhWA0S34hoDuSTvwaDQWE4riXyeYTgAHIAAEAHc91TAB6GItyAu9QQfJkYFBX9/xTYDwMgxgYPYGAYIcCw4HgvJEK4R9MzQhIAMwiClGg2D8JoUESNyJY4ljTgAF4nxgF8YDfJQgmAXJOGiQjhFSZBmLYABdChRKZIZhAKG9UhE3UxM4aSULYH1GCgWTUk/b8ggiBTNPcXJXAiXI2NiVZg0XHjxAgxhwX4SEs39MBAzbJybVjJ0NLEpwYi1NBUiA6xaB9OKgIsmzcivC8QHko8XSGZhSltJROAAWnSWMfTSigMtdUpMobSNh0K8Mspqkr0pALc0FLKEqBHfBFx8xyOxgJr5LKTlEF6axTl5eouSudEDDzBcJVlKVhhcXFvg8X5KR8WYVWBAwQjCSIimEDiLRSIqzoQ1Tjs6Q4Kj6KdET5JBmkFa52ljRbcWWmVEGqBUtupQFVUCIIsGTHAOAwKIwogCLUgvGKABJgDEUgLCUVwL04AAfTgQq03hzEUSL0mJsA0BNEdlKbMEnTSCTcc4LVYCSSwoGCxStK08QNy3OBPR4PntwAbi57nOEgY0AFkNj3MgAH5UgAOSELZZfrXRSCZlmYDZmAoDFzSJc4OBkjAJXOCCMGIxGQWCZN7mHDgfBUgACXCfAjcd38oi4y1OCTFM01NN26HjHWwFZ54oEj6P2e9x2zaUMBuA1VR2EYAAvF9IUt62qrdO2vXTwh0ZznViwAR2rMQ/YDoPU3TE0AGVzbTjPy9zoRizassRy8CO8d1/XY+HqO9ZjxOTeTsBpe3eXUmEzhGzgeXf3U8WfdXxfODblPxBWBR54F+Xp4lmzuIbgCQ5NMPaEtc/ubin1OEqFe8M4F+n60iltk4bIZgeyhEAefP8eMABScAe5YF4HwcKFM46T3Zo/cWL9OCkg/luL+cVz7QNLFsS2I8p7WSZugsaWDFzoLxsJNBuDSEADJOCI1oCjNGGMsYRFKN2XsGJeAIK4C+CQ9gDYziZN1aIoQ5BW2YHAJQPp0wT1IBEEqd1YS9BeMSJ6U0UQzWFCAWGEUvqVB+kSRAZINp/3+DteYoNwYQEhpgKIPlUgjlnGOKAAB5Ug3BhYC24T2Pshg/HDhXGOAAIpwCACRxGLnHJOacPlVHDXuqNAAHBNJE/I9GBB8l9AUBJpRmIsZMbwQNdpqnrI2Zsi4lgQAULkIgkhjrQIUPaEw9TcBdkCXgLqi4Lx1IUNjZg0ANQKGdMmIgBl4CrlNvkcZsAVgaiUEoDGLTOniJfJwNMczUz3G1syWJuQIHiCaS3Xg6MsCnVaYuN0BI8hwEAvYqZsBY4rAwJwMCMAVirGTGBdMUYfR2TAH0j+UAxmLjoKpYcaAwIQFNjgXgjAki8CKKCSwFNPTAoAFQ8GYeaG52MibhGHGBdy+AV56EIFAYccANT2FXMOAZHSFA+jkBAISEQLxOmZcITpPoyDJlIGZbGGxY68puT6CCZYRWbLiGuFYi4NTpljocsC6MaBiI2B81WsAfQACtaVoGfMwIFYBcXcD1Oyu4zDBkwGxkRCQxobrJFLKItVGqerwuQBeexWwBYKLQN2dOF5ZJBBMlgT0UEoKQFgIan07AlBQR4XAKC9waBiHykQYklQfS0CguILAOE/Xbh9J+ZgcgADEJaBZiGDWgGGUdcg+prVmOtgrQ3hq/JGxA0bY0wHjYm5NgS038Uzdm3N+bC3FuTP6rM5aq2tvbaQZRr9QVKGtaEW1LL7WSLnEqlVnzyVwy4PeAQyhYnMP7YgO1wzRmsuBQAfWxdigA6pIPIygX2PtcRIjdEAbV2qiSsfVMB+BAWHEXalw5JCLksOSsgLS0w0ApnIDAuQ4AYE2PgZMkBlWcHMGyS9Kw/kAp4KGMcMLuofP5ihI+MAnSQG1rB2JHyljIZJmh3I4QsP2Fw3DYchHFxSKiaoRDuqBqGtNsavisjX4txgD1CRPrICaqEBMns25OBjigp4ztEao0xugAOrMQ6U2jozWgLNOa80FqLVBVtZa0AVsreIfKqmYD5SEPlVt+VBBRGXKQXIIzsEWEC8wbuvlgUAFFaCnnGcqtZYmrUAa3RKzpF5EDApSoa+yfLWXsqEkBbqch2WfPYHIKAQEIhG2jYHdGmLjIwFK/CuFpBKtOkOXWk9eXJWFaCMV5rZWACkxEnRATa5V6rtWoL1f2ILErZXJsczEd19OvX+WCvYEESwYFODRZXdtoCr7CAOLgE6aBUG1lrFjg4LAOB2bVZq7kOrSZ5ucC29rHeuhVxR2k04FkSknBeuk7AFdWWwB1bEgdoVqQTsQDOxdlMVLru804Hdh7BsXuze5ls5AMAmlyCMnCUacJscSy2ecy5aAfSkC1GOEF+A0zmhBlba9RBmCjU0ek2ykOcc8y4J4kDYGad07AAzrqzOhCs528ZxAHPcTjVxGk3nUOBeSzl/sMg9Y5AOdnduKCdAwPp0hCidQo1pDk9x1wfHhPZL5XVYWyGTRzHEit+rgnoQqeMCuWzzXFNtehD15pgWhvaDG51CiRoTRrCq/56FLg16tdliDxFiwhvCePvYcocxLxcTAvYpLaq3FgKvsYKVzghYANESEEBI2dqpUfqCBecJGwtacBRlUmArgACEnBW/KDID3i8z2+dzca/3tviGy8V6r7sPlYA+8D61j3zr8Ll1BbAClGLcXWAJbNhe5LF4CUZeiPcAWEPkpXly5sByJ6S9tBbjJhsLdkeEDAmZevDlBUP70E/k1r+bo7+n+vWXAzAGAJ+4yPEu26yrKkBMAQQJ6Togqo+wWEBO6bKHKA2i2rWFWVWo+r2DWak6OQ2uB7WK2hyPWYA4B8BmBRWOBnAo2CUwEy2025Ob2E+DBy2a+US621B6B+WA0n2O2MAe2MOR28OiOpsyOqgqOt2TuigBsT2M24+xByA4hpAcOp2kaSOV2F6N26OCh7M8kYigqBeDkXeJex25e0ic+NeYAdeaBtB0qYAzey+iGne1Uvek+g+pAw+BBs2HBxB7h2sM+th1eC+S+U+fhPBZhW+V4u4+4SAh4ZQimpQyA+CpAWwYaBmvaUEqyqgGoKwPoMQzARmcaqa/aUER8AGUEE6tm5gKwuEghBqkQaUQ0MI+gOar0k0yIqIQoH0ghX0aSpiq08oliio20NIIMeAQQUG0AUQtB/W32MAls2qToL8DiOooQ9UDYgs2qyAskCYnARAEABkVsAA1L0FErMOyrzFwt0rwgYEETCvCheGtmgNjGSqoJLKId0ANJwNLGMgIGeMJjoBqG6JinuqsIuC6ALAbE6N8RSmJrkEkFGFwMqqIuEJeuDCwJIB8isb9rHCJrzFAO5JCFupicSbSkUWIO5CbkII0lWDMmbHss0oci2kQQkEEC8Fyjkd2nkRFmAOoAmjoGmhYBqPmkKT5vLKmkKS8HrvsAkD6C8E5hWrzkEMlq0BCSTDBtgiJnCYehyReCbnID6OFi+CKvyd+IZv2oOmKeZumvAFZvUVOvZqaWqVWqaRaWgD6flK0JECotltfreLfidEUBFCXnCF/i0f1kBAIqkMNlVk6AIgEaoYLAmZwAiKtkGlQQ3nGQmcwamSoS8akJmdmV1rmXwdvmALkApouD6h6T6VaV2jaXkXaaZg6SOk6eOjZm6ThB6QupWt6ewBFr6aOS+P6ToEdIFpQtsokBOTqMkhIEkSgEeAfp2CAEQNYD6L0LudYNYO0Wol0XCCYmcDoniGiPooVsMaMaMGkgDGUsqLYosA5POMaDsHsBTByKksSOoLYOeX0TkrcE5LefiIMCtKMDmo+XgCuaUF3ngDeceSSCcNosiABTMQYO2AuKkGNHCAeQReKPIM8NNOBYSGMa4ENDELACCNdBRJ5CYFRDRBNthFBDJBACRGevjC6nlH+NRBhEBD6M0VkKxGGcsO+S2C5G5B5DqN5LOH5GgNhcaIFGdJzJpIYhTFFDFOoJUMSFAC8HCGkLwI0I0C8JUGkNYHCJotIMSHCOIC8CsGkpUJUPqLwNIDAOoHCNIHCAkNYCsNFisCsAlIpC4sBDFFOLwARVFdFTFbFXFVFcFWAElLWWJfynGUpVsIgMwRJTALzqUEXOIEgKAAEIoGbEILBQgK4K4EAA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const balance = await Actions.token.getBalance(config, {
  account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Balance:', balance)
// @log: Balance: 10500000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.getBalance.md","from":5550,"to":5593}<fsm-vh3gqscxm4e>
type ReturnType = bigint // Balance amount
```

## Parameters

### account

* **Type:** `Address`

Account address.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP20 token.

## Viem

* [`token.getBalance`](https://viem.sh/tempo/actions/token.getBalance)

---

---
url: /tempo/actions/token.getMetadata.md
---
# `token.getMetadata`

Gets the metadata for a TIP-20 token, including name, symbol, decimals, currency, and total supply.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.getMetadata.md","from":178,"to":13503}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"17796bba722c896e3ea092096ebfba46eb5bcfc91851eb26e942755800833739","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinMx64lDiEqnAuZx70QCupKSKvBipYqQWSgDcu/uwvCyhcKlgB8wARmR3YPucAEcDhAaAAVCAAa0UAH5UgADay0AAkwEu11ccM4AB9OAcwLAkpYoL9/mBxKsLmgrsoSfssOIDnAYFBYZxPhAIApxH8cXiCRZmdjcfiYITmbS9nADlgsHIMGlxFhWZ9khYuLyRWKoEK+aKBcT7pKMF9OZTqbdDZw0CDQgBlaWy85s1VgNASq1DYQJMgABU5jDOAEkWakVUo1TrNfrI/yib9XKVylJEOpZLVlKokAAOFo6PR4VYSDYSLoCpAAZgGjmco0aE2oXmmvjm1ACTFY7C4RkEwkT2n00ma6fqGlzbTw3ZMpZ6iErIHs1ZGSAATOX65gpgYZn5WwsDPlO1bIYo+xU+tZKvI6pnEABWMf5gzWqFgadWOcLoY1iu9deNrfNqUNB7iACR4vwPacG0ACyazFuIAA8GSJMkAB8QQdMkqTIVkFCcPSQyFmQrw8BBJgAHTPoo5EwXBmziORPqOERpBwEhxRKKhESpD6pAQMwjBMghOx/PsvBHCcYBnGa1zuo8zxyCR7xfD8lpAiCMDgi+rIIsiqJUuimIarG4qWmSFKcGiNKWvSjLMsqHJcjywomdqxl6nGlpSjKcoKkqoYuuqLkeYK7lau6cDGuycgydZol7NaEhyPaPlOmGarulS3JwN6pB+uYQYhs64aujGIVucF4W5K4qG5OZ8D0rwMBQXosFFvRpRQBAvAIAYADiehwJwoKBj6y7WEeL4rHREjkUB4hKL1yDICAdDkrKuBUHC21oHAuQHoUwDRCcmwwDhyR4fgaBoFgnCuJwCR8cwnAAOQAAIAO4LQJAD0MQnC9+0dodVowB2d0PU9r2fd9jB/ewMB/Q4FhwIDeTA1wR2TsIEOPfx0NfUov3/YjNAdmjuRLHEHGcAAvMdMCnedShBCJewLijqTIGTbAALoUPcWXCAUu3bJa3Ng2w5GMFAvOpFdN1BBEAuie41URLklOxNN7USHTnDiF9jBdmRwiUceYA0a1M3iBhHF4Wzk2KKkL2IuR7svSrrga2A21wiA/MrQR5KlJhSicAAtOkHFzYHIDB8wpQJ3oxGR5wTGESnrGxxQK0nGgRy9lQoL4M1VF/IW6z0bH/NlP2fS9LYw43r0/TUK0j4gLRuviG+FZVl+S6zuof6bj4sxAW2BghGEkRFMI1MoSk0dL0DIvz50oj14gvTLsuV4Zg0Q7aOOBhh33s4D8MLiIJU4weA2Y/bi2wGBEEWB8TgHAYFE5epFpihgwAHlSDcCgFAE4cBTBdR6hOcBkChrsE4IGAAIpwCACQrSl2GqNcaTtLanmTL0csl5m4NHvO3PMgRy4X1IZ+a+oxlyj28M/SeIF6pwEas1JYnIYC5CIJIeecBeHYRMLwzq3VeogBLs1OEPCFCYmYNAA4Ch8J8SIDLeABtLL5FUbAT4BwlAlXDvIsuDguCCR0QJOQgjrRYL4WAAAUuIARtpeBXCwIvYRqjVgLjyHAZ6H9iCaO1J8DAnAPowE+GyPiH0mTZ01mAGRKxlGqLoCLIaaAPoQEsjgJ4SReBFA7JYV0rxEkACoeCcDhMhbxMBMS8BsVAiJxt8A60IFAIaUp7AGyGnIsRChyJyAgCzCIcI8L9OELw8iZA+KkCVpibk2pJl1PIl9UgYAFlYM2NEbkbJmp2W1HYj6VwaBHgNmAcJAA5aAMByIACsulUkZswciuRKncCgsMz4oRqmmMxCjCQUluEcSOIKY5pyy45OQHCIJTUoHkTEF1A4aA4S8yCArLArwfo/UgLAR55F2BKB+jAuAP0bE0DEBHIgy5KjkVoD9RUcM4XwDgORK6zA5AAGIWVQKRRAFFUQlm5BhbytlSLZlooxddLFiAcV4pgASolJLJHktOlSmldKGVMp+mK9laBOU8r4vCqBaBYDHAiORYa2ClDfN+Ss3hDS9nfFxEybUH1WkCosRja49jqkKsQP8lJUAVF3MSQAfXKeUgA6pIPIygo3hv/jau1cghG8PQZ8e5MB+AvSGoWDpQ1JDNUsK0sgQjBI0FdHKXIkUpL4D4pARknBzBQj9Z8WJ8SeA+kDJk0u4TIFg0+AoPCkBSAGxOPY8JSxK2KDQDWskdb7CNoFUNVtzVQhppBKXcdNzYAPKeSdZgbLOC2hgGY5qMLIBnKEGo7qrLkE/SAVKzF2LcW3KVToFVPU1WUrQNS2l9LGVYGZca1l+rDXiAjtemAEchARzFRHQQUQEjsFyEoydFhUOkGYJsHsbywC5AAKK0HWqoxkvrVDNVtRAH5aaHUKMQIkv2jytZTMGcMlmL1S5yGGRE9gcgoAvQiL8HF6dqSi04Dxvj2TSCCbwnY/lKK2OrM40EbjMBeM5IAKSozwi9WTgnhOiZ+uJtUJFpM5MM1ABTOSlNoBU9M2Z7AgiWA+pwIjxwXMvWjYQCAWK8LCILb6n52oHAykUMyYTInchid4uZzgznx2rCgQtDd+JLISF4BCD0TgoWZfNaQJjYAxN7E83M1IvmOQBcsvxPQ+AQvrCk4qHARJYumf+Ds5AMABFyDlreHet52v/ANlwNxHi0DkVIHiQMSSGtwGQq/TgrnbmICIMwHe5Zlw7yzD7Ur+wdlAKzTmyb02wCzZLoJRbARlsBvW7Oaw0hZy7eG51rgAa1RkDJHIXVYGoE/ToDmlFPYUzqB3tIV7B2uDdd67zCOJyWtkCaIgPekO9g7J63adxjBPG3dW59jZoRfv3v+4D8SxgwApkaE0awe2OtQ84B910X2ie4YsAD3r4arIpFXLORJVNGfkmavTHzjBeOcAAEq0ZRkIF6vxTFrLjUEOEKDuS6HHSieqrgACEnBVfKDINruEMWSumfi6U1I+v1ecGjWLtNUuVRTLALrq3hvbMFdmbkP2iSSNkYOXASj2CakDPqdEJpZTCO+22qxqS2svX6zaLaZ55JbR1cIB9JW8vtazIT3oJPR7U+rHT5nlTXBmDyhD/rNz6bBm1N4UEL1eFZkm/QxX9jdy1Maa0/xuTQmTdxYkxZzTMmBM2fOV61vdeOMjPU5ZzgunPavWs8Z4b5vJNz+s+7ifYBy9T7uUl1zMB3Ple81V/zcBAt1dUI1sLiOiTRZM2Zi3nBkAn6KzbvzNWgv1Zv81iLRJ+ZzlPdI8Bd6p9ZRdxcHcZcwA5dJ8Q9FcNlldXcNdgAtcXc1dDdjdH818SJkCbc7dJdpcnd0CDdSBtd3dgC/Z5pFokBloyhz1ShkBhEjgmp0VX05UfpwxVADhPhyIYhmB318UyUFUfph1aMfpNUgNzBPh4Z28D0IgA5a4kx9BehpA24FBD5RxKFT55wQ8L4ah6FvwbBmEmwJ55g34C1oAog98hkZ8Us4A0tWRuQMA8J3ZCVPEexQgM5yQSJnDkBeZuJOAiAIAZZlsABqXodBWYYZdYBQqgUlPAHA85OEezTED1VQRnI/boO5TgaCFRAQDaCdJQD4OdIaXgZ1ZqekKBZkPCdItpKjXIJIViLgQ5XpP1D+Z4UgcJewtLC5bUTdA2cBY2TwtNVo8ISyHgsQY2YHIQfhUIA4LRAPaxWxaFWFCTBIIIcsMZNgmVDg3DMAdQQlL9boA4BlfYhDNLMlfY8sX7NUBIcicsCDOQH2IIKjIoko0pCdDdcXKot1c5GFYHOQcibDXDNABZHYm6N9BVT9YlUlX9eAf9SQ7VEDH6QEp4rlQEkEzYLE/9VoSIS1ZjaPPaWPBeIoPELgemW8LPOQzvGIck1IbTITPCOk10fvM3QfVIFktAVIe8c5ezRzafLjLkxARfLktkp/STYUzgXkxTM1bfb3SPM9S9OENEnE8E6VSEjg6EtlZVOEilBEgDLVYDOGNEjlblTE9gUEnEiOPElDJBDDZqLDS0vDIQOaFoGglAFaAPYFUoIgawciXoAM6wawRQreM8cHNMDQkcS+bQzuTjfQq+IwrMEwgCMw3cdobWSueCMWeKQ4Y4U4J0bnOSHNBSJSD4b4Ugd0dSMEC2HSREFEbnDEMqKqXM+qWKC0XM2yN1ByXhPZMKaMfszyXM7yR0PyZUQKZsgcyqfUCKKKU0TLc0TKG0ZKB0OUAKEqN0S0IWHKX0f0QqccjcycokI80yMABMMM5MZcXoIcKMm8HMWMwILMjqeQMsFMRMoeZcW8FM8eHcV+PAd+T+MgTAKIcSfMqSQsgyZQCRWBAwNICSAs5bO5JQK1bIEAAAVVtBQVQstUIX0D3goVvIaHvJPk7lAskjOATPnEGAYQrEqG/NYXMLwA4S4RrwcQEXHVMVEXb2gqkWSQY1DyURDVUSCQ0VgCLSsUKP0UMWMVYu2QsS6RYDFxWPsVyGcVcWx1x1MWmj8UEkCXURCTZHCUiWiQ7QgDiWIgI1yGSUEtDUS1oAyStGyVyRLIKSKTYBKVFgqSqWD3bwaXDxaQyMsM6QmJ6XGP4tsNGXGT+XgIPzGT6OirkPWU2TitUB2XKL+BdVaIhWNny2cM4D3TuUeQXJeQIw+S+Vo3tSDUBW5Cag3mSDBSOSs0hX+LWJJ3FTlJRRfRlShI/R1K/T1PVURMA2RNAzavRLFXsyFXxBFVapNURTNUlQhNlXlV6qONhNVX1I1WGuNOJzmrNKNTaolQtStWSRozowSrqSdQyv90FDqPjwOgEGUD9ThADSDRssGQjSjVjQ2WuETWTWo1TVkto2zVzXzXq2gCLUnVLSow4pMFnWrQwFrQwHrRXWbXXXbU7XLW4B7T7RgAHXgCHRHUZyQWLSnQrTEDnQXXCGRuXSEFXRbUYDbQGO3XLQKoPWKp8KtSVL9SvQ0nQT+DFUfWfSWp6qELWu/TJU2qGqNJ1T1X2qgxgzgzAAQz+zgCQwgDtNIHQwRk4CdJwxdMth91I1YHI29PDjeLOsqpDzhGKy9yJIFI7xny7xH17xX1NwlKH2703z5I6ocxJNUydrnwX302X3FJwPlmHys1H3d35P9qcy83mWrzf3UzPy/yvwayetCz/1ayiwiDDsH0SwTumlS10HivKGy1y1qtlMK2K32zf0q0/wv1q2C0zqa3CxzqgDR1Gxf0xz6zvEGy7p2XGxx1OxmzmyuyECWxW1gDWw22IW216Be3dre04COxBtHvO3HoW0npu2npgFnoeye3LCXv23R3e3x2Z0Jx+zFQB1oCBwp1B3B0Huh17rhwRwiyK2p1R2XoZ17uHtxz3sQAJ2+12tZVvvvpB3UGp0aFp2fuJpnuAdZ3EHZ17q50gp53LD5xAO1jAJF1t0gKIOERgOpNWSSqQIwJQLQL1woaN3zvM0twofwIIcdyIZIPV3IJ9sKztrhCNr91dUD1kT3z8vCAj24ZjwF3j3pkT2T2YELxgGLxNwFxzykbzxkbkYUZIbLzbzqSryP1YvIj3wbxRSbwtV+DgJpMDsjp7yMzoefw32jvH2Ux320emU7yDr0yX1HzdoH3oakyse9rsW313xioTsP2P1CZ80bsvxbvDizvbsiz71sck1fwTobuqybu/2v1btv3/2ZEALsWANL0F1WHAPwft0Idl1+GCcSqVxV0Yc1yFx12odINoewI5OaetzKcIJYaEDYbdyAOOG4eoKWi9IYKoCYIFVIFYI1OWs4NaR4L4P4kEMVWENuVEO+QkO2ukNkNWUeQUN5iUO3lXAIuvAaBqBIozO4pfJnHvMMKHmsG/IkCUFKHqjwHjIvLwvLBOc0JsEYtgvgvAtSAwpQQvlueoqMIeYfg3BYUAj+eCCCusPgLUx6N0CcMuVcPdn8wpy8OYl8MuX8MCOCNCKCAiKiLIBiKgDiJAASIMCSLsRSN9rSNaUyI+myKtTyLkAKNUVaA+N2l2WuvwhEZqICvqNLkaMYGaNdUFHGLeI6Nwy6OLocNLqWQNnF3WCgGGKEF+TGK6UmIEALgpzmLkAWIUuWPHTsVFXWM2O2Jmb2O5EOOVROLOO5AuN0CuO5BuI6NdHuMeLNJeLeJ5dWE+NJoGN+PBVWNVOdLBJtfYJWrFt1I2sGsNKAx1VNINXNIEDkBxOtNtIJMjxY2JIFy5P1ipIdoivUylMZNFIFVZLad8alJlLs19rLdpJre5OrfJKSZIgbZjubajx4cVPPRfxVMzeBKjfVNjeWZhIlvhK2plpRLTcNQtP1rQBzZ0DnmwxSUw0SCjfw2GdoK9IsCal9P9MDMbhDIOY+ZXEqDnEIv7gfLeZGVBffJvmTKhf/B/Jfinl0NJKfK2E4EdnZgBekgXNkktHklw0UjeHLNUlzOrM0lrPhHrP0nNCbMHNPNJCF3bPdC7PslDEckZmcl1C1BPINGHNXPlEVAPIjHQ4qmI5nK8jnJilA7in+ESjtAo/XIyi3M9B3Lyj3IwGDGo9Klo9I/jFwpXBgYPmjOIo7kfJtmfaosXBvk/PothfTP/KCS/mAs4Ag5eGg5UhbBpZABQRLMg8QUwTePLjdLrnDOXEaEjNOezAfECD08UkU7uZvhITU7TL/IMGYry1YrmNhvby4rqR4rwD4retSUqP0rEu0SWMkqiWkt9S0tSvkqsSUvNZyQaKcRcXEH/q8QzV8QcH8T0uCVgFCSMqiRiTMviTZUSWspi7socqyTszyUYFcv4PctKNtrADKp8surDxEZFfaQhpCraTCoVzUzGQmQV1isWQy3CrIZSvMX5f2SlcaoiWarsTyrZqKsuBKveSqUtvoyqoXhqpBSXgavORORypar1VSJFq1NWoTZ/SluTZGtAYRX2omt9qms7rAEtbGqOtIC6s1LjZWfFoGr/U+52rlvTYOpNVB8tWtQBoqrO+tvW8yr+LupRV1p9SereJetW2i6ErDUj0jRjTjV+vKSTTR/KvOq0uBpOzzTG+CtJuhp3XJqrXnURuEBpobTprRsZovVq/MvHWxt7TJsHS+CJrHS+LJpnQpoRtyGppRuF7XVF9Va3RhvytuXZsO85tPSHbeN5pvQFtVqFvB9me1Oh8Tdh6RPh9VvRIVo0iVpVravVs1u1u3ZxPw14ZNv9wEcZ6tt8r64LZbcsa9q8a7Yjpj9717eRT9um+j742Ds8ddrj78YT/k04e33m9CaToidToyfTt/3ifvzzrrc+KS0Vd6JVfLpyyyirqbZrsh3ro/3SeiZ/2yezoSbgZh1CH6wHp/rPtPQ0o3ou3m2u3oDxxnvu3np2zpxG0O2O34CmzHsu23uZzn8Afu3LEe2exX5XqZxGBAZvrJxmMp3UDB1UMH9fvhyGA/uR2/tPu7r/sn/n/3sQevtVvAfJyQNoGsDMft3TP4s4fsbOErKg25wo5MG5YfnDgyFylMCCUBJ3LATjqDIyGdTUgpwAaarAmmyBVpqvnaZ4EumaA1hh036bV1KC20QPoUQoxE8g8QjYblAgj721/aXASRi1DQD54Xk6jMyiXk4GF1x0KjXgWozTyCDFGmZFxqonpjV4FchjRvCIJbzOMbCbjfxrHxr7r5NBifRxn7WqYB0uM7jRfAZi0EkDfG9jPQYEycaGD46cyMJh5hL5RNm6vfWJm3Tvy51s+KTCrF33Pw98sm7gnJh3XyY5JCmwg3Bq9HIEVNiG5jUhrUzwL4CYAhAmhlgQsHP4yBqAmIX0zIIUFBm/bfdp6XoKbQQAEzFgjAGe44ouC+ABZvwSnarNYA6zcQk722YK49moZWzpeVTDScbw5zOTosD0LXMrAaYTzqMEhaTBvATzF5kLkfbPMr2KOboWQiQBNw/OJnMzvp04CL0L4Iw8Fvcx86/lv2QQBFivCMFHDWUjhVIM4QxbuFsWcgbwsekuH4sAiqQIltqBJaRFmwFLKlsZzpY5IGWyfJlhkTcxstci+RHHNyx0C8syiFRQVtUTHx1EVKKESVjq3aJXB5W3Rc4cqwywDF1Wmrb7JtzaJShPgUxA1j2CNYmtMuNibLsOy9artrWNvO1gcXFpOsfo5xekG61ZEetbi3rB4k8X9bYJA2pRRXqGyFZbcASo7NUjG26ovd42/VB3gaSd6ptR2+1ZdlaSjY2l12edSyv23Ebaxi2lJEhq4ydqVsmSZJWtukMlJtseSSfAvki2NFWiO25o92uHTNHclpSNopxgqVyDc1xRYuMdiuwnbSjIe07GHgqO2pKi/RKozNtm3VG2kHo9pHWnrVBJ7t3SIzMoEexKF+kAyQZC9oczs5Zgagd7GMhc1mHbCX2owN9hMNMIHCQIAuP9uIBzL/AyKBZbDuB3WFQdGcMHSsmpGBA1ltISHPSI2SMjTkhymHCyEWRsgMhuy+HXskRyjDHlaOEUCjmOS44icRxoUdcWR3+CRQTQzHCcbmXY4rlUoq4zcgeN465R8oAYQTkVHShrj6OC4zceJ3mGH8m4RY2TlQgLAKchhMgcsSuF/Dvsn46nVYQBX8xAUf4xTfeixzmHUtJEeAK5MgIwR+prOEnQ+j0IaCkISx/nGYd+LGC/iHs+wr9uwiFycJAupiYLqxTC7iJ4isEgwFFyx7vVYuFXLROIAkp6JkuRiVLpXnS661TWWXc5LlzUoFcv+WlErtyF0p3pRKgoMJBEhq6mUJeDXSPE13J4tdOwmSJypwhcoBg3KQgXrl5U+SDdHUrAoaAiKCq6tQqfSVPpFTm4hMHBcVFVstyVyrc0qMIrKk1Xu67dLk+vfdAdxkalUTugNfigCgu7Ao6qxRE4Ftzu5nILWs1cDE9xmai0oeb3SWkm0VEokEehqP7snwB4zVHuC1Y4DbwSkhj5Rc7FNmlJd6/dVaKPE6imgx4XVDJ6VDbq0Tx7eoRYIfEnjPTJ6hptRVPb6vGiUB/UGep3IGuvzQBs9TJivLnuWmV688F0S6IXk2i15to3ickrtFL1xr40mQcvGAKOhJqToqM06OGirz55q85pqNRad8V17c99uh6F5Cem5pm8SeFvO9Camt6VD6h9vd7ilPDFlSxq8taDO73gyIZkM8YrWjvkTE7sV2AfSPL7iD78MmB6Pc6oFPYFwhdRFjYwboJsbaDPaLtPPtXVtFozZ8VjDPmYKz5Yz4+OMsfHjKcaF8HBxfBwZE276uDAhbIDwbk0SZYyRB9pTEelm1BN9K6+WUHrXXpyd9S+AQjOkEP75tZQBXWV+v3V6BDZpZY2Sfpv03rb9Z+XAffnPS2zL84Ga9E7CrOn4T1d+Gsu7BtkP5H0T69OcfuAKvrfcyUV/B+rfyfqKye6sOJ/ojk/oo5lwcDT/hNm/5ANL6F/f/g7KAE04T+DOG2SAygEc5QgaDc0HAKwZFNIhEBcpj01iGYC7k2AxIagUaY5DiBzo0gYw2iFpy85SfWgQO2IzG0GBZtZ6iwMaQiNkZqM5YNwOkYF5JBGeaQaSWUY8C+BKeduUILrGyDhcLLfRkoOMYqCzGagu0ejNz594yZOfCmVvlsFDzy2ztHTB4xJmYyLR2MqOtYJyRBMV5B+OmafhcGZNxZLM4IQkwfzbyuYIs0+eXz76V88meQ0GUnOQF4MshacjAXYKwEJD6mOcggXnLSEFzfGmQ5htAVLkDNQZVBVMQe2KGMFmCUzCofFI4LVDahSzbUssyaEyEWhjAGQm0MiAdDlCP4b5tGT6Efiz4gwswK+Ubh4Txhj8SYQtGmGrBSxz4+WWhOWFwt4JFkNCnkBoDagk86qPXJyCpEXxaFSnQeDfHoXQtqxhEiwuDUpYnCjRLMFFjADRYuFOAbhLFiMXuF4sMABLF4SETeGktPhEAWIhF1pYF16WqRUbsCIFDsswRhRQUZ8Qakuow28I5lrlyaLLAURsrNEZIAxEl0eZOvQYhq1uEEjxiRIkkdf3JGLFFKVIh7lay2IMicU+xB1scQsCnFORytdkfAGyWet1ivIv1rkFeICjIRQbPliGx+KiiWqkbAMVKIh7vSkps7aWqVJNLKjEeqo7ErGM1F5sxGhbPUW2xLaGjBSFbK0fPlNFil55PbfPtTOnljL6SjotANnxmVUy/aXosAD6JHZ+jJRBUmUYlLlGfTHe309pZGM6XRio2a7RaJrS3aOkIZyY10oULoLelj2VALMWe2DJELt4W2W9k52LH9CDA7zahTOHEWjDswBEthJc2WD1jGxYkYDhBUXJting5nAzhWSrK9iEO/Y6pMhyHFiczIWHKCThynF4c2QBHPspuLxXkdUoK44qDRwpWLjGOu41sQeOXIpRHQJ4zKOeN3IFRrxwnIKPeI3ECqyO55TofoHLDH0OFiAd8ToXrFiKm4YKuARCrhYgTtO4EncdFHbIWKQAtoJjugks7YJkJz46oJKuPgAqygTHOVXhK2xKqNOWElLCxTIlgB2KFEpRQoC1V0TfKwaWyiJU0TiVEubEgxBxKeppc1uliJYnxLsQCT8uhXWSqJLK4SSDK0k4yuL3q7ailJtldJKpMcrtdNJhSbrjpItx6Tqkdc/yiZIUVmTJuFk+ZbNzqmDIFu8VByYgSclxAXJfxbKlFJyR7cDePko9H5M+RDTAputYKbVTDg3d21+WYHnNTimTs7ezSj7qlNGp7VEemUr1NlKB4xSEUoPPZcGL6rrUjlYY+douvAwVTDqeU0gKj1OoBSg0rim6u6k9T48HqbU16vRJi7dSvqNPBNHT3+qh800zPEaWNPLUTSYAZaELgHiOmzTBeZ0hmktOwQrSsaONGXgTS2k7Tx0pNfaTz0pr891etNBadBounoI9e10jmsei5qm9sE5vZqLekFqBgn026ppYcuSnHLD1ds13v9JoAe8gZGtEGb7zuX+9XS9A02iHwHX/JG5AygmWvOsZzyb5C83ebjLb74zThEm4maHXnlWC5NBWBTfYJczHz5kDM/wUzPPlxNPB7M7eZzOSzcyy6WWZvl+AFlnqhZ+wO+YzLPkV9jND/WHHLIVnv8h6yss7IbJ35T1TZm2BepbNX5cA9ZG/XzVvXVn+yD+R/Y+uHOtkX1z+ROS/nfUAFCBH69/F2UPz6zuyX+X9b2S7N9kj1/Zv/O2QAOv5U4w5cDSOUgxQac5YBvOBAdg1JLJzi50BDAQrizn/yqGRA4BT4wyFFzP5ECqgbkM4blyBNwfeGcWqx71y2BhJFGWJubn48xBvc2Rv3M7nLBu5rc/gRts0YrAh5ujdzIoJDxGM0AJjc9ZPJ/mO0Z5FM7xuyUsEYzKZ+85eeoLT7rzTBKm6TWpue3oJXtNk7TXo2Tp6a06MTC+ZLK8HzyfB7ANJvpuc2PzjNoQkQYgNa3vyohw29AVUxXndbcBSQlIS0360PbBtuA9rcQVG0cMCm+QmBe3A9LPKxmpQxBdM0nZoLeCdQzBSITEI4KtmeCnZtMnaGXtRVFYW8KQt6EucBhVzYFVYFbh0LHmTCqgK80BVPtnxwuyVSsO/Y6qmVnAYFmIrbgKrpFH7BiravhYKLEWBM1ReouuHaKtWdw3Fo8P0XPCgiRi8Ih8OiJmLKWWq34dUhsUIi7FlgBxZy3BEbpylQom9bCLdS1FPFYrJET4r+IytsEcrAJfXyxH9E1WQxcJSiKiX6sYlTq+YnErNaJK7i9IpaoyPSXEoWRbIy4vku5Grsil6bfkUHuKIVLIa+G9xbUolHjsGltvV7gxpaVw8IxQJKMWLhjErsNR1yvpTqKW3UxySwyqPkKXGVVtmSbbFZeMsbYaa5l4m4UksuX30l3Rsy9ZXQMHbKk6loJQMY0tnU9751Jy1Eh0qXYXKV2VyjdgmL967tHlsCooS8szGnscxXy8MuWEaC/Kfmc4TCWYCV2S6G4eEysQwtkWQrxd0Km2LCqA5gUQO+4/4G5zLKGd0VGkABGADrKDj0GaHR8fivHHoMiVhyHsk5FI6Urtxy4qjieMoMMrhyTHZlWx1ZWcdaVroTldlAvECchOdB0TgwZFXELnspCN8WLoMCyqcJ0uiRTRRRz3wqxqZGsW/C05gTf4rB48ewYYDUSYK0iZchMVSh6qkJFsGzkIfLDSAAD0ZKQ8AcPFsq5QOuq1ZAZkVPg5d4AGYYruglCHKg1gG8n8rV0gRwQSUU9GwfPbBkQjoRsI2EdfCSGPwuwqRa4FrgxBYA7YdeFjFNhDR7oeMZ6AZlhg/QeYEANGA9QA6hTcYUMF6ORFkJZAKYwg+sfrENjIMTYFONlNZ27hVwJAdsJeA7EFgWwXYiIcaLwHCP9GBjgx/o57HVgo7FNcFJA+cEXz1i+C8Kn2JZPUymdkV+naYzbHIhoH5j8yl6Nwv3qrGe45EeqJsfE0a6NVexlowxHVWcgjjim/w78hsNTG8IMx6wxRx9ilBK4SAUAAEEUAB4hAeAXaCAFcCuAgAA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const metadata = await Actions.token.getMetadata(config, {
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Currency:', metadata.currency)
// @log: Currency: USD
console.log('Decimals:', metadata.decimals)
// @log: Decimals: 18
console.log('Name:', metadata.name)
// @log: Name: United States Dollar
console.log('Symbol:', metadata.symbol)
// @log: Symbol: USD
console.log('Total Supply:', metadata.totalSupply)
// @log: Total Supply: 1000000000000000000000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.getMetadata.md","from":13589,"to":13794}<fsm-vh3gqscxm4e>
type ReturnType = {
  currency: string
  decimals: number
  name: string
  paused?: boolean
  quoteToken?: Address
  supplyCap?: bigint
  symbol: string
  totalSupply: bigint
  transferPolicyId?: bigint
}
```

## Parameters

### token

* **Type:** `Address | bigint`

Address or ID of the TIP-20 token.

## Viem

* [`token.getMetadata`](https://viem.sh/tempo/actions/token.getMetadata)

---

---
url: /tempo/actions/token.grantRoles.md
---
# `token.grantRoles`

Grants a role to an address. Requires the admin role for the role being granted. [Learn more about token roles](https://docs.tempo.xyz/protocol/tip403/spec)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.grantRoles.md","from":234,"to":5656}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"5e8451097f9633d21d3a3cdfc8f44501a3bb693043aa17e5311b84bfc53aca06","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinKQwvDCMWGipACpDwsOCYABKaxtbpeVSiAAc/bXKqhotOnp4q+ubDPIWVgDMA0czlGNwm1C8018c2oAUWsU4RFCAFcYKlVuIoEI5BhOMBcpwCSsIApUgADay0AAkwDEpAsSlcpIA3PjCU4YkiwNtOOSqTS0HTlIyWWBCZw4IpYKQyRTqbT6cLWQSHHBjsTUZwAEYQdXiMAi1zIAC6l20+mktge9SQAFYXm08Ii5Ciur8kACQPYgSM+uowZgpgYZn4YQsDPl2FwjEdTFd9L1rM0rU9EDVtA6DNGTK6eogPV6hsD3X9/RCg1DSjQwyAI4U0BAANaKU0VPq9SryOopu3UVpvAz1ptgHP/QGFn2ISq9UuBnyzSuwgwJTn8I6cJT7NBqhRwADKGDAvAAPBlEskAHxBDrJVKnrIUThYRzMPRkOCpLPCAB0g8UX43epbuqe4HrwX4AArPq+pBwCexRKOeESpOBpAQMwjASkeAFctu8D7oeX6nGgSKkGAABqyIwOeuRgOIL5wE+6zrpuuEgYepSYrwCAGAA4pucCcOIRIKJwCTsIJnA7AAkuBABM1icL+YBfrkuQAHIQDQuz4BhnC6UJcCgfgqGQEiAmHEIikOFwADu4iMGgAliaQVkwIp+xwBZor1rkmpuRYvDOrAUCcJZQmanIEC8A2WowM5bmrMRpH0hJqwMSYMBfpW4hKNxyDICAdB0VgCilKS5WObktZcMA0TojQd7JA++BoGgWCcK4omocwnAAOQAAJ2Uo6EAPQxKsvVVawka4opMDTR1XVoX1g05aN40wGNDgWHAk15NNhS1Z+AmdQk3UrUN63sJtNDTXtuRLHE8GcAAvHVMDiA18FBHiorRNtwipMgt1sEaFCsgKerpRw764kqnDA/NbBfowUBGqkLVtUEETg397i5K4ESqYe8JpUichcG94h2Q5PCriYP6Nn+2FATu+G8Fe8EPr9BJKakvUUl+Qu9bjvMQPzgvC6LwnwEDvUYXAKKkL1YME0TYDlaSIBgwVT5DMwpTXkonAALTpPBWU6yAet0aUNsviMAlm5B+vQXAlsUAViUkcIpQ7PgbmQwc9Oih85xcHqIUwCQXKcFAn3iJbYNlGafTyZ2jwNO29r9iALOsezI7umOwwuJOfoeOCs7BtCVaBCEYSREUwhPWeKTm23U0FK3nSiKniC9H8PYKJnSBJumudG0XeYl0WTSyTO3g1wu1ZBFgqE4BwGBRKhO6pNkNZwIrZAH8aLbXO2NQj9aiA9hPgS7/A08dp6gyl6MC+VwGS8VvM9frxATemAoh804AfCk8leDWGgTA2BcD4EIMQdYA+594yNBuBnG+d8+yBCUtPHsBZ35IE/pMH+84/54DXhvMgwDFLizASACk6hKiySgEPNIvBGiND+JUNI1gbR/FktIWSNpxB/E1DcSolQABCvBpAwHUDaaQNoEjWE1AAUU1JqFBfdWyIFkrJD018UyyRzrgiA08kyELniQquZCQx1zwLReijE3JLHVLkRELl3Ekg7nAdUHEorcRAP7NypIfEwFJJwZg0ByZuQAUQVG8AJJwHyCJWAmokRKCUClCJVlPp6QEqk9CchJB0NcrkAAUuIREu5eB0i2M3fxIkXxejyHAHqCSkkhU1DiGyMBNRalQjZCUMEVJgFyKE6JsSRJ0G7gJNANkIDihwLwRgSReBFGmpYLk75iYACoeA8lPM0yJ0RSlH04DZBy+Bol6EIFAIpSJ7CCQEuEkw6ovyRSUNjUkD53nCE+WQVCpBfmCTACFAFpyvx2VImC1QBTeB6lipwMyMAQr1iuXSGg5S9Q4g0rAL8AArIpAoPrMHGYc7g65IqalCDyCJUSdoSEPG4+CJF0XlJstiwOyzkCkgAesI+X4xCYiRGgUkRogiYywO+EaI1ICwBJV+dgSgRqcTgCNUpNAxAmyILJSoX5aAjXEFgRgI1BXwHdi1ZgcgADElqj6iogOKqIkdcj8sde7UVwLJXStarKxA8rFUwGVaq9VQStWfXgGgPVBqjUmrNRa1CQrrVoFtQ6lNVqfWkFIBEL8kkA40ogHSuQDKPkKCiUi0UflUUShCtc1QLquDVRSqoMJIbECMumVAOJ4zcgAH19n7IAOqSDyMoYdA7tJuSULS+leSS1ErWGgXqAkHYPPMqsTglgblkCaRhGgXJsS5EMoeYyQgXUCXME2VyQyIAjP3dwcCUkFkBxxGleaEUYAPkgC5SQgd30HrEIoNAJ7aJnvsCZK9nAb1uVCGWzSAcXIEsyiS8UZK6Lu04LuGAgG3L8sgDiyyXrOBSRGgAeT9TKuVCroChvduGjVUadWxv1Ya41przVeq/Da+14gTZEZgCbIQJsvUm0EFEZyuQYnbosM5Zgn0jj9rAOo2gxURJmTbUWudJb6VQvVKSRAxNNYkoehWzK3ygi9QDnISKVz2ByCgL1CIIp5WcBQhYRyGMYB2eWUs0gTmHyYudeK8zgKFBfIgD8mzvn7MAFJdoPl6gFpzLm3MjQ84KbznBbP2dS1AYLyzQtoHC9C4F7AgiWBspwdRubKu9RHYQQBcAHz+I3SlOlIUHBYBwJYZzERXO5Hc553ZnAKsuXop5XQ4KQrlGiu5JwvKMNSmlMNzLBI6sgtSE1nUsq2toXuZ1jEuXTV9fRetsUgkuDIGjqEdGNoB42ku2KApdSGloC/KQTkUkwD+wwqeOunAqv0cQEQZgA9BEDxuOrdzr2uAUc1Mu/gX2ft/Z0nAQHARgedvB3maw0g8ww5e2yLgnavNkFonIZNUUrUjToGscVRxUzqAHtIEnBICm3adEaE23KztkCaPo2SHPrvjadO9r4OPQcU9IqEGnqb6e0EZ8YMAqZGhNGsLDjbpOd0y65JT+XimLD06dAO+Uyh9F/DzMTR6O66JuTeo1xgdnOBqk1DtIQvURQRJheOoIpIAAiepdAuWpM4mArgACEnBg/KDIFH0kQ2wAjey7DOPofOAjpd2W93nuwAx4zwnorK3gW5E1sTNTGm3JaeUHe0kJzDPnPCHsiZGtypmZJi3UK4rXrrj0LuTDzBdyHcIDZbGPv4TAr720Qf6Jh+j4fRPsrXBmAYEbyJN61WmmfI3zAIIzaHzAuTzJ9fFmosxby/5xzA2MtZa87DK/DnAuFfKc20/e+L/Waf4lkWfUCvpaXajY5ZP4FYl7v5gBr6f4TZVYwA1ZbYNa7YtYHYdZ15dana9aKDooubJ6p4P5AwIHShZ7Nb7biiHaqDHbdYC79ZgzlJl5t524R597O6u556ApgDe4f7n6wpgAB5F5h7AAR7R6x4h4J5J537AHp6iEuTZ6sElr56F7SFR4l70GazZS5RID5RlB4alDID+IkTrBSo0ZBojQ5KqBIiahfgxDMB0ZKqaohojQRQlojTsYJrmCahjTn4koRDazJxxjELqBXxdgNBpg4JwgRa4A/C5iyCvzehlzWCLyQjkKhj1wbrQBRCf5WZTY5QwAAD8qQeKD4QsKqWwRwoQLsWGBRYAGAxoSECIEAqMwOAA1L0KFLMJFBiD4VQBqngJIeUqSCVlEo2rctVt0JlJwAALLkwCAlTwY6BIgvhjbVoopPhHzooPjDEVJngwRcBoohThB3rrwsCSA4jZEzaRyCSu4YhQAORlFlp7GvLigWFiAORM5CCeKURFIsAu5lKYqerZYJBBB/ARDUYBomGKZgDqAqo6BaoWBIjGoQliY5GaoQl/DJpeYJBfh/C8bppyDqxBDtqCTzGLGOREnwau6rH1rlL8pM5yBfgKafS/JGEBq0YhphownMbaoxpxocaJrmq0k4kZq0kMloAikmytCRD5omYd5wAr5FCciUycA2iT4RFf69QchcipDxbOYPgaloC4GZaSGpB6mpB2jlIlZlafJWbqkuqal/56kGn367LGm2nchmkhZoBiqlbt6kjEy4YEakgCkilMn+ptSsn0bslqqcnRq6quGcZJoCl8Z2rCnsCKaimpmfTik6BNzOTTJyaJAZmq5ZQtAaEoAFSpKsqlBEDWBfi9C1nQK+G6LXCyQ3DDzBHFy9ivCBDfLTwxHWITighfxlhzgOKLiejwhOgohogfSYhgDYhwx/QEiPwyh8gW4MjMjwzsiukrlygCgKgbmLniiSiC48iyj8iCjrkihigqi4SpDai6j6gExnxNn6B/CJiYLdhmKOiUS9mzwThCKJHljJGOIGBUKAI0Lbynaqjqh3k6gKB6ioLui9BtmjyphflBjhC4S/mxHjhlx/CDmkJ4ASBKClAR54A9kvnugGofkNCWggUgC4TMSAToqpACguhRFWC9D3D9nxGuDJwxCwBMAHQ1R0yq4nRLQ9QpZrTmogwQB7TVSzRGyLRnTLS9RfieFtz3Rd7LC1RhxfAPiTluSdRUw0xRghzuxKT/gsTATsycxtzcysiPywzIDyxHxKwqzSygICy0CQJIJ+X+UIIiwQz0LeXMKsLsKcLcK8L8KCLCKiLiKSIyJyIKJKIqJqKaKahBVgCEy27n7WmMUswsV/6GXIDWBGi8aYXqjqylAOziBICgABCKCpJCBEUICuCuBAA=="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const { receipt, value } = await Actions.token.grantRolesSync(config, {
  roles: ['issuer'],
  token: '0x20c0000000000000000000000000000000000000',
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
})

console.log('Role granted:', value[0].hasRole)
// @log: Role granted: true
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.grantRoles` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.grantRoles.md","from":6002,"to":6477}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.token.grantRoles(config, {
  roles: ['issuer'],
  token: '0x20c0000000000000000000000000000000000000',
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const events = viem_Actions.token.grantRoles.extractEvents(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.grantRoles.md","from":6504,"to":6911}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Array of role membership update events */
  value: readonly {
    /** Role identifier */
    role: Hex
    /** Address that received the role */
    account: Address
    /** Address that granted the role */
    sender: Address
    /** Whether the role was granted (true) or revoked (false) */
    hasRole: boolean
  }[]
}
```

## Parameters

### roles

* **Type:** `("defaultAdmin" | "pause" | "unpause" | "issuer" | "burnBlocked")[]`

Roles to grant.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP20 token.

### to

* **Type:** `Address`

Address to grant the role to.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`token.grantRoles`](https://viem.sh/tempo/actions/token.grantRoles)

---

---
url: /tempo/actions/token.hasRole.md
---
# `token.hasRole`

Checks if an address has a specific role for a TIP-20 token. [Learn more about token roles](https://docs.tempo.xyz/protocol/tip403/spec)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.hasRole.md","from":211,"to":5806}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"85a38813b3282ff4bd2875a74fa06ec2d675d0c901545edfa0dbfa76002d3c25","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinA5wAEoQCqkARhCbMOJgpeVSiOqytcqqGi06etPhGwpdFlYAzAOOzqONE9Re018c2oASYrHYXCMgmEx20+mkAFZ5HVrmdbm08FCTC8eogPiB7F8RkgAEwkv6YKYGGZ+EELAz5CGcNAQADWilhFT61nxCiuDSR1Fa9wMLPZR3kryQ+MJQ2+0usFIB1KBpRo9JACQArmB+NCVo99gAeDKJZIAPiCHWSqVNWQonCwjmYejIcFSWOEADoxYovasnjAvQAFZ2u0hwE3FJTmiKpYOkCDMRhwGBGz1wH1sv0B/ZetZ6LWkMAANVCWpg5tyYHELrgTt4MAN632pSgEF4CAMaXwMF4rLgnEYCU4h1HvBiOq4q1HnHrfeHjF4nETCk4CXYs4AKgBJYMk6zM7NgL1q8RKLvIZAgOi1rDPKgAA2faDguUZhWA0VIBxoduSDr4GgaBYJwrjromzCcAA5AAAgA7ueyYAPQxD+0HvuCn7MjA4JgRBSYwQhSGMKh7AwKhDgWHAGF5FhXBfhm+EJJBRGIUoKFoRRNDgrRuRLHE0acAAvN+v4wP+ShBMAuScNEVHCKkyA8WwAC6FCycyQzCAUr6pDJYByXJym4WwXqMFAqmpEBIFBBEGmGWBDmuBEuT8bEzaBiJo6IYwkJ6iYWbiv6hoKFa0YOgZclOJOYBoKk0HWLQXopdBDlyauMAJSmcAVqQaWab6YAJUlKVegVYAubkz6PiA6nXk6QzMKU1pKJwAC06TRqe9UgI1talP1LojIOnWhk14aZnVFDXj+aBFjCVAAOq9qoZDMr246xdO4QbU2mU9epZRwtyFx8vUNxCncgS5g+ZhSninxysSeK/B4/xUj4sxqqCBghGEkRFMIglmikXWg5hulA50ognYgvS9DU52os0V0YgYrU4u8T3DC4iCVJUSqfTSwLqoEQRYImOAcBgUQxRAU6pI+SUACTAGIpAWEoriPpwAA+nBRUZvDmIo8XpKLcVGlu2n1hCDo9uIFj85wOqwEklhQJFmlGUZ4hQFAP5wO6PAG0bcAANw67rnCQLqMAALKHOeZAAPypAAckIjZOzWuikCraswBrMBQFbjk23OyRgO7nBBBTYYjfp1uR3Jqz4KkAAS4T4OHqdgVEwnmpwCZJimaaZ3QsaB2A6uvFANd15reep3A0fcFqqjsIwABe4jGDHqTx0Nk0ep3hCc33A8FgAjhWYiF8XpfJqmRoAMrt+P3dT9CBbzcWW5eNXAtByHDcn7Xwf1y3kdt0oYAO/AcAu0PX51s/uhgcnEf55w78v5wDe99xDbAUI/Y2Lsb42xciJJekFy5GkrrQc0UDdZlU4JUP+5FOBlVQUZSkWVODZDMB2UIxCoHgQFgAKTgEINYWBeB8G2o3K+msUHW3QWSLBP4cEpSgbQosjZY6n2vrkShvCvScF6IeZg2D0EC2khwvhYjOAADJODM1oGzDmXMeYRDbB2LshgJwMziqOYCThewNxZHtaIoQ5Bx2YHAJQXpUyX1IBEU8sMuTwxJGdFEDQajaHRiAemU4sZIEqDjeUiByTvQIYCb68xyaUwgNTTAURMqpGITlPKxCVbEPVuILUcg0DcCgMmMA+SBbEKdFqVM1SiEgB1HUhpIACkgG2AtAAQnIDs7IoDEIMZ2PAXkbH2D7KyLxx0fG9AAByo2Rg0KJaMRQgEyhExAgpZS41GHEyY3gSY/Q1BTKmZAMlHnFKkLcx4dxQAAPKkHKYbJ+wyjHPPNpwTcO4AAiXyRxrU4Lufch4irTJOPoA8KyllIEFMEtZRVNmox2TE/ZH1DmqmSXgGsdYGxNiWPsXIRBJBA1oVscGZLcBUHbCMgwW5NqPgJQoXmsioAlKbKkogFl4CzjbqwNcsAulKCUFzUl+wNr9yHIOPljA5AkpsWtXIVDxDErXrwTmWAQaUr/n2BweQ4BQU5dyhu2wMCcHgjAbYnBtiJngqmCMXo3JgHpU2Vl7LOB0F0oONA8EIBzhwLwRcy4YjgksHFd0TqABUPANGmkpbzEW4RBzwT8vgHVXcoDSq1PYUcg5GUmDzH0qSERHwOnzcIPMZBEykDsrzQ4Ddy2Uq9IhYstaJVxDHNsJs9TQ5HnNZzGgfbDhmq9rAL0AAraVaAfy1kdWAaN3BOBKD6dsUIGimUwF5tRCQ9tobJCLL2mx8EB1NhscgR8qTGzG1cWgdsndHyqSCDZLA7pkLIUgLASdXp2BKGQjSuAyE5U0DEO1IgJJKheloMhcQWBSKXqfv6NAzA5AAGJ4PGzEHetAdNa65HPehzMmGq0PqfcBF9iA30fpgF+n9f7DGAf7vANAoHwOQeg7B5CBHEPIbQ4mK9xtb1Vs8UCzay6ICrocY2/YCbO3dtTA3FNXdO5DnoqKwFj4qOIA3Sy6A7K525AAPqRsjUtSQeRlDGYM9c0TK610bq+dscdfY0DQUHMNQgmbRw8MsKm9aSwUw0DinIDAuQ4AYF1PgRMkB6mcHMOyWxNqIB2vWtwYMO5vW9jNUbXCoCYAOkgAHSQp7MukoC2LYLuRwjhfsFFhmg44tNnsV8taAdR1BknXOadBwnGSLXjAYrTZz2QEHUIR0fGn6cB3Mhe5JHn2vvfdAajmZaP/oY8B5jYGINQZg3B8b16gI8fEO1YbMB2pCHagR9qggogblILkWRPCLC3eYP3aE+mwAAFFaB3jXPUtTNnxNrqk8yxATqaqTvchWhQXoi1BGgr2OQfTzXsDkFAaCERw5vpLpzcN1kYCI79b60gqOHQ2MwwzNAkOm2w/h/jpHABSGiDpoJE9R+jzHyFscWD0isOnhOUdaz7eTzuVPK2kGrUESw8FOAffF+wOHK09gvodLQ9zorV0NwcFgHAmt0cY9yFjhM3PBxVs3P/T+9bOtOFZFpJwp6/VEfF6DsAWO5Ky+rakRXaS4Aq6THofA6v9YGm14oUOBvOe60lcgGAxK5BWQRPDBE4ebaSrVRqtAXpSA6h3M6gPcBTRkzjppogzB4ZvBJPDOZrkXcR71lwe5jnnOZ+z7nlMBeAhF8W4gEveJrDSDxFX5PkeuCae52QGschON7YA3QPsndoRnHUPDaQQ+6+cGj7H1S7Vj0wepk0WJJJV/RS4DH0IafGCas77ARAY/iyhCnx2J+yFZ+8Hn0IM4jQmjWGr67tfo+4rj734vYWDP6x4GY6LKCxJvB4hOoCS2y1hNiiTQRLSyoOIbDbDURCDQThwbrNpmZBCPg/KHD+ycBsw4owCuAACEnARBygZAlBj4+uNeXOuONBxB60KBiOnA6BmBYA1BtB/slBpODugm4u1Uz4TqX2P2cm/2TYj4ca0m0Qcqxszu4hj4EOuoHkFO3kbQa8XWtYa8fuhA8EdkOBHkVaOhegehM6zAhhLoxhphVOXAzAGACha4okUuYq0ObhMAQQFODoQm4c92rhBa0ONOCOSOrOaOTBhuOOPOER/OxOguNiFOwRPhMOEAUktOBOnAjOaUMEUR7OyeRurBCRyOSRwhXyIuYALh6RpuNanh7u8uyBhA3uvuauyg1qQeWuOuoceuHOLBPOyATRpAnurRyuc4fuqggemuu+oelklRVasBHk5B3kyBqB3B4mvB2BaRoRQYLaYABBAh60ZBCBVBbBdBpADBMRnOJRPOxxAcnBaBWxFafBFxghixYhYANUZ4F4SAV4ZQ/WpQyAAipAjYj6c2FGyEIqqgWo2wXoIaC2n6AGVGyEoC4myEm2bG5g2wZEUO7WkQdUR0EKpIjQ/QlwF0aIqy7QexmyFwKKL0io8SyoX0tIZMeAQQ7m0AUQ6RsO5uMAscw6DoZUaSA8oQ40tYJsw6yAqkcYnARAEAFkccAA1L0F8rMH0vrPotSoYngHcd6n6o+MLmgLzIpmmlLt0EGJwA7CUgIPeI1joFqC6OGnYoZF2o6EmqHA6GaXtLkEkBGFwD2g3LtICpTCwJIGavyaOLXKOFwfrFAH5NCGukGbmnOHCWIH5G/lUmALHvPFHMmHKgHGehenEQkEEG8CWhCWRlCS9mAOoN+joIBhYFqFBrWRdi7ABrWW8FPtzgkF6G8NxnINXkEICq0E6WLIOEVrGQ4k6MbIen6uevPnIF6M9v3LWlWSBPNlRjRo2atkBkxixltuxqREuYOShkuauWgJee1K0JEJ4mDs+BoXAcwqJAiGYfiRkVkdtKkPTmjg6NtDcYMSbN+ZwEiELreqkZoR+TTt+fkQBQMfqakCBWBWThBdUTVE6n1oNo+KeZeeuaRpuVCductrufRvuSBlidthxqeQdqhheewC9leQxf3DeToIDLdtwk2E9sxQPNMhIH8SgNeG3PbKUEQNYF6L0BJdYNYESd4qcCSI0P4vyNKOiGskWnSdEi9HMkTBikknSDScDJ5PsDsHsAoIcJyPJdILyAEpdPCjdKFFSvdLiPSYMLstKGigkqKOeKUOQXgOpXJfoG8NYCSMiMpTYFigYNnIOLkutFklpBWJsgjJpXjIqEdDELAGCFDIxAFMIMxKxCziRMhCpBALRB+AxHum1OBCxIRNBF6HiVkHxFBcsLdIgT5ErP5APJmGCi1eFKDNrI5GEnFCVLQOoJUCSFAG8AiGkLwI0I0G8JUGkNYAiOXtICSAiOIG8NsHMgTN0rwNIDAOoAiIiAkNYNsB9tsNsBVBlMZTBDFflOlJcooMNQeLwNJW9e9R9Z9V9d9QjBVFVNmbgTTlFVKrlLFcZfkS1dXqUMNOIEgKAAEIoG3EIHgK+CAK4K4EAA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const hasRole = await Actions.token.hasRole(config, {
  account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  role: 'issuer',
  token: '0x20c0000000000000000000000000000000000011',
})

console.log('Has issuer role:', hasRole)
// @log: Has issuer role: true
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.hasRole.md","from":5892,"to":5954}<fsm-vh3gqscxm4e>
type ReturnType = boolean // Whether the account has the role
```

## Parameters

### account

* **Type:** `Address`

Address to check for the role.

### role

* **Type:** `"defaultAdmin" | "pause" | "unpause" | "issuer" | "burnBlocked"`

Role to check.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP-20 token.

## Viem

* [`token.hasRole`](https://viem.sh/tempo/actions/token.hasRole)

---

---
url: /tempo/actions/token.mint.md
---
# `token.mint`

Mints new TIP-20 tokens to a recipient. Requires the `ISSUER` role. [Learn more about roles](https://docs.tempo.xyz/protocol/tip20/spec#role-based-access-control)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.mint.md","from":234,"to":6254}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"46f1c80e43ab006ecc429ac40c2ea48df2c7b1c8e47b608bc34a4be0659f09aa","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScAGYArmD8gmCcWJJwMACqYIxocEFEobEwiJxipBZKFJywvCyhcCVgscwARmQRJS2MShZoADrZrOxcqaTpWTmmUBC8CAYAsrFyAljm8JzipWjlypykMFj76WASxskQ0RucTa1knC0YVz0kyXRsliecF/fhMJwAjNZOEFAW8hIo0BEAHQDAYAWk4ABEZg1OPg0GgsA0APTYoiMGDMKFwfDY6azbGxATmATwbGjcbZXKUajiJRzZDIEB0cSsBQslhsDicYApNKZJlwTiuGKkCDMTgAcnxhMVsLADIlkyCioALAAmayKqrSCIDXGcA3Wa0221gEAAXQdom0+l1mjMihUakQgK0kl0gU1E2Z8gsVn+dgcpCcNHIiGk7k8ODwhBI5H89DwITCkU4vBMXALYGi3RKAGEhKWlANBcN81XuiyxJJ9AAOSOe5SqJAANn9Oj0eGL1ZZ5ksSH1UccznjiY81C8qd8GeoAWHhb2MF4MEYWDQJQAKjHhLGkgAlbe7/fN11If7/ACs8i9PcQHu0gbw+x3e4YYYnRBdWnGNZyQNsk0XFMDDTPw1yzAw62FIwklMFspF9ABmTCX27H0PwDIcDBQkwx3DJBgJAewZzjSde0gzBoJ8dMWRoBCQCQrg0AgABrRRb1be9dU7BQ8KQZ9WUHQJuL4+0AKsSjqNA2jEEw3UGKXGCV1Y9cDDiBIzk4ZhegAZQwBIAB5KxLboAD4ghHMtOGs6sqlGXk9DIVESOEKEZMUKFjJOMyEihAAFRxmE8sYrMbJRbI6TgwrlYz0gs4ABk4LLOG4koAANrFoAASYAygqVw8oAbky7LeQgeID3ubpemq5Jsp/a9GuPcRT0SIRL1/fdWtcWyBjADy4FSHcjNM8zeBZck5hAeZeilQ8AEkwsNHLeMUKVuI2ZJxCgKAjjgGEwAGAA5CAaCPfBGClR6rjgOb8DlSBYilM8hByhwuAAd3ESYYnYP6/m2Hq4B+5JuIGNpOAsXg5FiWAoC+I77jkGYePuGBonYP59jQWJSGyXZNiOd50ihVi2Q5LkeT5XAqDytnclrIZhVFXh9nEGgXO6Kp0UxaVZXlJUAAEgaUYzsQLfY1UGIUuFFGghjF6IUqlmW5YVmB5YcCw4CVziRR4PrhE17XFWltk9cJ7F1bYJWBmLMQGxspROAAXnzPmBbioIMra6jjZKZBnYgZ0ash4QVdREPss4SPCTYKFGCgB0ShFrAggiCgavcAZXDNS6Ek3I4li4P3xCBnILbOc7/LAQLZoSBy4qqJOdpKRVCqhQfjRquqGpKQFrDAQu2pbvuB6H6fS4GNm8sdCguXc5gWUc72EUFpRaedDfIpZTfoqlBEIpjKK43OteuWJ0nhBZQ98Ahk9octrdBq4Hr0ZgF4XAoD83EIfZ0IB0L6H+O6XC3pwIDi/AYIKaAQrzXkhRECsYXBAWsBpJisFVxsUCDmRg4QojuyLHFCscVOYq09qOF0glfSPn7F2OBiBWGfiIlROKZFAKKWjFg+Mup5zJm8AQnS7EgiHAgDgDgGAoijxOJ0ZqJwBIYX+L2NssC3ycMIoEJR/4zDkUQBJJSQjJx4PEdpTMxDQikLzMGSU+RCjFC2DsSo1Rtx1DkKiG4bRSCJS6D0E4tD6xOMmAtFEeBFjLD3Gsb67iKhbkOPACE/MkhfEuJsfxdwHhPEYC8TgYIPhcG+C0X4AIgQgmsCUiE0J1QImRLMHOGIsSIFxCqIkJIyQokpNSHIBI4D0nFCGUwEh2RIE5NyWgvJVgsw4lzVWYoxhalyNbCWyoCTMFdhqUZzi9SGmNJwU05psSWkNLaK59onSMI0eoVhol2F+kkogkAETQzGMAmYwRYFfS4IXIxaxLFbHZhkXIzAURcqcD6CAQq6gDRQEwo+csvBey9jUuWawj5ML6mkPqR84hMItDbLqXUAAhXg0gYDqEfNIR80RrAtAAKItBaLC9R+hDQiVfD6KcrzuHcT4VYVh5i/n6iscuEF8FiHgrIJCnaskSiwsKoaXgVyNWaq1dq60HK7lcpxTon0EkuHSV2nJL5VgPRipUhKwFmlmJwSIXgcaUVJpOD+O7CACgBgFFIJ7OA3q3HWUDfyKgi08Cvz+HlL1Cg8pGWgEsP4Mj8SwESXAQUCgvEtFiEoEJ3tY0Q3+ojKUGbjJyEkDtcGAwABS4gCgmV5n+ANQajLbgcNkOACoU2ZxgOjfJAMYAtHuHKAG6QxgXQGFGhNUAk3FNoAnHKAMIClBwLUUsvAGxDFKQ0dUAAqHgnA8ohqDfG5G4QpQAxyPgNtqhoCltiPYDYUoY0mCDVCbGSh855SqK+4Q76yBylIN+w66M/2hpgFCIGZMQOqH5vmHqeNOBfT7VWgG5QaBVp6o8G6sAoQACtS3bBgLyC6B7uCcCUNjCpcgj2FvjcbCQCRPVxVJqhg66GcgQxXcgPKMidxwHOmIaYVI8oOiCLnHE2JICwEI1CdgShekUgrTQMQcIiD6l1FCWg2JxBYEYPSOUAnzromYHIAAxPx+Agm0AichKBgYvGrOCeJLZwDYmJNtKkzJmAcmFNKeGSp+AaB1Oae07p/ThmZjWahKZizzmbOwFIIEqEnBp1UYgDRujb640IeSAjFD6Mr13qpIjJZyTVDRp84gejM6k2TrAAAfT3XugA6pIcmSgWuNfun8DLWXC1fBaPh7caBFRShvoQKA319jXF3JV/17tHo0BOHIDAAxXoJHekIeqUpzB8XBiOiAY67jcDCutfab9HhHEJC0BQVRID+skEWmAjwltiAhGtgY4Q3ofV25wfbfxQi0dum/f1uHIOEfcSR5g51OAmRgC9lOeVICYd+glzg61sQAHkPOSY6dJ6Avnzr+cWtiILamNNaZ03pgzCXYtoDM+Z8QcJUcwDhEIOECW4SCCiATUgAxmCE0RiWdgzAMlCAa8y2ZzNkMZt2JVyj1HQjZf/XGxA6oV6EbdjlyDn6dRvzkNjTgy7SByCgIqCIrULTJVWjnGARuV2m/N1UA6wn6r9ArmrvXEAv2KkN8bgApCbKoipncW6t2cpKOxcj28dyb9gLuq3u6pDr73UJAPsCCJYAGnBmXJaz4qVrhBZFwCqIGybySKnowcFgHAlgI+R7ADbmPUpM/+rddDXQoGthOFxpDaabu3PJY18385WV89AZKMXiApfy/yj0A9XY1e0R6fr32qPyd4PIAAaEbOj5mGb9qlwRt5R9xQlIPEdaYBX6PWskQ4E1WiDMCwvqX0bYy4Wi31wbHw3RsX6vxvwejgHvwCEfyJ0QGf1UmsGkFUg/yPyyng2q16DIHGjkCi2M2xDoG3CpCSHfHUF9GkAQI2C4B3wKDkAdDhHQzXzIA4UQH1H1GIPg13zkFP2bWzwgJQLJlCAwOsywNoBwLOHfF7A4WsE/3H2P2uE4JOFQJ4PFwsCwPIMazKmUHoMwlUnVAoWuA8l9iVFa0YCN04HPEy2NiEEVFakLSgw6yCDykRB6l0H9RKldRgFcAAEIkR7CyBXC8om8W87cPDlA7h9DDDjCuh/0wB3C7DAjSBXDXcV1hNANl42Z1Rpc5ks0voKs34j0T1ctz1BNR8ki8ptcvcPYPddDAwTJiNeQTIF9CAAZ84LDNxANyi9BKi+ZmAaioo6iGi08PZmAMAci/g/Yc8W0FAoRBiggPcqhAMm9BcBjdcP1fcDcHdjdw9LdrdzlbcThUQA8ndE8oA4ivhU8wB+jBjFi/ddjOBg9jkw99j1io8tjY80QVi9izcDiq0Pc5izj29s8YBc9J9C8Z859SgF9VAq9jpV869FA+1LdfDNjW8I4ATSBp8S8sR59K9l8ITa918s5DjEjy4tDnDdCi8DDaNQjTCwBzCviFjoMwAbCoiHDOAnCPI3CAiHDvC4To9/CGSgjSSjCTDwjIjPCYi8TktCi6ZJkUAuR0gFlkBA1SYdxxN8dcQehVBYgWgoQCxmBCdZNhkfNsQ7tMs8QwsdNzAWh5YFjCMIhHRwFIEkBMIXknk3wCIpINxvdhV7xbAqJfkVIAUxEpUnVdJghJtoAogzj9dO82QYAAB+EobDKoQeeTfcJIUIK+XkVEbDZAB0RKIgCATOYEAAan+C+HTGxmOmtPDWiQMEeP2hXTyhTzQHjWKxvRz3HEg04FiRWCzQDGaAhClF4EQwRlSEEz7SqGbOrRsjGC4EK2fUO0ODqFIEeEjO7z/g2EMOOigEGSEBVxnPCFKHVLEByFwKEF9VcVLRYAMMrQOicxj2iCCEwgiDxzaQJ3FzAHUHkx0HJwsFiB01fK5yjOGVfMwkM16GiChEwgZzMzLiCEVx7Kim2I2Fm2BzFBHPRmvLylwLkChH53FzQG/SVK8wJx8z80/LJwpxCyp3C1p36QMMgos0wpwv5kYpCwDEiAaXLi1zgF6MoQal0MfEaPT310VALDHiuItyqBEpOE5JrJKEksamfGT1s0+JKPfSErksQGOTkukoRIbFEoUqHzs0KPVARz+F40wuwrF35nws80xG8yJxIsUzIv5mC1C2pwiwM3Mri3MwYssrQGYrhFYr5zBiF1mwsGYqSFpn9ElOmXlx3BZCIGsChH+CSutBtP1XtP+G0TYTfBwgFUCE/Q9P+UwT+QgntXwRsRlTdI9g6j/CPA/hhgGk6k5XtN1FyqdPwgQW4RqpvHQSKu9JomwWwklS0mlWdQMGkTlAhQURynqstgAAlwh8B8pCoSoVClAKoolZg8AFqSQsk/pno45P4zhmrVJHweUxJmFOrpJZqzgdq1BeqXkbVsFhJhrWQlAWRnC8ACr0rVItEjUkAvSxqQBupepDIHASQShCp/h9Q1IWF1A2xpBrBxAWheBYBohobYbex4bEbkbUb8YMbdQ4aEakaUa0aCaiacbSb8ZCrobirfTXBwECxYAmAllzYfIpQZQtZNldYDMo5TZWbRQPkObxYFQtlVQwluZ6FugNlRaoQLSvZdktDRRuquAZRa564uB2a/JzU25go5pO4vZu4R4hdRKhadRAQoRHxjlewC5Y4IA55aAEV9QkUUU0UMVdQsUcU8UCUiUSUyVKVqVaV6VGUWU2Vh4Z5zUHa1UdUY7Y7bRw6l4CSFihKQajrMlwalrjkVa/Ibqkg7qy4WQb5xAkBQAAg9okg8BmRXBXAgA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { config } from './config'

const { receipt } = await Actions.token.mintSync(config, {
  amount: parseUnits('10.5', 6),
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Transaction hash:', receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.mint` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.mint.md","from":6594,"to":7107}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.token.mint(config, {
  amount: parseUnits('10.5', 6),
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args } 
  = viem_Actions.token.mint.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.mint.md","from":7134,"to":7318}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Amount of tokens minted */
  amount: bigint
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Address tokens were minted to */
  to: Address
}
```

## Parameters

### amount

* **Type:** `bigint`

Amount of tokens to mint.

### memo (optional)

* **Type:** `Hex`

Memo to include in the mint.

### to

* **Type:** `Address`

Address to mint tokens to.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP-20 token.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`token.mint`](https://viem.sh/tempo/actions/token.mint)

---

---
url: /tempo/actions/token.pause.md
---
# `token.pause`

Pauses a TIP-20 token, preventing all transfers. Requires the `PAUSE` role. [Learn more about token roles](https://docs.tempo.xyz/protocol/tip403/spec)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.pause.md","from":224,"to":5001}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"a6393fccb27fa70eaa319de7e39d7a619889bb2d3f5ab63be266ef0351e444c4","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinIxwAAriAK5wMFCpAEYQEAriYKXlUogAHP21yqpIVy06ekzrWztQXRZWAMwDjmcoyuE2oXmmvjm1ACi1inFIMF4MEYWDQqQAKkNhMNBGAAEqI5Go87afTSW4Ke4NGraNp4BFIlEMeQ/JD/ED2QEjPogjxgqYGGZ+aELAz5dhcIy40wXfS9ayyO71DTPOkGKUmb49RDszlDIFsxqgzACnyzUo0UUgcWFNAQADWihJFT6vRqlOViAArKrXgY7Y6ziztbrBsMXIhKpVjeDBZCLTCDAlNmB+LjOFgPjAAMoYVMAHgyiWSAD4gh1kqki1kKBnHMw9GQ4KkNcIAHQBxRtzPbHN53htjZDBsjOCF4pKEsRVJrUgQZirGD5ns7XOptsEtCbUhgABqoU2MBLuTA4gbcEzSLrvbXvFKUAgvAQBg2vbgnHEnHRAEk1gAmaxOE7MA21yXIADkIBoDF8FWFZ30/OB+3wOdIG2D80yEICHC4AB3cRGDQd8EnYbCYCArE4BxLC7VyfZyIsXg5E2WAoE4LDP32ORH3tTh6JIhF4T0bc8mUD8hIvEwYDbC1xCUZ9kGQEA6DPLAFFKAADLSiNyG0uGAaIEXEGhq2SWt8DQNAsE4VxOASOdmE4AByAABfClAXAB6GIESc3TWAlTgDJoAKbLshznLcuSvJ8mBvIcCw4D8vIAsKAzW3fWz7PnSL3Ji9g4pCthktyJY4gnTgAF5DJgYyYFMpQgmAXJOGiBLhFSZAiogABdCgWoo05JI4ZsgoG1qupgAK20YKAetSCyrKCCJ+rAVr3FyVwIjA1M4QROBNjkLhqvEfDCJ4TD22A7ss1vcsJ1rZq1qAh1FFSJzrFoNtvqc1attyLSNJAPqlMzYdSgrJROAAWnSCcZJBkAwbPUpkZHJsYc4Icz0bUg4ARiglIRLcd1MdF8HItBKOotaGSJLhTjYmASDALgoGM8QEb6spST6P92Q9B4xl9QIVz7VMtT+AF9W5b1rBjU0hShS1AhCMJIiKYRyuLFI4Z1/yCm1zpRF5xBel+AW6iF5pqFaP0OQnSW2Wl8NRkaeW+RNbwlYTK0giwOccA4DAomA1JshAT6AN4axY7j+OE8TpPk+sCPnUuXpKh9JUhez2l7eAp3Ixdg1ED/BXvfjeZAlPc9L3IpZjhgXIiEkTW4CbqsTCb+9H2fEByfIjTG4UDTOGYaBDvIgPiFm+BxLgfIFE4WB9k2JQlAsKGR8pnD4M4ReFzkNu7TI3IAClxFb7NeFIJl26b8fEQcPI4EcmeiDntj9gwThcJgfYfE5y4R2HjUCYBciD3HpPZedBDbvjQLhCAB8cC8EYEkXgRQAqWFZs2HaAAqHgnANJFg7qPaIx84DvlwoRfAT9VDQHfAdewH53zD27goNs3FGoRA0rWdhwgm5tjIHOUgy0x6M2ITvNs+EdziOwsZaIpw+LkV7GxU+uE740Beh+MAv9IKwDbAAKyYVTWqzBwGEO4JwJQ3F9ihCkRwmAY9EoSFTA3Cc25dg6M0YRSmyDkAaRnkiKhbYxAPk2GgDSPUgiLSwM2TynlICwBMW2dgShPIPifJ5Y+NAxDQyIH+SobZaCeXEFgRgnlgnwHxhZZgcgADE1SqHhIgJEqIjNciBOafjcJIjomxMsvExAiTkkwFSekzJfccl1XyYU4ppTymVJ6W2OpjSel9NIKQCIbYvwUxsXYhxAiyHOKUWteinA1F/1oW0rgekt5kWIWMxAO8x4TygFPcBuQAD6+D8EAHVJCiSUH875MFyK2IgPYuQD9l5QqMYiNATl3wjkIFABCglLC0LIO3VYNBWZyAwLkJCqYUJCDae+cwjpHn7GAaAngaxvwIIpr/faU0uIwFrJAUgH5BKqBgL/JYeLFBoEJbkcIyFUIUs4FS8ioQYVQQpjygx0kTEHzMWefGnBswwF3uRQJkBtFYR6Zwb8nkADyAy4kJKSdAcZ+NJlZLgDMvJaAClFJKWUipVS5whNqWgepDTxDQ0NTAaGQhoY9OhoIKIAlcgT0EhYASzBjK4i+WAAAorQVSy9tgPP5QcqFRzXmIB2oDExpUnFcIgI1JyFM5DcT/uwOQUAnIRAANy5ESVjO+uCFowAbcgpBpAW21lPq0yJlbBGcO4UEOtA7G0AFIkq1icsOltbbO1gG7bOCwRF+2DqbSOqAY7kETrQFOk5witnsCCJYXCnAM03rEU5f5hAIDxNrB3VFDz7FsQcFgHAlhW0RA7V2zyPa93vhEaRc8VFdC6LYuUXgvEqZOH8eq2AWzS3bog61J9ojUhvqOJ+g+849CwTEn+zgAGgO7HA61RjijkDM1CPNL0ZsvQMcYx+LgN876ojbKQFM34wDk1WEWFWnA712sQEQZgZtfh/jNlcbauGeO8c4Oa/YCL+BCZE2J2CcBJMBGk88+TOoFQ6lU9xpjXBnl7rIKeOQPrHw1M8nQREkTcSIHUOoM20hbOtWY6xuQPVoaaPKUHJoZc/xBc06F/j98ZOwEQI5ncoRXN+o87QLzxgwC+caE0awanu08cUQ51mTnMsposB51uchvliF7SkfmOodplU4LXci1VX2MAbZwPEULEpCCclu6RsiwBBA0gAEVOLoHlAASYA3XXAAEJOBzeUGQNbGkwPqd3X2zb82cX/P6zCob+wRtgA21thba3T2YZEQDLSO0s05tUYvMSBaSFOLHkxcIeCIFgHLXAS9XBblVRsXobMGrmDZnI4QXCy1xtwhEVDtosOjLw8RxAZH+3OvMAwKQx+1V72wukiThQQRbm1hEft+NxOq2zvnYe9dIGt07t7fumjC6h3NpPTo25jOqfSRZ/WpdK7nLs83Qxw7POJf8+PY94XYAiei+vaIu9MAH0Edva+99pHv0Ud/eIf9UXFC7DbftrnUHOp69IERw3cAv3kdUKb83gHLdzUe894HnXutQ76wNy712xsi6rZN6bd2cXLdW7dk7pBds24g/L0aMeeVnZD8NwRN3jvbaT77rZL2gYtHkkgRSZRdWlGQB3bcSIYnWpGZ5TeqhNj7DbDEZgtqUnOrGZ5LiULPLzM9eYfY3kq0mIiMDbmsokAAT/PIK21IRawmnbgYMVgah6ldkgD2kxK7mmrngIIqLoBRA17OuDckYAAH5UinAwLWb6aTUS4lCNjZgo1H/IB6tOTgRAEAs00mAA1L0OxLMNxGbtPlQE6ngGnjohpOemPDQqoF1jrt0NJJwAALKHQCBqRyo6CbANi4JnIqJ1hUK7C1ioF0L8q5BJB4xcBXLhCPIBwsCSC/zX4IaSLyofhQBQCETv4wrMFMLt5iCETeZCAtwHjzyHz9YnwBJBLc4JBBC/C8KN5DLN4ppgDqBpI6A5IWCbClLaGRo37OraG/A+p7oJBti/CrIBpyBqZBAFqtDEEioYpyoDaZiUHqKKHeZyBtjJrGTiIaFWQ2pjITL6FOourwBuoj6LLer+H2GBr+FBFoBpHQytCRA7JlpaQVq7RaxFApjHScBeio7r7Vq1oxDFGpCLqtq1jVGswp6QZHaNFoilGPbnqXpCIs5tGIC/RFFNGc6p7c6jR9EdE6JdEg6vbA46r6oaRJFpEhGDJhHN4REOpRHTK5KxHuoLJeqVJJFrINKpHsAprpGnHGSZE6AawCTQKJqJAXH5YyRl4KRKRfZIilBEDWBti9A/Gxwz4mwuhlzyhL5UjOy2wvCBDcJFzb5hily8gH4QhH4ijtBwirCvifAHBHAnBBg8xAl/h/hPA5wNBEn5yBDolZhfCb4qgchwmyx/hGieyxi2xKClDdZ4DQmAmXD8xEmCwNC2Aol4BMrXiYkUSHhFyKg76lzyzcwxCwBMCpT6QXT5aZThQ5RrrRSVLdTJR6RBSaxZBhTZSORORtgT46wlQFHLAGQUlqK1h0z3y2QnRnSSiXT4zXRix3SQyPQDRhzORRzWAxwpxBnBmJy/SbRqbdEzo1pzrClix7ADE2mfBqalAjjiBICgABCKCLxCB4BEQgCuCuBAA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const { isPaused, receipt } = await Actions.token.pauseSync(config, {
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Is paused:', isPaused)
// @log: Is paused: true
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.pause` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.pause.md","from":5342,"to":5738}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.token.pause(config, {
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args } 
  = viem_Actions.token.pause.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.pause.md","from":5765,"to":5961}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Whether the token is paused */
  isPaused: boolean
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Address that paused the token */
  updater: Address
}
```

## Parameters

### token

* **Type:** `Address | bigint`

Address or ID of the TIP-20 token.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`token.pause`](https://viem.sh/tempo/actions/token.pause)

---

---
url: /tempo/actions/token.renounceRoles.md
---
# `token.renounceRoles`

Renounces one or more roles from the caller's address. [Learn more about token roles](https://docs.tempo.xyz/protocol/tip403/spec)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.renounceRoles.md","from":211,"to":5491}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"30d2bdf2635250f6359f0da611ced8b75cdd1e915d48aa5fa8de4385cdfaa662","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinKQwvDCMWGipACpDwsOCYABKaxtbpeVSiAAc/bXKqhotOnp4q+ubDPIWVgDMA0czlGNwm1C8018c2oAUWsU4RFCAFcYKlVuIoEI5BhOMBcpwCSsIApUgADay0AAkwDEpAsSlcpIA3PjCU4YkiwNtOOSqTS0HTlIyWWBCZw4IpYKQyRTqbT6cLWQSHHBjsTUZwAEYQdXiMAi1zIAC6l20+mktge9SQAFYXm08Ii5Ciur8kACQPYgSM+uowZgpgYZn4YQsDPl2FwjEdTFd9L1rM0rU9EDVtA6DNGTK6eogPV6hsD3X9/RCg1DSjQwyAI4U0BAANaKU0VPq9SryOopu3UVpvAz1ptgHP/QGFn2ISq9UuBnyzSuwgwJTn8I4rRQQFcwNUKOAAZQwYF4AB4MolkgA+IIdZKpM9ZCicLCOZh6MhwVJZ4QAOkHim/qyQFuO7wAeR7fgACi+b6kHAp7FEoF4RKkEGkBAzCMBKx6AZuR7buq+6Hrw36nGgSKkGAABqyIwBeuRgOIr5wM+6zrkBeEgYRR6lJivAIAYpzsescCcOIRIKJwCTsKJnA7AAkhBABM1icH+YDfrkuQAHIQDQuz4JhnCGWJcBEfgaFASJhxCKpDhcAA7uIjBoCJUmkLZMCqfscDWaK9a5JqnkWLwzqwFAnA2WJmpyBAvANlqMBuZ5qxkRR9IyaszEmDA36VuISj8cgyAgHQjFYAopSklVLm5LWXDANE6I0PeySPvgaBoFgnCuJJaHMJwADkAACjlKBhAD0MSrANtWsJGuKqTAc3db16GDSN+UTVNMCTQ4FhwDNeRzYUDVfiJPUJH162jVt7A7TQc2HbkSxxAhnAALyNTA4jNQhQR4qK0R7cIqTIA9bBGhQrICnqWUcB+uJKpwYNLWw36MFARqpO1nVBBEUOA+4uSuBEmlHvCmVInIXCfeIjnOTwq4mL+jb/jhwEEWBvDXghj4AwSampANFLfqLA0EwSaG7qDA2YXAKKkANkPE6TYBVaSICQ8Vz5DMwpQ3konAALTpAhuVayAOuMaUVuviMIkm1BuswXA5sUMVKXkcIpQ7PgnkwwcTOih85xcHq4UwCQXKcFAP3iObkNlGafTKZ2jwNL0aZ9oE7McZzREju6Y7DC4k5+h44KzsG0JVoEIRhJERTCK954pKbrezQULedKIyeIL0fw3Gn1pNPa/aeghhd5sXRZNDaM7eNXC7VkEWBoTgHAYFEUvwKk2Q1nA8tkPvxottcvQ2paCjp7aY85wRU8dp6gwl6MikL5C87zHXa8QBvmBREFpwfeFJlK8GsBAyBUDoEwNgXA6w+8z7xnUPca+I8ezpnHmpKePYCyvyQO/CuAZF4Vm/ngBiTEWKeSWOqXIiJ3I0JJO3OA6oeKxX4iAX2nlSSMJgKSTgzBoBU08r/IgGN4AyTgPkCSsBNRIiUEodKvDbI/SMiJKRGE5CSFUhADyuQABS4hER7l4HSLYTcWESVfF6PIcB+qiPEeFTUOJ7IwE1FqNC9kJSwQ0mAXIXCBFCIknQLuIk0D2V0cxNYjAki8CKHNSwXIPxkwAFQ8B5GeSxfDohaMPpweyzl8ACL0IQKA6ikT2FEiJHhJh1TfhikoPGpJHw1OEHUsgaFSBNNEmAcKrSsnfkchRbpqhVG8D1AlTgSIJThXrPkukNAdE9JxDpWA34ABW6iBTfWYL4tJ3BOBKBipqUIPJeH8P2hIPCTcsjkRgLM3R9kFn+10cgUkv9hKuzEJiJEaBSRGiCDjLAH5xrjUgLATZ352BKHGrxOA40tE0DEEbIgilKjfloONcQWBGDjQ+fAV27VmByAAMT4sPt8zcaAojh1yG88lXy0BSlIP8wFHVgWIFBeCmAkLoWwvYQin68A0AorRRirFOK8VoU+d+IlpKGXfI6REb8sk/aHOOac/p6p+HjNFIFKZMz8mFKpUZY6AhlAeR5NyxA5zAlQGEb43IAB9FJKSADqkg8jKFdU6/SnkjkQBOXICx6oIqanWWsNAA0RJ21KVZVYnBLCFLIBYzCNAuTYlyKZI85khCbhEuYJslrNSeO8TwCCckwl+xxJlJa0UYCPkgO5SQ/tq2prEIoNAmaGLZvsBZfNnBC2eVCMG3Sft3KrJyps8U2zGKu04HuGArbPJvMgIsmyDLOByXGgAeVZUCkFYLoA8tdnyuFgqkUitReizF2LcUMtlWgYlJLxBGzXTAI2QgjYMqNoIKIblciCITRYNyzAfpHEdWAAAorQMqElpnpVUP6jVwatUKFJIgMm6tNnPVqQoepEBGkDT9nIGK+T2ByCgANCIIpQWcFQhYFy2MYCkceRRqAj45mUt+bhtp+GGlBGIyxsjABSA6j4BoRNIJR6jtHxr0cFExzgJGyNSco5xyJTKqW8YGR09gQRLD2U4FB0gnTBNusIH/OAj4WGxvSic8KDgsA4EsFRiINHch0YY0kzgen3JMR8roHp4VyhxS8k4F5M7mWYbAHRgkJnOmpAszqYFNn0IlPsxiZT2KXP3M8/JsUqjkCR1CFjG0/cbT5bFKJLgJizFoAApyOSYBfaYTPLXTgBnj2ICIMwfufxFL9xuKrOLbIuA7vDZGxrYBmutbgO1gInXrW9bzNYaQeZhtVcK1wa1jGyAMTkFK2KBLxp0DWL8o4qZ1D92kFtsbyMStyCNEbJ5OWyBNEQIpRSd2CSqMe3Vr4S3ut7YoqEI7nzTu0HO8YMAqZGhNGsCNgr93dtcn22DsDFhTtOidfKZQn2/h5jJi9RNjFPKfQGm6xgpHOBqk1PtIQA0RS8MGZ6oIpIAAiepdDuWpBQmArgACEnAufKDIIL0kHnYvye80p0XPPOBU5p3ThnYBhfy/FxpqLHTcjqzJjBuDnkEMWqQxkvD2SQrhGSX4tWVUcPk2bhFX5H1Dl6D3LO5ge50uEHsnjZn8IOku7aO79EnvvcQF91LknzAMCZNDZ9QzIb8Nx4UEEKlj4lUikA7H83BGiMqbY9JtzcmFOMYRgX8jRetfabADHlPOUBNCdY5wMT4tBpqeL1V2X5fhOF/U0smvdfc9+YMzAIzCX9OU8s6l8U6XVCZcc291z1GpdecUwjZAE/pSK+n9Z2fdmLUOey85xQ9zIZLJ1zbkn/OXeU+p8GlXbSwBM+z/X1nwzOfc5TXzsnQuRdf9IAl1Xxl3X1SA13ciVwf0DVV3VwAMFy10v3VjygKiQCKjKCXVKGQBYXInWABQPU5XGkUVUCRE1G/BiGYCPQhXhW5XGmikDXGmvXFXME1Emlz02QiE1kTjjAIUUiHmTAaCzleHaHNynj4LwVnmsA/nLC/lDDrljWgCiDfwEwC3yhgAAH5Ug9QMBHxRYoUtgjhQgnY51NCwAMBjRkIEQIAMZOsABqXoCKWYGKDEDgqgOFPAbvJZUkbjP5I1VQRNMfboHKTgAAWSpgEHKmHR0CRFfB811UmWfEPnuUfAKT8KQ1yCSFgi4GmXuSqUtTXhYEkBxBUKC3DlEhpwxCgGcgMODWyPCnCHFBILEGcguyEDoRonURYGp20TmXpUUwSCCD+AiH3XZQILAzAHUChR0ARQsCRExTGO/VUPhTGL+ClUYwSG/D+EfWJVViCFN1aGiM7XjWHRpwSMNR6NJAuzkG/FAx+iaTwPZUPW5V5SmPPURWFVFRvQlVxUuK2NJUuJuLQABKNlaEiGVSwztzgB01ek5Bpk4BtH9z4wb0I0Ew5C5FSBEyo0fFROpRL271SGxNSDtCWW8J0zqUbwJLb2xOANLySXxNwm5CJK4y0x41t1JDJkXRXQuIECuIBLuLZU6keOPWeJhVeKFWRUYNvUlR+LlRJX+PYDA0BPlJ+mBJ0EbjckCWA0SCVJh1yhaBQJQGKikTwlKCIGsG/F6HNIgU4N7lbAJyTDQRTA9EwUCAaVEJngnFBCITLDnBDFrjhEdydBRDRG+kxDAGxERkBklnVBlD5DxwZGZCRnZHpJjLlAFAVATMjPFElHex5FlH5EFHjJFDFBVBAlSG1F1H1GJlPhtOuEUkaCvi7AaAwWzkdBojdOfm9FLgGykJ9JrkXGCF/n/i3lpxDKxAwG4FM3EAwGPB2AvHqUbNSDAGiMCmhDcIMAAHE9Aq1PIHSikIAEhLVJAhgMAVU5s1EZIlzmAVyIpLBlNkhx0VE/I1UDIlA/ZlgWMlpO0Y5EpfhwoLAelRJJyTykECFGh7TGykAkxnS8Bdz2zxCJxB4eyJAlBSh+cYLCMQLPt1An5YKbAyEBICI2JcJ1goBUhegp4Ex3TS5JDE4YhYAmAzUFozoVpLo1pJNNpcVwYIBDo6oFoDYWKroBpvxWDW4noHdlgGoQ4vhHxAzPIepaZ6Yowg5XY1IAINwOZdwuYeZW4+ZWQd4N9ZZD4FYlYJYdEhwhZQFrBwF4EbLbKYFxYVZidc9G9OIiKtxSK29ZL5z05VZSg7ZxAkBQAAhFApEhA8AXIQBXBXAgA"}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const { receipt, value } = await Actions.token.renounceRolesSync(config, {
  roles: ['issuer'],
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Roles renounced:', value.length)
// @log: Roles renounced: 1
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.renounceRoles` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.renounceRoles.md","from":5840,"to":6269}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.token.renounceRoles(config, {
  roles: ['issuer'],
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const events = viem_Actions.token.renounceRoles.extractEvents(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.renounceRoles.md","from":6296,"to":6708}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Array of role membership update events */
  value: readonly {
    /** Address that renounced the role */
    account: Address
    /** Whether the role was granted (true) or revoked (false) */
    hasRole: boolean
    /** Role identifier */
    role: Hex
    /** Address that initiated the change */
    sender: Address
  }[]
}
```

## Parameters

### roles

* **Type:** `("defaultAdmin" | "pause" | "unpause" | "issuer" | "burnBlocked")[]`

Roles to renounce.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP-20 token.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`token.renounceRoles`](https://viem.sh/tempo/actions/token.renounceRoles)

---

---
url: /tempo/actions/token.revokeRoles.md
---
# `token.revokeRoles`

Revokes one or more roles from an address. Requires the admin role for each role being revoked. [Learn more about token roles](https://docs.tempo.xyz/protocol/tip403/spec)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.revokeRoles.md","from":250,"to":5786}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"4331bbb216753b0e0d034449438e7597cb718b5c0bcc79635d29f21308e5a7b9","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinKQwvDCMWGipACpDwsOCYABKaxtbpeVSiAAc/bXKqhotOnp4q+ubDPIWVgDMA0czlGNwm1C8018c2oAUWsU4RFCAFcYKlVuIoEI5BhOMBcpwCSsIApUgADay0AAkwDEpAsSlcpIA3PjCU4YkiwNtOOSqTS0HTlIyWWBCZw4IpYKQyRTqbT6cLWQSHHBjsTUZwAEYQdXiMAi1zIAC6l20+mktge9SQAFYXm08Ii5Ciur8kACQPYgSM+uowZgpgYZn4YQsDPl2FwjEdTFd9L1rM0rU9EDVtA6DNGTK6eogPV6hsD3X9/RCg1DSjQwyAI4U0BAANaKU0VPq9SryOopu3UVpvAz1ptgHP/QGFn2ISq9UuBnyzSuwgwJTn8I4rGBERswNUKOAAZQwYF4AB4MolkgA+IIdZKpM9ZCicLCOZh6MhwVJZ4QAOkHim/qybk2O7wAeR7fgACi+b6kHAp7FEoF4RKkEGkBAzCMBKx6AVuIH7oevDfqcaBIqQYAAGrIjAF65GA4ivnAz7rOuQHbuq+FHqUmK8AgBinKxcCcOIRIKJwCTsEJnA7AAkhBABM1icH+YDfrkuQAHIQDQuz4JhnB6cJcAEfgaGQEigmHEISkOFwADu4iMGggniaQ1kwEp+xwJZor1rkmruRYvDOrAUCcFZwmanIEC8A2WowC57mrCRZH0pJqyMSYMDfpW4hKLxyDICAdD0VgCilKSFVObktZcMA0TojQ97JI++BoGgWCcK4YlocwnAAOQAAL2UoGEAPQxKsfXVawka4kpMAzZ13Xof1Q25WNE0wONDgWHAU15DNhR1V+gldQkPWrcNG3sFtNAzftuRLHECGcAAvPVMDiI1CFBHiorRDtwipMgd1sEaFCsgKeoZRwH64kqnAgwtbDfowUBGqkrXtUEEQQ/97i5K4ERqUe8LpUichcO94j2Y5PCriYv5bipOHAexYG8NeCGPn9BLKakfUUt+wt9XjBLnehAtCyLYsifAwN9ZhcAoqQfXg4TxNgBVpIgODhXPkMzClDeSicAAtOkCHZXrIAG/RpR26+IyCRbUGGzBcDWxQhVJaRwilDs+DuVDBwM6KHznFweqhRuihcFAX3iNb4NlGafQKZ2jwNL0Pbpv2ICs2xu4cyO7pjsMLiTn6HjgrOwbQlWgQhGEkRFMIz3niklud9NBQd50ohp4gvR/EmChZ0gSZ5+0CGl3m5dFk0JY1wG3j1wu1ZBFgaE4BwGBRBLzCpNkIAUuolRyVAfw2mkvCNI0fyVGk1g2n8cnSHJNriH8mo3JUlQACFeDSBgOoG00gbQJGsJqAAopqTUJ8WzXHbDcTO1pJz2nzofOeHZPSDArqMOSM414VnmE3beEBd6YCiGhXcx8axwGVmQE+xokH6AUnJNB3ZMGBFofAOePYCwEKQEQleZY5whkbngLeO8yDUKUszehFIFK8GsGo9RGjNFaO0To6wiDB6tkQHJOSHpx7oNzn2QIyk55JiEYvURkwSHzjIXgOiDEmLuSWOqXIiJXJeJJN3OA6ouLRV4iAQO7lST+JgKSTgzBoAU3chQogaN4CSTgPkUSsBNRIiUEoVK0TrJfX0oJDJGE5CSAUW5XIAApcQiI9y8DpFsNuQTRKvi9HkOAvVkmpNCpqHEtkYCai1GhWyEpYKqTALkCJcSEmiToH3QSaBbIQHFDgXgjAki8CKDNSwXIPwkwAFQ8B5GeNpMTogVMYZwWyjl8BxL0IQKApSkT2CEoJKJJh1TfiikoHGpJHxfOED8sgaFSAAqEmAUKwKLnfnsmRSFqhim8D1HFTg5kYChXrLcukNAql6hxJpWA34ABWpSBSfWYFMk53BOBKCipqUIPJomxN2hII8niEKkSxVU2yeLg5rOQKSCh6xGHfjEJiJEaBSRGiCFjLAH5RqjUgLAcl352BKFGtxOAo0Kk0DEGbIgclKjfloKNcQWBGCjVFfAT2rVmByAAMS2sYZKiA0qojR1yMK11ntJVgtlfKtqirEDKtVTAdVmrtWhL1V9eAaAjUmrNRaq1Nq0JivtWgR1LqM12oDaQUgERvxSSDvSxlzLYXqliai0U/kMUSlCnc1QHquA1VSqoSJEbECsrmVARJUzcgAH0jlHIAOqSDyMoUdQ6dLuQZRAJlchWnqjCpqUlaw0B9UEk7Z5FlVicEsPcsgrTMI0C5NiXIRkjwmSEB6wS5gmxuVGRAcZJ7uAQWkssoOOJ0oLUijAR8kBXKSGDj+09Yg46Xrote+wpl72cEfe5UIy6tJB1csSrK5LxSUvop7Tge4YBgfcsKyA+KrJ+s4NJUaAB5INCqlUqugJGz20adVxoNYm41przWWutX678DrnXiDNmRmAZshBmz9WbQQB92C5HiQeiwLlmBfSOIOsAMDaAlVEuZDtZaF1LpZd8hQpJEAk21uSx6Jmsp/KCH1IOcgoq3PYHIKAfUIgimVZwVCFgnKYxgE5tZqzSBucfDi910rrMgoUL8iA/yHOBecwAUj2o+PqIW3Mea86NHzgp/OcEc85zLUBwtrMi2gaLcKwXsCCJYWynAYGFtq31MdhBKFwEfEE3dqUmWhQcFgHAlh3MRE87kbzvmDmcBq65BiXldBQtCuUGKHknCCpw1KaU43csEia+C1IbWdSKq6+hJ5vWMSFctUNrF22xRCS4MgDcoQMY2mHjaW7YpimNOaWgACnJpJgEDphM8jdOB1eY4gIgR8R5yWHjcTW3nPtcBo+uzdf2wAA6B3AEHAQwfdqh3maw0g8zw4+2yLg3a/NkDonIdN0U7WjToGsaVRxUzqGHtIMnBJimPadEaM2/KrtkCaEYuSXP7vTadN9r4eOIdU7IqEOnmbGe0GZ8YMAqZGhNGsAjnb5PD1y65NTxXqmLCM6dEO+UygjF/DzCTJ6h76LuXeq1xgTnOBqk1LtIQfURTRPhZOoIpIAAiepdCuWpG4mArgACEnBQ/KDIDH0kY2wATfy3DBP4fOBjrd8uz33uwBx6z0nsrG2wW5G1iTLTOn3J6eUM+0k5zq1XPCIc6ZWsKpWdJu3MK0q3r0r0HuXDzA9yncILZHGfv4RgoH20Yf6JR/j9fVPqrXBmAYGb6Jd69WV2xa3zAIIrbHxgtTwpzfNm4sJaK8F1zI2ct5b83DG/LnQulaqa28/B+r/2Zf6l0W/UJW2Wt2k2BWL+JWZen+YAG+3+M2dWMADWe2LWh2HWJ2PWDefWl2g2igWKHmqe6eT+wMSB0oOe7Wx24op2qg52/WQuw24MVSFeHeDuUeA+ru7uBeIKYAvuX+l+CKYAQeJeEewAUese8eYeSeKeD+oBme4hrkue7Bi6hexeshMeZejB2sOUeUSABUZQRGpQyAQSpE6wcqDGYao0+SqgSImo34MQzATGaquqEao0kUi6o03GKa5gmo40l+5KEQusKccYIiNwloZiKYaYlicIMWuAPwuYsgeC3olc1gxCkIzioYTcu60AUQ3+dmc2uUMAAA/KkISo+MLBqlsEcKEG7HhkUWABgMaMhAiBAGjGDgANS9BhSzBRQYh+FUA6p4DSFVKkgVaxLNoPL1bdBZScAACyFMAgpUyGOgSIr4U2ta6Kz4jCWKj4ox1S54sEXAmKoU4Qz628LAkgOIuRC20cQk7uGIUAjkFRy6BxHy4oVhYgjkLOQgPiVEpSLAbulSOKvq+WCQQQfwEQ9GIaZhqmYA6gGqOgeqFgSI5qUJUmeRuqUJfw6afmCQ34fwgm2acgmsQQnaQkixyxTkJJyG7u6xjaVSwqLOcg34KmX0AKJhIajGEaUacJ7G+qCaSaPGqa1q9JeJOa9JTJaAYpZsrQkQxaFmXecAa+RQnIVMnANo0+URP+fUHIXIqQyW7mj4WpaA+BuW0hqQBpqQdoVSFWVWPydmmpHq2pABBpRpj+Bypp9p3IFpEWaAUqlWnepIJMhGJGpIQpYpLJwa7U7JzGnJWq3J8ahq7hvGaaQpQmTqop7Aqm4p6ZX0kpOgrcLkcySmiQWZ6u2ULQWhKAhUGSnKpQRA1g34vQ9Zai/hBi1wckNwqCyYDQHo08eAfyc8cRdiE4oIYidcpCaRkRywToKIaIn0mIYA2I8M/0BIfCMofIVuDIzICM7I7pq5coAoCom5S54okowuPIso/IgoG5IoYoKoIEqQ2ouo+ohMrCLZ+gfwCYXCDQFirwgQU50RZgboYwC8E4fwSRI5Tikii4wQFCVC+8Hus5WIGA3Aha4gGAx4OwF4vyXY+AqQYASx/k0IfRBgAA4noN+u5KEQ8hAAkM+pIEMBgCWljiUpJHhcwARWFJYIVskOhkUj5GWrpEoEHMsIFgtHHJwLAEkMNvpKKGinRahaWanIYu+WPNhZPDwr2apTEVYAOfgovKPMkQOLlKUFHr2fFmwu6Cap+UgJaFInxOxCxFuFAKkL0HPL0PcIOYka4CnDELAEwIdLVPTOrqdMtL1BlutNaqDBAPtDVHNCbEtIfP1N+N4Z3A9D3ssHVBHF8I+H+UtNTLTFGGHJ7MpABBuLhOzARFzJ3DzKyIfFLLQOfJfNfLfPfI/M/K/O/J/N/L/P/EAiAmAhAlArAvAqLKyHwnDMgIrIwirGrLLPzP1MotYKorostStVoiNWAETPbpfraXhA5U2E5QAX+VhVnJrKUE7OIEgKAAEIoBkkIHgE5CAK4K4EAA"}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const { receipt, value } = await Actions.token.revokeRolesSync(config, {
  from: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  roles: ['issuer'],
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Roles revoked:', value.length)
// @log: Roles revoked: 1
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.revokeRoles` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.revokeRoles.md","from":6133,"to":6612}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.token.revokeRoles(config, {
  from: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  roles: ['issuer'],
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const events = viem_Actions.token.revokeRoles.extractEvents(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.revokeRoles.md","from":6639,"to":7045}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Array of role membership update events */
  value: readonly {
    /** Role identifier */
    role: Hex
    /** Address that had role revoked */
    account: Address
    /** Address that revoked the role */
    sender: Address
    /** Whether the role was granted (true) or revoked (false) */
    hasRole: boolean
  }[]
}
```

## Parameters

### from

* **Type:** `Address`

Address to revoke the role from.

### roles

* **Type:** `("defaultAdmin" | "pause" | "unpause" | "issuer" | "burnBlocked")[]`

Roles to revoke.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP-20 token.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`token.revokeRoles`](https://viem.sh/tempo/actions/token.revokeRoles)

---

---
url: /tempo/actions/token.setRoleAdmin.md
---
# `token.setRoleAdmin`

Sets the admin role for another role. Requires the current admin role for the target role. [Learn more about token roles](https://docs.tempo.xyz/protocol/tip403/spec)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.setRoleAdmin.md","from":246,"to":5570}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"d9c54665ca890ceb4e883643fe63cb29f5ad11e7649208e7a46fe48ce88991c9","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinKQwvDCMWGipACpDwsOCYABKaxtbpeVSiAAc/bXKqhotOnp4q+ubDPIWVgDMA0czlGNwm1C8018c2oASYrHYXCMR1MV300lkD3qz2orTeBiRJi6vyQAJA9iBIyQACZGmDMFMDDM/DCFgZ8gjOGgIABrRSXbT6XrWGoKR4NACsLzaeC5vLARJ6iFJ5KGwJJlTpEMZUNKNFZIASAFcwPwjpw4HpjhAFNwoMwLABlDAmgA8GUSyQAfEEOslUu6shROFhHMw9GQ4KkCcIAHSyxQxi1oK02u2O528GMABVD4dIcDdxSUnoiqSzpAg9otLqTKZgtvtYCdJpjpzQhtIYAAaqFDTBPbkwOIw3AQ+tzZbrfW002M6UoBBeAgDA69HBOfgYJxxDOVlPOAl2NvzTheIwkrw9wpOBZjzsAJJZqnWTk8hO5XIAOQgNF2+EY64AcecAZvgFaQIa66HEIG7iFwADu4iMGg66HqQG5bmg+xwNBYCvrkABGW4WLwciGrAUCcDB4icARciLtytEwGhW6rO2nYWEox6rKOJgwDGuriEoy7IMgIB0MOWAKKUAAGckobk7KFMA0SrHBMABskQb4GgaBYJwrgHhWzCcAA5AAAohSj2gA9DEqymYp8LKZyMDwgZRmVmZllCbZ9kwHZDgWHAjl5M5XAqdG66GQkxneVZfnsAFNDwqFuRLHERacAAvKpMDqZpShBMAuScNEQXCKkyApWwAC6FClZy2EFChqQlXhZWcNVblsDGjBQLVqQ6XpQQRA1HXuLkrgRB+JqxCs8CGnIXC5eIiHITwpomHGb5gImk6po2za8D6RZBu1ZXxmAqSmdYtAxg9pnjWVFYKDdAFwH2pBPY1O6NnWN0hpBMA/WA025HJMkgPVYkhkMzClL6XEALTpEWAkwyAcPDqU2NhiM66ozm8N5nAGMUGJbEdsIpQ7JuTXiAcW14R85xcIzlEwCQYBcFAcHiBj9VlAKfS9KSopYogvTNDiryBLWU4NumJoKv8gKqpSiCVNYmoMj4sy6rCBghGEkRFMImUeikaNW05LXm50ogi1Lfy2JiTxNFKeJkkWqskurwwuIg4rqLr3hMtCeqBEEWAVjgHAYFEf0WADnDZCAsAJOIS1oErYDp/yFR9JUVLyHUHsYto0oGMnJxTn7WsB2qiBUmHkIG/M0exxA8eYFEr0wKk6cfV9BdO0XUvqPcEse5UXuBAPDeSmSgyB6MrceOCesR4b+ox3HZB96+cpDyAd3Prw1hX9fN+33f98P9YY/CxPvQ3BiM8SvPMq7Q3MsqmvakbdtQdxZIEIcI4xxbiWFOXIRBJDmzgFOf0Jh65UAXEuPAdMtwyRgQoGSnBmDQCWlubuRB+rwGAvka8sACKGiUEoTiiD9yqDgjedccAWCMDkAgrkGFcgAClxDwIdLwUgXxmHXjDOSPIcATJkIoZRAiGBODwRgARWiFZ4IWnzDGWa2DCHEOvHQFq640DwQgCeNY55GCXhiPCSwPNIyzQAFQ8E4DJd0SD8HRB4XAdc8FkL4EIXoQgUAOGGnsNudcuDUEKBjPRIqEQZJBlicIKcMYyAVlIKNAhHMPF4P4ohTsuTYJxEZkxTgwNKJ8PguImgr5txgBUd+WAMYABWHCsL5WYHosAbjuCcCUPRAioQClxJgAQ4KEgTTQKLB2GANTLF1OQphSxyAZLd3WP4xMaAFyGjQDJWqQRhpYEjDZGykBYCdJjOwJQNkMFwBsjwmgYhkZECpJUGMtAbLiCwIwGyWz4Bkx0swOQABiIF/ixD7LQEnMAUBcgbKhWTGFWSjknN0mcxAFyrkwBuXch5i4nkvPgGgd5nzvm/P+YCis2yQVoDBZCulwK0WkFIBEGMnADHDIgKMuQ4z0k+N4BUoiVSLSUUCaoCABybzhSYaoHBeLECFIIUQqAJC+m5AAPouJcQAdUkHkZQertV/i3Ly/lkitx8vaWsNApl1z4zCVBVYnBLBBLIIggCNAeZyAwLkECJowJCBleucwvIMKaIgNor13Asz3jMZuFRPE3J0RgEGSA6FJCYWTd6sQig0D+tyOEUC4Ew2cAjVuUIAqfybnQq0/inTzTdOHGTTgq5c1bg2ZABpMEUWcHvDZAA8hi055zLnQHxWTQljznnqTeR8r5Py/kApRTGUFELxDI17TAZGQhkYouRoIKIaFchELdRYNCzA4JHC1WAAAorQSS15IIKvppasZaTvGTMQLNSGnT0oTISRAIqplNxyHoqo9gcgoCmQiAAblyBczg5YLCtU4BBqDFjSCwaDHwmFMq0BAaFfxRJQRwMwEg5YgApCFIMpkcOwfg0hsAKG0NOKGlR7DMGoD4csYRg5JGf2ZPZewIIlh4KcAfWJnJpl9WEB7nAIMSDnVMNGZRBwWAcCWDgxERDyGbKofEU4zgWSjwjhwroJplFyi8EYlhJwayW2wHZX+tjRmyoyeyakBTEAlMqcrKE9TO5MN/J04swznUypsOQFzUIg1xRS3FFF6LbDRHiK2DGUgxp7xgDpgBd0UdOASanYgIgzAXZUiljcGaHnovbi4MOgidr+DZdy/l/8cAisBBK8qirSprDSCVLV1LnU2HKvQ2QIcchaWLmBTZOgawDlHEQOodQUtpBjZi1wOL8C5C1WRnU8LZAmgtypNtxrZn9sZYkaV2AiApudlCHN+li3aDLeMNddQjQmjWDqyhtLXBJs82my9m9FhFv7e1WIEzKQqR/CVLNDK7rhxblyvJ7hAqrQEWCkIUyrHCkxmKWAIIMkAAijNdDoQACTAAgTAVwABCTglPlBkCZzJAz9WOMYbZ9Tzg+qsecBx3jsALP+cc/4y5rJEM5KzSfS+rcb7lBRs8RMghpFwjOPzmAADcBhNcCIzlIZegHStuYA6ILhB4KjUJ/NLJJu2jm7Upb63Ma7eG8IRgLx+5cqSetTGX3CgghEaDFk7n56ffAfI5R6j0HcN6dY+xkzGGsPLN49LojUfg9kdAxR9PnA6NPTMkxpPUXeeRkw9xjPies9CbAMwaPpHRPZIkzAKT3nxPycU2cwLanVcabC9pxQiz4Pc5T+hqvyAu+kF8735T5oguqBC5pk7un6qNNl7rlHDOTeY8gyLvlYuCc5+AyTsnkvaf07R8z1nVOOdc+T0ZyvqQr+C+F6L9J4v7/s9IEz6XbfSGQSYSJAUSMoGAXAKgZAJBDsdYY5cdHFGyRhVQQ0AiGMexSda5J5PFGyOiPlGyJdKlcwAiOyYDTpCIaGIWVEakSoGWT+bEKub2QpBuDEABZuHWTeekcOHUTuPAIIZ1aAKIXPEDIqSzISGAAAflSEZgwCDAeluS2COFCGJjbRkOaWQFqlLE4CIAgH6hKwAGpegqJZh6IdxKD0FiU8BK9GkZJBNDlVEgl3UO9uh+JOAABZHOTYa8VoQ0MMUzEVPCMVEMfxRZIMKVYJRVXIJIfMLgapaJKNWOFgSQFRcQ6zfJGtbcKAKAZCZQgVeI8Ic0NAsQZCFbIQOBXsShThe0HhdCPhZFVPBIIIP4ZJBArFJAm9MAdQW5HQZ5CwQ0H5Tow9CQp5Tov4WldDBIGMP4DdRlOQOrIIRVbcHQPwwtV1atQ/EIiVRpDZFbOQGMa9OCXJNovSCdPFAlXoudUlRdSlFdGlPY2YplPYw4tAF45GVoSITlf9OSQDOaC2IoY0FaTgcUe3FvWPGIQE1IGjODIMCEnmCfF/VPKvOE7YYE6Xew4TDJcEmVHmRAEvFEhE4zKfVIFE1ISURpDEvXeXXXTtLqGSB4l444zFU4pA84mdS44ledV5clIgu4gFB4zdcFZ49gG9V4kUuCd4nQM2NCQxS9RIcUr7ASFoUAlAMSThWZUoIgawGMXoHUq+Kg8ea4KkcUOed2BoUkJgwIRJVgpuTWUELgrUfWZkKORYeaVmL4XYbCXCU4T4C4Q0/QKkdQD+cuBoGoS094M4L4G0leCkIOP4P4YBJ0yOI2YIbuXuROBmJmL7AACXCHwFSBkjujp1h04lcChksMwQMFzLgGCQgASA3CAkcyzKOELiNJuBFBDL6GXnDIMCbJwmZmrLUB+EVDYNXmbkqF6ETIkCUFKAZzwGtP9JJGsFNIYJsD4IMD2EZn7K+zCxrNSDul6AR0qHFEaHUHfmsHEAIl4EzkPL+GPNPPPMvOvOYlvPvLPOkAvKvJvKPJPPfM/OfISAbl6HuHYM1h1iFhiFgDhHtkimZmik8hMkY18gBRqggFCiUgigdmSA8lii8lMhjDIKtjSj+OWBUndK2A8lWnWkRDgp2jlH2mTEVhnGOlOitnOl+hnFTlMkzmzmWjzlBhemQTMhHjIAEuPkUBunPmsEvkflkrkrvlBnBh3xj3z1Mk3ObJggcD3JL3IrQDjC9IHLzLq1KHxnECQFAACEUE4SEBlAQFcFcCAA=="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const { receipt } = await Actions.token.setRoleAdminSync(config, {
  adminRole: 'defaultAdmin',
  role: 'issuer',
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Transaction hash:', receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.setRoleAdmin` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.setRoleAdmin.md","from":5918,"to":6375}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.token.setRoleAdmin(config, {
  adminRole: 'defaultAdmin',
  role: 'issuer',
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args } 
  = viem_Actions.token.setRoleAdmin.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.setRoleAdmin.md","from":6402,"to":6665}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** New admin role identifier */
  newAdminRole: Hex
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Role identifier that had its admin updated */
  role: Hex
  /** Address that updated the role admin */
  sender: Address
}
```

## Parameters

### adminRole

* **Type:** `"defaultAdmin" | "pause" | "unpause" | "issuer" | "burnBlocked"`

New admin role.

### role

* **Type:** `"defaultAdmin" | "pause" | "unpause" | "issuer" | "burnBlocked"`

Role to set admin for.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP20 token.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`token.setRoleAdmin`](https://viem.sh/tempo/actions/token.setRoleAdmin)

---

---
url: /tempo/actions/token.setSupplyCap.md
---
# `token.setSupplyCap`

Sets the supply cap for a TIP-20 token. Requires the default admin role.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.setSupplyCap.md","from":152,"to":5817}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"3425b57e63dd869d50e97fa72c6063375687c2cec9e58782eaf2d9e3f31e96b3","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScAGYArmD8gmCcWJJwMACqYIxocEFEobEwiJxipBZKFJywvCyhcCVgscwARmQRJS2MShZoADrZrOxcqaTpWTmmUBC8CAYAsrFyAljm8JzipWjlypykMFj76WASxskQ0RucTa1knC0YVz0kyXRsliecF/fhMJwAjNZOEFAW8hIo0BEAHQDAYAWk4ABEZg1OPg0GgsA0APTYoiMGDMKFwfDY6azbGxATmATwbGjcbZXKUajiJRzZDIEB0cSsBQslhsDicYApNKZJlwTiuGKkCDMTgAcnxhMVsLADIlkyCioALAAmayKqrSCIDXGcA3Wa0221gEAAXQdom0+l1mjMihUakQgK0kl0gU1E2Z8gsVn+dgcpCcNHIiGk7k8ODwhBI5H89DwITCkU4vBMXALYGi3RKAGEhKWlANBcN81XuiyxJJ9AAOSOe5SqJAANn9Oj0eGL1ZZ5ksSH1UccznjiY81C8qd8GeoAWHheuMAA7gBlWJYVYYcviLCdbq9ZuupD/f4AVnkXp7vqnrMHgUse4PR5PWDH4aQXVpxjWckDbJNFxTAw0z8NcswMYsxD2GBeBgRgsDQEoABUY2EWMkgAJRQtCMKvVsb31WQu29DQB0DPB9lQ9CGDDCdECAkB7BnONJ31CDMCgnx0xZGh4JAOthSMJJTBbKRfXdR9ux9D1tHogwpJMf82I4riQJ49jrH4pdoJXET1wMCSuDQCAAGtFDIuT7wfajn2c1ShwMay7PtVirB06NYxcdjwIXATvBg1dRMCOIEjOUo9H3Q85GPU9dwwBIAB5KxLboAD4ghHMtOGy6sqlGXk9DIVENOEKEvMUYkEu/ZLfzShIoQABUcZhKrGLLGyUXKOk4Dq5WYRh0gy9I0ESn9UvS3goSItBYlIMAADVChgXKBjACq4FSVD4pm5qUqwNreBZck5hAXc9ClVQ/jgU781PGJ2CuLCAEkOsNTh6rAGEwAGAA5CAaGw/AJs4aHNjgBb8DlSBYilfChH+hwuG3cRJne0gMb+bZxDwxJ0esgY2hhhI5FiWAoC+ZJNhaOQZhs+4YGidg/n2Fa1oqK4jnedIoREtkOS5Hk+VwKgAAM5dyWshmFUVeH2cQaBK7oqnRTFpVleUlQAAWxpRxuxAt9jVQYhS4UUaCGPXojGo2TbNi2YHNhwLDgK3LJFHhSeER3ncVY22TdrnsXttgrYGRCiwGzgAF58zVjWBqCYABk4fMveEEpkGjiBnWz/7cIO4ZUSz5Ic84QvCTYKFGCgB0Sh1rAggiChS/cAZXDNYGEk3I4li4FPxGxnIA7OOA6tshrptmlr5oSAqBqqauc4BkpFWsWgoQP41S+epKzpKQFbWsMBu7AfuBjlmXHQoLlyuYFlCqUTgEU1pQRedF/uoslfr1KUCIuoxh6nGWeT8uQ81WsIFkWF8CE3LmjZIjESJcGJvTGALwuBQHVuIP+zoQCyX0P8XsnYFBKRvP2N8alSFNVPq1BaWk/LAUCvGO8uojKCQimZMSOZGDhCiPHBsOUlAVgGorG24jRwunIr6dQbZFI0UQHQ9ygQP5sMAhw0CiB1D/F4eFUymZAhBEOBAHAHAMBRBPnNM89wLwnAcuQ6QtgXI+iopovA9jl5/l8kgZyulOGTmMcuYSZjsyhGEXmYMkp8hbRKGUCoVQah1DkKiG4bRSDDS6D0E4Mj6zxMmFdFEeBFjLHQmsVGWwdif32IceAEJ1ZJC+JcTY2S7gPCeIwF4nAwQfC4N8FovwARAhBNYQZEJoTqgRMiWYbcMRYkQLiFURISRkhRJSakOQCRwHpOKEMpgJDsiQJybktBeSrGluJJWtsxRjC1LkYOBtlQEmYLHDURyEl6kNMaTgppzTYktIaS+dpHQkLIZOawVCnw+j9PQjyIASmhjMABRAwSAr6P+AAZnCSZSJcFzGWOsZgKI29OB9BAHvQ0vBwUMsZUyhl1LXG8SotQtRbkAzIoBjo9Rej9J8VCsZISsEop4D2j1A6Tg/iIQgAoAYBR8byoUFI4QCrbnXTwEgv4MtVUwBlpwZg0Alh/EsfiWAtS4CCgUNUGALRYhKAKZ/A1GN1YwylDa8achJD/QgATAYAApcQBRdyq2YuIuAmrjUoQcNkOACoLXNxgPTHp24HX3DlNudIYwgYDF1ca01dqwQcAetuANB0UKMFLLwBsQwhkNHVAAKh4JwGW2Vo0KCNbwX1cApTbhyPgWNqhoBetiPYDYUp9UmE1VCFmShO4yyqDOjVCgoRkDlKQJdGwwD01XV2mAUJsZrR3aoD1vBibs04CjVN/rODbnKDQe9xNHhg1gFCAAVl67YMBeRA1bdwTgSgWajLkO2g1RrvYSASHKgaq073WQfU+wmAbkAy0sahftxI0DTCpDLB0QR244mxJAWA36oTsCUFsikvqaBiDhEQfUuooS0GxKeRg9I5RYdnuiZgcgADEmH4D9twxAKkURsEDHQ8J7DYhYCkFIARojyySNkZgBRqjNGDl0fgGgRjzHWPsawJx2TvG0D8aE9xkT8nN3Qk4IWkDEAwMQdnd216yRKa3vpoO0dVIYb3P5o9dt6nECQaLVAM1+awAAH1m3NoAOqSGyMoeLMXIZ/Ccy5t1znP0oTQIqKUkDCBQFRvsLcQ67iIQmjQE4yUBjwwSIjIQ4mpTmDsgTLNEAc13G4B1L6D1kGPCOISZmMAqiQHxpIQmQ2o01YhPVvajX7BI1a5wdrfxQjgfBsg/G76j3frqX+5gs9OB3Rm38dDkBn3ozM5wL62IADyyniOrNI9ADTs8tPXWxLphjTGWNsY41xmYImoR8cE+IOE12YBwiEHCMzcJBBRE5qQAYJrysWFR8wVpQhosAFErlSxvTa3YwWsuhFc2uw1iB1QP2/XHNzR6F06mQXIFmD72ByCgIqCIABuYFI0di5DbjAdnAaK2kG51UJD8nxP9CHtT+dEBF2KjZxzgApD7KoipJfc95wLsAFpRq9FROriXXOoAy8rWJqkjOlebvYEET8nB8eKad4qBLhArFwCqNG4r/NRn0wcIeRQqbef88Fybk4UpHf42lXANkm291bCcGzImR1Ze4c3bTo3IKc5u63SUL3EAfd+/lHoKGuwg9olPDgSwUBBe1w2FwZAuDQitzvL6O8Tfa4evDeUDCUJSDxC+mAJBE1spRWBKFogzBfS4v1L6NsA8LTN49Y9loeX+DD9H+PqGcAp8BBnx9xAc/EC4usNIC/K/e85w9aF3oZA9pyBBzx7EdAUJUiSAY9QvppB34t51zt5yAOhwiPp15kDqKID6j6iAEeogED6RrO6n5P5rShBv4iYf60Bf5nAGK9jqLWCr75595cCP4nDP4YE44WAf4FByAxYpLKAwG4oX7qhiJSp/Apye6MDs6cAETObexCCKiG4GrHrJZBAyyIjEy6D4wAAkwAHBrgAAhEiNIWQEoTLJHnnkLqbiUFIcoHcAljweBvwV0BqmACofoTIUodblsApmjmAA/OqITtcnaijEFsgu2p2pqj2n2k2oPPTnAPbkhPLsnMBglL+ryLuBXoQNuJ3CIZuJumEYGLuJEcwNET1LEfEcEVwMwMeEzmES7qId4QoEEPLlUHZobujvkUrizmrmLhznrjzlocbsLmbg0RblLlbvevLtUSUczirqzh0ZwFrgCrrpbgblHm0aLuLpzl0bYb0WAHkf0Ruu7tui7oXh7iXmXqUBXqoIHuIMHpAQ3hHobq0boXXJsaQMXt7liOXgHtXocbXqHg3s6PepumwZuBwWEdwbwaYYIWAMIX0UzmIaepIWoXIQoRVMoaoQYaQBoS0SCtHiLrCTIZwEYX8QIeYZYRCTYe8YpvfHLKLGcigFyOkLcsgNGqtKhIRq9riD0KoLEC0FCAWMwO9uRgcuptiMzM5niIZmxuYC0ObCCd+hEJCgonJPqG2HQpys+CpDylokzvylRCEvooZCKnwqYsStmMVtAFECsSzgnkngAPwlCvpVAHyUYYRJChDgK8ioivrIAOjDREAQDNzAgADU/wXw6YLMhxYpVA2qBgyJD0AaMscu+GD6Q6W42444R6nAlSKwdqAYzQEIUol6nm5q4Q6Q3Rvmw6j0AwpYYwXA3mU6nWhwdQpAjwRpugu69MW2GwUAUAeyQglOpZ4QpQTJYgOQ3+QgSqW0XqLAPBfqSGMmwu0QQQuKEQL2yyb2OOYA6glGOgv2FgsQbG85COSeBy85uKXGvQ0QUIuK4OFmcgA8QQwWKZPUMeGw5WDZqQ/aiGaGMs3+cgUI2O6sS6tJqmb26mmmy5P2f2+mAORmwOL5x5lmL575aAUFcIAYkQsyARcsDOiuSEBY8QY8nAd4CRtRgxioaFJwJQGuPOVQ+FkIZxSJ0xDY6FJQD496EZCuohdRpFiAAKpFiJOhMeJQzFmFth9FhJMs6o52dcz51Ib57AOOaAn5KmmIamH2f51GAF6semBmgOxmnGYFEOAmkF4l6sMFcFKOH0GOfwWOOlZwIs/oJJFypOqELIRA1gUI/wDl1o4ppC14MB0gHEspPouKdEyKC6ypgqQUIUyYJiRKEqCEXxO4S8Z8TiBSLErliiuK/wHoXlFEvlH4UVp0v4AVnE2K+kSVBKrISgLIHBeA/lEp+guKSVqiz4Hi4VIAIMO4nZp8r0jiF8zKPk6KbEt4gV8YhkJCBYsATA9y/sNUUoMoTsbyrsnGRcvsI1ooqK41+sCo7yqoRSysci3QryK1UIwpEiXyYioon40Vv4VQGCkaMo48k8XAY1c83kjUJ0zCK8vAa8EiG8x8WVp4JQi1Oo7VNoAKvYXcpclKu8tAdKzKENkNtoR8t8A8wRc6dRjV24zVR4rVLFE2mVT1WAA8LIkC4gSAoAAQigNqQgeAzIrgrgQAA"}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { config } from './config'

const { newSupplyCap, receipt } = await Actions.token.setSupplyCapSync(config, {
  supplyCap: parseUnits('1000000', 6),
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('New supply cap:', newSupplyCap)
// @log: New supply cap: 1000000000000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.setSupplyCap` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.setSupplyCap.md","from":6165,"to":6648}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.token.setSupplyCap(config, {
  supplyCap: parseUnits('1000000', 6),
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args } 
  = viem_Actions.token.setSupplyCap.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.setSupplyCap.md","from":6675,"to":6873}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** New supply cap value */
  newSupplyCap: bigint
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Address that updated the supply cap */
  updater: Address
}
```

## Parameters

### supplyCap

* **Type:** `bigint`

Maximum total supply allowed for the token.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP-20 token.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`token.setSupplyCap`](https://viem.sh/tempo/actions/token.setSupplyCap)

---

---
url: /tempo/actions/token.transfer.md
---
# `token.transfer`

Transfers TIP-20 tokens from the caller to a recipient.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.transfer.md","from":131,"to":6123}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"dec220aff49bf6fbcd09bc1c824e3f8dc091edf7bd95fbbb92e4c24833c8f7ec","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScAGYArmD8gmCcWJJwMACqYIxocEFEobEwiJxipBZKFJywvCyhcCVgscwARmQRJS2MShZoADrZrOxcqaTpWTmmUBC8CAYAsrFyAljm8JzipWjlypykMFj76WASxskQ0RucTa1knC0YVz0kyXRsliecF/fhMJwAjNZOEFAW8hIo0BEAHQDAYAWk4ABEZg1OPg0GgsA0APTYoiMGDMKFwfDY6azbGxATmATwbGjcbZXKUajiJRzZDIEB0cSsBQslhsDicYApNKZJlwTiuGKkCDMTgAcnxhMVsLADIlkyCioALAAmayKqrSCIDXGcA3Wa0221gEAAXQdom0+l1mjMihUakQgK0kl0gU1E2Z8gsVn+dgcpCcNHIiGk7k8ODwhBI5H89DwITCkU4vBMXALYGi3RKAGEhKWlANBcN81XuiyxJJ9AAOSOe5SqJAANn9Oj0eGL1ZZ5ksSH1UccznjiY81C8qd8GeoAWHhb2MF4MEYWDQJQAKjHhLGkgAlbe7/fN11If7/ACs8i9PcQHu0gbw+x3e4YYYnRBdWnGNZyQNsk0XFMDDTPw1yzAw62FIwklMFspF9ABmTCX27H0PwDIcDBQkwx3DJBgJAewZzjSde0gzBoJ8dMWRoBCQCQrg0AgABrRRb1be9dU7BQ8KQZ9WUHQJuL4+0AKsSjqNA2jEEw3UGKXGCV1Y9cDDiBIzk4bZxGEaIyAAZQwBIAB5KxLboAD4ghHMtODs6sqlGXk9DIVESOEKEZMUQKTzgMzSEshIoQABUcZgfLGWzGyUByOk4aK5WYRh0ms4zTIsqzeChS80FiUgwAANUKGAHIGMBvLgVIdyM0Lwsi3gWXJOYQGPEywt8zhDwASWiw0jN4xQpW4jZIFUO5xCgKAjjgGEwAGAA5CAaCPfBss4PbNjgQr8DlSBYilM8hCMhwuAAd3ESYYnYa6/jyuBLuSbiBjafaEjkWJYCgL5kk2Fo5BmHj7hgaJ2D+fZSvKioriOd50ihVi2Q5LkeT5XAqAAA0J3JayGYVRV4fZxBodzuiqdFMWlWV5SVAABe6lCy7EC32NVBiFLhRRoIZGeiTLWfZznuZgLmHAsOBec4kUeESEwRbFxU2bZSXYexIW2F5gZizEBt7KUTgAF580p6nkqCYABk4fNZeEEpkD1iBnQdlq+v51F7eSR3ODdwk2ChRgoAdEp6awIIIgoL33AGVwzTWhJNyOJYuEt8R7pyZWzhWoKwBCvq2sK5zkqqf3He4kpFWsWgoSb40vd5CB4gPAFrTAeOwGTgZCfxx0KC5LzmBZFyzYRGmlHR51R7ilkx4SqUEVimN4rjFbh65eGyuEFlD3wV7Qo+rdf33GagZgF4uCgKnxDn50QHQ/R/ndXDvXvKdJK/Aw3rLgkMigFFLRljC4IC1gNJMVgquNigQcyMHCFEI2RZkoVmSiTfmJtRwukEr6Xstguxf0QP2X+REqLJWAQpEC4D4yPkwtA7wsCdLsSCIcCAOAOAYCiG3DunRui9AEhhf46gf6iRIWQz8FC+EnGoeJWhYFED6iYcuFimYEGhCQXmYMkp8jVRKGUCoVQah1DkKiG4bRSBpS6D0E4WD6y6MmJ1FEeBFjLD3GsC6Wwdhm32IceAEIqZJC+JcTYli7gPCeIwF4nAwQfC4N8Fovwu7AlBLQd4EJoTqgRMiWYUcMRYkQLiFURISRkhRJSakOQCRwHpOKEMpgJDsiQJybktBeSrDxhxUmAsxRjC1LkNWzNlQEmYAbDUDS9F6kNMaTgppzTYktIaW0qz7ROjwSItsRCJFvj9OQoMUznHyQUVRMBSjASqK0uo+CCCOFcMwFEWunA+ggAbuoA0UBMKPnLLwXsvY1LlmsAw/U0h9SPnEJhFobZdS6gAEK8GkDAdQj5pCPmiNYFoABRFoLRXnCP0IaCSuyfQ/2kdJCA8jSGKJUiohcjFmHaQ0dme5ZBHnjVkiUV5DdDS8FWfygVgqhXWnxZswlj4PQktOeSvARcqUeiUnQycVzmJwXgXgeq8VGpOD+EbCACgBgFFICbOA+rihuRMGalxsw8BHz+PjPVCh8acGYNAJYfwOH4lgN4uAgoFDVBgC0WISg7Fm0da9G6+0pS+qynISQ40XoDAAFLiAKOZCmf4TVmpdduBw2Q4AKk9eHGAQMom3UDfcOUt10hjFWgMO1Lq3X+rBBwKat0IClBwLUUsvAGxDASQ0dUAAqHgnB8Z2VNU6/Mca4BSlujkfAObVDQGjbEewGwpQOstQoKE4MlCx3xlULdwgzVQjIHKUgB6r5jvDVCe65Ur2qCpvmEyUNODnRLQm265QaAJpMo8TasAoQACto3bBgLyVaI7uCcCUODZJcgb3bpgM6uWEgEi6uSmVT901v05Feh25A+MOE7lncSNA0wqT4wdEEaOOJsSQFgKBqE7AlAVIpHGmgYg4REH1LqKEtBsTiCwIwekcpSMrXRMwOQABiEj8BZ0UfbpCK+AwiPybI2IWApBSDUdo4U+jjGYDMdY+xupnH4BoB43xgTQmRNiZmApqEUnZMacU9p6xUJBrH1g/B0ISGT1Tt4K+n6H6gbzuXVSfavSkZzTHUZxA4bnWuqgO6utYAAD6Q6h0AHVJDZGUNljLO0/hwYgAhrN/ryvAe3GgRUUpN6ECgBdfY1xdxzWNUbbKNAThyAwAMI6CQTpCHblKcwfEXqVogNWu43BopDSmsfR4RxCRgxgFUSAxrJARpgI8LrYgIR9YGOEY6p1RucHG38UIiGtrH2NYBmAIGwOU2YCtTg5kYA7aDvjWafwrpuc4ENbEAB5PTdHikMegMZlapmurYgs9x3j/HBPCdE255zaBpMyfEHCX7cIhBwjc3CQQUQYakAGK61rFgyfMGCUIdLWKOm43fb63YcWysVePZOlDiB1SD1A4bZDu6ID7sVMfOQ4NODttIHIKAioIgAG5FnpR2LkKOMAJcdul7Lqo00tPKcF4Fx7e6dTi8lwAUnllURU2u5eK+VxlXoqIzda/YDrhN+uqSG+52enT7AgiWFupwLFfvL2Khy4QThcAqimsa0jZJQMHBYBwJYO39uwAWkdycKU57npaveroa9LZeCQ2Ms1PXFHz284z0sx2IeL0lAjxAKPMf5R6F2rsBPaJhMp5LcrwOGwuDIBvqESOj5fSPn74HZ96byj7ihKQeIQ0wBH2ynZeBwIEtEGYFhfUvo2wpwtAP59wOWg1f4AvpfK/dpwHXwETfUPEDb9UtYaQqkD9T8ds+hLvQyD1TkA5hJtiHQNuFSEkO+OoL6NIJ/oPkHCPnIA6HCN+j3mQKQsovqDAc+vAbPpmgHo/r/uVKEIAQpsAbQKAWcO+L2KQtYIfrXtPlwD/icH/kQbThYMAQUHIBlkYsoMophKpOqKgtcN5BbEqDlowBLpwOeOVnLEIIqErmnEbnevlkEPjIiCZLoMagACTACaowCuAACESI6hZA+h+M6emequqIahygdwYhEhUhXQJ6YAhh1hGh+huuHaWm56A8hM6ojOnS/q50sWPm46yGzqvAM6g6qc/OcA3uiSUWlsgY5k4GvI5kbehAt0sc8hgh56IhSRKRzAaR8UGRWRcRLqGAE62alsgelWj2lRCgQQymVQ566eFOFRQuJuYuGukutu8u8hFhTu6umuUubuUAHhXwXuYAzA7RihnRLunAlucyNuoxfRDulhQxPRox4xBuUxMxPuuel6NR9e/u4ekeWIreceneC03eyeigJa8u5hSyWeauQcxxpAjeZx0epQbeqg8e1xSeveEc4x3hqcghuhIh4e4hiGDhMhYAchbR9Rj296YAKhrhdw2huhBhRhNhpAphjxKugx2JGhnAdh0J0hThLhxhuJwJOmPhQ8/oLSKAXI6Q3SyApqZUO4NG4OuIPQqgsQLQUIBYzAkOTGdSRm2IYM5WeINmgm5gLQXMQuoGEQjoz8r8SAmE78n8b4BEUkG4RuVK+yiqSiUC9KmkqqcCukwQjW0AUQiJwu+6+ebIMAAA/CUP+lUE3CxvuEkKEOvLyKiP+sgA6GlEQBAOHMCAANT/BfDpjgwLTKlUBdR4DPFTQdr4ye5oDOoRaLqB7jiPacDuIrD+oBjNAQhSjBbJA/SpCzolpVDZmJr2RjBcBhYbqTaHB1CkCPCOmF4mRAzXYbCLQ1JCD+YtnhClD8liA5BgFCCGrVTRosDiHxrTTqaq7RBBCYQRBg6FIQ605gDqAsY6Dw4WCxCCa7mE5Ol1K7mYRia9DRBQiYQY7SYpxBBxYlnxTZ4bCtb9nVnpBAzLn4xgFyBQg05UwHpckGYQ5GYmaHlw4I5WZI62ao5VLiGPmyaAUgVoAYVwgBiRDZLRGEwC4KHGwFgdwiGPjZEdEi46gkUnAlDm5y5VA0WQj9FPHrENj8KcDPge5KaTG3qdFMWIBzJMX4kpklACWcXjEZl0nqgfZ/BEaAXAXsC05oBgX6aYiGZQ7QVsawVUyWbWbI52aiYKUuYyboVKVUxYU4Wk556wy/QYVJDowMlYwvwWA7gshEDWBQj/BeXWgqlirqn6jiKvg+g4QHJ4B7oGlEJGkqQQSmkwJMq3J6nGw/jXidy9SngqxgCXgXz/gvx3iqQfzELakDh/wgApV/iRU0oQLYQqosLMoGDsJygPI8LewZVnAAAS4Q+AJQ+MDc2h3BSgrg9JIASZBgnVJIoS10e0b0H0BK6pj4xKwV94EkMq/8p8mV41agJyvoUV5yKkwkKqzSLIuh4VIuc1qkYiWpPoRC6qBg6V70mV3eJIJQDc/w+oakj4vY6gbY0g1g4gLQvAsA0Qb1H1X1P1f1ANQNINuon131v1/1gN0M0NsN4NCNQNBpP80VECUCz8BYsATAvSSs/kUoMoosIyEsom7sCshNooTiQypN6spS1N2C5MyUwyCoioUICppsEyghoo5Vl8Mo2cucXAxNgUE0xcACBUCQFcpsVcrcrqHFdNeQiogIUIj4cyvYccXszy9ctAHy+oXyPyfyAKuoQKIKYKEKUKMK8KiKyKqK6KmKOKLQLcAcRcdcPK1gfKwqPtvtNort/coJlFou91Z8Dgz1cyAtaAJcbVSQm1KcLIm84gSAoAAQk0SQsqCArgrgQAA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { config } from './config'

const { receipt } = await Actions.token.transferSync(config, {
  amount: parseUnits('10.5', 6),
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Transaction hash:', receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.transfer` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.transfer.md","from":6467,"to":6988}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { parseUnits } from 'viem'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.token.transfer(config, {
  amount: parseUnits('10.5', 6),
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args } 
  = viem_Actions.token.transfer.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.transfer.md","from":7015,"to":7271}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Amount of tokens transferred */
  amount: bigint
  /** Address tokens were transferred from */
  from: Address
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Address tokens were transferred to */
  to: Address
}
```

## Parameters

### amount

* **Type:** `bigint`

Amount of tokens to transfer.

### to

* **Type:** `Address`

Address to transfer tokens to.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP-20 token.

### memo (optional)

* **Type:** `Hex`

Optional memo to attach to the transfer event.

### from (optional)

* **Type:** `Address`

Address to transfer tokens from. When specified, transfers tokens from the given address (requires prior approval). Defaults to the caller's address.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`token.transfer`](https://viem.sh/tempo/actions/token.transfer)

---

---
url: /tempo/actions/token.unpause.md
---
# `token.unpause`

Unpauses a TIP-20 token, allowing transfers to resume. Requires the `UNPAUSE` role. [Learn more about token roles](https://docs.tempo.xyz/protocol/tip403/spec)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.unpause.md","from":234,"to":5042}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"acbdcb03cf8c56a50bc60fe3d4d353742e327ae6fa423ee3dd905872a93fd690","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinIxwAAriAK5wMFCpAEYQEAriYKXlUogAHP21yqpIVy06ekzrWztQXRZWAMwDjmcoyuE2oXmmvjm1ACi1inFIMF4MEYWDQqQAKkNhMNBGAAEqI5Go87afTSW4Ke4NGraNp4BFIlEMeQ/JD/ED2QEjPogjxgqYGGZ+aELAz5dhcIy40wXfS9ayyO71DTPOkGKUmb49RDszlDIFsxqgzACnyzUo0UUgcWFNAQADWihJFT6vRqlOViAArKrXgY7Y6ziztbrBsMXIhKpVjeDBZCLTCDAlNmB+LjOCmsB8YABlDCpgA8GUSyQAfEEOslUsWshROFmhsw9GQ4KkNcIAHQBxQdzPZvOpjsbRvN0hwIvFJSliKpNakCDMVYwAt97a5/O8DsEtCbUhgABqoU2MFLuTA4ibcCzSIzYCza4HvFKUAgvAQBgAqnfs3BOOJOOiACSawAEzWJw3ZgB2uS5AAchANAYvgqwrL+/5wBu+DzpA2x/mmQgQQ4XAAO7iIwaC/gk7CETAEFYnAOIEXauT7LRFi8HImywFAnAEf++xyK+9qcKxVEIvCei7nkyh/hJV4mDAHYWuISjvsgyAgHQF5YAopQAAYGRRuQ2lwwDRAi4g0DWyR1vgaBoFgnCuJwCTzswnAAOQAAKkUoi4APQxAiHnGawEqcGZNBhU5LluZ5PkqQFQUwIFDgWHAIV5GFhRme2v7Oa5C7xb5SXsClUVsJluRLHEk6cAAvOZMCWTA1lKEEwC5Jw0RpcIqTIBVEAALoUF1dGnPJHCthFY3dQNMBhR2jBQENqR2Q5QQRKNYDde4uSuBEMGpnCCJwJschcI14ikeRPD4Z2kG9t+D4bhWk51p1O0QQ6iipB51i0B2QMedtB25AZekgCNGkNhepSVkonAALTpJOSnQyAsPMKUWOjr+KPDheePoxQGkIjue6mOi+C0Wg9GMTtDJElwpw8TAJBgFwUCWeI6MjWUpJ9CB7Ieg8iC9LctJ+iAq47I+Wp/AC+rct61gxqaQpQpagQhGEkRFMItUlikqPG6FBRG50oiC+Lvw+kqYvNNQrTSwjCtskr4ajI0IHq94msJlaQRYPOOAcBgUSQak2QgADYG8NYidJ8nKep2n6fWDHzqXL01TyHUYv21LgSQe7kaewaiC+3yJr+/G8yBOel7XrRSzHDAuREJIBtwO31YmO3z6vu+IDU7ReltwoemcMw0DnbRIfEMt8CyXA+QKJwsD7JsShKBYiOT7TRGoZwa+LnI3d2jRuQAFLiF3Oa8KQTI9+3M+Ig4eRwO5i9EMvPH7AwJwYiMB9giXnMRHYY5oJgFyGPGec8N50Atr+NAxEICnxwLwRgSReBFDCpYTmrYjoACoeCcD0sWXuU9ogXzgL+Yi5F8Dv1UNAX8Z17B/l/BPAeCgOyCXahEPSdYeHCHbh2Mg85SCbWnqzChh8OykT3DIwilloinBErRNcPEr7EWfjQb6f4wBAPgrADsAArdhdNmrMBgWQ7gnAlCCX2KEeRvCYDT3ShIVMrdJy7l2IYvR5FaYYOQHpReSJ6EdjEC+TYaA9JDSCOtLArZ/L+UgLASxHZ2BKH8i+N8/kL40DEEjIgIFKgdloP5cQWBGD+QifAOAHY7LMDkAAYgafQmJEA4lRFZrkMJnSmkxMkQkpJ9kUmIDSRkmAWScl5OHoUlqJSykVKqTUupQzmloFaR0+ckT6FoFgKQUgEQOwARpo45xrjRHUI8eonarEMyfGAUwnpXATL7xohQmZiBD7T1nlAeeMDcgAH0SEkIAOqSGkkoCFoKkK0ScRAFxchX4bxReYxEaAPK/ibKwqAaFxKWCYWQHuqwaCczkBgXIGFUxYSED0385hHTfP2BAqBPA1iAVQTTIBp0FoCRgHWSApA/ziVUDAIBSwKWKDQNS3I4RMLYSZZwFltFQhooQjTMVpjFKWNPtYi8TTOA5hgEfWiYTIAGIIkMzggF/IAHkxnJNSek6AsymnzPyXAJZxS0ClPKZU6ptT6n7Mads3Z4gkbWpgEjIQSMhlI0EFEMSuRZ7iQsGJZgllcQgrAAAUVoNpDe2wvmSquSim5/zEBHQhpY6q7j+EQHah5GmchBLAPYHIKAHkIgAG5chpM4HOCwFE1owA7Rg9BpAe11ivt0uJjaxF8IEUENtk7O0AFIMp1g8jOntfbB1gGHaOohE6p1dtnVAedGDF1oGXXciRJz2BBEsMRTgBaX3SI8pCwgEAUl1l7vi5CMkXE8QcFgHAlhe0RAHUO/yI7n5EM4JI6il4GK6CMTxcovBhJ0ycCEw1xzSC1pPYh7qX6pGpD/UcQDp8Fx6FA4jcDnBIPQd2Ah7q3G1HIHZqEVaXpxZei49xv8XBH7P1RB2UgKZAJgGpqsYs2tOBvo9YgIgzBbYgXFlcQ65GxPic4I6/YWL+Aybkwp5CcBlMBFU78zTOoFQ6j06JnjXBfljrIOeOQYbXyNP8nQREcTcSIHUOocW0g3PdV4/xuQQ0kZ6JqWHJoVcQLRaM3FyTL81OwEQF5vcoQ/MHMC7QYLxgwBhcaE0aw+nh1ibUZ5zm3mis5osIFruchQViGQykYWOojo1U4E3WijVf2MA7ZwPEKL0pCA8sehRSiwBBD0gAEVOLoMVAASYAI3XAAEJODreUGQfbel4MGbPeOo7G2yWQom2i6b+xZtgEO8dzb+3b3EckeDAyR0i0lq0WvGSFbKHuOnhxcIxDYFgHrXAR9XB3kNUcXoHMRrmA5kY4QYim0FtwkkcjtoaOLIY6xxAHHF2hvMAwFQt+jV33osUrThQQR3l1kkRd9NNOm1ro3Zeg9sHj2nuQ9d9tnaBdffeVz5niledi4wTukGnkBdHq41d6a8ur1zsMVLsA1OZfPqkW+mAH6qOvt/f++jwGmNfNY+xxQuw+0XeF2O6ayAzekc4LRgDcAgOMdULb8QEHksO5Wl9n7MOhsjeR+NybT2Xvzel02pbK33tkp23tt7t3SBned4h9XqQ09ivu3HmbYjXs3ZOzn8PJzfuQxaKpJA6kyjmtKMgXuu4kSJNdVM/ye9VCbH2B2GIzB3WZN9TM/yAkUX+VWcG8w+xApNssREKG/NZRIDApUfOVIVTOxeO0dxZcah6i9kgNWNdYxmmFNrPAQQQPQCiAbtdGGVIwAAPypFOBgOsQNsmolxFCEJmYGmm/2QCGhnE4CIAgGWlUwAGpeheJZhBIg9V8qAfU8B1dDE9J71p5GFVBhsTduhFJOAABZc6AQHSDVHQTYJsFDXgDRJ5LMehXYOsfA5hSVXIJIMcLgbRLhb5EOFgSQIBV/LDORTVP8KAKAciQAtFPg8IU+QfMQciELIQTuI8FeM+CbS+UJcJEXBIIIX4IRbvCZXvHNMAdQbJHQQpCwTYKpcwxNN/X1cw34MNMdBIDsX4SNOQfTIICtVoWguVIlDVSbZgl5K+MJELOQDsbNSyGREwhyN1GZOZawn1P1eAANOfdZUNKI7wtpKI2ItAQopGVoSIM5OtAyBtY6Q2IoFMS6TgL0PHFdWXFtddGIOo1ILdXtOsdozmPPJDV3VIXotEBor7e9R9cRXnYYxAJXYY/ogvWozmVIH0QxcY2HP7GHM1S1PSXIwo+I8ZRI3vZIr1VIxZIpDIwNNZENOpXIlpdpAo9gHNIox4yyEonQfWMSBBTNRIF4irJSBvNSDSYHJEUoIgawDsXoCExONfa2F0KuXoECHfT0dkYuPAARY/CuFWXkSYOuc0BuWEGo1YDYbRA4I4E4IMAWOE4WWwB2BoJ4ffNUa0d4bRDEjkMMSuECI0S/U0CQJQUoEbNEltbOfQcpGk0WBoGk2/AwHlesbMPYFyUIHYMuRUU/SuNWfmGIWAJgbKUyO6CrfKWKIqfdRKOpQaTKEyCKA2LIGKQqdyDyDsJfY2Kqao5YMyIkuUusJmF+ZyK6G6SUe6JpR6WWdcVMN6Y2D6MaKOTyOOawBODOeMhM1OEGfafTCY1dVojyGU+8T4GYusd07RfTUofFcQJAUAAIRQNeIQPACiEAVwVwIAA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const { isPaused, receipt } = await Actions.token.unpauseSync(config, {
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Is paused:', isPaused)
// @log: Is paused: false
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.unpause` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.unpause.md","from":5385,"to":5785}<fsm-vh3gqscxm4e>
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.token.unpause(config, {
  token: '0x20c0000000000000000000000000000000000000',
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args } 
  = viem_Actions.token.unpause.extractEvent(receipt.logs)
```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.unpause.md","from":5812,"to":6010}<fsm-vh3gqscxm4e>
type ReturnType = {
  /** Whether the token is paused */
  isPaused: boolean
  /** Transaction receipt */
  receipt: TransactionReceipt
  /** Address that unpaused the token */
  updater: Address
}
```

## Parameters

### token

* **Type:** `Address | bigint`

Address or ID of the TIP-20 token.

### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

## Viem

* [`token.unpause`](https://viem.sh/tempo/actions/token.unpause)

---

---
url: /tempo/hooks/token.useApprove.md
---
# `token.useApprove`

Approves a spender to transfer TIP-20 tokens on behalf of the caller.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useApprove.md","from":146,"to":11650}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"2bf003f5493f7e541fe74b232dddbd8b378080a8e7358ad94560ea26b9b9c7a7","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUoiaicACUnABmAK5gjowQYJxY4nAwAKpgjGhwwURhcTCInCKkpgoUnLDWLGFwZWBxzABGZJFlbYwKpmgAOrms7FzppJk5eUZQENYIegCycTJojFgm8Jyi5WiVipykMFhHmWBiaymcEDHbnC3tZJxtGHd9JKl0bGbn17dtERgnAAjBZOMFQV8UvI0JEAHRDIYAWk4ABE5k1OPg0GgsE0APT4oiMGDMOFwfD42bzfFxNYmNbwfHjSa5fL+MQKBbIZAgOiiVhyfwsNgcTjANIZbJsuCcVyxUgQZicADkxNJKsRYBZ0umwRVABYAEwWFU1SSRIaEzjGix2+0OsAgAC6zuEml0BvUxnkShUiFBGnE2iCOqm7NkpnMwJsdlIDicUncnhweEIJHIGkCeGsKRE2ywJ18AGUMIkygZBHC0AJ5HC4pkAIKFxUkUuJOEAJR0cVIYAAKl4ADwAYRSMV6NQS/EgAHcwAA+fwicS6ADsa9kvuUSGBMeowZ0eFELZLZes/hMZiQAGZY/ZHH5EAA2ZPULxp3yZgL0JgjMWVkYK4SC4+5yIoO6IN6mghnggGXlGt73vGj7OCab6YKmejpn4Wa/noIqjJwNb8PIy4elIm4+hB/rQYeQQkWRkbXogd4gLYD6JogRqvh475YT4GYctmejxIklypA2MDNkWbbnqO46Tpw05zouwTjAKOhkHAAD8FZ8FWjFgPWTannJHYAAr2MwWkTApYATtUylgDOEDzguXQ8AZcDVrWxlSTJrYwO21hdj2faDjg9mOVOLmqQuQxgJpcDpNYQIBWZwXnv41ILPoBmxOwBayVUdwpfIsCkMREDEfGYBwDETz9gAkhZJrVaR9UImAQwAHIQDQZT9vgjCyqNZXnvgiqQA2WIFcoohcLOojTIVVXKECeyiPVCbJD15w1R0nCmNYMhxLAUDXKkOxtDIcz8M8MAxOwQJHGgva5AcOynN8mRwhyohckgPJ8rQAobLgVAAAYw/ktBDIRYoSoBcoKkqqrLQozCMPiNAjJq+1iUkVwycE0TAEMnCcLm9VcBKzB0otMA1KNFkVaV8oALxeYYvmdSZ0mZSFZNalTb0feClNU5wQ5tHSNb7dL0spCOJjWPwnPAGTnCcwunAMxcMDBBK5VgJVZQqhYtBwjbZrbMwEAJGgZSghYqSuJErhS0rUCjaIt0wFAmus+zihe6k0sJRHSuBb43sy/ics4ikUdU5aYDhzDUMuhQvIacw/j57ZsoolZ8Y2U4Pk57y4t9kYywXHthzwCsaD/a67qrruFhseBfq7gaQZaEeegZbJWWJAhLFsRxKFcTeRoYR+2FfsJ+HsXmXAnuPIX6bzRkC7H5mhd270RcOY4OUpKluYu5Fd9xFhGluNG7vuMEjyA29BSFU/mM+yEExPgsEvASOFvw0HXupRUOAOAYGiAbJmZRCjiEYP7OQmJv5nkstZYu0VegLhqBALAEldJlAbkzAA8iQvacAhwU2jtcecZAyhQytgAEmABUKorgoYAG546m3NpwNhtBOHcLDvw+OApHbnG6L0foAjGFHDSusZ2nB+x1TgLtFI3ZVEkKUe4TgAAhQEABRUgipSCRWZsVH+544Rl00pXfBChCHOVcu5TgAAfZysAJxmCgNEXWnAiAQEYFAHKGI8DDSBIgiSsQEjE1SBgR21NtrpJkDITgs48j4FCag9BWway1V6Noda+A4mMwSdtS6xCJJhBkK8QghgrrbCgL7Bp2TrCNIBOra4NC8z/SDEDFAedrL+CKJUIpJcNGVIKdMgOsoIBtAAFYwEcNVSUcBZQlI2iI+Je0ABiYAobt1ziAfO/h6m0LhCkYscRrBpR2ZwFEw1xpEwSbkrJsRGBHByZU1I+zDlXHGnAR5zyGorG2GbHJjAflHXSDswOxF5kgrACqWUpxW7nPGeXa5gyuopAsVY15cyPlJK+fC7JE5/mMFuMC6pTd5C5idtpGFnAyCktqXChFQIkWZEuvsrl7BcWXImVQG5Qz7k6DQHIS6byRqyk+U3b5NK/lAlnIC1FVTG6gtlDAPJTxwVPPgFCrJrxGpoFsCioqLLZGVw5SKqqPLEUREFZyo1FSgRQEWjsO1ljRXVxAEcZg4hBD+BRM1W4qS4j61EKRfWrd1hyGbgARxKCIOANQob3IhWaqGvL1X/JSE07YMQnA6s4DIJm+Yek/NjWqOJohYDdRRI2H5+z60yD6Q9FVeZwS5rAA801OyoY5uJYG0g46REypxPKqG0RxBAjCRExJ4laE1B5fs2ugSClnU1dSx6x0FCQCOFAduboQDAV0EaYEg9qL9xfEPWCeh4mQ2MIhZ97E4xAOcMCRefFMLeHAWvII0DiFkEwEuh2Tt5F9HOPfECRojTej7pBABB5h5BBkU7P+SAqKzz/UgQDKYQOrzwuBsIaCoiSgmLqfIKCD1lAkU5OoDQZCYgeB0UgnkegIcGMMUUYwpThhmNEpYyaNgkllDsVjzcTjwBhItJuNw7jcaeC8N4jAPictoN8GEfxniAhBGCCEFgoQ/FhN1ZEaIMRlGxLiAkRISRkgpFSDEtJ6R5Bk8yUTMoAajJBvyQUH7EZ0zo6yVa8oYiKmVGqVzBMhhhhlPqW0dsLRWnxDaE0Do8tOg7teii3Eby923P6QMWHX3ivo2J/DiBCO/tQt3UB5GhKUbwBB2B0Hyg4DNiwzgAwQBWzXMaKAN5VAjmsM+Z8N4DQjgsKoBekhUOiBvG0AAHAaA0xjrCSBgGuVQkhVAxAsG0MxbQ2hDaQ7e1QG2X5Pqoh/IIQjcKfpYvdn9nEnykf4m1t7kDwNFm6/Ajq8gyhDatiaaweXYdw/hwju013O4gRvMCND5W1Avs/kZer0gvtzx+61z87WfxBCSjZFKDggQ0zgBAOQQwpnUzzPT0onBL506FFQXKMT5lQ1p6zwtDsoArH5a2CJWw5MilTbAOWCgEMKGZ/VVnqLFrHVlHAFg8LxBbI2kMAAUqIIoxZrCVBIUrzncSNl2FyHAZUJULrPFeLOGAbRniKlnJkCYNmBxougKLvTwndmzhquVeoE5rDM5GFZpoWoABUnBGwiI54L6mNaXm5OUPrHQhAoAa8efkiIIiBdyDhHdBQZMZ385Z6X51leYWXWr8r0vy0+z14WlwHpqQjpSSFTVWclQaBbO2q8fqrbVka72DAAU3UE9J4UHdAE2Sm+W8LaYFciQaeKQUL2FFJSB95E2jVZAUMiyQvJGgWYdIobOmCI5vEiBCSQFgBPu5WgPM0hrTQEQSIiBGgNHCLQPiCeDjGfmanCNiMwDIAAMRgE7IiBX6wgN5DAn5wE+QIFco35344gP5P7QAwCv7sAKAf5wD4hf7wBoC/7/6AHAFYCgGKjn6QEwFoEYGWLwhzJAgL4rJhDF414wCFpd7Hq95wrKCOxcDhalT7JQzP6lAl78H6z+6l5agAD6ceceAA6uIJ9AoGocoUNPMlwUvhbirisuso4JitnqIXntsP8mYF6hbqNDQOcE0kMHAJNNNI7LKCYImvsm0B7l7onhZM1LspUq8KcKSAHDUGejYZtKEQ4SIDCC4UlG4YkFNCkJ4dWowImo0tcBtFVGPjAHCBPrsEcAKD5JwMWDALEUCCfpAEPlcGgZwM1PiJQlgffs5jIYQe/rlGQbWpQX/gAUASAcyAweAUwdAaIEiHUTAEiCkEiGgUiMkNEM9KQEMA7HSg5OwGGhJD7mYmDKFspJrgcPsoYTwSvoLogFqFnBPkMHIWXhABXiqJUlkv3uwDIFACqJEEotaBZPsPkA5jAC8Tkm8VADUCUggWIbcXwfcY8c8XdJwAAKRwB2wqgh6kDvGfHfHZa/H9CYhwmvHomglbIQl0hQnN6FF15mCzicAkrsD6jqEtJ4g1B04VwjQHAAiXR2CFjyCByfFfFZacA4nnAGpTrZ47KAxAg8orj9JbRpTEmX5cqXFgDWhUy0mkBlAMl8BMnlBKg56lQclYjbw8lQAClKxq7IAwBFAyDOhQQBiqCmnSxq4m5m5tykAJDNS+6jSXyA7ggyGIBEDMABgLwBgbbpwqmOlcCUJrIbKunumelwDemBC+n4H+mBk3gWCSCsShkOlUxq5+n9BkBJQyAjFzBmr4h0AbJ0h7QNZrgBiSA5nbBcAWlWnOhIgD5GnqnPjcRGgNlq6WlhDOlqLJmwCIAFl9hhAlmQrlm0CVkSQNZdnPgWBhnZZmlcD5nnCFkTlhqmDllWnKGsYlasRai05rmaQ6yqjqFHqdgrLr4pAqhKJ3Gt5gDBBQyojbTlKcCcIU4wCuAACEaI75ZAv5i6WJgpfxmIb5igTwl5Py15PQyuYA/5kF5Sv5YJoeCpliQwWcWoex4MqaDYkhfOKecgAh6ese+01xcAZJ+YYh55IYxYU+AoxYuphAs4ZMD5m8nKlidFOgDFpRzAzFNkrF7F1FXAzAGAxFQI3MVJxhpeklwQYhNQXK/J+04lklMJ+o+JwJhJmJApQp/xWIgJ8JaJ7xaF1wpJYAal0J5emlRlNUSJKJJlHxKlPx4FAJQJTlZlkJllEl0JlJMA1Jap9JjJ2aOprJ+pLahp3JgSfJoF+lmIyAapGpIVzJupygEVnJRpgSboWyXKx5nF3555KoMF2ScFt5GKSiVl5JcIT5L5yFTwX5mkf5AFUFpAwFLl2JblLVH5JVnAZVCFSFgFbVZleVpyMMgW3IvImQH6yAdOvYaUt+7Rj++IfQygcQbQcIuYzA+InRpBMhici+RI1BQBJgbQ+IdxE+kQLoV6N6t4a4z8j6kET29EOYfB9WAGgCzWlgxOK8pOgOnWrJ0A0Q6lNllO2i2gekMKGANQNsdyhKYQTizAmCYAGAyAzonkq6l0wQAA1MCNcBmHdC2lddzhJiAPFVslDCSWgIWpnvklSVeIUZwMsKsCmpKVoK0DCLKIIW6sikSbTTqkMLSvmMIUXvsicA0KQK8GDRKQ3tsD8i2p0ntDwSLfnm0CIHkFWSkIzsUFsJrtjDWutMfqfn8TEMEDeJEG0TgctWGmAGuG/sQVeHEEATbfMRKaQTbTeCMf0DEHCDeBAWgFAenMEPssGBzcKTEXLdkgKnvkbVWTIHCCsdsZXotTgR0fgV0cQT0eQT/gMTQcMXHf7VAdAXHYnYtKXZQcGFEPCFcTDDcYkJxayr8NzKoBxdVTZSqI3eogiR8TUJ3R1WBbiWUJ3WUOoPKYgdRazhpR3Q6ogHbH3XFV1cPZwKPeCZft5dhftJUTUVDAXeXcndgU5stbtfbSQb0d/v0cdbQTjAXeMSXVsWXffRXVoLRisQoRseXXtMMgeEFlNSdB+kQBYHCMCEA3aNdSjroDeBtlYI9f6GxM9ngOXu9Q9URl9Rtj9YJADiJBvLTHYtgtYHvIZH5IfELA4qfB9DYq4rFJ4nfOA0gAaBYA+uhhVu/C9XoFgsfEg59fPL9sBiTpg1AsDlBqDr6mIGUAwkrLfANqIuInsDwlIowq9uqSIhwlwrI5IkomabBnIs8AoucBo9LCooaiQkNFojomAHokY2gIYj4n4k9FGJEiTfMLzkCOnlwCapCvEBas3JziQJdCIzsK/YynqsZFqEMLEtWhEG4/mjsp42WqcPTr47UH6mtFWuij7mE/Mq4+UNE+anE/AAkyiv4yk0EypikOk77i45E9k6Ork2EfkzIIk0U4E2ikymUzdnQ8CJhkw3Q9jkEP45wwTsRogNtug6Bh1noF1kIzBjPTowJjYwkP4vY+08Myhg9hhr08eFowwMxNGMg01lxKoCAkBsvBgxAlg9+VTnKXIdrVVHIWUJJVEk43oOE+cSRQoSLqmg7pLuUNLj6q7nEPLqVHIaruIRrlrgbbrpUgbkbqIIOebsCzZBxLbvbuLo7lpi7m7n4W5F7j5FqOE8LgHlCBwMHqHjgOHowJHltQZsKUqUMHPsnnwaRe6iIfkoDdYSaoXrKK84UTZRbTmncXXhbbLdyzVVoe3nYJ3hkj3h6vvoPkflDZwAUUUZPvxbPonpwKccvnIWvrTNtFc9vrvn3jknK1sqgaMTshfogZbYfXgS/j5EQafdnRfYMVfZOWMQHcweazsmvXSEumbCgcbaWRa6wdOinTaztenfa90Z5k61QS68MWgYXZ60G965VLxnCBwRq4vmcdq+kt3ulB6rTbRRIccXzn6bmwS0oftKoRoVoVULofoZwdm90nwdcNGeYbKGy7JrYYankfEU4XKhgK4e4ekbNN4dUe7ti08I2EESETAHU5kO0HIFEUVMujqq8LTo4YkUO8kSOzNF4VkZKT8gNJUvkfgcqyUdPkjRm1vVWrUQNECA0V600S0da7gRG3ayfVnX0XG3nXQW6xa+MZMdMbMWAPMV64sRAMsewGsS9MdJsaQNsZ/ThfsRDIcYRU29wVq4y7S2NVDHXXce3VpU5bpcqZ1YPYZR5SCWZVTRPaXkR3ZYiciTUKiSCaR65RR8R9R2Pd5QK1OsEDJUFcVSlWFXqeyZFVyX1ryZEP3eTc6mKeDZKbCtKQ9LKfKyG0qeGUlZwJqcQqFSyWJ4rgaZJ8ab2U2f2dabaejmZxUabmonCG6WAB6e8gmSkD6QJymQGUGUaCGcuUrI2ZwFGWYbGU5/GYmfQMOaUF5+mZmZA356ufcCmWOUWQB6QRWdYJrWADWXWTZ82WEK2e2dyZ2d2TZxZ3C1wB5yOclxOWgdObOdWWuAuUuTZ+uU4Cl9ucqRZ/uWowoIeTePlTg4VdzMVVeTeQhfeXR4UbVa+UNZ+cAN+c1fVW1SBXpV1Utzp6N/BXTohd1UBTRxhasXhyh3hQWxhwy+SUyzsrh5RaJeZVwNzPRYxQJSxW5CJfXTg1yjxWgHxVe4JTAMJSpSefrL5eSeeTJXcfJYpVxbxkomsSD5blPVxzpbJ11Uj6ZVst5VVQjwx0CQ5SxyRyj5x4x55RjxZVj5Pf5YFfx8J1qfp2lWyUZxJ1ldJ4TzS5wIlVOslbT6leFeJ5ldFYHDlSUqNbd0NxeZt+VRNz5epdN+t41TZIt0Ne1QvRR+t71f1dt4Na1ahblZhXhxNcDFNVUf4LNY7KQAtQfe+6tfgOtZtUqB+wQXtfgQdSskdS66deddCZdWA0Vg/AaOmWs/6M9dhq9eSe9TPPs8Aug5yP4N+Qgw8cs/79A905YOMyAEfCirhto6CIc46OH1w1H8c2AhRmTgDTnkDeztZQ8cENLRDWUCPjDTbFKkWYjcjajejWUJjeCLjfjWQITUEo83lOTSUpTT69TSy/cAFQzRm8zWsGh6HTZOHdzfyu6oHDUPzXrlfBMFwCrVWuLWGpLQpzLTyjkQrT5ikMrR6kXuCmrWsO9BJNrQemC/rTriUma97WbRbWG1gNbdtHbQ647WdrbRXa2gd2ttE9ri1zgPtP2kwSDoh12ai/fIBHRyLR0jWJ+Xeo/X3pLVbWjvL9jGx/a50hi/7G+h62Lr0hy65dJEJXRk4+4bu73OtA6nPIt1JuU9Jet3TnoOpWeBlJeivXQrj16Bk9dusPQ4FOwuBmIHgft34Eb0hgt7dAfSATqYCv+lvNOp+wdbftz6v7IgdfXkG31yBj9SgdQJSbrEgQpgD+m0xGSTVr0f9SZIA2Aauwfet1YZpA0D5IQqsn8RBjs13AR9vszgNBkX3+xnN14QPdhhPHwY8xCG/MMePYg7BkNz4UUS+DFA8TxRE+qgB6inz3AbM2GJDSeJ4KDIF80IPDE5mM1L4TNBGcCaIP4zEbxxJGSjaRqo32AKBeE+jKmIo1YQqNWMTQ6RFs3gyKJ44hjNRCY22jaJkkFjNRNY18QLM7GgSQfs4wib5h3GZqWJguwKZ+NkmzTXVKUxCb7QMmlTeYTkyWHeMVhSTMQMUxabBNym4TLJgsJiYrA8mPjQpmsKKglMdioTCpnMKiY1MDh8TBpg8JOHrCk05wxPs+EYaY5hmmQkAP01yHAhvBhOZwHNlGYl9/qpQmBFMyYRmBah7Qnrrwnmb9YAkgcRPmuGT6gi6IIfPQDUPz6DMvq9DBEX9XObJRUoW+ckjc1kps4HmjjPKC8wraKExcxACXLJh+YHFZcALBXCyJBbq4BR2uQ2gLTACG5jcdneFq20RY25RoKLXkWi2dyu5J2nubSD7nxbcjA8owElr1g2T0oKWUealv8XjzqsoYklS7rKH5pdtqmnLXgm3Wr58sXRCPQVoWh5QitaqQrDvHmyEIyt+8JrEpCPkVbntiiFQK9mq3nzNsPRqedfGIE3xK5HIhrLZAfiHxv9A25+Kmm+xUG4C1B+AjQYQNdaJtxiLBMfn6xNJgAzWKbS1pgW/4FiM6jrAgZfQTZesk2sBL1iG3YLhNNWCYt5sv0OIooi2dIY6P+DWClsgQ0hFMlyI+aFEVCahTQn2HrZx49CmbAccC1MIxkLCjotdnYT7absEizhHdikVsAeEx2h7KtFi21FVQZ2wRddt4wiLLtEuLqf5BtA3Z5gt2p4oYBED3YZFx2kdXIqewjHj4VWV7core32T3t6iqQRos0VaJNij6kbPAZ/jbHxt/25Y0gcBwfagdwOKbSDtB0O7GD4OZgrYUMFwoHECK04rNlh0HH8FrutdKigIPo7V8nixPNjmIPcrGVuOq9fgYR3YlaU8eGMLiSrzZ5o8iS/E3jn5X46CdqeunbUgZ3Sp88oqUnZymIOh5FRa+SnS6Cp1qjU4x6ipB0tp0Ul09eejPfnupNy4WcbSqgO0jZ3K4Oc4yLncLhVz9JedoRPnYENmTI7+c1cQXGMs5NC6uS3OSZSrlFzTIZksy8XCMolyq4blxyxZWrul0y7ZdgQ9ZPyQlzy7Wk2y8YIri+BK5ZS4pZXeUe5KS6JSUuKUmchlznKNcXwzXYqbmTXIVS2uW5FaJ1z3IHkjQN4I8vtCB5i8RusFMbttyl6PkxWM3VqnNwW5a8UKK3PyfFTKBq8JeA1XbsNSMl69pBYAKiWhxomK4pCtotPO6iYn4cWJQPWig914pPc/uAPVuvmE+6XTvu10l7mxUB6cVyeqaaSgFRZFwhIedIJSmwVh7S8q+sJTicj3EkGVJJXlMnvD0EFCTGOIk1juDNW5E8qOhJaGYJg+kUk5J30oTmZJ56GdjMVk40rFRRls8OeViLnnpwJkqTLJak40kLxqgi96Bp5GyEVXV4jS7ylVWGS3gmly95uTVWaUBXmkcc2ey04aVtxSBCz1pwvTaeNQsGG9r0xvKgKb3mowBkJhIa3rby2oO8J8DvF3mdVLEe8LqUQBwcVgNAbgXBDWcEXIXeoPoUGXEI5mRjwAx8qAcfPQB4N94gQLZVEFPtAyREgBKEzCJRiNjGwTYpsM2ObAtiWxGgVsqgNbJtm2y7Z9sh2Y7KdnOyXY7Z+QpAE7L+x8NAh4GNlsDRBk18zUEpSGg304Cw1m+CNayG3zRoY1wkWNHvl+H77E0IRpNYfjVFH5WsJ+9NKMDPykypoF+nNQMTzUFTr88k0ooWjvyv5zs0glQA/lLTLnaBZap/DpOfyLIjjLo1/daurXv57RH+maCURC2zGQC0Aptc2m+1/620T6gA/EC7XSCgCH54Ar2lAN9pJs4B8yEeeHTXYoDV+aAnevIL3pKDsBusqNpnWLEUFNBrrEgUXTvqIcH6iCp+lyBoE11Tpt3TukwLulwzHibAnuszlEEQzxBMzXgbsAEklzp6cGEQecG4mELtGZC2jkd03pVF2eQC+FAoOQVYDU6KE1QdG3Qklj2xxAnQaQIQXbEDBz9YiW/RMEIckO5g7+pYKOJpQbBQDEBhYDNl+8NsGOV+KxHBGeyGaA8bOYgD8HOzfq/DIIMEOyFhDAIfMOsFELwZhQz4A4C+NviobJDaGUECwGBFBEZC3BOGKxVnMpFcR/8NI8xZ1jKE9ZKh4oaocHLaFiJ6hcjZocaP6wYj4lHQ+Rpoxmb8ZehyiDZJY0GE7QRheSsYUMHlATDcRSzdkbMKuH7Dbhywn4asL+FPCzhmwi4ZkyqbXDamhwhpccICbNKNhLw7YW8JqWfC6l3Sxpo8O9QAjWlrwy4R0tqVeNvhEyppVMrSbLNVA0Iq2Q+ngZ6BIR72aMPbMj5wjeIpi05mBnCUojyhyS4RHUPSU4jFm0wjxRsvxwp9g+1WRRoEodlPhjQ0fQGLH00jx8FA6yo0J9j9lp9iwfWYRKHKNDjZJs02WbPNkWzLZVs62LbDtj2wHYjsJ2M7BdjaDvVMMXy5wCAivS5hYAf4YTOKHCGygYscWDGIDGxi4xSQbAAmOFkpUpZosaMeLOqGYBJYWZuDY+OeRsUHx7Fx8EWPtGtAjgciUMd9Dq28a/R5WUkF1MknBCFEFAGbJOArDTwUt+ANQROtkzaDYwdke0dOCEJChwh30xsKWFn3UTsrGMKoUEHCFUB2xnwkQCgFLFaGqhoVsKiOQiujnIr45qKpORitTnYqM5bQM0FLCMgWwocFgGHIjnjUJr7QEajOOnBYHt0M+O87oXbFNUOJ/GOkOENavTiCTHiQc9EbPS3RWK4Qeau5MHKLWUKIVFUFhNmsrXVrFG6cfwBXFEBIBQAgQeQJrhSAuyEArgVwEAA="}
import { Hooks } from 'wagmi/tempo'
import { parseUnits } from 'viem'

const approveSync = Hooks.token.useApproveSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
approveSync.mutate({
  amount: parseUnits('10.5', 6),
  spender: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Approved amount:', approveSync.data?.amount)
// @log: Approved amount: 10500000n
console.log('Owner:', approveSync.data?.owner)
// @log: Owner: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb
console.log('Spender:', approveSync.data?.spender)
// @log: Spender: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.approve` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useApprove.md","from":11991,"to":12636}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { parseUnits } from 'viem'
import { useWaitForTransactionReceipt } from 'wagmi'

const approve = Hooks.token.useApprove()
const { data: receipt } = useWaitForTransactionReceipt({ hash: approve.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
approve.mutate({
  amount: parseUnits('10.5', 6),
  spender: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})

if (receipt) {
  const { args: { amount, owner, spender } } 
    = Actions.token.approve.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `token.approve` Return Type](/tempo/actions/token.approve#return-type)

### mutate/mutateAsync

See [Wagmi Action `token.approve` Parameters](/tempo/actions/token.approve#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`token.approve`](/tempo/actions/token.approve)

---

---
url: /tempo/hooks/token.useBurn.md
---
# `token.useBurn`

Burns TIP-20 tokens from the caller's balance.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useBurn.md","from":120,"to":9097}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"5b6d09a09c9cff3e14ddc9584d71dec809880c31569d5f43fb47e4d50b5f31db","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUoiaicACUnABmAK5gjowQYJxY4nAwAKpgjGhwwURhcTCInCKkpgoUnLDWLGFwZWBxzABGZJFlbYwKpmgAOrms7FzppJk5eUZQENYIegCycTJojFgm8Jyi5WiVipykMFhHmWBiaymcEDHbnC3tZJxtGHd9JKl0bGbn17dtERgnAAjBZOMFQV8UvI0JEAHRDIYAWk4ABE5k1OPg0GgsE0APT4oiMGDMOFwfD42bzfFxNYmNbwfHjSa5fL+MQKBbIZAgOiiVhyfwsNgcTjANIZbJsuCcVyxUgQZicADkxNJKsRYBZ0umwRVABYAEwWFU1SSRIaEzjGix2+0OsAgAC6zuEml0BvUxnkShUiFBGnE2iCOqm7NkpnMwJsdlIDicUncnhweEIJHIGkCeGsKREzzipDAAGUMIkygZBHC0AJ5HC4pkAEKFktl6xwgBKOhbABUvAAeADCKRivRqCX4kAA7mAAHz+ETiXQAdmXsl9yiQAA4g1odHg2i3S4l/CYzEgAMyx+yOPyIABsyeoXjTvkzAXoTBGYsrRkXEkQLcdx9RRN0Qb1NBDPBf1PKNL2veNb2cYFlyfTBUz0dM/CzT89BFUZOBrfh5AXD0pANddQP9CDg33PQiJIyNz0QK8QFsG9E0QI0LzQl9MLfDlsz0eJEkuVIGxgZsi2PawhxHMdOAnac52CcYBR0Mg4AAfgrPgqwYsB6ybI82zhAAFexmA0iY5LAUdqkUsBJwgGdZy6Hg9Lgata0MiSpNbRJO27Is+xwWz7PHJzlNnIYwHUuB0msIE/JMk8qGpBZ9D02J2ALIsqk4HsAEkzJNQifNlGJFWVZQgWsMI5FIFVZQBGRRESGAETAIYADkIBoMoe3wRhZRGu44DbfBFUgBssWy5RRC4KdRGmHLSEI/AgT2dq4ATZJuvOCBniBUxrBkOJYCga5Uh2NoZDmfhjpidggSONAWwKnZTm+TI4Q5UQuSQHk+VoAUNlwKgAANofyWghnwsUJV/OUFSVVVloUZhGHxGgRk1A6RKSK4AEEsCwYJomAIZOE4XMwHzCVmDpRaYBqEazPkKACvlABeDzDG84jfOM6S2wprUabeltwWpmnOH7Q8cRSWW5euwcTGsfgeeACnOB52dOCZi4YGCCUBQgBI0DKUELDAGoDLKFULFoOFXZVOVIlcFW5a53a7pgKBtfZzmqi91I5Zi8PVf873+3xRWaznWXLTAMPochl0KF5NTmH8HPrNlFELPjKynC8zPeSlosjGWC59sOeAVjQP7XXdJckBtyi/Q7mNqFooIUtFtLjDgliEITO8jTcDxnwwnwM0E3C2LzLhDyH6xdIFgyjMk1L2y7d6QoHYc7IUpSXLnUj24DSR7y7sDgMguiQDXgLrFg5i77YuMJ+cCxeLnlhd8NAl6qUVDgDgGBohGxZmUQo4hGCiH9piV+MlzKWQLuFXos4agQCwGJbSZRa4swAPL4P2nAfsVMo6o2YGUSGzsAAkwAKih0hgAbm9ubS23Rej9E4TQo4SV1hW0KvGeme0UhdmEfggR7hOCNkBAAUVIIqUgoVWZ5TfugkumCT72RwY5ZyrlOAAB9HKwFHGYKA0R9acCIBARgUB/AZTwENIEMCxKxASETVIGALa03aoEmQMhOBTjyPgexCCkFyFlDWQilQFDaHWrVQ2zMvHtSungsSDVXiEEMNdbYUAuY5NCfVEJAJNbXHIXmP6QZAYoGzpZfwRRKgxK2CidxUS2nIOuG0AAVjARw5VJRwDiUdVJkNPH7QAGJgEhi3LOIAc7+GyRQuEKRixxGsElMZnBOnDUqj4rx4SQmxEYEcMJm1UipOmVcMacBtm7LgPEUJmSwmMDOR0UZmQrq3PSftZqDdHmrEWU0kuqyan0w2WAFRaj9mFUOd40S9dTmhNHJcxgtx/l1yuPIXMltNLbE+Ko3K7y0XHR+QHDaQIyBqLBcs5pVA1m1M2ToNAcgroHLGoTE5nz0UXKBFOa5NK0m4tSGNGAESniPJ2fAF5KwZCvBiDoWw1Lcr4otucIlQS6VkrAFdb56QxnUqlbVFJm1aiLR2Bq0lpAGVHGYOIQQ/gURFVuP4uIhtRDETSasdYcgG4AEcSgiDgDUSGmynnyshh8s5GKgQpCVdsGIThRVtRoPmcpoTPVqg8aIWAXUUTEzOak7NlTHq8ooeCSNJZo1jMhhGlIcL2CNs4LW4s7LOWQ2iOIIEDinHIt8eG4lfzLVV2sVE86Qr+WUt6JAI4UAW5uhAP+XQJpvRyCokgL+T8gieIhiPT+48kJJhnuhbwQDF5BDAXgsgmBe3MC1aInofRzhXwAkaYEX8t3dwfLuKCehuHvqYuYNc38OKTwAZegSOEb1hEQVESUExdT5HgdOsorDFA1DqA0GQmIHgdFIO5V9/R4bfjGFKcMMwMR4GWP6jYJJZQ7CwwoBuJx4AwkWvXG4dxCNPBeG8RgHxOBQh+FwXjAJMggjBBCCwYmYTwi1CidE8wyjYlxASIkJIyQUipBiWk9I8hMeZFRmU/0GnA35IKQ9CMuASjDDKFGVU0Zqh0/jIYjm9SGhNGaTgForT4htCaB0oWnSt1XWRLiRoKIgT/YGPue5QxmemB/MDJ7OKgmg6+BecG8C3ogQ+8qQsygDBAM7E01hQvVZq7VurdoysfvXQaaQcWwI0SS3gAyaXtwZag+evi89sIfiCHFKyCUHB1TzBAOQQxWm02m3IMoJ84AzcPa4vQXTIZ01W3IWNT6oArCBCcYgTitgsZFIG2Ah4kkFR22tjai1OAPJYJ88QIzapDAAFKiCKMWawlR8ELfpg9qy7FchwGVCd4kl1nivCnDANozxFRTkyBMLqQwukHaO6J2gop8iESnEdBKQysWMGsAtkY4mmhagAFScGJu2lba3Y1nQiLKcJyhDY6EIFAWUsrIkRHbfduQcJ7oKApm27bi3Op6tIJL0dwuZdwmWkWBXC0uD1VSN8iSfyjpTkqDQEZ7VXh9ULf0/newYACi6vTxnCh7qtSVyDvbz36ZiA6sD+yhZqXxIN3kLaR1kCQxO888kaBZh0khs6YIGm8SIEJJAWAFuNlaH0zSDN8A0BIiIDFuEtB8SiCwNjUP8q4TYmYDIAAxKXsZIhI+wlHUMYPtevL17pdH2POJ4+J+gDAFP7AFDp7gPiTPIgc954L0Xkviow8V+r639vqj4SIqBA7iATvpcu5gKzoJOvfkfOUBbLgdmCqTKT6UEXO/DbQCOxjsAAB9WntOADq4hciKGfw/walr19O6v30oMo4ECqXLzsxpcmYNKutDtiNDQOcEqkMBNIkFNCkBbLKCYL6qkm0CjmjgzmZEVHEptK8KcKSP7DUAutsJcrVK8DASIDCAgXFEgbYNNGgZwBgUCA1NcOapwGbp1BbrsEcAKF5JwJ2ltJasHpAEblcK3pwEVPiCQp3nHlphfgPmnhlKPizOPrngaPnoXsXsyLPmXvPlXqIEiJITAEiCkEiK3kiMkNEM9KQEME+pinZOwE6mJPfkoqDDZopHAGfr/o7mEM7rtjvogFqOnBbkMFfmLhABLiqJtCEvruwDIFACqJEAItaGZPsPkOpjAIkWEskVAPbMThHsflEcruLvqAkfdJwAAKRwB+YqhE6kApFpEZFBZZH9CYjVFJEtFFEjL15lGJDK5y7BBmBTicAtry4qgv75J4g1CragEFQAhXR2BkzyABxpHpGBacCdHnCyhy7c5jIAwcEGq7AOCPTbRJQDER50phFgDWg0xTFlCzF8DzHlBKg87LEFpYhF44DWI7GqxPbIAwBFAyDOjgQBiqCAlyxPb/aA7NykAJBFRgBDQjQnwgJcBjF96IBEB0LAgXhGgBhbgpyPGwlcAkIDJDKInImomHIYmBDggX64l0IXgWCSAsQkkwk0xPbMn9BkBxQyAGFzDyr4h0BDJ0j7SICrg3zcnbBcAglgnOhIgG5/FkAPjRZylPaglhDwkiJMk4n8lFhhDCnPJim0ASliTSn3gPgWCklBZAlcB8narGlClOqmBilgkP6sZcQXgsRag7ZOnqR6yqgv6zodgb6mCrZgAqgCLRGq5gDBCQyojtTJKcDMJjYwCuAACEaIqZZA2ZPa7Rux2RmIKZigTwYZZyEZPQIOYAuZ5ZyS2ZxRuwsAqiQw6cWoXhYMgaDY/hQIkMzOrubOYy9xHZ0MkRwx7u1wdIIZIYxYVuAoxYnxhAU4FMcZK8omqic5OgC5ghzAy5Vkq5655R05zAGAQ5QIfM4xwOIRcIl5wQx+NQdK2xB055l5MRcRPRBRfRbROxexORWIeRNRzRKRLZQx75FRsRVRwFR09RjRoFqRr5mRpZuR+RiF4FdIThF5IxdqYxMAExUx+orxeCI6ixXxBwKxvx6x1iWxxZAFmIyAzxnAJF7x5Fyg3xqxap1iboIydKAZm5mZIZMx4ZkZdZsZ2FH5CZSZjZTwGZ6kOZeZFZpAhZyFHRqFSlaZVZoSNZUZKQDZ+ZKlLZ/F8y0MFm3IvImQh6yAq2hYSUMeShCe+IfQygcQbQcIuYzA+IKhI+F+8cjuRIk+o+jAbQ+I0RFukQLoK6a6l4FgP6G4/o4Ge6OYMuPWAYvc7EiEnE/8A2gCsGI2+WoB0A0QH5lR42u02gOkxKGANQrsGyUKYQxcQhZQJuyAzo7kA6V0wQAA1MCNcBmPdAWpFelLRnoAxSMpDIMVHofpEuMWeJ1JwPRmsODJQQoK0DCLKFrpSsar8jUJzpEp9qfBMFwLrtsIQcdpUE6qQK8OVScYrpwQWiUvtEEadULo8m0CIHkJKcrGAGCaGuUK9m1CkkHiHtkTEMEBeJEIod3k5U6mAMuKnkPmeHEAXnDdYScSPnDReAYf0DEHCBeOXmgJXinMEKksGOtfsZQRwWcjtb7iDZKTIHCA4e4ZLg5d3soX3qoUPuoWPtntobodPoZp8oTZXlXgzczYtBLdnsGFEEpgdBEXAKeVms+iGaoBudvp+fqASucGULUakTUNrbCPRRpYbWUOoDcQ3krWtprSqKbX5obWpSWV0WUKbZwObfElNYMKZZDFqKIZwMHgzUzW4YtKzV3ppk5T5YjcPhoZmnzUFYLYHcYeLcHWgFLUiDLfYblM4SdK4aQO4ftHUn3JZpZadIekQBYHCMCJXXaFFW3ABBeMCLFr+mBKxMlXoOLmlcCBlT/KeoBNlvxLlgVXoIGVojJJvPpD5DvP5GggfL2MfPJA5OfK5E1peBePFduoBABs/Kgm2J3d3ZBs4Gyf3UNsAkJCECdoVlAlamIGUNQqrC5nQu2kwiwnsGwgIkCU+jws8HwucO/XLEIlKvgoNOIrtL4tIoA2gHImYhYjAFYgHC4qNSAF0m1PmLKs8q8smqcDNiQFdFANamtKKncoZFqJjpaig1wGg/Khg8QfANg9Sng2IAQzitxikPfqQ0COQ+UPWgqiEjQ7tjg9fTsA4YQwCqwyQ3SRwxEBQ9w9Q8CnQ7g/g8I8wx4SvSxF6PfP6LFm3SAAw6IHvX1ofdPCmDBoPZiflhffelfcBi+j/VwOYgkJYlGM4nXboBeKoL3M3f6Luv3HgNY/oxBllXeF6MfVenlnoJmRNtcVfnNu9lfstqlSNfMG4palviEftrfoGtDmdsxgDT4ddnELdgcAARrs9vzoDe9vEodT9n9gDvqQAWDnYBDlDoqDDtSoJgjkjtgS5Gjl5FqFjhk7SnjqMHEkTuUDgPUKOBTp5d8BtWOWAHbkzjLqzigxzhEtzkfnzlw7YGdcEdbZUVDRGtEaMVDYrqk9bdJScyU1tfvnTWEoboHtVTwX3nCPwRUNbmSEMAs3/kEWc67lGR7lEwvT7nrncwHiMi3oYWMuHg3tDeHb3snl5IPtHbzRPjoVPvoa3iLQvpC2MqUXSL2gas3qDSKVC0vqQLCz3t5ZzYi2oQZii/zeizPiS15MYYvrccvnCKvpwN86Er89ftc8lAfvtcfs9hRv2e2syVfuk4dqLlqE/q/u/lUF/j/mvoEWUjLoAdSSATztAOAUCJAdwbQXARyhgIgZNCwbNOwaKl06jk8MTPgedXw6QXIOQWSlQUQbebAfQaa4wea6gZa4wL6pwf1JtOtLwS85bvucIX7akhIf1ImqkDIXIQoWzXC1Swi1HTzZoXHWi3oUy3PkTdXqYeYZYWANYTi7YRAJnY4WANnW7lLQXV2d4StX2QcKkjy7s3tnMwrVbaLpUfEbBT+a0Y7QxWhSBYUS2Z7b251P29+fBTUE0YUX+Q8epc7UBehROxbUMUc3hTeURTMXMWRZ8RxZRT8Wsf8ZsZECO6WVufCrddoIrouFUlcQ82S/cWScxaxUe0sae1xTRQHFqQqTqeCZCcCNCSu6rPKSIbU/gnCEiWACiWiXAAyfQAabACyQGIScSfaZB09pSUATSQh3SeiSkJiWh6UHiSxOyZyTh46fcIaS6YKaaaKeKdYN9WANKcuLKRB3R4qWEMqaqesaQBqUaEaIB6JmCXqUDtieh0aUx63uaZaVKcuDafeHaeJ86U4Ex+6Q8cB96a/YoL6f6QdCPUJXzCJdWWJdGRJVOXedJcmYZemcAJmYpbJSpUWf+RpW5yxaJbWdGQZcpc2RbSZZ2QdN2T4a22xpMpecs+zt2xOYrbZxJrOXzPOYuQeSuS5CeUl7ezuWgHue84eTAMea+SPZBdviGTedEQ+U+be6+ZJVBV+YO4hcuyhWu9+RhSMhBThRrbO4O/O+jEu9e+1815u/Et1x+aMXu3hQe28d+xRWxlReexsUhcN/sWUExXai8Yewsce8NL+9RRe1ALxfEiZUrUGVZMJdpZwLpeJQIuV3Z+/jJY5/JVZK54ZapcbWu959d7d/55pQWcZe2d7eZUDJZTANZbZaQPZWHZSy5fgG5R5UqOm/3r5X3v5RvoFbmyYKFeFVELXZFtfG461p40gElT48PQk0etGEaAY0gDlcY11gDP4JmXgB3S45eKoCTwlfT2EyAP5NStY9bBYKoGFp3bTwE7/PTyE/lWY3oMEEVTYpwKVdBfezAFVSbrVa7CyoKU1cwJiK1e1WUJ1eCL1f1WQINTYgg0k2NTe/EpNXi2gLGvtfcARfNZy0tQGhwVoBTQTgK1Sv0S74dRivmK9edWkJdeIDdfKnde8g9cUsZikC9Qfm9W5Z9e9GJDE9OmU1jEDeC6DbjRDVDam1gLDe1AjUi8jaje1OjdoJje1NjScLjfjViyTWTT71ZJTX2tsDTezrcwHfSEHXnSHcX7DxzRm0i1m7HaiwLfoYnYW2LfSFLWnRnXLeOZDJOSPYbarerXef267Xrfbc+mt4Ba7e7SUZbbZ3s9Bbbc+ogEf5bCf5iGf5O47+v77RD/7ZDIHVLaHY5fC6j0zZ0ts2M/RlkLUZpJ0l+KdFfloCQzCM62pgBtqw1B6NJV0pdFpBXSro2wCeMVFiPeHAyk8x4iWQDMYFiLi86efdXKiY2Gxy9l405HeuWH5gT0hYU9PeEFEPiol56p8RelFAvjzgOenJKwG1n9CPwKeL8PeOQMl690v0MvUxmfQKyWNogujW+t7Afr0Jn6rGVwBwi4Sf0da39N9JA29gAMREwDHaJIjADgMREUDexgalgZONremUZBlIy2boNFUfDeRoIyYaWoiGbDCRmwWcGUMxksjLBjIAEa6MvBHiURsQwOjsN/BqDGRm4LkahD6GijXKMo0bYxC/BnDQITw0wa0NkhCjRhko28FRDC6uAi8FuG54b0tGYg3RpIMypS8qOsgmgfIIsaQJ7C1UdQbQGYSaDY0NgxxtYlUYXhJAm6HnogBqGdZhI1UeoT3U4hr1j6nIFnupDZ5kCBBBoCwB4zGFCDaBMyToZwGdjLhjQUANxoOGsD3h7wF4A0IOBF6ElJARoVQKIAvBtAtwBoA0I2GsCSAYAy4LnqoBiAWA2gSiNoG0E7qxYGhvdf+CulzCwAvw+OcUEwNlDygH66MAGFjBxikg2A+MOzHCK8wE5ER1UVUOqGYAeYcuDAinHzF/CCw6wg8N+OLAOjWhBwnBKZOkmvymBgUP0B5hJHWjmDwQnUBQJywThXAzo5OfgDUGZpcM2gWMMZPtBTiki4QB6U2LLCF7IZWQ3mUEHCFUB+Z7wkQCgLLAdiqgKsFgKrPVmNEmj7QZoIYK4BTjTsbaAvK6ELz8yyjdGWkOENYxTjRF+2uwpUPfxqCOjrUzoh+inH8Clw9GiAUAIEHkB+EUgXWBAK4FcBAA"}
import { Hooks } from 'wagmi/tempo'
import { parseUnits } from 'viem'

const burnSync = Hooks.token.useBurnSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
burnSync.mutate({
  amount: parseUnits('10.5', 6),
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Burned amount:', burnSync.data?.amount)
// @log: Burned amount: 10500000n
console.log('From:', burnSync.data?.from)
// @log: From: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.burn` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useBurn.md","from":9435,"to":9998}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { parseUnits } from 'viem'
import { useWaitForTransactionReceipt } from 'wagmi'

const burn = Hooks.token.useBurn()
const { data: receipt } = useWaitForTransactionReceipt({ hash: burn.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
burn.mutate({
  amount: parseUnits('10.5', 6),
  token: '0x20c0000000000000000000000000000000000000',
})

if (receipt) {
  const { args: { amount, from } } 
    = Actions.token.burn.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `token.burn` Return Type](/tempo/actions/token.burn#return-type)

### mutate/mutateAsync

See [Wagmi Action `token.burn` Parameters](/tempo/actions/token.burn#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`token.burn`](/tempo/actions/token.burn)

---

---
url: /tempo/hooks/token.useBurnBlocked.md
---
# `token.useBurnBlocked`

Burns blocked TIP-20 tokens from a specific address. Requires appropriate permissions.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useBurnBlocked.md","from":167,"to":7326}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"0df2568dc9b4097277b953d5c3f9968dc9462d150265a4dbab251c23f27cd1be","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUoiaicACUnABmAK5gjowQYJxY4nAwAKpgjGhwwURhcTCInCKkpgoUnLDWLGFwZWBxzABGZJFlbYwKpmgAOrms7FzppJk5eUZQENYIegCycTJojFgm8Jyi5WiVipykMFhHmWBiaymcEDHbnC3tZJxtGHd9JKl0bGbn17dtERgnAAjBZOMFQV8UvI0JEAHRDIYAWk4ABE5k1OPg0GgsE0APT4oiMGDMOFwfD42bzfFxNYmNbwfHjSa5fL+MQKBbIZAgOiiVhyfwsNgcTjANIZbJsuCcVyxUgQZicADkxNJKsRYBZ0umwRVABYAEwWFU1SSRIaEzjGix2+0OsAgAC6zuEml0BvUxnkShUiFBGnE2iCOqm7NkpnMwJsdlIDicUncnhweEIJHIGkCeGsKREzzipDAACEZHN+DAoABlDCJMoGQRwtACeRwuKZYuFktl6wV6u16xwgBKOi7ABUvAAeADCKRivRqCX4kAA7mAAHz+ETiXQAdl3sl9yiQwO9mhDeDaXdL5crNcS/hMZiQAGZY/ZHH5EAA2ZPULxpr4mYBPQTAjGKDZGNuEguN6ciKMeiBnsGOh4JBj5Rq+77xp+zhGgaf6YKmejpn4WagXoIqjJwzYVk67o7ieFgxj6CH+shWioXotHyBhz6IG+IC2B+iYCRYhEASRQEctmejxIklypO2MCdkWN69neA4znOC6cEuq4bsE4wCjoZBwAA/PWfCNjxYBth2149n296DgACvYzCmRM2lgPO1R6WAy4QGu65dDw1lwE2LZ2cpqndre/aJMOo5FhOOA+X5i6BQZ65DGAJlwOk1hArFjkJS5/jUgs+jWbE7AFkWVScGOACSrkmjR0WyjEirKjsbROZW2xQFApyRVqAByEA0GUY74IwsoLXccADvgiqQO2WK1coohcCuojTHVpA0fgQJ7KIYBwAmyRgEMzbPECpjWDIcSwFA1ypP1TkPTE7BAkcaBdk1OynN8mRwhyohckgPJ8rQAobLgVAAAao/ktBDFRYoSpBcoKkqqr7QozCMPiNAjJqt2+QkSRXAAglgWDBNEwBDJwnC5pdXASswdK7TANQLa58hQE18oALzhYYUV0fZKllRpiXWMzWrswDXbgmz7OcJOV44ikWvax904mL24vAMznDi+unC8xcMDBBKPVKmUKoWLQcKe2a2zMBACRoGUoIWGANS2a77ue3CKpypEriG9rotXQNlbm0LItVHHqTa7lWdG3FnDqX28eTvievNhuWuWmAmeo8jLoULyxnMP4TdebKKLufGnlOJF9e8urRZGMsFw3Yc8ArGgEOugxMGggerF+ieAAcQacUEpVqYNSt8eYgnCThokvr+Hj/sRPgZjJFFCXmXBXpv5UDlZ0u2XLcWF5pSUjoDqVTrOvm6fpYKG4tweiQEaQMC9EKnlXhePQd94qKwqpGfi35sIJi/OJE+RFvCkWAjQK+RlFQ4A4BgaIdt+ZlEKOIRgohk6Ynge/JWcJO4mR7hlXo64agQCwIpCyZRh78wAPI8JunAScrNc742YGUZG7sAAkwAKgZ2RgAbnjgKP25xui9H6GoyRRxirrADs1eMl1ropBHIYnhej3AF0BAAUVIIqUgaUBYNQQc5AczCPJt3YQoThAUgohU4AAHwCrAecZgoDRGtpwIgEBGBQEqhiPAc0gTkMUrEGmmSMB+w5hdfJMgZCcBXHkfAcTqG0LkLKe6exejaGOsodJfNMkXXetwxSYQZCvEIIYD6w1RadOKdYLpAJezXBEXmCGQZoYoEbh5fwRRKhVK2CiNJFTll0OuG0AAVjARwnVJRwBqRAE6QJkYZJugAMTAMjKeDcQBN38B00RcIUhVjiNYYqxzOBrPmt1bJo9SlFNiIwI4JTTqpCabbFpo8lpwE+d8uA8RiltJKYwEFHQjmZHetCy5KQVSylOBPe58yu7PMmZdN5YBHHON+c1f5WSFJAoxcU+c4LGC3DxbCq48hcz+zMtsT4Tj6pouBcUrF6RjlDWhWQZxpLHkLKoC8qZ7ydBoDkO9P5S15K01SOK0F4KVyQrOTCkeVwlowDKU8BFXz4DIpWN02IOhbBDXqnyzRPchWcDlaKsA71JURBxT661jTTq1F2jsd1IrSAKqOMwcQgh/AoharcXJcRbaiArDC1Y6w5BjwAI4lBEHAGoyN3mIvtcjdFIL2VAhSE60QMQnCmpkPzfMIyQXprVOk0QsAERgBRHTEF0LO0yDGfwJlerZTBHLWAD5drjnIzLSkWl7Bl2cDnVWdVmrkbRHEECeJiSp28JqGi6FA8okVJekCA1WLeiQCOFAKeboQDQV0EaI0qDIH+m/eeLiIAMlI2MJhH8aDcInmPimHB0lyJBEIdwsgmB92+39tovo5wQGMUQEaF8894KLzA9QFCQQNH+x3kgee+90F4QkmfXBl94NhBoVESUExdT5CoTesoSjFA1DqA0GQmIHgdFIGFHoGHBjDFFGMKU4YZgpKWBPPNJJZQ7F4woMeJx4Awl2qPG4dwRNPBeG8RgHwfW0G+DCP4zxAQgjBBCCwUIfiwgHciNEGIyjYlxASIkJIyQUipBiWk9I8iqeZHJmUkNZmw35IKYDWNuZsdZIdeUztlRqn85TIYYYZT6ltN7C0Vp8Q2hNA6crTpp5vtAThr0h42JMRgQB3L0wKOICo3GGjTE6MwYvnBvACHiHIakWUAYIB3a7mNFAF8qhpzWG/N+F8BppwWFUC+I0kgjSqFEC+NoS8DQGmLNYSQMBdyqEkKoGIFg2j2LaG0MbWGYJGl3FYH9SADRNaCOltrK8hKdYgzhnrgE+sgXgycRDJDohh04GN92JprDlcR0j5HKO7QPZnrodbH23tIU+3gWybXpB/ZEl+I0QOpIg/wUEfKnlCoOCBJzOAEA5BDCWRzPMzPSicD/kzoUVAqqpPDcjRnnPq2+ygCsIE4PiSwDU+UEU+bYBXgUBhzTIv807S4PClgGLxCHKaUMAAUqIIoVZrCVB4ezy6nPbb7LsLkOAyppeJKGiZlcMA2jPEVCuTIEw3NgHWeLyXFmZM1JXKcwq+zOWMGsOzkYLmmhagAFScDppunnouOZtp+aU5QtvlDQFlLa8pERN3q5gHCMsChmYbuFxzuQcJfWkBr0K96dfrcN/2kWFvmv8mpCxcpXFpyVyVBoIci6rwpr9p2UXvYMABQDpT2nhQZYATFPb7zmA1bTDbkSAznSChCwyuH6Ps6pzkDI3B0i8kaBZh0mRs6YI3m8SIEJJAWAM+3laCCzSNtNARBIhED4Rwi0D4iiBYCkxX72pwjYjMAyAADEUBxyIgd+sIreQwF+SBkUKBcqD+T+OIL+b+0AMAn+7ACgP+cA+If+8AaAgBwBoB4BkBio1+sBCBWBOBTi8IDKQIK+EAa+Ze9eW+feD0ekwauehAdInAiWTU0KyM7+pQ5eYu0Aku/uAA+knkngAOriC5CKAaGqGzThq8H8Hl7bJ7KOCEr56EBQBqbgpmChpW5wALQ0DnDdJDArSJBrQpB+yygmDZrQptDe6+6p6uQtQ1KnSvCnCkjJw1CPrbDgpNKvCM7OEwhuH5QeG2DrQ+GcB+FAhdLXBNLHRT4V4z67BHACiRScDbpnThoX6QBj5XBYGcAtT4iCJ4HP6+byGkHf5VRUHtq0FAEGggFgEQHMjMHQGsHwGiBIj1EwBIgpBIhYFIjJDRC/SkBDC+wcq+TsAJqKT+72LwzxaiEyFGGr5hACEd5b6IBai1wz5DDl6V4QDV4qinRFLD7sAyBQAqiRB6LWiuT7D5BeYwBvElIfFQChwR635+xSYPFV76ivFlicAACkcA3sKo4epAnx3xvxJW/x/QmICJ7xmJ4JhyKB0J9xghjeMawQZgK4nAa6zeKomhvSeINQTO3c80BwAI70dgjM8glY3xPxxWnAeJ5wsoTetuxyUMeR/quwDgk650xUpJt+cq1xYA1o7MDJZQzJfArJ5QSoOgnJmm3JWI4BOAUSwpRsu0nAyAMARQMgzoSEAYqglp2s1pZuFuk8pACQLUAe/yf8VO4I8hiARA0iwI62AYS8VcGpbpXAgiuy+yXpPpfpC0AZgQQZxBIZ0iL4FgkgAkUZrp7M1pwZ/QZA+UMgYxcw9q+IdA+ydIN07Wu4AYkghZ2wXAtp9pzoSII+ZpZAP4OGRorZ1pdpYQHpRiGZsAiApZRYYQlZSKNZtAdZik7W34P4Fg0ZJWVpXAJZ5wZZs5CapgNZ9pqhGmOGL4AkWojO25JkVsqomhrKnAQ4fBO+BKeiDxXeYAs6qIF0DSnACiNOMArgAAhGiD+WQEBXujiSKQCZiN+YoE8PeSCk+T0NbmACBXBQ0kBRCbsLAE4kMLXFqAcQjPmu2CcechnnINWs9EGmqfhajHcYkDfNcJIZLCGFWHPgKFWAaYQCuMzG+UxXKreWxRxcwFxZ5DxXxRSVzLbBgBRUCJLLSY4ZznCHJcENCTUHKkKVTMwLJZSXCS8cCYiRiViVpX8TBUCSCcZSSfdOSWADpXJY8c8YSciaiTUOiWCdicKaKYCViIZUSZ8dhbZfZZSU3jSTAHSQyfqDqdwqWvqRyU1CabyeaQKZEKZbieZTaVqZwNFXqeyYaQlX2qaXyVEm6IcnKpeUxQBbeUyQ+chS+WACqHosFZcXCB+V+WBcdP+SZMBaBfBaQBBWldBfiWUBhQhbVc+ahehR1VhWVXhbcqjNFtyLyJkMBsgEzoWMVI/h0a/viH0MoHEG0HCLmMwPiF0ZQfIaXKvkSPQVQYwG0PiA8TPpEC6K+u+q+EvCxARohPPP+kEOXm1sCEaOBqJJgtBsDmRKDgNhydANEA5XCbTldNoJZEKhgDUJHCquWSwswJiBPsgM6GFEeu9MEAANTAjXAZhlh9rPX86KYgDeUnKbpkn37op560lPgV6cDLC5qIzxGH6eRinCGBrSokniFnJDDsr5iD7bDhFS6VAJqkCvAI3Smt7bAgp9qDI3TnFS2l4IptAiB5D1kGxgD2nFry4kxtqNLn6X4AkxDBAviRDtEEE7UJpgC7hf7kFPhxCgEu2LHSmUEu0vhjH9AxBwgvgwFoBwFVzBDQrBitAwi2F5EgpSrBr3QX71kyBwhrG7E15bUEGdHEHdHkG9HUEAGDHDGMEhYYrh1wHwHp1Z27T120HBhRDwg3H0VwBSUdqeq3mqD8UtX6X8paLIlfE1CD2whQX01lBj1lDqDKmoGd3KUD2eqIDexj2DWT3s5oacCz33RM1SYEVUzVE2nIzp2Z07G7Q534E+Y7VnXu0UF9H/4DE3UV2n2TF13n1oCN1IjN2rH1SbGPTbGkC7E3TTLEYxbLVPTAZEAWBwjAiwN2gvUY7vVE5fX+iCS/V4BV4A1A3E4HxfhLzk7nwQ1U45hMUMJbwuRPw2TRSvwKyeKfwpQB6/wH5ZRBLAJIOIAGjAjY6oMngcSwIgDkMPwPjILRg4PUYA4vgviEMMb9Z6CDZIakIRpiBlASJGzpYyLyKKJ1KKCuCqLqKoZD0Sa6LxwGJWo8KzSmJXR6qWLmNoA2KhLhIwCRKVjJLzCC5AjZ5cC2pIoopOqnDM4kDvRQCRpHSmr4p2RahDDrJePlCVrHJ+ORHwCBNDQhNiBhPcrmqRNUzRPhqxM+P2qJNjy85BPKM7BrHhM8rZNagxMRDePxMOpFJJMlOpOhMVOZN6YpCgNvWcM5n1aEbY4YN6BpOiDYPA1fgGhuBYKSREN4KyQhDg5DZKNmNGKWMXTWOKS2NGJuPVRjhWPmKpArM8LdM1YGhHz9PfV456BHMMCiMnjiP/aiSqCqAyOwaQ3yOLOKNQ77N6rcARD4CaO0AKIaZ6OOMJARJRhJI03uN6B/MUg2bKBLTnRmJ6qPaegHYXP+jQLEZrz44/OKRwsqB3MBgPMk7OCLaEOcj+AAWYNPFovvbfifVHj+ivYkN6B7PrMHOmkUhlDuyA1LaqDfi7hLySAWC0LWARL8tehCsitittASvONSuCvCuiviuSu4bSsqtysKsxAA3Y4SMg2uCvq5iwBgQybihSyCB4zpaExQwkxkykhsCUyJYWstb5DWu9SqjqjMDZaMXSVCOIIDi3mQQyytgbweIfzKxVzCnTj5EXItJCGmDFNgxn6iFPBcvBAV4KBwgFj6ypDPQx78A1BZ1xNtAkzHI3RVwBv0ODhAaOxaxkZD1usFAqighwiqDezfiRAUBawaOqgTZTYzZzYLZLYrZrYbZbY7Z7YHZHYnZnYXZXY3Z3ZmhazQ5uy0Dw6o5bvbsOgrvVzRt+ub6OX6gcsouZJ2A8vezVuRtwgjPmRwg3NNj4s3SEtVz+DdyjOICgCBDyBOEpD44ICuCuBAA="}
import { Hooks } from 'wagmi/tempo'
import { parseUnits } from 'viem'

const burnBlockedSync = Hooks.token.useBurnBlockedSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
burnBlockedSync.mutate({
  amount: parseUnits('10.5', 6),
  from: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Transaction hash:', burnBlockedSync.data?.receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.burnBlocked` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useBurnBlocked.md","from":7671,"to":8305}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { parseUnits } from 'viem'
import { useWaitForTransactionReceipt } from 'wagmi'

const burnBlocked = Hooks.token.useBurnBlocked()
const { data: receipt } = useWaitForTransactionReceipt({ hash: burnBlocked.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
burnBlocked.mutate({
  amount: parseUnits('10.5', 6),
  from: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})

if (receipt) {
  const { args } 
    = Actions.token.burnBlocked.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `token.burnBlocked` Return Type](/tempo/actions/token.burnBlocked#return-type)

### mutate/mutateAsync

See [Wagmi Action `token.burnBlocked` Parameters](/tempo/actions/token.burnBlocked#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`token.burnBlocked`](/tempo/actions/token.burnBlocked)

---

---
url: /tempo/hooks/token.useChangeTransferPolicy.md
---
# `token.useChangeTransferPolicy`

Changes the transfer policy for a TIP-20 token. Requires appropriate permissions.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useChangeTransferPolicy.md","from":171,"to":6573}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"c50850524110b7ca9c0fc4ed621eb980504ba6bbaaa0473aa617fef54500dfa5","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6INYQYCKctqKKMAAqpFFwAGZkAAoQJtYYAMoYYNaIPHyCAHRoAvLFAK5wMADCdtFxCcmkaRnZudbFAEo6laRgMV4APLWhiYwKFJyVYPyQAO5gAHz+IuK6ACwAzLLySiqIAEybGuLaQZGN8WEtbYyZOXn+JmZIRzZ28Y5+iABs7k8ODwhBI5A0gSYrHYXAMgjWml0AHYrMZ9so1GctDo8HCjK9zB9gl8HE4kNttoDqF4Qb5wQF6FC2BxOGV+PIERskEi/ntFBjEOpqOccXo2RzZKZCZ97D9nNs3B5qcC9KC/BDGXpErNHIxQjMavUotomrdUukHh08qNxpNprN5hAlssABRYezMHRkOAAfgKeNK5TAVUNDRNNyS5vaTy6KQ9XtIcBtYAmUxmc0WKwAlP6inBA+zg9U6mHYhG7hbHp0en0BkMcMnU/aM06VgAdMBgUSeuDu6wwA0l41l5pRy0x/xQCDWBB6OGcRLsCJh0wKVn4AdoctkThsdqcACSABEF0vRJwYgeUkcLKyg8UOx2AHIQGgFGL4RhwThfzjnuCdPgpChBA1ScIQAjrqIXALKIjBoN+i6kOum4RqSepgB2ZScAARgOpjWDIlSwFAnD6ueOEyNO/C4TASEDqQtZgKuf6cIxvahDUxT+GICizsgyAgHQ3ZYHI/gAAaSQhtAdiwzJcMAhSGJwrgLsBzCcAA5LBCjMIwAD0NDQppj4pjqaAYZwACCWBYC6WacMAHacBEnEKZwzCVGINDTF+KTyFALGqQAvEpJTikWobDqakatJWVrWPZpkuYxaD9GAnAus5LmcMMOFeWUmEZTlLmhLUGT8MFwD2ZwwXLB5XnQTALqKRFBSaRYtDFN1mnTHuloHlABQAIwZa4WauNlJWBXAoiUTAUBVX5AWrpNxUucsU05Ua0ScPcmRbcM+n5WghWbcVWYdmtkniSAAC6FCCe68TMP4z3dgm34ALR7fGTj5vdj0gKl6VGAAso1Fn6uxlQyGg3F3Q9IDrBIiAABxEnI/KHEcSJYhceDFjt4ajnF0adC8UrvDK3xkogmyqFSmAqj4YI8ZCeghGEXBXCTZpk+OnS5oYBYVETpYxRW5N5DWaV1iMYwpna6aOs6nKo8NkinGi2PvNrmgE5zEvbgLVbPJKbyCjTpK/BYTM0qqdLs5qIBusBOAcBgDmed5MAFC6RDiIwc1yHABS8yO/P7QlxRxi9n2NpMyzTBAWBQ2EfqcBDvsAPJpxhSZOetMxYFATWkAU4mdQAJMAIikKt4kANxbWYCzR4NBQ4ZMphoC3xeMf2jBp++aG6qEvRD2n/fuJwABCog1AAoqQwGkPWMDTBHktjmbsZ/d6icKMnKuZvVAA+6awBMZhQA5dWcEQECMFAk7TrOIAfgOPvQZZ2p5OnTgGBQIRCiKAmQMhOALHgvgR+QcQ7wDvKyBuChtDIWUN/SGlkoikVTunUQECMDgTzGRDKogoCBXwZA6wBCZA4QcDRPBBduJnD4kgASIB3qvSoIHBuCDvoXg3HAvh81vwQBwgAKxgI4JB7o4Dfmwhgzg4kf7pwAGJgHEgjIGXD/BMM4sUUIWRKjWH7PIzgP0Py/n/uPDK0CIELkYIxKBG4MpKNUZZX8cATFmKSLDP8YBSL2MgXhXci8aikXcVg0Imlvwwzhtop6Ho9H5wMaEFea8LGCOseZSywTHHOMYIkFCDVvKWXkCEWY/0AmcDIJknBUDGAONCXIiJJS6nsESZw5JVB9FhEMWALIOg0ByFIpYz8iFcn6nyRMZxCxXElI8fqX8MAYE7m8aY+AfjCELh0LYBaZFkIVNAmAapYCOnIQaS08JBzVkYPQUIsuYhDm1NXp0wGglGLMHEPCKgP0DzFOAZUDyoh2QNThsPOQbEYAAEdKjwAQtMcSRifFbPEo0hxsyByhBkEQ0QiQnAlJkE1cINCHFAs0iQEFsAHxgB+lZBxSiyV0IYQuKZYRMrIsGai+R4kkXpLeaQPlyijHDNGeJBy4gBxPxfmygBBdpgNKUSDAYBzA5EQHPk0JkxICMSgAjJGKNdBHE1nyA4SBeTCmxEEVRuALbmCFJEWmvwjiMyVMzbwap6Q0Bdm7VOZBMAOX6pkTuuEe6nPVsa7YqIsbmvRvjUUnD4qDUppbS1TqbbOCOPbFmXrnZBD9R7QNd5CwFDbCATqN5rAWBrbWut9aG2NqbRYctka9aWtjQKIUBtE0RVTeYPGxJZR02ze6h2rN1QMiCF2HsfYBxczgOkGAHZeGuTCEugoitF1iSoFOGceAv7KIXUu9FzBoCwwHFgYCRAX6IP/HJKFsB8qoJYseqFyhoI/m/HAFgTTxBIIwR2AAUqIQOWRrANzTmu7d39pENC/BpK9xBb2kRwkQhYMAcK4WAgsGoiZaUdkPWeqAF7am0HkgohYEBOC9mkUUh4rloRmFOWHUyAAqayyit0noiMS8x0DlAeR0IQKA36TGwMXkeziS7ihUQUPZYV4k30wGKBchTATSJKek3IYosEBjqY/TzMBoTiyROowsBuNAkFRCIS+GlEjv1bhgN2WlHGrKcAUFRehkCtPrrkOi0w6w8jzttAofoBzsIWfgpuajyBxJId8cUEQU4vLiTui6fAp0sBh30vpSAsAHOGK0PpPdcB9LEpoCIL6RATjFFoPpUQWADIJa2cUTLzAZAAGIWvyOS6BNAkrAkdjiz1/MyW6lpYy1lnLeXoAwEK+wBQJX37lZJWgartX6uNea8BRL7WuujfG6vLMxRBEDk8+IghUm/MwHRTQjKJm2kCcIF5H80IOAsSUeJfLftlOnvPTp0yAB9NjbGADq4hmKKFB0D98QiLveeg0usikjpFoFiUJ5Q0BvxSs4GYNZyEF1fhoKc3FHYAJ5CAiBMCJgwVKJwjhvD1kUgHgURuIh7EYDMHmtMXVf5nEYKIUTkQ8gRkYA7IvQCwFIA08YGC2hZF7mcDsyphzNGnPdnzJwIZm4hFxcgFZ/Uo3Dz6RzpNzLaBsuIFyz9hbxXSurcq+tmrmw6sNaa/pUbbW0Adc66IL6BuYBfVCF9UbX09QOSQh2M9hSUzsG+enAjYAl60BElC6on34deau75mD4lECmRug5jsynZMQHk5pDcEDzPsBkFATSWZ+65b2g3FjBQq9USgbXqA0xsJ9a8iX7TKm5MukrzAavnAACkcBepaSo6QOvDem/6Rb73MO4Fx+d/n3X3v1H+9oEHzd1TgqXRt04Bk9go+wcQWy9MRdnplAsXoaROwtl5ALQb43jszeUit4Qq8zJHsWabQDTdXVlLcBwGLdXWAVeAvMAZvFyC/CuTga/PgW/GjCAB/T8RQXCchcCRrHAW+b/FfEqT9ZAGAdVO6QURAYaVQYgkqP8LgcDSDeGUgWYA8QYCZRWH1LgU/ObRAIgZgGg7YI4GgtGS6eAkgnKT9HOVHRwYoNgsADgqxOAbgwITKH7AQoQ6NSQRAbYcQ+g0grgTQ3uMgLsGQT3XbLZfSOgaRLyDCRAJEJEGgyQQw6Qrgcgygr6CzAgsgf4Y4I4NwlyT9CgghZg4eXgkw05MwghSw6caw2w6wew0IRwv4f4CwCQhA9wvHfg0wgYWI75UwGw9VIHeuVcY4bYPQ0yBdYwj6WqLSMHJpSBbocRQLGJfuUvPTMAF0cSI8YcZCWuGdGAVwAAQk4D6OiFIBGIlWX1Xzb3GP6JQKaM4BaO7nXTADGImLQRGN32gLqQ7BulMhTzTwHAzxwK+2438143CTgIOMkmLzyDcjIle1CguCyA12YCyEwJgEIAWHsg6KeLqXqLeI+K+M9F+P+MP3CGYAwEuIHFCjP1LzhJdH62mDqS/yKhhLhLLwrw7xrwX3rwxJ/z/3XzxK7wJN2P62j1hKHxxNHzJOn1n20m7yX3oN/zX3b033xJ3yQSpLACxNpLUzPyQKvxvzgDv2+MfxwOf3wLf1vk/1mPZPmOQCQIKFQNTnFIwKwKfzwNf0IIWgeiQX2KKhqLxzqNCk0kaIcVWLaLAE0n7gFKPy6J6K2J3EGI+lGIWMmOmKJJXyVIQgKFdOQitOaNaPWM2P6J2KNNXjuNulYX4kEhqDtRAGQEXX6H7HSwtyt1ywUBgUqBwmKBCGYFmwKzKx+2Oi830hdzdxMBwn0lLwcyzHukNURHJAsF2B1jjUHR7UuCH37SQGGlRAzTlCQDtjHVzSdg1ALSwOgAcmxJHyANEG0Ezhs2mG6kMVSXMLjk1wKBs2QDuhzEfmflIhdAAGphoyIwQqJyEmzd1348B/SFFqNxJ990Vns8cYAFgCRTsIYIVRIBxzhKhPQWNQEHtL0bke9GlBNAMlZEwuBTM/w2dL0G5vlSAiFFyQCGkFdyFKEMIrsELJNvEcIRB4Jkiip1V4Vv1f1iV0FYt4s/9EgXRtgsxzcstrd9JvkwAkQisltXhKh6tOLQ8lz4AOKohthLDe5EhihthvcOsJCXQlFALgL/9ccFdWkIs6L7CZBigkIE8FNMzpt2Lbd8xFtlsZxHcEUNtXctsPctLZKustLdLoInL1tzg4AswTtC97i4AoSeYTkuBQpVAASj8R9NJKlTkChJ968t5/LfS5iAzXIqkCh1AkF98oSZNQrwq0BEBZ8sq4rHzw5/Lkrdi0rNFJJTIddOA4s7KXL9KptLcZtjKeKzKysKtLLqybKDI7L9tOtHL49nL+rXKtB3LTxkIY98I49SAE8MIWFhQ2EUBEyCJkyiALBihho1qa1mzhBWy9DhphozUBQOyey8A5N+yaChySQRz0Yc1PVJyp08BTTt4TZo4YxhZwp7xxZopnr4oYxZZ0oN4j5mxVYVg209DtgO10QcZ9YRRLhjZSYXqKZ7UByLrh1fgKQbraQ2Ypy8BC0A0vZOAnlRACgi4SpKhS5y5K4a464txG5+4So24O4how1czTk6acpB5VkR4Lwx505J5Oa+4rpOBL5Zhr4pRX47z909BD0+MuANlfFtQdl2J0gSBSJCbRrFlolgxTJCMhEZaaMeVtlcVoVt0VaCboJzwkINaylQgk8daBw9a5atkFajalaZBTa1bLaolrataio7bOAHaDbnaOd4BlaDkPalwvbf4bbQbwb9rOyBRobrU8BCazrBzrYrrVA0YMbHYsb7q9BcbPYHIOaIjR4Eh0IJ5pF+aY6/hB1O1DhuyYa8Bi605U6UbnVnA/hNhs6J1vUOZXYkMi18aICwhy6wBuBF58BKbaBa4yjFBXB0VhbAk6Ixa35Jb9AJ6yJilH8FEeaMIY6kQhQ66Bzu1G6xRd7Qhx64AVAkbzr066YkRR0gRvBeJ/AhiTry8Y7JBMZIbRzsapbz6Mo7Ar6ChOphojhtgGYa60ZJALA5prBr4wGIHVAoGYG4GEHwHIGkRoHYGcJ4G6JEHMHsG0G6JU6iRhy6Y7YkYQhYAmQYRHIwpvxVJEh1I58ly9JDIuc2ATITSninr4afrOh6iAwIoQwhxrh+HpZEoJD6DagFcVFIZbsfwMp2I2AwgoDixLlbFMoVMFBTsTpCpeMHh+BphdL9acI9J5EMIJC+Go4BGZZbUWpspg0MBQ1RoKBso2otJK0LBq1m0/H/GG1eorppHHiQry9R8YpR78DgHcq4bbHJHihCafQFDK6IjSgAHL78AJD/AH9RAkBQBAh5Af1Qg8AEIQBXBXAgA==="}
import { Hooks } from 'wagmi/tempo'

const changeTransferPolicySync = Hooks.token.useChangeTransferPolicySync()

// Call `mutate` in response to user action (e.g. button click, form submission)
changeTransferPolicySync.mutate({
  policyId: 1n,
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Transaction hash:', changeTransferPolicySync.data?.receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.changeTransferPolicy` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useChangeTransferPolicy.md","from":6927,"to":7501}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const changeTransferPolicy = Hooks.token.useChangeTransferPolicy()
const { data: receipt } = useWaitForTransactionReceipt({ hash: changeTransferPolicy.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
changeTransferPolicy.mutate({
  policyId: 1n,
  token: '0x20c0000000000000000000000000000000000000',
})

if (receipt) {
  const { args } 
    = Actions.token.changeTransferPolicy.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `token.changeTransferPolicy` Return Type](/tempo/actions/token.changeTransferPolicy#return-type)

### mutate/mutateAsync

See [Wagmi Action `token.changeTransferPolicy` Parameters](/tempo/actions/token.changeTransferPolicy#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`token.changeTransferPolicy`](/tempo/actions/token.changeTransferPolicy)

---

---
url: /tempo/hooks/token.useCreate.md
---
# `token.useCreate`

Creates a new TIP-20 token, and assigns the admin role to the calling account. [Learn more](https://docs.tempo.xyz/protocol/tip20/overview)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useCreate.md","from":215,"to":11155}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"3d490a002c7e2f3cbae101c3273591aa8fdaec268e90c4041b25fc475f2316e1","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6INYQYCKc1qQwojQAyhhg1og8fIIAdGgC8mkArnAwAMJRMTDxiWkASjo5pGAAKl4APAWhAGaMChScOWD8kADuYAB8/iLiugAsAMyy8koqiACMVtTi2kGR0XEJ1v4mZkgATDZ2pA5OSABs7p44eIQk5BqBTKzsXAaCo5q6qpezimUag0ax0eE+Rn25mOwVO5z8SzcHmoXnuvieAXorzYHE4mX48m+4yuMLkgIW6lWWjBenxhNkpmhJ3sjgRh1UNxRdz0Dz8zyxelaPUcjFC3XyRS2pR2zTaHS6PT6EEGQwAFFh7MwdGQ4AB+ZIQjJZMC5CXFbblAAKmu1pDgsrA7U63V6A2GAEoDak4EaCSa8oVzdLylU0DV6k0Wo75S6lSqADpgMCiLVwDXWGDiwNSsq7KhQCDWBB6T6cVrsCLm0wKTiiThmfqcOoASUthwseONaUTiYAchAaMk6vhGHBOKPa5w4Dt8KRQhA8pxCAI8XYuP1RIw0GPy6RV5m0GcwudRWBE5lOAAjTOmawyHKwKCcMV1y8yQv8K8wXeZqJh2rVpOURpqE+RpP4YgKMWyDICAdAplgcj+AABqh260ImLA4lwwApIYnCuGWc7MJwADkG4KMwjAAPQ0G8pE9o6wpoKenAAIJYFgqrupwwCJpwESgThnDMDkYg0F0o6WvIUCAYRAC8eHpHS/pmjmOzcYxAl/uGnCqvxAmcI0l5iZkZ5gIZhmhAUJjWPw8nANxnDyUMIliSUqq4cmWrJKRACyGBNsapFdNOzCXhAMi+X5dQANIhRENRRIkGC+QAqrEAAipEEe6rgGZZslwKIb4wFADlSTJ1b5RZhlDAVhmSiUQV+g1jTUSZaBmfVtXuomNWochIAALoULBGpnMw/gTSmtpjgAtJw1qTXN4GjbBOm1EYfnuSxYrATkMhoGto0gGMEiIJcAAcALzEgiwzFS6x4AGTUWnmxiMkczJnKyzhTIsnKYNyPiPBBLx6CEYRcJsJS5l6hi+tkr1BrmlTVLUDQ4A6ToKq6yrDESF2LJc/zGHMQJLCsmjPZDqM7HsX2IJStgshclhA6iPLouDAogOqc44BwGA8aJ4kwMkqpEOIjAlXIcDJLD71pMts1OPaUZOkMXQQFge1hPqnA7eLADyeunvafG1QJKnJMhFi0AAJMAIikNVyEANwNSpzZQMkl4dKYaBe9b9azckrvViHllhRFUVToeUcNdYSXyNYqUJ27ijR4ZACOOQDjAdTGnbDvO5HiiuJ7DWiFAVFgKXTsu4nlfV6HUQZowetDkexUiqEVSd3rIfuJwABCoj5AAoqQc6kFjMBdErwbWCrNrqzjHTa7GbquQAPi6sDtGYUA8S5nBEBAjBQP4BZFngw6ZmLMSsUKiT65wGALhEogWdYogyBkJwfoW58AXxlnLeAnY8RuwUNoPcygn67VYr/J8ut9YAJkIFZcghnwWVrrJDBQD/6AMvA4T86CLbgRBFBJAMEQAzSmlQaWbtIELSbPgTMLDZalTHBAS8AArGAjhoEajgGOC8iDODIWfvrAAYmAZCa0xoMM1P4ShoE0ihFiDkawGZxGcEWsOCcb9+4WRAYAssjAojAM4RZKRsjWITjgLo/RcAhRANQcAxgljrycDEfkJ8DjkGhFImOA6R1lHjTUVQDRYQtFgBnnPQxHCTHMVYhYoB7QbGMFaPuNy4lWJpwXGAdWtYLJkGSV4zJX5/GT0Cfkyp7AomqMmuo82mjtE6DQHIJ8RiRw7nSWKGp2TMz9DsfkxxYoJwwFAWQKcrj4DuMOlgssOhbBlWfHuYpPQym/04E0vcXi/EBM2bMxBCDOGcCgDEOsFZDktKiMwcQXwqCLWbHkr+OQRKiAJG5I6Xc5CcCiPneA24ujIW0Ys8RyFvGWNGXg1ZohWhOHyTIEo4QSFAK+aREgPzYDdjAItNilipFYrIXZMsQywh6UhWAHReilnIQhaEJJ7BmXSK6V1XpyEeLiC4VfJ8pj9ZwC6F4qRm0T7gPvGMnxQC/EdEgFEKAJ1hA/HugAdg1bdSmZMaY0hALI3ADIDjMx+vCZwixAbImBt4XkGIaB8wFrrMgmAeIp1nmnDOFcFBE10IsK6N1ybkiQEG/VGxU4pUZqasmrNfrs0OJzEG9reZBGdULN1YcfKZ2rH6o4FhtXBruogCYIJqRBG8saz6prC1xotUcJNdqeb8jTVgQWrqRZTgwOFSKEcW6+rVcSRAhwpiPTJMWvVoIgix0itG8wQa61/QbTarmoM+SYgrbNNMDhMxQzgJFGAiYWGCTCAe5IUZ91IXzIWYsIBH7SL3Qe2FzBoCHUzG24g18oF1jgFhIFsATJwMAo+oFygYjjjHL+qi6KEEQH3ImAAUqIaWsRIhdxhqBA9IlhF2DAKOEiH6iBfqfJeQK/QYCXivHOfo+Q7SEsTPel9UA30HNoNhCR/Q4NpmEbkxg1hBJvDMKUhWjEABU7FpEXqfREdFBiQHKGw8oaAkHdFgMng+zDcg0jvgUNxDlyEQMwDSIcvT5SnwGc00ZjctRTNgZhvsvxAYglwf6G7Gg0Df6BX7ASgRkHDzRGYIS8TbFOAKHfGQoBFnT1yFhaYMYiRd1ygUDUTZF5XNbgPHB5AyEP1uLSCIAsYlkLDVVPgLqWAFbUWopAWAvmtFaGonfOA1F0U0BEPNIghwJhpFoNRUQWAaK5aWWkMrzAZAAGIhviIKwuNAfKwBQETNlqbPoCuVOK6V8rlXqvQBgHV9gChGs3paxitAHWus9b6wN6iK2RtoDG5Nucbi1uz3dGkDhmYwv8IARp6LMBYX/wso5hp8nCBiXHG8DggEpHIRqxLQzz7X1acYgAfVE6JgA6uIPDih0co6HFcr7EWT2XszPwoRjgwmKcIFAMc/L6znM4XuPdo4aClKwYmaciRZzzkXCYP5UjLzUdo+xS0zYJGcMCsBGA4U5BdCVbWGxiDAos5EPIHpGBEyTxnHOSAfPGB/Mwc+C5nBvNGd85nALPpOCxBgAeK52XIDubFCtzgzZqImw22VtAFXEBVbh/thrTWTttbO517rvX+uDae8N0bE3RDzSdzAeaoR5orfmqKHiu5EwvpyY6dgzz9b0cSbQBCQK8jQ8J+Fn7UXSfIUQIxQavnEyGe0xAXTpFOGAJc+wGQUBSLuhDlVpaWdtzJC7++YBveoBdAvDNsSLfLNt47xPuDABSOACVyLT4H0P6iI+g4KyXDAbvU/SB99n1xtAhW0CL7+8Z2e7BVQNk4Gy0gqpSIY+XBV0KEAtTKEAjISfDsE4nkDKgH0H0TGH0tFHzHEOWw3EVEG0DMwTnIRgR3WgRe1IAbzAGHwEjf2SC/z4B/ynD/x0BHEUCvFriXH6xwBPigP30snA2QBgGlhkGGmZiWFUAYMslrC4FQzdj1jSFIB6GbHqAGSjEdS4Gf120QCIGYCWCmEOCWCuj6lwMYMMnAxNkEWEWOhELADEOMTgEkMCD0jhzkIUKmAsEkEQCmFUJ4KYK4HMKDjIGTBkBuxj3EWojoGETElPEQC1URAcM0K4BYLYOGnmlc1oLIEumHUOGCIEnA1YIAQEPQzMNkJcNqAAQ8MLCWW8NoF8P1gCMuEugsDULwJCPrAyNKVcOyOeVMG8LYJRx9WHSmFsMYj3ScNmmcjIgxzlU4AqH4Ti1CRDlb2szAFVGQkyl/ngU4GdkrVcAAEJOBpjFAyBFjeU98D9hNkhVjZi+jLFBiA5T0wBli9j1jL8E5YBZ5ExBpGIp5S9WBy9f1KCYcpMYsZN6kcDbjUJm9EghJnxwdFJ1hYh/MUxYgyDCB+huJRiATKkeiQSwTmAIStQoSYS79whmAMB3jMxFIX9W8cTVRZsuhKlIDzIsScTl8P9V8z8+9d8eCYDD9x8T9J9ONz8Z9oFZsc9sSl8dNqSWT19N8uht92T6T1Dtix9j9T82SL9OSF8wAKSl8TMX838P8iDdZRVSD/8KCawgCaDQCT4ICtjGSdjOBkACDOB1SSD91tTADqCQC6CypRpoFKkOiATK0ejP9+ijjhiwBSIQ5FT79xjJjzi9x5jZoliViZj1jNiGTYDdjoy9wDigEfSTizjEzFjLjXTFFUIIIkDoJYJ8gq1kB90agMwStvdfcqsFBQEchLw0gQhmAdtatms4cOpwtqJw9LsTBLxqJW9fN3QRpTpzpdB2Qx0KYFhC1w08BDM517pFhzUl0OYV1k1m0N08BVRtToAeJKS+TUxiptBDZPMug0hTy4kAFVZmAj9PNkBhpPQL5BU9IABqRYZ8R4d8WuQc69e+PQE07caBZCefNAWFUHBnfoKEd7HaAFRCTMNYHILUYTH+IHd9epMqLoUCxBRMbJcIJzWsCXd9N2Z5UgQKfcpA2ChbWsSxAhLcU8H7XC9TFxS8EQLcPw0II9ABHIKBKDHxcQaBZbUfVoVUKYd0L3crP3aiZ5MADVerQ7fYHIXrSStPMi5rSSqYDwoOVoNIKYO7MbNQ1UKROChC/8+nI3U5ZzM05CPwmQNIXcQvPTCsrbcSgPH0A7I7IsEPMFc7CPK7GiKynSibKy2ymIIKs7NYOAd0N7RvX4uADEjDXZHo1QWE+/Pk0iEIXZZINffvJeEpObY0+MwSdKzgdQTA6/Lk/45K9vD/NK0pRABKaq3KuMpkgqmqoqy4oCn45CRiW3TMbLPykK+yzbH3bbZymSty5rVrTyrsyPa7PyuPcbQKgvYKxa0KrQcKssCsXPG8fPUgQvU8ahVYWhFAQs28KtIgCwNIRYC6iwCwIcwdC6Q4S4BcotSmR6acvQHTOcpYJ6xddmK6RtNEMGFtGcgE5eeGJSH0FSU0bMOGHYdGf8CMbGTWGMRUXePNYdK6cckNKmMtWmYIemRIT6q1Rc9mKw/67mQG9cvQdNDtHiG5MQZIK2SyW2aRMuZuLOBQKuHOG2Y0X2f2QOUpLmrNCWHNbOBqGdeOH1QWj1ZKdOPtdmwW/OQuYuP0RucuftTmmuOuUwVWtm92QWjuWZbuJsXuE8AeYRQ24OfqTgA+HoI+RkG+b829e9WTLgFxRlcRDxVZYCSKEgJ8OmusXcSZEJE0RiBjK5F2hZd25ZQBKXeAH2zZf29ay5JBQpUIYvMOzMCOt2txT22Oy9X265W5JOoO1OkO8yDOzgLO6FaOr2uOmQAuxOwO4JUu/akco4SQUtZ6hYTut6kAf2wm76uEJciYa1W4JtCmqQjcj9DNTtZm+2JuH1Kua2w+b8e2tGqwlYcdSmSkXulSAe4mhECYDVMmtdB1CGcALddMRLP7di5nSzc9SzW+G9B+K5WvaTJjFjQjL9OnKcP9TMADHIIDSgwzVccDZxFgHi2DeDMAJDFDNDPWEnLDLUVmPDOAAjOcIjR8K8MjCjKjZUWjH0RiRjJHTMOgdjPETjKcHAawXjfjRstgITMfMTCTZCHEgHWTMcUCrc2nSOtTMcN+rTPkkSiFVvEzESlAgRqzbHWzNcJC2pXCtLNzTLcpLzXbNIC3V2ALILCTInGvBHccaGX+DME9J0FLcy9LdzC8fi3I8RfLUqorByoapy3bQPQ7YPCa9rKanynIvLOalbIC+bRbMAaxvLLA0Spx/3FxlyoPY7DxsPC7aa6PGxn0Pxzw8Ra/Uk97e9XRyLfRwHeRkHUBWbCHbCSvTMWHWQ/Rj+5HcyNHTHbHasPHAnT7avYhSzZ8HQynMcbhunGxMwOZO+sIVndXDnMIHXXnMcfne3TMIXfB+ZNiMXfCvOmXUqeXCsenZXEnYZ9nTXZMLnWwXXBcSZg3WCyxAcJnU3NRjRpE63bq/JR3QuPBfxNJt3D3cJqs5svbaJtx2J07Lyy7KPHx2Pe7ePRPQuFPIldPTPJOnPdgLakKva+4x4mC8UMp0LVp37Ovb4nM5CP41vFKmkmU/vMk6A/Kwl6fNq+x2/cq0nKkzvAUzgDfLfIlsU0lpq8l9kylm/DEg9B/OeZ/GARsVUz/b/TUm08gu04A6Iw0iKvKw/A5R/PcUi5ArxMYSlQ8DAufDJ2eHAioi0q0sVsggAygvUh0sAoJioxI0I5I9gzgxYbg8Uxwm3eBvQ0Q8Q0cEw+gdI2ACwxQ5QgNcojQq1zgbQinV1gw914w0IKQ71iWeQ2w6w2w+wx1yo5wmorI9wlbfIwo/wwIxYSQBIvgs0m1iIqI0A7Akow4eIlN4Nm11IhBmQn1zItwoFrwnwlOIojVEoy4Mowt8DNNpwFt+o3Am15o/tVo9o8yTooWz05MgYoYk4/0nlrTYMqYxMuY4ABY9MtY0gDYkl/fP8o/UMy070hd/dU4qMndzMkq640gDqpFsvTMCvV41+thz48RbFpvGKmlrgYp4EnQUE4oZEyE5UdEn9hVvcf9tAQDgLFEmANEsk6dwM0nHo/EpfQk4kiDsk7k3cyq+l6UnffdiUo/Dl2Ui8Mq5D3lglhlpl4Ullojw95kgjzluU6lyjrTZUwV1/RVtU0V3/W0k1+06V8A2Vxq0080xVwgvjrUiVwTqVg0p0rMm4qd907oxSL0w4s9kYnDpfVd498MrUSM0MvduV0049ud1M897d+Ba9i8bMwaPMw6+hIs/wEshcUgcswaj5ms5QOshsv/T53zT59s/hTshJlrRgXs/s8K26s6dVBNwtLeycnGg1Wck1cwRYGEH6hECwE+yCfwStPAD6u63QKwxLicpAamc+5W+QWsKAKAYCI/B2dsawa6tr9rjrzrrr7riwCYQmrLoe9mXLlc8e9dSeqm7hnc3kyq5VmAI8sADAE8s8jpNwy868hb28+8y+a+Z8189ED80+J+n8kAQ9gCoCkC0BMCiCo2Q6FiFFwy9XMcfJk5VCjkjCzhLC6xHChpdTKRNtFgcQEipZMilAo3aiohLMJ8Bius5isMfWdimVSDCBmDPinLASoSkSxxrAcSyS6S1yuShS3+JS7QFS3+NS/70pTS7SuPPSgyrQeCx7xXU5oBMy1Hvq5agays4aqJ0a9xv5rxwF2akF+aliGQEKkK+aMKiK4vL92K5qrgRSRK5dozFK+qjKrK+Xhj/KtX1qm9sq/FvDtXuqnKrXpqnX4qrV7lnFrqu3Cy9nnamITnxyyJls3n350Pf5xJ6iIXh7Bah3tACXqX4uzagxhFtOxzgss6E6/wM6i6q6m64aYc+LgGSkJLpAV6qdIr9vfrg+5wP6kbgGsb8+6d0GnYBGZSLsFGdSEMDGBGmATeZ0FGgmEYEr9PpQnVBYZYFLjYfGj6KEe6AbtmNkDkAv8movp1aemmwu+m3ib2EuFmhe9WtuJmnmv2K8fmy20OStOWpOUOcWnf0W0OaWr1A/hQBWguGgGrhuBftW9mjW0OWueuHWxe5fwyA29DHuX+PufWQeC2keZe22qvRPhHcna4dSeK7Wrq51gUddBukXSbpXIpkZdIhmAPCDZ0lkUA72vXQTpwCKwzdF+GnVDriFM64AyOjnRWR5146ftHAcnQKT4CkB5kZ2iQLQEe1yB0A/OtgLEDF08BRedetMA75IAe6mfPQP3XS4D9c+6fa4KP1Pqpop67aYWDxB9hr8A4NZUpAAIWxACyovA6QF3SQBTkhB1AVfjn1hBD9nAEwRNFIJTRA09AlabdMY0My31EGcgB+n9hAEv1ymVTEhs80/SwAf6UGFFgAyAY1gQGdmCDL/Wgy8VJEH3GBshlED1sMMf2bDCg3wxeDMGmyUjMAlwazMaMOoYvMQ2YxAoyG7wDjFxmoa0MBMDDR7ti2CySZLM7DepN4gUw9NeGeFTFlR0qrCNWhHHHjuIy8SSM0gwZcRiEOe5PsGkijDLB5gW6XMfMfmIDtoxCw5NOh/2AxvFjsFJYzG0CCxsoxCbDZzuWPbnq71cp88PeAva7LdlSbJMAmZmJbGj2SZ2Nb27zfYV8zd7uU4mnvbxmcOF7+NtWpAN7B9nRbfZcmtQuRsDk2Sg5imWEd4GiwqY+sPB+QozKjnRxY4AIuOUTPjj+ELCQG5OXQlTiaH05+mJuVXGzg1yc5xmeuY5gLiuRZCRcCzcXPuGWay5F4VRI5ErklxbM1cOzLXPsx5xkjK6JzSikAnObzIzc6jGYVbnex3MpEDzZ3BZFdzu5Pcew5xgcJiYvD+e4XQFh8IewJ4k8ELNPGkwzwQAs87AWFnnjD70CHij7VFi+xaYAjFh9eKKri2/YG8V8DLejqZ0lKkcOSlvfXtN2dGn5aOZEV0WJ3dEuiKWeveUqIx44qkeOIrYgoawE66khOCnYlqb0QrwFZuKBNVp+A1bGNLelSXVhoX1bSdxWxrBMfJ0dIWsg2RbMIgAg4KqAuCfbfgi62EJusjCnraQuYXjYPR/WybS1kW1Da6FmxEbVsdG1MKNs42lhRNnYUDa8F+21RQdtkSzbttWKDcPNgWxrZViS2kRM4OW1iJVsGxByNgnENjaIBm2C4tJtmw7a5tu2vbdcbOKbbpsh2m4Edk0RaIjpJ2cvD0upws5ac/SSVWlnp3XYGcYARnDMrGXFKMdL2+xU9scSs6QSLiN7ezqhAfZPERhUIt9neC+L2i8WAJP9qFgA5Ik4OCHP8VwHhJQcYO4JEDtCUQ4Al2OuJMCo4KMwYcxIJJV7CHB04VVfRrJQjm6JI4hiWO5HeUrRLpY0l/RIpOkimODHMcyOcGCjjyXvycchW0Yg1vx1k6lj9S5Yo0kGKPwSc54UnWMSpJLFUEyx5rZ0nZ2U4fi1OvRaCb6SXYKk5J/46Rmux3Ybst2cE3dmBLZZmd1234mCaEGs7wSzJd7HFhHzoSFk7crnUsh5xgAKjqytZeso2UC6tldsIXXsl4x7J9kl8A5WLm3VsKqAg0afAIt32BouDRBihcQcuTHp4B8uVAQru9Wz6t9cp+UirpYCsF3pjQbuTKMkAmBgBCaj0bLs4GG6VSx+Z9J1JN04C4ddMs3ebot04CnktEK3C8pqHW4YBNuyQbbk+FVAvk3yZAA7l+T7rP1fysBM7lSwu4KYGw13KCndyBQPdEKwwupOIjQoNCwEmFaMHaC4D0V8KzzAHsRQQIHlyKUPKivVxoqhA6KP3FTExRYhw9TwCPTikj3CFQN+KGlDHu8xx6/w8eDWAnhJSJ4agSeWMsAOTwEpaV/KtPK5DdOMo2JTKr3NnqLxsoc9MeXnR4a4zGoeVPGaomajTLmp+9C8gfVatLywmOiQaOVBKn+LaEd4demVY3rsgklH5zeXLb0RxKqo5Vaq2VKWTxMVhKzdeXo+UncXMh3NeqNM/qvTK56Kinhhw93pNTZm+UOZwvLmUtX96S9eZwfOFqH2Wp7UQpR1KPglhj7nVLqywBPknyHRTBSY/A2wkVLqkDpq0GXPqYNwRD58hp0g1qSX177l8IalfNSDDRr7w0F4DfPGHGEJgNS7Cm9ZqV3yeipde+vU8qVWxPqWDKa/MSfvIOn6iAGac/FWjf11qtxBaigvmioM36WRt+ItM/mLW7RxxT+UtSNLLQHnn8la8/eerfz1qa0n+bcl/vrXNof9jaX/U2mAF/7oZ/+NtdQcfE0GO03BldJgZANYGYDYBnA+ASnToHp0iBJ81AWfJjpsDKBjcrgQgODp3zGBj8qOhgJgEcCA6uAj+S3UIHfyIBv88+f/KoFXygFN8ngQXMkBPUCpgg8tHgBEGRz7o0ckwW32rlrlxudcuQZmkf7a0l5S/NQXbWAEILyuWNHevoOIU9TSpD0cqVMCRDxzqpF9LUFnwjk5SJgvXEOVVz5hsQta1/B2BqjMFQApgqgAoNYFJhTAJgBQCwKoCUKSB2QogKYJeCugTAJgY8awJIBgAapVAkgVQK0AsCXgp4l4S8ITRZgxyBprgU6CEFgDYh3gvEcGgRCIh/4AxSBKiLRBlxsAGIKnaGJWGr78ZFIhoSGlXwznWBNI5kYfAUCNwyJdoSw0wGwIYb5BoEAYI5GYj0hGYFA72TqGZBkx8Z+AXQWygskvBURxEp4NQqX3KBGpPIBkY/ilHShZQQoBkfuf5ECgtBWAnmTgBlGygUADI+/MiAUD6WtKwArgNQsrzpZX86uDXJZMrKCWRK0g/tXUEjDADVKfRH+GZc2E6l1Ve+yy25KssUEbKFZpEIRU/z2XBKDlYgVZfQrUL+B/8ogJAKAECDyBf0oQKqQgFcCuAgAA"}
import { Hooks } from 'wagmi/tempo'

const createSync = Hooks.token.useCreateSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
createSync.mutate({
  currency: 'USD',
  name: 'My Company USD',
  symbol: 'CUSD',
})

console.log('Token address:', createSync.data?.token)
// @log: Token address: 0x20c0000000000000000000000000000000000004
console.log('Token ID:', createSync.data?.tokenId)
// @log: Token ID: 4n
console.log('Admin:', createSync.data?.admin)
// @log: Admin: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.create` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useCreate.md","from":11495,"to":12018}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const create = Hooks.token.useCreate()
const { data: receipt } = useWaitForTransactionReceipt({ hash: create.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
create.mutate({
  currency: 'USD',
  name: 'My Company USD',
  symbol: 'CUSD',
})

if (receipt) {
  const { args: { token, tokenId, admin } } 
    = Actions.token.create.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `token.create` Return Type](/tempo/actions/token.create#return-type)

### mutate/mutateAsync

See [Wagmi Action `token.create` Parameters](/tempo/actions/token.create#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`token.create`](/tempo/actions/token.create)

---

---
url: /tempo/hooks/token.useGetAllowance.md
---
# `token.useGetAllowance`

Gets the amount of tokens that a spender is approved to transfer on behalf of an owner.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useGetAllowance.md","from":169,"to":5732}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"b0c37f5d3bb0182fd912e817d276901fd1c5110436708118f3f541db520ed0f9","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUWKQQOBwYAJScUKJiiJwARowKplwAPpwArmCwAGamMFD+UBDWCHoAKvgwnDKiIpxwOdbW8HAFOTIyGJyk8BAyJFBxCaKcBeycyvUAjjlkGAB0ADpgGxu19Y3Nre2d3b39g3DDo+NiUzNznIvL65vPOw1NXAcdcF09fQNDIxKV0m01Iszq9yWpFWWxeEL2HzaXx+J3+50BY3i11B4IWUJhz228PeLSRR1+pwBlyxINuEIe0JW/hE4l0ABZ1MZ5EoVIg2RpxNogjT/CYzEgAEw2OykBxOJAADncnhweEIJHIGkCeGsEDAzVEvQgAHdRGAOklUukwFlcvkYEUzKUqOVKnhXgjSYdvsc/mcLkCaTcwXcGatmZpdKoAIyybnKKQCrQ6PCGmQms0dUXFSXS+yOPyIaNs5XULxq3yagL0JisdhcAyCCOspAANk5ckUCcQnM0QrwjaMYvMUpAtnz8sQEqVHjLqr06r8WprehYbA4swE8mbEkQAHZY1yu7ze4KU3o0FuwNnxVO87KC84AMwl2eYec+DX+GgrkDdc1oIweq5HAMAAOI6AAgkaprmjAAA8ADCepFAoFApGkGQAHyhPYzA6GQcAAPxJIOKyXvw8grDkoEQWg0HprBHQrAACnhBGkHASEoWk6FWth0SkXwgjkVe1G0VBMGZjAKwAEo6DkpBgAAaoaSzwfxNpYRsYCiPhcBYA49Q0eBkmMdJZQVFU+jCcGnBCoBiicNUACSLEShYm6UWAnBphmcFMgKChVMgyAgHQelYHI/gAAZxWgcC0Bsa71pwwA8MJcCcK4UzhMwnAAOSmgozCMAA9DQdYFbC/6OEBPmQVgWDBLEwAbJwnC6vqXDpTS6GMHAAAyECiFApgKNlnAALwZYYoneeJpn0VJcHBG1Pkdb57QQHkaBJAVFi0Csx0FRQ7WbQZ8iwKQ+2HcdKynedrjRLCHWMAUnDBANw2jeNsSDGgik+fBY1EFhP1jYo93wWVoPaRtANA5wIOMGDDH+RaaU0kRokAMpoKQ40ta4MNwxsrgbHFMUgAAuhQYWGbKzD+IzekcVlAC0nBsUz7NMnTYWI0pRgAIr4miPRcMajDKF58i+StzG03TIAsrue57nGx5INGp7JkEJl0ejTG4LIOZ3mOMpyoWbIWKW77eIuVY/kEoThJEmCxA4uq7SRnAxYdAAkwAiITiiuDFnDZOtm2dSY8h7ZwiHxza8HVLK+rrmg6GIXYphR3ahTFFA6Ex7Hm2jVAZxwEkkFQFXnQANzneXnCQHBACyZqiNopB+wAcnqHRd7pvcF3kRdOs3G2t3AaRgH7wS4bzTg12lLet5tdhwPgpFNPg0+b9lsRTVh3N5QNCHcHQWGxNkE8OsX4/2o6JSH5vc8KGAkE5Mo7CMAALwSPVRey82ar1rr/QghMgGAT1PJB4IgT5nxYhfUC8Fcbzx/n/GBwD4EKSUtULwt9n6TyBPfF+xd36z3nh3ToPcYBJDWpwfScAGHZSSGXI+HVWEMKSJgr+ohkhyDod8Bh1Dy7PWmigtBV8b4SNjvdTgbIWHsHqPdBRm0HZJDWMYCohpdESJytkAAUucMAsksDWEgttXapDH5OiwhIpREoJSqMGJwDRG9ziKQ6H7B+r8oDT2MZ446nBozRnceosJFCyHOhAK6ayNifY2l8mgMQtggSXlxJ1NMn1mBwAUCsUC9pSDRECqrSMUhNZHh5EgGpfZzwgG9jtG0N5zBPnvNbZwEp7blgXJWb82o9BuwiGQT2LQcClL9gHWgwdQ7jQjvYwJlk3R6Drg3b4nAIAfTuJdUpFS1a6F1vyWp3YGlniCPs667SkCnPHA+ScvS3z9M/EuasrswhjKiLECi8g/bVCvC5KAAB5UgGzq7LOLqspJ9dIUzBcgAEW2bsiErl3KeT+WAQ5VSpwRK1nUnsSZ+wXivLcollsJyFmeSqR2gzlxBF0vpQyHROp6nRDADYRBxBsv1MMRhSd2X8phe6CEMUuocsjswaAPR6hfKIIwWAWVJhz1YHIOIMBkg5AUNaCaEr+XggSJwAaLQWCMEaCGCAuINgmNENy3G1hCZYC4Pq9V+FxxgAGvleViqgTJH6MaTVKRwjGlApxJ4RJ6jSqgLKzgdAs5ZTQMaK1l1rDvUYNYNldYzA2hrrCAAVJwSC/tkJ8rkJHawewsrS1lvhP+UAsoHHwL5LK4qhVyBWOmBQLUYroTbWWmSZBwikB7b5fI/tXUyVNEpUdygjXWDNCkYyoExjZONITGgm4x39EHrAFYAArRtBMYB6SeIW4tCh0zJENBO9tMBI6mBZHBXlqFFJZKteumW9RsnIBil85ExS0DlF/jFGmwR8DpKwDXMqZVICwEPSsdgChYZWTKo0GgIgOZEAlGyFYtAyqiCwOVf9nQVgQeYDIAAxCR74IhgNoC9vkDYv6aNwEA9dUgoHwOQeg7B6AMAENIZQ5UNDCR4BoCwzhvDBGiNlVY2RtAFHqPhGRHRod5TnIQkvRAa9Mhb0DorYu5Iy6gQ1sIL/Y1dYODjRyTFODjDJ1SplR22EAB9fN+aADq4hPWKA865pIrxtO6d5Ry7ZyR90wEcAVLKdbCANt8h4swMs6hgglQNGgNo+gbDgBgc0+BwiQBog0RglEcnJBDWGotLEXKJrqJSUCzBhEwHQpAME4hv31dCxlhO2XdK5fy4VnaWUTBlbyRAOYYJd0yUPS0Y9ek2OcFxjATr9Rf2QE3cBVjnAXJlRBVxiDaAoOIBg/ZwTWhhNwFExhiT2HcP4cI8RlTpHyNUdEBzDbMAOZ6g5qxjmQFYigg2NKjxphQTMDwdi2EABRWgkV1U0Rs3cYLN7+2SsQLCKmh6NiTs7RAbtBU6hGk4Mm0gMgoAFWiNPGD58MhryJ+mEn7ByfoWyXRnaaAcd3rxwThnVqACkcBTqFVJ+Tyn1Oyq09zUkPnTOycly3ez3+XOB0rCHewYIZhjScGh6QYdwQCqecIBEOA6FzhxZs9esYdgmryBKJTqnGwaeoLp3GvXMxeHaDHWMFk1h+CzAfN+lNQGh0Y7ADTjquvh1JCN3wKDZuIAW6clbzgNupklCd5L2ORrkAwG5TIGmPYiyqEz+XI1DqnVoBWKQPILkwC1AGqWl2n17OICIMwIsT4JRFgVC9cPWeK5cBBRFqLVea9gDrw3uATfAgt/423jvT4LCSEQE+Xvpfs9cFbxkMgukZByee98MqdAou/3qvuPcRZJAb8H5wXP+eaYc3XYRyIiBWxTglDfjqRq8+Ggr4wZ1OfWARAHfJSQ0A/CoToY/WgU/OBMAfcd/VsCwPvCPW/bfG0XfcAiHUwY/fPVzBZRQKcJ8VfWECVLfNmaaQqTzc1PTWSHTR9PUAqaeXHadMAYIGKRFM0MeYOJlGAVwAAQk4E4MUDIH4Jikd37ylwSiSGELHmoN6E4DoNSD5TAEENkNENZ2Dw40pjihhzhzVWXSRzFVLUlTjiaDzWeCxzgBV2aA50oKFHxkGD0lxkTxgEIGNBamYPZS4CHXsJ0EcJPWYBcPwncM8JsK4GYAwBMINRmi11C35RWGiLkGCA53QnU2nmByiO5y7QN1l1FwpwkOdzDmkNTxgGJ3yM0O2WVzAEiKSJkhyMJzKMZ0F2FyKmZwKIlykPpyaI/XaMqI50yLqLV3dxHTiKjw10N2N3jxaFcOUEt1GlTxfztwKMKMlxd2lzv3GJuk4FjxNwTyTwmhTzT2WLpi3SHVIO8LbgoJmkNxoMUPoJUKYMGO51YPYPULBB4LZgEKEK4NEPEM6PWJKPeJ2LuKUIYNUJ+JENIH4MqPOLACpm/B7hCjClAlNhAGQB8VIA6DA0O2Oxg3SGUByGSBWF1GYD43gyu3szKmER0zKju2kxMGSDKlx0PWiGVmEFxQlFbAVAJXOWJSaUnXJR5MpUeULDtheQ/CdiGV/GCDi2gFiCGJyM9xgD9jNAwHQnugiDgMNB5gWySDVOQBpkEk4CIAgEVU+gAGpIlKx0xRo2SXQrI8BATE0rUYolc0BI4zM24YBjRhwVhOAO5JYAD1VBQch8Jc1ckfJjNOBDJvgSh0IvS5gNgihOIuATIxgmgckwgWBxB+hlTvcFY9NK4ZZ6ob10yW1SRkgRAZYz89QuU1J4BTVSoLUt0WNiiChggnxogDtIMTsyoIcwA9xEMLsxQch8MBzfsGErsBynwD8MgCgVgnwFMKM+9gg7hQzwyEpEt6g8lYyV1WyYoz8ZAVhwcEge0cSeM+yzs2MhNElrtxNJN7sZNyojzlyqMjzTy0BPyOZBQ4BohylMc4psdzRLiUkuAZpVAvDVcGiwKkh+cKd0IwLViuikhYLOB1BFcgMBiQLoL8cDdYLhckKATii140KMK2csLqiqZYRls1tDzAJjzPzzzuMjteNrzhzkM7z0MHz6SHtZNXzXtKMPz2AIcvyRKEgfytA/y7IQd6gwdxK4CKkxBgokBQpVZTAswqAiALAVhoxdKLALB2TKkWwpw9xWxeTeROlqBLk8Au0hSulHxFQ+lJT6UPkdRLi/ITZLRMJUlYkHESgRUahiR9gyQfQKQ0QAxMQJg7JQx8QcUTKJRJBTlOxCVpBrL9ZUxFY0ThxFQHKnlWxnLvBlL/BeDbL8cdxdAl8Ox4xeQrA3L1ksqkhowLBVADK2rrwzZbxmq8qxTXAVZdRYBaws40pZpBBJoCg8oRce5SoKoYAqoLjuoRqaR9SsrJoZoyIsVFojYsq1pzoWldpbpaA9w2QJQoAnxVBEJrBWxWwXxEIWqu9JAJRVBRAnxkgFQ2Q2QAAhawSQGAPcVQSQVQAoCwZIaHZIZIR6Daa5MgQ6vcZfSQPcBGiwRCGMBUaMU66wJ8SCCwZqxCPcKAHG5IVqmACwKAaMfG6wRGxCBUSGjqLFQ6jyawNq5mlm1mtm9m5myG56BajlHnA3Y2aSRAYXTy6SPvfwOtUQJAUAQIeQOePUPABKEAVwVwIAA"}
import { Hooks } from 'wagmi/tempo'

const { data: allowance } = Hooks.token.useGetAllowance({
  account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  spender: '0x70997970C51812dc3A010C7d01b50e0d17dc79C8',
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Allowance:', allowance)
// @log: Allowance: 10500000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Return Type

See [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook return types.

### data

See [Wagmi Action `token.getAllowance` Return Type](/tempo/actions/token.getAllowance#return-type)

## Parameters

See [Wagmi Action `token.getAllowance` Parameters](/tempo/actions/token.getAllowance#parameters)

### query

See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook parameters.

## Action

* [`token.getAllowance`](/tempo/actions/token.getAllowance)

---

---
url: /tempo/hooks/token.useGetBalance.md
---
# `token.useGetBalance`

Gets the token balance of an address.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useGetBalance.md","from":117,"to":5413}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"c7528612435a35df89295a7a12ef72ca886311a30623cf9079ae2b6b2e88aefc","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUWKQQOBwYAJScUKJiiJwARowKplwAPpwArmCwAGamMFD+UBDWCHoAKvgwnDKiIpxwOdbW8HAFOTIyGJyk8BAyJFBxCaKcBeycyvUAjjlkGAB0ADpgGxu19Y3Nre2d3b39g3DDo+NiUzNznIvL65vPOw1NXAcdcF09fQNDIxKV0m01Iszq9yWpFWWxeEL2HzaXx+J3+50BY3i11B4IWUJhz228PeLSRR1+pwBlyxINuEIe0JW/hE4l0ABZ1MZ5EoVIg2RpxNogjT/CYzEgAEw2OykBxOJAADncnhweEIJHIGkCeGsEDAzWSokaYA6SVS6TAWVy+RgRTMpSo5UqeFeCNJh2+xz+ZwuQJpNzBdwZq2Zml0qgAjLJucokAB2AVaHR4Q3Gjqi4qS6X2Rx+RARtnK6heNW+TUBehMVjsLgGQSh1lIABsAGZo4pY4hOZohXg60YxeYpSBbDn5YgJU2i5hVXp1X4tZW9Cw2BxZgJ5A2JIgm9IuR3ed3Bcm9GgN2AM+KJ9nZbnnC2JdOS3Oy/4aEuQN0TWhGHrcnAYAAcR0AAhI1RBNGAAB4AGE9SKBQKBSNIMgAPlCexmB0Mg4AAfiSfsVjPfh5BWHIAOAtAwLTGAVgABUw7DSDgWD4LSJDzTQ6ICL4QQiPPMiKNA8DIJWAAlHQclIMAADUjSWKDOMtVCNjAUQsLgLAHHqcigOEmiygqKp9F4gNOCFH9FE4aoAEk6IlCx1xIsAUhEjozIgzhRCgKAzjgJkBQUKpkGQEA6HUrA5H8AADWK0DgWgNhXGtOGAHheLgThXCmcJmE4AByAB3UQFGYRgAHoaGrfLYS/RxfxcgBBLAsGCWJgA2ThOF1fUuDSmkkMYOAABkIG80wFCyzgAF50sMfjnMEvSqLcmBgg6lyuq89oIDyNAknyixaBWE78ooTqsuiWEusYApOGCIbRvGxRYkGNApJcqCoEYIhUKe77FBOlYoPK77fout6Ps4L6ftQ6iINNVKaVw/iAGU0FICa2tcEGwZUsBXA2WLopAABdChQq02VmH8Kn1KYzKAFpOAY6mGaZcnQsh6SjAARXxNEei4QrGGUJz5FcmiOfJkAWW3ONOTkA8kAjNtqGPIJdMo+HIMvIcbzlPMWyVDxi1nHwNTfbU9FCcJIkwWIHF1Pb8M4aKjoAEmAERMcUVxos4bINq27qTHkfbOBgsPLSg6pZX1Vc0CQmC7FMQPrUKYooCQ4OQ627zfM6JJGp8vyAG4LrzzhIEggBZCCSrIV2ADk9Q6eu1O0MFsjyTP7Qrzaq7gNIwFd4IMLZpw4CSXOq5Duw4HwAimnwAe58umbUJZ3Khug7g6FQ2Ie5tO0gWPvuSjXufh4UMBGpyZR2EYAAvBIGrHif6an4uH8ITHX5/HqCSDwRCxGmlvOiO8AJQVRiPe+j9/5vyAZJaS1QvCH3Tr3W0WdMEnyzlfIeI9a6dEbkkdanANJwEbllGeld14UJIdoJIsDb6iGSHIYh3xG4ELzq4MBECoF7wPjwkOQNOBsgoeweoQMRFbRnDAJIaxjAVCNEonh2VsgAClzhgDElgawjUdp7VwRfKAqEeFiIlBKSRgxOAyLoecKSHRXZYNPlAAeGi7EnU4BGCMNjpHePPtg+0hlnR6EMc7S0Xk0BiFsECM8uJupGhkPdZgcAFArAAjaUg0QAqyzDFINWSseTxkTL2PQTtdqWj1kgNWo5bzjkfKbeRpZLaLiCLbCIZAHbi1Hkkao54bJQAAPKkBLoXb4JjgklFCcZcZflOAzBsgAEUWXdO4tl7KOWIqRLcugIyqCsPuEpXYyknmoOeGpfIDZ3klE+c285yzviCGpDSWl3I9XRDADYRBxDdT1F8pIcF9TDFwI6IyLoITRU+aCgOzBoA9HqGEYgjBYCZUmMPVgcg4gwGSDkBQFpJowuxcoBInAhotBYIwRogYIC4g2Jo0QvzUbWExlgLgxL6hYVHGAIaeVkVEFRUCZI/RCq4pSOEQqAFmJPCJFyhF2K6CJ0ymgQqdLNIwGsLdRg1h/nVjMJaaesIABUnBGpu2BV8gO1g9iZRFmLLCj8oCZQOPgLymVoUAtBSsGQEAFBtWikhT1IK5ArDIOEUgAavL5DdpylYxVpJRtJRyzyyQdIATGAkwqmMaDrmjf0VusAVgACsXUYxgOpJ4przUKF9amWNXq5AB1MCySC/ywAISkvEul2bRb1AScgaKyLkSZLQOUB+0VSbBHwDErA09yrlUgLAUtKx2AKFBkZcqjQaAiEZkQCUbIVi0HKqILAFVh2dBWDO5gMgADEF7vgiHHWgR2+QNiDoff5J94bJ3TtnfOxd0AYArrXRuyoW6EjwDQHug9R6T1nvKp+q9aAb33vCMib9pAckrGshCWtEB63BqtUklyab/xAntYQB+5LqwcAmok6KS6FGcrhQq2isIAD6xrjUAHVxC8sUNxjj/S8N1qNO2r5izkjFs1WgfKmVHWEGdV5WxZhRZ1DBJ8oaNBLR9A2HADAJp8DhEgORBojASKJOSJK6VZq6I2RVXUSkAFmDsJgEhSAYJxD9qcxJ7T4c9NqQM0Zkzu1MomEs8kxZcwwSFtoqWlo5b1L+U4KjGAPn6iDsgLmv8n7OA2XKsM39M60BzsQAupjIGtBgbgBBnd0H92HuPae896HL3XrvaIRm2WYCMz1IzT9jNfyxFBBseFtjTCgmYEgsAsqwAAFFaARWxeRejdx8OEZY4gWExNS0bDjb6/1+U6i9B7ewGQUB8rRAHgu7eGRp6cBO76zgarSAXaQgkp9u00D7cbbRQ7wRjswFO5wAApHAM6BVXsXauzd8qd3DVJCe2dt72c81fYfr9kNtFw3sGCGYQqnB5tYbx/lHjhAIhwCQucRT9HDRjDsC1eQJQrvXY2LdyB93OC47BJQ6hEExgsmsPwWYt5+3qrHeG7bYBbtdWJxGpI5O+BzupxAWnVl6ePdPTge07P4chzJcgGAvyZCky7PmVQeu85kpZWytAKxSB5BsmAWoQ1gXPPukxxARBmD5gfPmBUV0Zf6/zlwYZ0nZMO6dy7/Abu9Qe/x0B73vuWwWEkIgY2QfZeh+rknjIZA1IyEQ21745U6Caofg1RAcY4z5kkFbg3XAjcm9JozbN2uyA7gnBKBvOfjdGlt4wdlnu8+WgL0aYvFROhl9oBXwBYBq9Nh3BYLPIeupkq9/n6SE/pumDLybjjPsJoThbBn2EnyuCvPqLNMn1KUliQIy2vU+UB5xoTWAYI0VlkQS7pwL2V/XAABCTgb/RQMgQA6KNnYPBHeKJIUA3/HjO/TgB/VIEFMAYA+A8Aj7CXWALDImWKWERbZbdNNbKFS1WFUOJoI1Z4XbOALHZob7GacyHQdGQYdSVGNXGAQgQqNqV/AFLgcNJgoUVgitZgDgrCbg3g+grgZgDAcg7FWaAnCTb1eQtab7JCcNKAsbOQv7H1P1QHZHF7c7S7KAjnX2WAx7YHZ7aHNHBJb7bQ1QvQo7Qw8HSHIqYw2HK3TnRHSwkHGw7AxZTHMAWQxwnnfHGAQneXUnJXSnVXdXSaTXRnHXFnaIUw+Hbwiw5AKI0gRXCnFXFoTg5QOnbyLXJne0cmPNcNc/fg6uemJg2/XoZAx/NAl/Bw3Q9/T/TAsEf/emIAkAn/cAyAuHGAh7LozgRAxolAp/dA/osA0gQAgIqosAYmN8EqYKUKACMFEAZARxUgDoKdErMrBddIZQHIZIFYXUZgQDZdWrJjcqdhAjcqRrODEwZIcqONUtaIMmGWOWXQByBMY5TsAEnsc5TlK5AE+pQ2ZwCwe5bwR5K2D8YIRTaAWIRwgHPnbQV2CCDAJCIGCIefI0VmZLJIbE5AUmbiTgIgCAVFe6AAaj8TLF9W8i+PBTCRAAyJVTpWigxzQADko2rgiMHBw1riFiH2xUFByCwkNRIxSCRSoJKCQn5LmA2CKGYi4F0jGCaESTCBYHEH6AxPqAFy8kaILlFganEw1PdVJGSBEFFkrz1B+XkngEpTKhpTzQ/XMIKGCBbGiGK1nXK3KmmzADjFXWqzFByGPSDIG0blqyDJbGLwyAKBWBbGQxvSD2CDuAlKlPihU0NMaK0m+G7U4EHUrxkBWCmwSADQOP/QDMq38lAydFq23Sgxgya3gwqlLNTLvVLIrLQF7MZkFDgFSLm1oOkP+WMVmlUD4OxycMB0iQjlB0uyQnnLSJGKSHnKSHUHRzHXsJNF0IB3yg3MhxXOGI5PXKqQji3M+x3KCOJlhDS0y2ik7N7KrL/VKwAzrNDPXUbLqxbOeOawQ07I61vR7PYGmz7LAoSAHK0CHLMnG3qEm0gvnzyTECCiQBClllMHTCoCIAsBWAjHwosAsG+OEAKQnAOXbBOTVhBKCEO3BJuXHBNhVDhNfHaR1BqNTARgUWQgtCtFcSzlmUhV2BJE+HJFRB9AxGBDMiDHxDyV+MlBbCjEBN5GBI1hTFWnopHBlChMlELGaWfHVgUH8CvzwDotIsbAnDZCOWKU7COWeTwB1kRgjAsEOSIqIovFkEzBcAYrzBhJll1FgCrETlSjmkECmgKFyihxKjKkqhgGqmqN6hCppDNFWimlmkIh2Vmy1n0i4vWgukqT2gOiOjjDZAlCgBbFUBgmsCbFbDZBghcofEkAlFUFEBbGSAVDZDZBAmsEkBgAVkkFUAKAsGSHm2SGSDOgukyqKtoAcmsDcvmoWsWqWuWvmomoJiD3oO9QPMcoUUh04sgiD38EdVECQFAECHkGHj1DwHihAFcFcCAA=="}
import { Hooks } from 'wagmi/tempo'

const { data: balance } = Hooks.token.useGetBalance({
  account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Balance:', balance)
// @log: Balance: 10500000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Return Type

See [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook return types.

### data

See [Wagmi Action `token.getBalance` Return Type](/tempo/actions/token.getBalance#return-type)

## Parameters

See [Wagmi Action `token.getBalance` Parameters](/tempo/actions/token.getBalance#parameters)

### query

See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook parameters.

## Action

* [`token.getBalance`](/tempo/actions/token.getBalance)

---

---
url: /tempo/hooks/token.useGetMetadata.md
---
# `token.useGetMetadata`

Gets the metadata for a TIP-20 token, including name, symbol, decimals, currency, and total supply.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useGetMetadata.md","from":180,"to":13885}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"ba0d6e59f59bb9a5429e5c8f90558913930bfe2f294f96336382a6252f972e31","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUWKQQOBwYAJScUKJiiJzAADpgnBmc1gCupKTy1hhJIqSmCgDcaZlxMNYsojJwSWDZzABGZJXpmQCO2RA0ACoC8gD8SQAGFrQAJMAlZa4TnAA+nNlgsABmpjBQXdVgoswwxWiligeZWKLZcHvjnG18cqLpaxvbu1Cr65swOzM+yqmTg2SwWBkGAAwqIsI82owFKYuB9/oC9r9PgDvlcMnAMO0IDIzhcKiCMmgBg0AMrgyFFJ5IlF4zjnN5wLZkAAKxMYhQAklAEcywKi/l8gVj0bi0q5pZK9v4oBBrAg9IN8DBODJRCJOGDrNZ4JzsjIoZx8nBiSQfvExJwtuw2VrOH0yBgAHRpH1gTXa3X6w3GuCm80YS3wG2Y+2iR3O5Ta92kL2+tL+nV6rjBk1bM0Wq3Ru0JONO0gupPZD3esC+jOB7PZI25/MRwsyW1xEvx8uJt1VlM1uuuhsGpshsMFqMdmPdssV/vV/wicS6AAs6mM8iUKkQa404m0QVj/hMZiQACYbHZSA4nEgABzuTw4PCEEjkDSBPDWCBgfUnGIsZJKk3QZDkeQFIyCyXBSNR1MwDRNJwLTtJ0cF9AMMDDPwYyTNMcwwQoSwKjiQKskcJykmUrI3HcDxJM8xIwG8pEYj8aKKsCYFjhCUKwvCjGiuK2LsWxso8QSRIkga5w0XBVJiDIdJ8YyiLImKrLsv+XKkLyJiCsKQkaSJMpSpxZF7F08oWexyqquqID1lmY7NqGebhpG1ozsWDrzn2yZesumi6KoACMsjbsoj4HloOh4IBognrIuyXte9iOH4iBhWuz7UF4b6+J+AT0EwrDsFwBiCMFq5IAAbPuW6KNFiCbpoR54FVRhnuYV4gLYGX3ogF4AOx5Zgr56O+fhfqVegsGwHBsiMYA1RIiAjVYTU7mosUdXoVK4atKXnsN6W3plzgAMxXeNBVTUV/g0HNIB5mAjiMH+6z3AA4joACyOhJSWAA80J/jsCgUMkcEQfk73QXJsE8bACFIc0rQdKQrKYUMK2PFMszzEjxHLLZEmHMcpyyWStG3PcRlPC8LHvBKlkcWz7GsmCqkCSKJnieZnMU6ChLPDJRFadSyn0lCxksgpt46TyfKGfzKKC5i5PkXKAB8oT2IBZBwI8XWeod8ievRf1oIDQElp63KGzoxtgxDSLQ6B1Rw1B1HI9UqP1I0GNodjGH9HjR0EwRxNkiR2tWXBlHU5LcF0QzCLM6xCcc6JIv4rLMJwurYqa7nZmJ5JYvEn75I8YptKF/LmmKxyun6fyGBCiXplcWX1m69ESRmxbYBW79ANA7GnoAEo6LkYAAGoNFWINe5kPsI7XrKB4hwcoZj6E8bj2H4/hRNEfHws6zxyfb2n9MMUzzHZ9fWtv9x1Q8wyfPN737P9zglJcW9967SxUgyP+WklachVgZLujN1IaxzoAsArhdZpGTnAG4xpvowBtnbYGYh7Jqk6nwfgPZOBHjQGUTggwBTcgvBYZaR1OCJWnk9UQCh1TIGQCAOgxxIS4CoBMURaA4C0DSAtCqyQeDkLgJweUWxwjME4AAcgAO5cOYIwAA9DQcqajfRvQ+l9AAghCYIsR16/n/FwYAXYxDQ0YHAAAMhAJKtD5QAF45GGHNitce+DJ72zEMEdelIVpJDUdMT0cS1EUBBK4aIvoMiMC2JwYILj3GeMULEfIaAF6cBBlARgRBdY5NKYoOJnoQa6NKeUkEBSiklLKbrYAsZRiemTvKcJnTPTAOJMkupDSMFoLSKIiYIAAC6FA+E3FvMwfwCyqZOAUQAWk4E7RZLtSBwE9DMuZIBmmkH/P4AAigONs8AzRcA0YwZQLD5BsKng7GZsyQArnWiNOqkVmq7hynteKehrYhKIaIU8qUzr9RvHeLKV03AeHypNHwH4nrfj0KEcIkRMCxFHo8HC8ghQAHlSBmKgFAK0Cic4kMcuSylJpODOgFAAESZRkvs9DGHMNHgc4QIUpCbjkP83a1BDzAuoCtSFp0rrnThc4C8d0UXTWKs9IIWCcHalsd5GAaQiDiCyH+HVSRwb/mYrSvAGYJjauYssZg0AzTajCMQRgsAFFxjgAtOQNQ2jZAUBpBQhqzXeuUAkTgLiDQsEYLqXsEAKxpAAFKiH1TSawpQsBcBtd6k4A0wAuNUc6ogrrMRtAjBomAbQnjhA0fcPZQ4/SuntVAR1nA6CLXEWyDRcbsG1HSfyQ15UzBiiaL6AAVJwMxnAJimp1csawgYFH3MeYBQgUAFGGnwJwPUU6s0wE9DICACgrETGhtao1zFPRkHCKQY9W7Ng7vPXIT0WjTm3tDZm1iHQ8E/CpJwDRpQaDLTvRGAActAPdAArdd5wWLMBrOOydCgD1tAaA+4NMBlimBXO9LV7sFC5ExL+/9DztS/uQBMZ1E4BloBVNkNAExpnBHwGgNAWAmi6N0ZAWAUHPTsAUPUhyujdQ0BEOsogF41yeloLouEejKMmk9Mx5gMgADE8nQwiFo2gWIbwoBpHI+p/Zmmr0MaYyxtjiAONcZgDxvjAm1RCYSPANAYmJNSZk1gOT4QqNKdU4Z4zeRoiejoa6JDEAUMyDQ7OrIn7tT0R+EuwgdHw3lQ4LQvsExrOIF3Xah1T7fQAH1R2joAOriDzYoYrBWkgZjCxFoNOqmVtAg7UNAaiFErugO6/IKEYAPK1OWbVLiaBiihGkAk718DhEgHcHUjBcILjaNW2tE7uQCgUYma59x2hyGhpAcs4hSNagjENkQ8g0BjaOBN2w02ICzZMAthokWBgDc4GB2AnooM01g/szgNIYBHe1ORyAgGvqGc4AKXRxLTPMdY+xzj4HbNaHs3ARzImXPick9J2TujDOKbQMplToh1kg5gOsv86zDPrM+rEMsaR7U9dMGWRCNC/z1oAKK0EEd6u46XQvIdQ2e9DExEC+kmVBtIu792HuCGorU5o41dtIDIKAajohdA41si44ikjy4PX+9gKvoa/s03dtAkvH17oPUeuXMAFecAAKRwASeopXKu1ca90VrlEyE9eK8N1AY33aaNm4t+hy9eR2DBDMBozg7PI83rUSVwgEQ4DQ2tCu2hKGfh2AhPIPYav1dpE19ybXCir3OhOKGLh2pdOyQcBQ9kuCTc0avaLsAmuMjx+vUkZPfA2Pp4gJnxQTwkqcFzzgIExevfVDDcgGA+qZDTNatlVQ0/qhbq4Km9NaBPSkA2AKBtLjTVqsyVlogzBspXQvNlB8KSO8z8yGG4lzXWt74P0fuAJ/Ahn/A4gC/iAV0FgkggBd+6+s+XAWWKIZARwMguO3mJouidAtQdGn0YAG0I02Ukg4BT+XA8+i+0y6y/6cIkQiAdUw0F4OBGQYaC+tIaajAGav+sAiA0BpyDQ8BqoiByBOQrO6BPyZBFg9+neuBKEf+rBsBuiiEpgSBi+BWREw0V0gBvo2qkBVMnAviSe0akWM84WWGf4aiXQUuL6YAwQEwLKbw2g5YcwPSAAhJwOYYoGQDYRMEXg/t7sOkkA4ZYZwCVloZwDoYiGamAHYV4U4UHrJLAHkBMqIr6JztznFp6iPhljOralkAuu3tERMBLu9EalwGbuoVQjoDSDBscDSEPjAIQBolYoYbka2nkAUUeMUfkKUeUZUdUWHgBDCJbgUTHg1heikXIMEGbtDFeq4fTl0eHtbrLn7gbsrqrq4SXmXrrnbvrm7oHkBqHmAMwBMTqtLjbjMU7i7pogHh7uvqXj7ssfbmseEZsdsQMXuhXjer0d3lHkningPgaOUcoFnmPhPvnvMQsV7ucR4ZwMgC8aQL3u8Wnp8cPoGtnuPiQf8bMkBlesobUcnAUZoeaP4boUEQYeMfcc+uVqYaEVYcALYfYRYU4S4Z7u4TrpSY4eWL4diQEXocEQyZYTYeEaiWAJMpwtwkgLwp8gDv4MgNaLkMaIxrDhZhxsiMoNkG0J6L+MwAjtxqjtZrom0Mhropju5iYG0LolLlBtEO8vyrVKvn1MKjtBtECkELutKuYL8jCoNFlBYEqt4Cquii9MEJ1lALEISVMVXnADXo8G8BgNDDUhELwQ0NsscMhGGcgNMkPJwEQBAK6pkgANRhRMofgHpJQmlUAqikJ6DAkdq/oTCm50bLCJa9YaI9TBb/S3IMHeqHitDnYKLWCxacA3Chh7DQw1mJhpA7B7JcDxZbobauhhD1ApgvLV7aB3o/BPZboUoPJoGoZjnbpghtAiAPKoF/h6orzwCRo6IxpAYGba5bDBBXTRAw7maWaSFvAjS8bI5njZDSaIRgCU416o4flXTwEohbCehXT47Kb37BB9itknDDpbo9ZLk9kMxnkTCoEyCejM4JDHpSnmbw7WZI78ZFmo7CbOauZY4eZ6LIUgWqbIVoVoDUXrKHhwDRBBZi6iLZEqGGobBcC+KqA1GTEy5qK/gcVJAO6q7QwCViiAl0nIRiVoBJDqBAaVnm45G8U27SWIAu7SUSWllSV3ZiiyXhEKWZG+j/ZA5IU0IoXUUYVmZw73k4X7J2b4Vo5EW6nY6ea6LkW+YqZUXsAs60X0W06V7sDahM7eUJBoF8pioCkoB8KJHGj+BEAWCehhSJUWAWCmmfICrZR1RbRWktSypipxRBDW4On1RyqXSPjumFRoqzR2m1HsIlggSwy5DwyFCgIBy9p7zISoRYw4wRynxRznyEQkxXx5w3yUxUQ0zyQ8TpxPxMSvCswjXvwLWfygiFy/xMgCwoI5zczVwSwkxSxKQQJyzrUKz1wwLtyqwII9xlyoI2QfwWoagjguQ5juStheRFiOKlgJiuiBThVfK6BhQjQjR/LWkPi2kJSvLEInSOmlVDQXiqAVUPRVUlRBBYoRBkC4pZBNW+wTUj40qFkOR4DQhY0IyZJ7oKDBYpAgAACqNILKlNQWa0/1D4QN20LUoN+V+0/UxNhQxVZBMN8K8NSKE0Hpj01VeAGqDguG6GB5g2luJqlu91TkroQu0WTaLahaxa7qx5QiPqfqAafRIadgXAEanqJ5Bqv6g5YASaKa9BjBu6Lyua+a3Z4QRasAPwpaf6FaVaEANaxs9aGYat3qbaFUG2XaBoOAdQOw1gA6bAQ6OuY6E6U69xc6C6f6/WLyygXWrkm626KtF6UxN5p6Uujxt6deedT6xhb6RtMW6QX6Y5RGAGpGcaYZb24Gn20GzRcGaQCGVCAukW5dGG4adibwuCtikMBGP6iujdiFeOClt51lVmiOdlyODlhFomzlpFHBPmBOfmCBGmIedGOmmw+mFGe9RmreeQ89MpqpNmy9eFgma9GObmLlXmnBoYFFamZ9AWpAQWIW2odWguOWNdTwCRmIiW+R0iaWSRytWWQDgde6hWxWZWpyZQVWNW/O4WqG9t4WLWjg7WGdq63W2oZg/WZADWw252l212U2f4d2CiD2gO3tvt5YZia2E5MAW2MAO2MAe2zoh2FYJ2RqFDo2GAaQeoGAk2t29282te2JL2ZD72kGHdP2wWxlC4wOWETK6Q4OkO0OmFC9N9uFKOjl69z9m9eOHlxOpO5On5VONOPY9OgVQ91FYVsRXOrAPOiRgafYAD/dOWGRvJLFcAHR+dfFMxaxpxbhWllxqxAe+lB9ilUuUxtu9uhx0MxxcxkTixFx4+Kx/ucx8TWmITT6JdzxCesufeqeg+sJo+OeiJQIhetJWldR16s5wZ85deK41gjeF0TdERbeOB4JkJ/e0JGeOg+APxdTeeU+bhEBoJtBS+K+YUa+szIh2+DBu+++YAh+mox+f4p+0ef+ABYU1+t+Qhj+1BXAL+uDmzH+uzX++zP+hzzBABQBIBV0YBqzlzohzB4h7BhmSBtAKBvBGBWBVBm+8zBBRBt4eeEJ5BF4lBXzELCz6zjBzzpwfzcBAL3Be5fB5BWV5zG+YaUBYoMB7BUhHeCzchJMChShtYSl+oGJGhzJ2huJ1oYA+JDLF6ldZhVJZJFJpJzhmlSxHJZDLLOJgR7LIRfLXJ8lF9pAhl9LcRHjCRfO2o06luKdeoI69L4uwTDLeRyWvijRJRzAZRJwbRrhbFV6DRRRpr5rFRPt7RBrbCOxzEPRMAseUu9xQxdGIxgWXQBJluex0xeTsx7uwrOT4TcTGxdGQbylobqTzu6TETkbIJ0bBTsbildxwbpTnrce5TbxIz1T4zkzCJ0zBejFTTIrYJCewzVTMJpbI+8JfxQIyJv6PJHRqhJwmJ4rrJeJXQOb4ePLpJnA1hVMrg0rjJQr1bOTo7fbbLf4U7nJ3JURgTUyB4kVQp9wwiIAYpd2pAkpVl19cp+ACpSpQ+hj6p4Gmp2pG9+phpwbxpaVf1SAYUkgLNOVu4LN7UEq9pUNSALNA0F0Q0bpQt90EV/gyceARVZp6077n7UUu4W0aqhN3NjINNLKvNQHsKZVlgCNqKM0yNeAPp4z0A/pwbgZJoIZSQYZEZcSUZa5MgsZzA8ZYAGAiZyZqZ6ZwQWZOZZAeZfpitzT5Zc9adjyMe9ZnAjZMgNCOtkF7ZwDX68FfZ4nm6ltw5+oG57Dzt05EYQZNeC5W62JSUpS0ZkW2nY425NChSvBB5MgVY66Uap5ZGp9AFV5N5+jWA95H5T5dmr575bwX52gP5bwf5U5YogFwFvmYFEFWgbZ0F/DcF2rhGca5G5FFlnnx72FS9z599Dmj9xF7mOO7lO9nlZl1FvlWgDFTFurQTXb7FpcXFPFuxyTqljuIljX2ms7IJ7XclLeRTXLT6bXOlMl6lo3ab9JfXhTmxkyRlAOoJpl0aqFIVaAll0pOXapeXxjhXG9JXZlH9XlpAPlq3dF1X/l5YDOQVYALjbO/JPC0VpgsVVA8ViVyVqV0yHyr7w0FgQqSHSAeVv7hVh62H/NzgT44HyqotxHegbFdViQMMPEm8LVONdcbVaM+8XVR81QJ8hKYA0cF8Q1ZMH8FEVMrV1wj8iCWc81Fc5cXE3Mq1xcf811W1QCO15PkSB1Tcx1Lcp1bccCnc3czPm1JPcoZcitzkQY44LYnk7YnYsYlCAUVyv1GVF4YU7NX7MUHNEq8PEKAHNpzpIHWUavBHnpYtmKzqOKMQKEZPqP4v+NxZIAIGahEAHKrovKjNl4F4Gv/3e4YNeg0H+vOHLp10YUpv0PqHAfVM2CktBtuqYA+qst6G8t6GEvytcDeWTqLtmtW62t3qsAvq/qtC9t764aTnZtsa8aVtyaogqLma3ROadgeacABa2fbtTwZaXtS2Ptta+yw42o8DratA7aod3aEdfa0dypsd7ZATPdGrwuaR2ranBDWdG645UWoTR6hdG/JT5TN5RnA9RJr6+/pfnZtdoDk9f609v6Ldij7d32xw8GidvjO/g9WGYgOGQa49+Ql/xGgGrns9BJlfU2631tuq9JzKYxIo44LGZXfzAkyPp6YwA55N+ufUiKkBgBNlXLvZQfoQCn6UA1yjAMJxwC0Bv9WrH3Vf5zouyY5cBslkgY0JoG6rWBpqzYSZ960RWUrOVlQajpqsf9Xupg0izYNX8eDDrGRzXQwViGfWRMEn09RnYRG42CRjdlobSMFsfYbvsw1WzrYBGXkLhlqR4aiEDsPWTbOQ1kEXZRGV2BQTQxmz0MZGxnZ7FINbofYvsJQFRn9gW59gNGoObRmfQhxQ4MBi9LbtgIK64CiuL9LegpksYk4sINjSnGfWpwQALujjRnDd1W6uMlW7jHWrzgYF8D6sA9EXMxSyL6skmYTMNqmx670kM2RuOVoNyKH7Ew2aTV3CcUm6+4ShMbAbpsWLrlMym16CplCRLbfFm2vxeppWyaEtNK81HDpvei6Y9NY+A3AZqsyGY+FehjbfoXCUGEVtEBwhb5vgQaDL5VAq+cFmGjr7v5tmn+b/PQCYKnBjmpzdXoSzmbXM38WzHZhMweaktzh6Lf/JfjeagFbhIhElk4AkLYsgWPBNAqC3fYHC8CCzQgsQVhZkEKC4I1tIvjr4XCWCpLNglizPqAtgWII/ggS3hF/CyWcBCljIQaDUsyQtLK6GiTsQ28e2zLPwv23ZacsjCxJXloyTHbkkJ2y7akk0M8J8sfCdIxduyUFaFMeSc3NIfEW+hqsk6zA+dNqwCZ6sGu+RY1na07oOtLWLXLgDayVFoAmisGVUU6yta1U3W3qXxL0W9aW5fWaAf1j/UDZbEjRVuYoVcUaFlDmhjozNr+luJ2iQ2KTfXPUIyYRtnRMTfJpUPdFxtbRhJPNrHnBI9Di2ywiZgMKmaT5hhAY0EgsMqYfExmKw2puW0TFQB22caTti6yZbqIF2krfQoO09EjteR47E4JO1FakAZ2ZxEVvO35GljBRMrVdgq3Xb3dBS0VEUlQH3YSkYAXneHKe3PbKkr2N9W9uFh1JmMH2RpBii+1V5XRGomvA3kDx/AK19e7NYDvKiQBgcXw3gMQAoCg5UwYOIPODroAvDLjgaLUFDhiid628qaeaGgD8GKIQD7CxIGNLzW3G4dQO4fJGpHxCC+kKOCbAztoFDLsd6OvGDNExxY5scOOSZJINxx+C8dsyRUQTgWRAD4U8AInONBWSAHL9JOuwBsk2Xk7xcoKHaM/iA27Ipd1iA5LUEOUYAjlv06/PsFOUQgzkwJtee9EuVM6rk/w65BCpuQVI7lbOaBezo52PLRpzaaXNzpFw85X0fOj5bbgFwfK2Nvyak8LheSAoUVYuroBTol1grYkVOl/dLgd0y5+Cr2YAnAejhCGb1SuhOI7id2O4JAzu3CRivWnlEutpKBRbisU3tEqVRuQlTrhpWTHTcqh7QyjnxVUrjcOK3IrrnpQimhjRRaQNRmZOW4WThxmAgISvRslOUzG+3Zbh5SckJAqu7kyhFd2cYpC7um7B7p8ie67tXuSVMKClUXHmkJMlpX3oD3FTA9jxW4sHuVUh4i0AJ94uHhDVEANUke6HDnvBCDidVD4YcY+L1Tx4E9BqccYnktVJ7jVU4U1SnpnBfg08+4rPSSIz0Eg89/4YkY6V/HZ6o99qjcVSFAlbjKw9IF1IXudJZ6i80E9vLCQTQeoBgnq0vF6rL2nDy85wX1SsEuAvGXhVAiHEVIgHZrri9Auvb8QNIUL/iiOgE1Glb1iCDJdqZIb6dhL0A0gdq7KBcB7yhnDQ6osM60k6URmfIdqKMw3ruMAK3QhplVDGfeIlqj1LcMtOPinx1Rp91WGfZtN6g1pupc+ptHWgXz1rF9uipfE2s5xklV9ratfW2vX3QwO0m+TtMWSWk76Vo1Bvff2o2kz5D8R+naMfr2ijox0/wM/BOpOnn7RYZRoYZfr6XXRNgc6CiQ/gXRPSv8I83Q/fmXSZHH9lgp/KgQhQbokYgMt/Nuk4NNZP9EM5A3IUPWwzcybuSICekBj/59NkBVGOellP8GgDAhBFYIXtwIFn0P6xAs3AgJPqAC0Blk2ytZKCG2TS5r9bekQK/rytSBGDHIUAyol10EKNA42qlnoHeMYGf+YWY6jYFINOBlWbgeg3/rkDBBNzfBq7PEG9ZSG0g4RqYPkGSMlB1glQa6ANlkNWGmgowVaB0G7Z9Ba8owadhGzbzzBu8qwXNkexyN7Bd/WOZ3V+xqN3BmWTRmDm8G6N65WA3KU3Pyn4DW54QsrlYyiEU47G8QhxlsScbBUXJvBDnOkM8aSiX+uQuUfVyG4BTE2sTTJvFIqHrE2hoYmoQQrjS+jShjYqNi0LdHB5qhubTofmyjFFsG2GYuMasITH/FGmtC6Co8TaaGdOmYgbpmyF6ZVC5hwhVMUsM4VltW2eweEdsMWZ7Dlm8Io4Y8NOGPM3h5+S/Ccxvw3D4R9wxwMcKeF7NXhXAd4a82ALfC8RYhVEQCIxE4sQWgNMFkiznyQjoWiJOFnCPcUajERas5EZizCGhhMRwIv8BtHxaCE7FvzBxeS1EDSEqW8hK8XSwa5FisSrLVsYyODaVjWR1YmALWMFY0l+F9JZsSyQFGcj6xwotdilLADKsMhXjBcA7NSJOydWmRVirUUVGFFtR9rVovqPVEtNbWPSlUX0qqIGiqRQ7RrCaPzZmj0MFoq0WMTDFRTahro/0SUpdGELgxcaD0QGQdE+jk2DQohcmJIU3FQxkyi9BGILbdD2F6Yr4lwqzEKKASyY2tj3kWExi5F8Y7MUiQ7GUjGWahWkeUqyXljCSuS7wvksKUytilUTJsbyJLFslKlsrDtjUtETdioqwpXdgOMPZDjsu95UcYqXHG2VJxWpacfe0YAGl5xJpT7hTNGh/c4ZP7HqRuNT769pATMvDvuORSHiuEJ4k4GeL6npV2pI0WldaTvEvRiZ0kJIJh15osqdxbK9GaqnvGkdM6fpTgLsqPRcSIJ4ZTgJGRgkCTmOhseCZxyQlpkUJfHdCR4iE4O9HIuEqdGJxrJESzAJE2Ts2VrzkTFOfcp1LRP7Lp0NOTErTkJJ07sTxA+ncYdxMXImcVy5nFicJOs67k7OCfQ8uX2kmV9zy7na8opI4y+cVJpgN8mpOC7wBNJ/5SLjpJi5pBwK+k11YZNkaRYTJiFDLqt3W5YVsphckBcXObkFTXKDkyihV1W5lSaunk3BWxR8nNd/JXo9rsJViniUwpQUzgP10YWRSE2/FIKROu67rKkg4UshYpVqVpSlu5letVlw25NqjG4AtteArcoHdip3alBb2ou4sCkht3MeKiu3YNS4qCVZqa1KpX8r1o3vPKquO6kFVeVUq1GRDwPHsz5VL0MaaEgmmI9vY0026XBF3jowD4ocHqlhBWkDVY4iwDabTy2kpw9qD8eLPtLmofTNpQCU6VdRF4kaq44quDWAi54PTzp0Cfni9PgRvSkEpcCjdhrF540fpjvSXo2DciTgts71BXv5G+rK9PegBFKjeN3AIyGVSM8aYBtZWw1BaIGxGhzO9KW90a1vBDZjwWkEzfpIAFlO1SQiky+w5Mz9boCugtTpNWvOmTpu6hQppVv4gWnKq9Lqpo+mqOPrzN3T8zzUlqy1On2YGD8dZWtSWfnwrQyyR8JfaugrIr5AZLaKspEfbUb5vBtZbfXWZ7X1nLY/a/fFgSLO1DB0OAo/cOpbP7RT8bZHhO2VKIX6tKXZogt2bYHX5eyZc2/Q/iXQDn3pD+ldE/tXXdUsSI5//ZuuxwcFKMH+XdMAD3SwVAN3+I9KWt/1S5X9I5AA8uXnJxUFyj1eUyAcVzLkoCK5HcrTNXKQGn1dt39IBTlPy6tqwF22iBe/Q8rEDRiwWMgfwIoFKcL+anCBsPMlG/zmCE8/LPS3YHIMKsCgNBrwJf5LzWsK8+rWvJIb2Db5lDMwdQykb7zGGR8lhmwy0HnzuGvDAwYDkEb/gt5l2cRo/LobPyq1TKN+THOUZxlVGbg10B4O1D/yUBPgvRmtqslFyTGeA67SEv2QRDrGsC2IfYzpyIK711UseG43FGZDR5C857dgvyEdKF1JCrJkCRFYnKkpiTZZZQsdwHK/R8xY5fQq2URF51uxS5WwrTGjM7l8ioYU8vWWjDLuIaozlMPEUzDGFUix/DIveUW7PljypRZCKWYrNNhELDRXc2eFnDLFuiq/AYs+YB7n8Qg25icPuah7kR1i95lHouYQt8RaI7nWEtxagjsCfiyFjsK8Uwj4WiLaPf4roI74glcS9ESgOz0uKolPw75hnokJEiklNLFJRSPpZsV0lcKgdiOtBVkNwVCKqFdkxBJlLMl8KusYipd3IqJg4ulVhKKyHNK5AWrUMDgoKEKijW3SnUS0Qtb9KGumo7fb0r31jKBl5y40bWTj6egfWwxFposvP34LvRQY3XautyarLSF2ys5Z6OSYHFtdNC6FXQvf2nLs2nok3YWzN19D7lLbK3XwoAMgkXl7AetrcpqbQH1heYlpr8u7bagAVE+vvUsuHbMjR2Q+qfSPuV1ztYVLYyfUKJRKz7H1vYjFeKSxX5zdEeKi9iqUJUaliVBpUleSqfYLiP133a/NlV970r/1sPTccYChTWalNrpAjkeO5XeBYOFmgHkwhs2WBzehm4zfvHV681pDMqv8WzLU1gaUawElVRrvVW0dIJWqhjjqtgJwTLDCErjsaszJoTcy5qzCYTJADWr8JWmasunXtV7ppOpElshWsoldkTJXqx5D6uYmWc2JpQDicGrnKhrbBy5MzkxyjVuyY1Yk/cvGoc5HlTaSameheQUleclJYAPzi+WzWBd1JIXAtRFxorFqd6ekl1fhgolEMUjNa1znWpQUNqDGDc9nbt3bVkVz1ZXEqTRVO5+Vau7SwobUSHUzqWum/WXGOpCkTcp1glGdTN3IUa7F1glZdfFPXVzrkpMReltuu6Ms5ej19foy2o512TCpKFC9dGkq4THzuFUpBckJQVhU6D9UnDC+re4tSPuX3DKtfh95wy/1nNJQz1DfZbR9DWUYDRytA1ubGVAEcaZNJg2QQt4NG9HnNJDjdVw4qGs+FOhjiXwsN9PJOLbx2nVBpqVPA6cRs40nTeYTPd6RxtJNUaQEmJzIA3Blj0a2NaARjc9I7hqxheH8G6vpt42PUpeAmjyFOG8igy/I4MxcIOAk3LiWVq42TWIZADIz9eeh5zQqkRSqbCOxhkjppqiB4pwE3PHk6KccjDAlIvEBkKZvd6BIlTqgFU77zCgRRteQQTk4dQwC6HoTOpgHnqfhMHQuVVAaDnoCUOCGRonUuGSKqCDWnUM3ppIP8ZSopnUzaZtM8dEkOnQwofUGE84DdIfJfwsAMqO2lkRdRFEjoFRK7m0R6IDEbAIxF3tqIOJgIGdcFBWd8QjxAkoKW2ONPCQghR40SaYEwmsDpnRzY58c6OYSRyh78I65JkTXRMtUXcuvLpMjxiCzm+KzvKiEufGldJk49+ChWojFUgJtzkGrpLjP3PbGjNGPJoCefBRdJ7NF5hdfGciyJnbz/SL04XHvz+BEoSAUAIEHkCeo/weAcRCAFcCuAgAA=="}
import { Hooks } from 'wagmi/tempo'

const { data: metadata } = Hooks.token.useGetMetadata({
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Currency:', metadata?.currency)
// @log: Currency: USD
console.log('Name:', metadata?.name)
// @log: Name: United States Dollar
console.log('Symbol:', metadata?.symbol)
// @log: Symbol: USD
console.log('Decimals:', metadata?.decimals)
// @log: Decimals: 18
console.log('Total Supply:', metadata?.totalSupply)
// @log: Total Supply: 1000000000000000000000n
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Return Type

See [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook return types.

### data

See [Wagmi Action `token.getMetadata` Return Type](/tempo/actions/token.getMetadata#return-type)

## Parameters

See [Wagmi Action `token.getMetadata` Parameters](/tempo/actions/token.getMetadata#parameters)

### query

See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook parameters.

## Action

* [`token.getMetadata`](/tempo/actions/token.getMetadata)

---

---
url: /tempo/hooks/token.useGrantRoles.md
---
# `token.useGrantRoles`

Grants roles to an address for a TIP-20 token. Requires appropriate permissions. [Learn more about token roles](https://docs.tempo.xyz/protocol/tip403/spec)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useGrantRoles.md","from":236,"to":6643}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"f4391afb0618a6365e397f75dd69c90dea54e09d9cd37c91d8c93575a93d1dde","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6INYQYCKcCqSiYGgAShBycADKGGDWiDx8ggB0aALy2QCucDAA4lEx8YkpadmxOoWkYAAqXgA8AMKhAGaMChSchWD8kADuYAB8/iLiugAsAMyy8koqiACMcxri2kGR0XEJ8DXW/iZmSABMNnZRjn6IAGzunjh4hCTkGoFMrOxcBkE000ukeVmMK2Uam2Wh0eEBRnO5muwVuDicVwWL2oXnevi+AXovzYHE4eX48mBsyQj0ey0UUMQ6moOzhenJlNkpmRN3s92clzcHhxbz0Hz83yJem6Q0cjFCgxK5QOVWOqWsnR6fQGQxGEHGEwAFFh7MwdGQ4AB+DII3L5MBFJUVQ7VdXZAAKpvNpDgmrAvX6g2GY0mAEobVk4HaKQ7imVnarkm76mhGi12l1/dqg3qDQAdMBgURmuAm6wwRXxlVHJNpfxQCDWBB6QGcbrsCLO0wKTikGttjuiTjNACS7suFjJ9uyBYLADkIDQMs18Iw4Jw15wh3B1fg+5BipxCAIyXYuKNRIw0Ov26RTxW0BU4Oj5WAC3lOAAjCumawyQqwFAnAKkOn4yI2/BfjAt4VqQDRNN2W69vAbBhDA2T+GICjNsgyAgHQxZYHI/gAAZkdetAFiwJJcMAmSGJwrhtn2zCcAA5BeCjMIwAD0NB/Gxs7+rKaCvpwACCWBYIaoacMABacJwIRhLRnDMIUYg0AMa7uvIUCIUxAC89E5BysZOtWrppDJQmKXBqZNJwhoKYpnBtJ+Gl5G+YCua5oQdCY1j8IZwAyZwhkTGpGmiDQhp0WZGRsRYtDZKlbEDHkiXJal2Tpb2NYZMgbFrnAhRkGxAC6jGhq4Lm+fpz5gTAUAhTpendrVPmuRMdWucqMScImvVtDxHloF5PVdaGBadWRJEgBVFB4SaUTMP4K3Ft664ALScJ6q1bRhi14fZaZGAAstFokKnBpUyGgR2LSAMwSIgADsKJyAyazrG9MK7Hgcb9S6ap1lyFyICith8hiiALKo2KYKKPifJhPx6Mp4T7JUNYnBGhjRgUQMJrjybwemOB+gGOrBvqkxUq9v1bBC31IJs/1siA2Mg7Wpzg+YzLQ3csMWIjuJiviaNSiAxp9jgHAYLJ6maTAGSGkQ4iMKITVwBk3OJicHpek4vqZgGEwDBAWDXWE1qcJdKsAPLW6+vr66TtQpmmABqoj/jAAwAEKiCUACipB9qQrQ4AM7tWdYRsHSbVN9BbOYhpFAA+QawL0ZhQLJEWcEQECMFA9aNs2IArhWysxWJMppDbnAYBAhRKdEHcyDInCjFe+DF5r2uJFOZKkH02h3sotdXWJ0RAVbNt+zIGBHpGwE+aIUD6UvPfWMvn4OJBi+uxh2zYUguEgBta1UBr4/D/AnC7TXg8PzrwGfgAVjAjijyacB1wfmnpwEidcbYADEwAkSOkta+pp/An1CFGUISRCjWHLIA5+w5Vw3hEmJPu3c2yMDgr3fA8h7xRU0mJTcpUMHwDgDKHu89e6MCId+TgACShARAeA18bF1y3UKPdWBy0EFUCQWEbIoRw6R2wSuTcjc5QKkIT3XopDGDdEoXwhU8gQhDBNluHyZA5EsNUVBThIduGUJMewUR8DVqIJdsg6RYAkg6DQHIICL9cFtnwSothaiSEVlGOQnyvDZ4Kk3DAfuZBOB0MwYw4RK82w6FsM1YCd49FtxiBaIxnBbF3hYRwrhGSYnTynuQzgUAYpDg7IU+xcFmDiCBFQXaI4tGt3bs0ikUV7qMCIrBGAABHMqIg4ADBIqg9BiSSKsKIeoisoQUmiG6E4ShMgYrwC4PvIhXS2IkDUlvdCBZdriSISA3ZMhD5BT8U3V2TkpluJmQwkikyZER3YG80BqCPFeJIrJcQFYS5lzucosIAwWEgNOk0DJGt/bzJ7hwvokA4JQEesIEEbMAAc0gWarBpBzII4DcD82hKiGGDx1gI2FEjbw4oCQ0GlrLK2ZBMCyUypwPMIBkpvTmJcKA8MOjWFpAsOYHQLCqAWIKS4qhRALE/NiuYcxA7WEkDAN6qhJCqG6BYT8odPyfm5QzXQE5wRfQJZDIleA8hnG5ISilwsHiXDFsjBlUsggsvluy/KiQMjcpKmVUg3LkAVRNVcVQn1IRrGZJoAGeg+yJDtRDP6jr0TOtdfSyWkpPVYDlmyxWU4Yz+p5bQCc1gLCVqrdWmtta631osMazF1JIZvSWPixksbWRBDMsm8w2LeROoFJmvEqMc14CLCWMsFZMZHALPfJSyCjgZEzHAI4Fcmx4FfiRWdcg5nMGgMIisebiBlyftuaichqkwA8goBQiFd0PjPBudccAWBsPEKPaeBYABSogNZJGsOPa2i6whHDUr/OwYA1ysRPUQM9QFPyr1GDer8fZRglB9DObyr8D1QCPQU2gNEgGjAgPEnA1hNGMGsIuv4ZgYi6yEgAKgkqA1dRw5l/isaw5QEHlDQFfeggeIdQGPuyOBBQMlvk7qXXIbIhSpNGKAjJsDcmLxNEU8oGKHcfIcLjDwsjoxx40FHtEVeC5YDZC/q+x8MBizYZY+JCI4FD49xU2uvdG4VLRHLKBgMjQMkfiM1eB8ZHkAkRPYk7IIgGwaRIhVQ0+BxpYF1jxHikBYDWekVoHiDYmw8U2TQEQ20iCXDmNkWgPFRBYF4pFhh2QkvMBkAAYjq4AmLbc0CArAFAAs4W2tRhiyY+LiXkupfS9AGAWX2AKFy5XArWziulfK5V6rtW+xRcay1gbQ2I6hmyDgisCgXN+1E7JmAnHO56esX3fjGkNx/A4IhEBJEMuq0ffuw9cmhIAH0mNMYAOriGg4of7P3lxVOOxAVzoGPNLO/r/NAAi+OECgOuIFnAzCxLvJjNcNAYgrwLDuNIe5Qht3XCYXpIDPzocwxJd0I4gHkNXrdGAzAmoDFRVuUh09V645EPITxGACwh13PucnnBKcVmXsBCpnALPoWs/E2zxYoycHcU+is4XIAmYVANzgI4eKOxG0ltAKXEBpbe9NnLeW4ALaK2gErZWKtVZqzxAbDW0BNea6IbaOuYDbVCNtAb215SyVvAWA9Gj/TsGaTbbDBZQ60EIle4oz3Icnbcx9xAQk5rWYLGJiTho2LkO7oZ9gMgoBsVDAAbgLGlva48GMZFL+BXuFeoAZTIx1jSBfzviYgJJkvMAy+cAAKRwDyhxDv1e69gAb+6Jv14W8j7b6R0gleu/K9i2gPvqn0IKbMKMTgsj2DF4B8eFLAw11mmUIhQ+QE7BSXkM1avtf688Ub6Ya8BTPl3hLM+NoEpsrkfGPA4KFtviYjnvPp/opKfqQBkBfnwFfvEhALfquIoF+FvEeNVjgPnB/r5FuFwMgDAPChVEyBsKoAQb5NpoBsBg9KQEMCOC0LgpmEylwIaG9ogEQMwBsNKhsNitNDAYQdpo7Ajo4NkIwWAMwQonAGwYEE5FwTwXDBYJIHDIIdQa5Nplwd/mQEWDIO7htgwjxHQL/BpK+O9G9BsJIJoYpNpiQWQdtEZrgWQE8JDJcLYUQQUvCnQQMhwTobkk0H7IYY2MYaYdYOYaEO9I8E8BYEIQ3jQVwAEU4PoTxM0qYCYfCj9iIE3goJDAsHDEJJjEkZtOFOxADoEoNNDqYGumAGxHPmJupmAIaCRAACLRCTycAAAkwAk6MArgAAhJwO0YoGQAMQCnPgvkvrrMMR0XEhUUQvEJ+DUaEEMSMZPAMVvrtsGtAmREJEninhWGnpgS9uxp5lxoAtAQWHnnAHvuEJ1mUbsEkCrswEkGgTAIQKMDJA0cglwCYo8ToM8XBMWG8WaJ8d8XcVwMwBgGcRWMZEfrDkcNkLCYaJ1gMCYu/t5NCbCQPkPq3uXhvlXpiVMd/jMfie3oSVvp1pHjCf3kXsPqPhPlPuvpXrPgQYvqSSvqPiyZ3qPNSWANif3ofjAMfvAefpfhMqgegfftgU/nga/qGMSZ/hyc3pwMgPAYgRKdfu8XfpgQ/jgc/vnItKPCYkUb8ZjqUcZGxAsT3EsSsXUXPoKfvtkE0S0esXEj0X0YMbMaMaQOMUqV/qqe6XeDaVUcsWBmAGsXMX6VvqabsfNOfDhHhCUKSiAMgGuo0OWAlqbubmlvesoIUJ+NkCEMwBNplnbm9qNC5jxMti7iYJ+DxGJtZqGAtE9C9LoAsAsOatGkgKmnGpzI+n2mzOsIOums4KLLSuLCjBKISJ6ugdALJDiUXgAaINoHbGZgMDlJIn7PtKrhkGZqGuGMXKXEBIaAANTrDASfDgRbwtlUC254Aqk/4fgkQ95oBzK3YDxH5IgHaXT9KDLc4KCFBmgMY6YWKlK8mfn3gFjqLhD6ZbhM7HrjzNKkCrwrlAEsIy5bw7yvinbwUialSfgiBXiRHeTwpjLxLvqbJTxhYRZL7dCGgLChgm7JYW5pHRBvTZazbnCFCVbNJgDB6rnwDsVgALCGHf7dDZALCe5NZCGGggI7DAWC7o6kIy4QWjzhbmEyDZC3hx5SbZljZsVW4oI27zaFbbJO4rau68RaUyUtZaW6UxSOWO47BwCKkJ7xn55pDmn6IDTGSqA/HOn0m+VoAZBj5V4DAhUBlPkzEhUZDqCjxvl3FInBU5KhV5RRWTHKnTEZBxWcAJUfhJXxlCQa5qkkS2XOX6WjZm7jbGVcVzb5bmVLbO6rZu62VbbNYOWx5OXdUuVaBuUDj/7sA/gx6kBx6vhnwsgXwoDJm/iplEAWDZDrBLWVqtnNqvSdkDodprDtr9lBASZDkbAjlpr8hIDYojoSxjqzl4DFGdiWSgzpAmRRhmSOhVg4zxx1DkzRwwApyBi6gZzhpwyPDtoWqMjswsiwh7AkzxyHXrDHVCxjlICdkXXTmMrowywnreqFo1JiB6zQ0PWfUORgC+wIrZxDC5zcjlz3mVxbpVKbLhAJIMJMIpK3QJAkBAQ41Di3jaKRIOhCQFivz01cCM2ALM0s7wBs0ZKc2DU83UKhAeUC100hzC0vKi3JLi0ebs3VK1Iy0RJy183eSK0VhC3xKq1JLdwa2S0c063c1631zy2A0LBvRbWg1rDMx7V4Cc2w3w1oinWIBzDnWTlurZrXV6BeoFqyRwTlh+HLhPgvihD1DR3WyO1Kr0iWp9ndp4BR0xLJ1kpHWjl+2qBzAo3urjph2Y0R1gFhDx1gDcAhz4AZAkTJQ9E5EdRzJk09bQSU0bpVx11wADwQBaJ35AJx3gqO2SBRqsyUHWrsij02x90qB51w0F2wyPAupB3eBYT+B9F4AHXrXzCqFp2MjgjsFbpz1iR2D90ZDJTrCXBiqqCPDO2SAWDazWC5y3332P24ov2fhv3QQf1zAP1P0/1/3dAANAPf2v25yw3toI1+2ixPQhCwDEj/ByRPWMTMRoHsScTcR8Rs5sCCTeS3VxwPVlG2gvXEz3W8w2TeQN4dAy5gJXQXZebISljIIQFxhFLgpOToQKAHZjReRKSBT8ADC6Wm2fjcSAKvhCEkO8zZAkpxQuScpJS0B8oCpCoirA3iqSrSoT1yoKpKoqpqoapao6p6oGqfjpQuSJrwCFTFSAJBqVQUBKP2hZRloWAVoNpePeO1pWNgCuBCHJVyb0nNDn0KiX0N15SyOGyc2WiSG/w50PSPjRDPjgoL1CH+C36iBICgCBDyBvqhA2oICuCuBAA"}
import { Hooks } from 'wagmi/tempo'

const grantRolesSync = Hooks.token.useGrantRolesSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
grantRolesSync.mutate({
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  roles: ['issuer'],
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Transaction hash:', grantRolesSync.data?.receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.grantRoles` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useGrantRoles.md","from":6987,"to":7567}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const grantRoles = Hooks.token.useGrantRoles()
const { data: receipt } = useWaitForTransactionReceipt({ hash: grantRoles.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
grantRoles.mutate({
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  roles: ['issuer'],
  token: '0x20c0000000000000000000000000000000000000',
})

if (receipt) {
  const events 
    = Actions.token.grantRoles.extractEvents(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `token.grantRoles` Return Type](/tempo/actions/token.grantRoles#return-type)

### mutate/mutateAsync

See [Wagmi Action `token.grantRoles` Parameters](/tempo/actions/token.grantRoles#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`token.grantRoles`](/tempo/actions/token.grantRoles)

---

---
url: /tempo/hooks/token.useHasRole.md
---
# `token.useHasRole`

Checks if an address has a specific role for a TIP-20 token. [Learn more about token roles](https://docs.tempo.xyz/protocol/tip403/spec)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useHasRole.md","from":213,"to":5731}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"306dac353c73a78bf54e64cd30cbda4af1447f271833545285c0d219109fa181","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUWKQQOBwYAJScUKJiiJwARnxyomCcAD6cAK5gsABmpjBQ/lAQ1gh6ACr4MJwyoiKccLnW1vBwhbkyMhicpPAQMiRQcQminIXsnMoNAI65ZBgAdAA6YJubdQ1NLW0dXT19A0NwI2MTYtOz85xLKxtbL7uNzVyHnXDdvf2Dw1GpWuUxmpDm9Qey1Ia22r0h+0+7W+v1OAIuQPG8RuYIhi2hsJeOwRH1ayOOfzOgKu2NBd0hjxhq38InEugALOpjPIlCpEOyNOJtEFaf4TGYkAAmGx2UgOJxIAAc7k8ODwhBI5A0gTw1ggYBadjgACURjAkqkzRlsnkCjBimYylQKlU8G9EWSjj8Tv9zpdgbTbuD7oy1izNLpVABGWQ85RIADsgq0OnVzVNcjFJSlMvsjj8iCj7JV1C86t8WoC9CYrHYXAMgnDbKQADYAMyxxTxxBczTCvANozi8zSkC2PMKxCSlslzBqvQavza6t6FhsDhzATyJsSRAt6Tcrt83tC1N6NBbsBZiVT3Ny/PONuS2dlhcV/w0FcgHpgRyMfV5HAMDcOmZoADwAML6sUCgUCkaQwBkAB8oT2MwOhkHASSDqsF78PIqy5EBIEmmaqwAApoRhpBwJB0GMLB8FWmASHRNhfCCLhl6EcRoFyKsxo6LkpBgAAaqIMjLGBlrpCxmxgKI6FwFgDgNERwF8bgzqVNU+gcUGnC2DA1j8KYCicIwhScNaDh6vkXBGtZrQ4NYlmMNYgxmgZUw1AAkuRkoWJu+FgMygoKNUyDICAdCKVgmZUAABslaBwLQmxrnWnDADwHFwJwrjTOEzCcAA5AA7qICjMIwAD0NC1qVcI/n+AEAIJYFgwSxMAmycIZ+otDltJwYwcAADIQKIUBmQVnAALy5YYXEhTxGmkXIwS9Zk/XWR0ED2UkpUWLQqxnaVFB9bt4RyEdY1tGQF1Xf1eHyEdJ1nasT07a40Rwv1lmcMEY2TdNZmxEMaDCZkYEzUQSGgzNiifWBtVw0hV2Q9DnCw4w8MkZwGbmtlgYAPxlQAmvApWcEdAByECla4qPo5sribMliUgAAuhQ0UqXKzD+ALinUflAC0nCUYLYvMrz0VYyJRgAIoEuivRcOVjDKExskWQU7kJLNgO2QdYAOc0nn8TzvMgKyu4JlychHkgUZWNQp5BOpJFE9eI53vKBZtsqHilvOPiah+Op6KE4SRJgsSm/ZpNJIlJ0ACTACIpBma4iU2ttu2GSY8hoEkEEl+bYE1HKBrrmgcEQXYpg2vkRQlFAcGF0Xu3TVA5xYZwbVQP3XQANzPT3kC/jAACyGRVWQKecAzM/zwp2jgjkbf2h3E87T3rQMWAy/BKhMtOIP3eH0XRr4NhzT4PvN8FbE81IVLxVjTAYHcHQrGtztA6YE28gF70nkXOAx82q5GUOwRgAAvI2+pT7n1FpfJIMC4E5yQWgf8YBBKPBEG/D+5Ev5ATAgAZWgbAwgODkEEKEiJGoXgAGgPbo6QBHDSjPxvlAhQYBZ5dEXkkLanAlJwEXgVJI18X7iOEdoJI1CBGiGSHIIRPxF68MPr9BapDyE/z/rQJC2ie6fU4OycR7AGifVMUXOcxN1jGEqBJJxpjCo5AAFIXAIVgawbV9r2S4bvR0JjJ7mMlJKKxQxOC2MnhcYSnRl472AVAfeHjYlnU4FGKM0SbFZPYSE0o5QdJ4ACXZc21k0BiCMuMC8eJDISRkEDZgcAFCrCAnaUg0Qwp2wjFId2zteSJmTP2PQSdzZ+yQB2McspA7OGfKHBx5ZI7LiCLHCIZAE5WxgMvJxyRoYACEZCVHwlAJxNonEqXUhcnITj8jXKArczgTj7rQmeU4ooogNbDxqlsEAwTUklNdHoImm5DL1BMr0+2ugixJkPMM/koyzwgBulpYw2YkWzInAWRZqpvCLkrJ+dZYRNlRFiK9E+SQaiXl8lAAA8qQYeo8fiAo7sC3SzKB6cFmL5AAIjyqy9w/IBSCpS6F/TCwtidnGY8yKgiUqmT2AOD4pQvnDoSqOX4FJKRUp0AaBozSbCIOIA1GJiZQUNQlEALpdJvESnqK1MB87MGgL0BopKiCMFgPlKYUDWByDiDAA5CgFCzUdeaiECQLL5X9YwJowYIB4k2J40QJrKHWBzlgLgEavLoXHGAMaJVPXeuBMkAY5Vg0pHCOVICNFnjEgaK6qA7rOB0HrvlNA5Uk3KWMm5DyepaxmHNlhOEAAqIenBEqWvNfnaw+x8pax1uhOBUBY3tHwNZfKDrBpkROQobqiU4I7qdasMg4RSCHusgUKdub+KVREle5Q0brDWmSGpICdSk3lRzjQcFGQBgM1gKsAAVrGtAQxFLPAnW1TgCgTnJAkre3dch86mFZDPA1MFhLAnqT+7WDR6nIESqSlEHS0AVFgYlbmwR8DVKwFhWqtVICwDA6sdgCg0Y6Vqk0GgIhxZEElOyVYtBaqiCwHVUjXRVh0eYDIAAxFJn4IhKNoETgUTYxGlNwHI7AUgpBqO0fo4x5j0AYBsY41xqoPGEjwDQAJoTImxMSdqtpmTaA5OKfCCiFT56emcDePBiAiHmkntnY0zI77ALAiXYQWBFlawcFmvcRKLHzR3udVYlt/E4QAH0x1joAOriELYoAruXqWQiCyFs1XlgsgeMmgUq+UV2EDXdZGJZhtb1HBBGsaNBzb9E2HADAv58DhEgERRojB8INOSDWutQ9yK+U7fUKkQFmBqJgHBSA4JxCEbW2a/rpchsKRG2NibB18omFm00nl8xwRAZgKB8DkHWmrE4JQmAB2GjEcgH+gC2nOC+VqvSwzdG0AMcQExtLFmtBWbgDZvj9nBPCdE+JyT3npOyYU6IcW/2YDi31OLbT4t/yxDBJsV1MTTBgmYAwhtYAACitA4qBqIslqrCGkNhbNIlRAcJOZgc2Bl1Y+7gilXqH0b97AZBQFKtEfeTHP6mFSkkKXJzODdtIHLuC9SVMHTQCLlDz3xeS5gNLzgABSOAF0yra7lwrpXtUVcjvVxbzXDvO7goN7A43p7z3sGCGYcqnAmf6aD6VQrhAIhwDghcVrs1EPjDsJ1eQpQFeK82Mrshqv8qB/BBIqRGRxishMnMe8hGe0UfPQLsAyv+rh4vUkaPfAGPx4gInxQKRpqcFTzgR02eXdF2jcgGAJqZDcx7IWVQQ+e7RozVmtAqxSD5F8mAOoY1LXEqBmlxARBmCFifIWRUf16/D97lwelyQGuOBX2vjf+At/6h38Hsz+/D9tgsJIRAwcz8N8v04D31VzIAUhkFcyxx+FqjoGMlgXwUQATATELEkDnxHy4DHwn25nFh/XE0iD3CnElFQMAPHwkkX0YGzV33fxAJEgkggMqC6GgNoFgLwX1AQJbD3AsH/wv36mjWAPNlANoPp1MGgIn1y2zjMinDbF/zhAjS4B1QaEWij3jWaVNGSHQ31FKn3lFwfTAGCESj5QyE3k4EznkNcAAEJOADDFAyAzDEos9z9Xc1dLDDCyBOBCtlDCZgt1CwALCrDN4zC9dq89NSAOZko4QWc2cP1OcGhp0Tc50F069QjEphdfxBouBDcFo4MdBKEINEJmBKFO8YBCBypuotC0i219NMjhQci3sCj0JijSj/cWhmAMAZ0vJFoQ9at+I2jNpDc4I/N94qdWiTcxcIAD1zdLcvcnc59c83c+8PcZcddvd6lDchiejTcxiJcNck0bc7cKpZd5d7Cc8c45jtitcDjAieU/cwAWj1iz0I9L1Oim9I9W9Y8O8u9zJk8+9cD09DijiXdZinDkBnjSAW8Y929WhCjlAk9e9+9fjeZwVz0ZDyj5DMilC+hPC1DDUwBNC1iRidC9C/DXCTDRZzDnDrDSBbD/jHDB4iTwR3CMTVDvDfCXDKTLikSwBOYPwqpIpoogJ0VkAElSBOgaMIcocmMw1lBchkhVhB1TNWNEc0tao1FgtapUcnMTBkhapRcwNogbZhBJVIlRwhlux4U+wUUMslVFQVVJwLB1UCV3w1k8BghWtoBYg7jxci9tBl4AM4JPoIgWCwDpZFJB4ANkBuY2JOAiAIBvUgYABqXJCsE5aaPU7SEFEAQEztJNRKX3NAfOWLIAmAcqYcD7WeDWcgwNIUXIdCEdCLFID1ZoT9OCAs+YTYYoGiLgdScYS2e4MIFgcQAYL0hoEvayDEvubWfBJDLsrdMkZIEQbWOA/UY1CSZYWNFgeNU1IjEjE4tAQoYINsaIcHejaHWqenMABMdjeHcUXIUTM8knReRHM8tsCA1XQoVYNsdzOTM/YIe4Ksms1KDrYcjElSH4XDJNYjOAmQVYOnBIQ9UU4zE82HHTSzW1JHOzBzNHZzOqSCz8hTSCmC3c9genezIUOAaIHpQXZKFI2QgaIJRaVQMo09M3CpMua3eXOCFi6kzMpIFipIdQH3CjVY1IpizY0qXiu3Ti53Gknis2Vi/i/XQS64zmOEL7X7RKHCgiuCozSHEzJCy8zjVC3jdC9U9HFzHCnHeTfCoihIAi8WUiinWYanBoWnaywM3pMQCKJAKKO2UwTofwIgCwVYKMIKiwCwfUvpZsSQwZWVaZeVPAfdK0m0gsEOfFFZJcKsIIGio0ImC0BCa0QpIFNMu1EkA4ckb0SkdEf0LESYAyEMAkCVSKyUVQAUBFU0uKhcTSRK7Fe8ScJ8e0vADy/weQ+KsYncXQacGZE0vkd2YlAcS2N5VwtFJICDZYJVN2JK5wO022PUWAGseubKJaQQOaQoYqe3KqGqeqGARqZEg0LgYaSYdXTSOaRaHCcVb2TSLaK6CZVi46WgBMdkSUKANsVQCCawFsdsdkCCCwVQJ8SQJq0QNsZIRUdkdkQ5awSQGAR2SQVQQoCwZIJnZIZIb6fqJasqBa0gYm4KN6MqE6QKawUKhmxmpm5mlm1mnJb6X6G681UY8YgmcmnZRAO3bKs0M/fwFdUQJAUAQIeQKBfUAahAVwVwIAA"}
import { Hooks } from 'wagmi/tempo'

const { data: hasRole } = Hooks.token.useHasRole({
  account: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  role: 'issuer',
  token: '0x20c0000000000000000000000000000000000011',
})

console.log('Has issuer role:', hasRole)
// @log: Has issuer role: true
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Return Type

See [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook return types.

### data

See [Wagmi Action `token.hasRole` Return Type](/tempo/actions/token.hasRole#return-type)

## Parameters

See [Wagmi Action `token.hasRole` Parameters](/tempo/actions/token.hasRole#parameters)

### query

See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook parameters.

## Action

* [`token.hasRole`](/tempo/actions/token.hasRole)

---

---
url: /tempo/hooks/token.useMint.md
---
# `token.useMint`

Mints new TIP-20 tokens to a recipient. Requires the `ISSUER` role. [Learn more about roles](https://docs.tempo.xyz/protocol/tip20/spec#role-based-access-control)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useMint.md","from":236,"to":9397}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"81309f31f44049ff315a55266231b03aaae8e5d9663c808078d1f3aa60a60d20","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUoiaicACUnABmAK5gjowQYJxY4nAwAKpgjGhwwURhcTCInCKkpgoUnLDWLGFwZWBxzABGZJFlbYwKpmgAOrms7FzppJk5eUZQENYIegCycTJojFgm8Jyi5WiVipykMFhHmWBiaymcEDHbnC3tZJxtGHd9JKl0bGbn17dtERgnAAjBZOMFQV8UvI0JEAHRDIYAWk4ABE5k1OPg0GgsE0APT4oiMGDMOFwfD42bzfFxNYmNbwfHjSa5fL+MQKBbIZAgOiiVhyfwsNgcTjANIZbJsuCcVyxUgQZicADkxNJKsRYBZ0umwRVABYAEwWFU1SSRIaEzjGix2+0OsAgAC6zuEml0BvUxnkShUiFBGnE2iCOqm7NkpnMwJsdlIDicUncnhweEIJHIGkCeGsKREnGY/QAyhhEmUDII4WgBPI4XFMoti6XrHCAEo6OKkMAAFS8AB4AMIpGK9GoJfiQADuYAAfP4ROJdAB2JeyX3KJAADiDWh0eEL5xLiX8JjMSAAzLH7I4/IgAGzJ6heNO+TMBehMEZiitGBcSRCbtuPqKBuiDepoIZ4D+J5RheV7xjezjAkuj6YKmejpn4WYfnoIqjJw1b8PI84elIBpriB/rgcGe56IRxGRmeiCXiAtjXomiBGueqHPhhr4ctmejxIklypPWMCNoezaDsOo6cOOU6zsE4wCjoZBwAA/OWfCVvRYB1g2TaJHCAAK9jMGpEwyWAI7VPJYAThA04zl0PA6XAVY1vp4mSWgR4tu2aCdj2/ZDjZckKU5s5DGAqlwOk1hAj5RnWP41ILPoOmxOwBb9FUnDdgAkiZJoEV5srVtsqSiFAUCnB5WoAHIQDQZTdvgjCyp1dxwM2+CKpA9ZYllyiiFwk6iNM2WkAR+BAnsohgHACbJGAQyVR0nCmNYMhxLAUDXNVzwyHM/DPDAMTsECRxBV2+U7Kc3yZHCHKiFySA8nytAChsuBUAABoD+S0EMeFihKP5ygqSqqhNCiFviNAjJqa02QkSRXAAglgWDBNEwBDJwnC5ktXASswdJjTANSdSZ8hQPl8oALxuYYnlEd5hlSYkeNakTN3BeChNE5wfZtHS1aoyLIspAOJjWPwTPAHjnBMzOBaUzQwQStWZQqhYtBwkbZrbMwEAJGgZSghYYA1HpesG0bcIqnKkSuML0sM8tbRyFASu0/TVTu6kIszh7Iu+eHfb4uLOIpGHIeWmAweA/9LoULyKnMP4WeWbKKJmfGFlOB56e8gLXZGMsFyrYc8ArGgL2uu6i5INbFF+m3MbUDRQTJdzqWMeYLFsQhHFGm4HhPuhPgZgJOGsXmXAHn5zbaWzekGRJKVth2Xa9jg1m2WODmKXOLf/sCkh3h3oFARBtEgCv/kwUxN+sXGCa3hYPEz5hb40AXspRUOAOAYGiBTC4pRwRFEqKIH28AyjP2bKZcyecj69BnDUCAWBRKaTKNXKmAB5XBq04B9gJiHImutOD/QNgAEmABUIO/0ADc4cBTm3ON0Xo/R2FULroldYlsCrxiWitFI7YhG4P4e4TgAAhQEABRUgipSAH2prlAeqCi7oLCrZLB9lHLOU4AAH3srAEcZgoDRDVpwIgEBGBQDShiPA7UgSQLGrXYSGNUgYHNsTRagSZAyE4JOPI+B7HiEYPAuQFUIAEUqAobQM1lAeM1rXRaB0cGiTCDIV4hBDCHW2LVPIq0wjBJkACBW1xSF5hekGd6KBM7mX8LAmJCD84FTmlEuBnTrhtAAFYwEcGVSUcB4mzSBP9TxokABiYB/pNwziALO/gclkLhCkIscRrCJQmZwFE7Vuo+NEmExgITYiMCOGEuaqQ0kaxrlcbqcBdn7LgPEUJWTzmXM2ukCZMADoPNmatFUspTgN2WS0ou6y6lLS2WAFRajDndJOejM54TLkjhuYwW4wKMlXHkLmC26kqqcDIMi75mLQl/IiJkIFPSKXsChas1pVANn1O2ToNAvsUXHNlKc2u1Krk3MnHcqZjyvHPNlDACJTxXl7PgB8lY+TYg6FsIC64M0iVcJLmSplM1vm0oBQdWVaTUk9KgGNHYOUDUsqOMwcQgh/AokKrcfxcQCyiCIhrVY6w5B1wAI4lBEHAGo/1tlvKVf9H5oTsVAhSKq0QMQnASpkFTfM1g8mcA9WqDxNUYAIjACiTGlyHlZpCdUs6gq8zggjWAHZiqJn/XDSkJF7AW20K5TiX2/1ojiCBA4pxsR0VkJqN8h5FdrFRN2kCYVm1eiQCOFAJuboQB/l0Cab0chKJIHfg/IIsy/rGFgveeCX9nCTxTN4f+88gjAJwWQTA/azYWx4X0c4JFW6cWBO/Hdncz0913EEThFtX7mFXB/dit4jS/xvfxbC96wgxKiJKCYup8iFGKNA5higah1AaDITEDwOikFcj0D9gxhiijGFKcMMxXFLAbv6kksodi4YUHXE48AYRStSDcO4JGngvDeIwD45LaDfBhH8Z4gIQRgghBYKEPxYRFuRGiDEZRsS4gJESEkZIKRUgxLSekZSmRhhlK9Jpn1+SCmPWDMmaHWRTXlDERUyo1T6ZRkMCzepDQmhNhaK0+IbQmgdOFp0zd12kU4kaciwEAOBiA5BPQvmIwnqYpB0eF624/ynmheDc9EN4AfaA59ZUygDBAAbJcxooDnlUAOawd47zngNAOCwqhzwTyNKoUQ542ibgNAaeR1hJAwCXKoSQqgYgWDaEotobQqtfv/HF6QCXQJGh3Cl6gEBwNbnPYhJAsH8u8Vnlhd896TiPrAdEe2nAqsGxNNYcLr23vvY+3aZbF9dDngsN3f9oFqLAbwHpfbLhDvjzgy+Irl28CxQsvFBwQISZwAgHIIYsDiZ5nR9AsKaOhRUHSm4np/1Ue45jWbKAKwgTXeJLANj5QRQBtgOLZJ+VycBtGlwF5LALniDGWkoYAApUQRQizWEqLg7HS1ccFhGXYXIcBlR06cZqkTk4YBtGeIqScmQJhqZ7D0qnNOJM0YqpOBJ8URm4sYNYbHIwVNNC1AAKk4JjWh+OKfE3TQc8Jyh5fKGgLKBVkSIi0M54Wk6Cg8adrJzjuQcIDWx6qgdePsvE8TS7Cn7ngTUibXEkChJk5Kg0DGYtV4zVYBwkGSHvYMABRFrdx7hQJ0AShPTwTmAMbTALkSCj2SChOyasqiXvI80EnIH+td955I0CzDpP9Z0wRtN4kQISSAsBa9bK0EZmk6aaAiCREQOLcJaD4lEFgRgzJFSz+xMwGQABiGfSqRAL9hKnoYU+X8TLn7AVRS+K+OIa+G+0AMA2+7ACge+cA+IB+8AaAx+p+5+l+1+P+Hk9+T+aBb+FK8I3SQIreEA7eEeCe3eee508k9K5yQedIW0X4awBwDy/0m+pQkelO0ANOhuAA+i7i7gAOriC5CKA8GcFtQ9IEFEGR4DLDKOBgqB6EBQBsY3JmByozSo6dQ0DnD5JDC9SJD9QpDmyygmA+oPJtC6767u4mSFQVRzSvCnCkgII1BLrbA3JpKvBqEiAwhaGxQ6G2ADQGGcBGFAjZotRzQzRV6Fq167BHACgeScBFgwDzQ9JT6QBl5XBoGcCFT4hEKAGr66bMEQG77pSwEZoIEn4Ghn4X5X435zBKpwgYGP6iBIgpEwBIgpBIhoFIjJDRCXSkBDBmw4o2TsCOqiSG5KLfR2YUH5QPLiEVKd4U6IBaipy15DCR5wjR76hzQhLF7sAyBQAqiRD8LWgmT7D5BaYwBbFhI7FQB2xW7z7mxUarHrEqibEnScAACkcAJsKolupAux+xhxIWxx/QmILx2xvx1xYyb+9xKxJBSeqi7AwQZgk4nA7apA+ovBhSeINQaOxcHUBwAIB0dgOM8ggK+xBxwWnAQJ5wMq8JM0iOy02gqeuwDgZ0C0iUkJ8+FKCxYA1oRMqJZQGJfAWJ5QSoOgeJnGBJWIl+OA1iFJ0sY0nAyAMARQMgzoYEAYqgcpIsCpEuUujcpACQhURunUYUgCXAiJYBiARAzAAY3WAYm4ScvJ2pXARCQyIy+phpxpcAppgQ4IzBVpNpf2kgzEDpWpRMCp/p/QZAsUMg1R7y+IdAIydIq0iAK4AYkgYZ2wXASpKpzoSIJe0pZA94sWmZCpypYQupwifplpUZXYYQcZSqCZtASZokqZd494FgjpIW8pXAkZ5w0Z9ZjqpgCZKpnBHGnE54zEWoqOvZqkqsqovBFyoSrYhBveKQKo/CqxWeYAwQ/0qIi0KSnAjCCOMArgAAhGiAeWQGeX2gCZSScZiPuYoE8IuZciuT0LLmABeU+SkmeTcbsP/r0YsoDFqGMT9AGvWFMaTl7nIDGjtHStyUMEsXADCaTNcDQSzCGEWPXgKEWKKYQJOHjJuUvOSqovOVhThcwHhRZARURahfmMwBgDBUCCzEiTLl3nCMxcEPcTUDgfwn0UxbCU8aCZceCf8RSVSacViOca8T8bsf+dCWAIxcxWsRADHs8TJQkh8V8XJXseSTyYCQ+WcRcbpQpXSAJSpcnmxaieiZiWGiKbiflJKUSTKaSZEPpUcUZYqfyZwIKTgvZTiWKU5TVFKcSdYm6GMhStOSRSefOSqK+cuauZ+RuRZbCdubuT+U8MeapOeZec+aQDeR5YZcCWUJlTNAlZwO+WuV+Xlb+f+VFcBWnI0tyLyJkMesgGjp2IlMvrkevviH0MoHEG0HCLmMwPiPkTAcwTHG3kSEgbAYwG0PiKsbXpEC6GuhuheKoEBIDv6JBgejmCQeDsCFtlBmPN/NDnxLDmaSVridANECpesfSW9DAFpFVBgDUE7ByjGYXDEWUBXsgM6K5EOgdMEAANTAjXAZgnQ1SrVE6MYgCSWTL/RQmL5UGRJImniFqcDLB+q/TOFD4WTUlkHGr0o1D+6RJC7hQTBcCF7bDWG06VCOqkCvBPWMnfLZo1QMy5KhK03h6vJtAiB5DJkpCY7YYh587pqpKT7T4nExDBDniRA5HAF9WOpgBLg75QGnhxDn6q3tHPUwGq3ng379AxBwjnh1FoAP5JzBAPLBitAwiKFBGXL/KUGVRT7JkyBwg9HDGx49XAF5FgEFFQFFFwFH5lEVEoEmYXIW0P6P4e3e1jQJ0IHBhRDwiLGAzLGJAkXEq/AsyqDEUZ5R5qX6g50iJvF7E1Cl1FX3klXY5vqcDqAcnv70W46qXqWl2IAmxV13mI1lAd0N3/ko1UapxajxFAju30he1DFjS+1AE6Z9UTUa3QHFGH6lFzWR0e0x1P7x3T1oBJ1Igp3dE5T9FAimBJ2rQNI9zWatXbTHpEAWBwjAiP12hrU/YXgta3z+gsT7V6DR5HUnXZZHYAQXXnYAKCSLxoXIJlisy6ReRby+T+S7y3QhSHz6IRSnxRTnzRbfrniASf0HbJaPxQODwZbRgAOfxAN/YgO3rFZ6ClZPrgK1DWplCULSw0J0K0CMIcauBsIcKvrcLPC8LnD8LSxHDSIiLdhiLLS+JSKyoyJDDyjmIJCWJRjOJw3zAk5Ai+5cAKrvKfKqqnDo4kAHRWpiDTQSogopCG5DDuIBERA6NRoTL6O2HwBGOaqmM7A9EWMEr6Rag2M9LaPlCOPKohIuME7GNMNmNeP4pPK+Ooz+NaP2NBNNohMGOuMyARMePmMxN8aX0bXMSSCQY7VIDxY/0gAeP/2Q63jnhXrTyFYXbXV0PXZlaMOgYCMUb9BmIWIXSqMraegWAsTFOAZlNtMMBDxtzkPQbOBejUMIZw56AnlI7smR6i2qEkFlDMUuIaN6C2NzGwUFjsEBqq4M49TM5Ais5xDs4HCSG5686FiS2C5zQi5i6iCVnS6SEWRsRK4q6Kj07q6vCa7a6mFOT64NSoy2Mm4BpQgcAW5W44D1Ajj26jVSbUmIVgDN6e4kFwW+6yjk1yHB7JNh6yh7NF0x6K3hqrHJ6K1MkktwjpXUu55Zr55JSu3F6l4T5vWcDhE1517RFkhDAYszEd6sFbSkyLTLOD7D5F5hLstjLf6361FD1K3z2gFb4eSQHL2h1r3lHIFVFoFb3P4KsTJD39pgBQBf4y01G/7YEAF+0qvjWB3quFHGZauIE6uVGoFGvoGW2YFes2tkZwh4GcBCvEGF1wVBIF6UHk33G0E0ZQXTL+kiuQuFpajcF8ECFVDCGiH4Ft4VKSGEHSFoCyG3UKHOFAjKHmrsXqGeEYDaF9R+FDSBESrAt65PCYyWH01hP2FyCOE5QDpTJuF5jVuaG1veH1v6GNuMA+rBGVvcuREVAN7MCxFj0SrJEtQJqpDpGZHZF2sgEOtqtL0h0lFusR16tesGuNHNGtHFodFdHTR9FXSivn1WOgXjF42QUMFiG5vCtYtovIUt2J7CWaWiV/HV293SUmVXGD13HmVZ2F1t0bHAfaU1DfFXHiUGU12osQeyVQdN2KWUu0mIkwDIk2XxV2XYminKDBWEmFnWJkk90PmkXIqs1BFmvMk1Jskcv+vclOk+V+XCmBVUf4khUuUknmsYc9mKnlmqnqnAiakSfOlxGS7CJwgGlgBGn8o+n0DVmwABm2lGj2ldnSxZmcCumFuqeemacpBmk6elDWnMQWDBm4NGeSd9lOAxkNkTJNktkplplXylnZnSd5kFnEmkDFlGhGgBfkoqlvPmlucDmxloHefWDC1gBtkdkueKfxd1mxlDk8nSdjl7BVATlTmowzn3BzkszxVLmVVJVo5gApVwccXpV7lXkzTZUWS5VlWFUMe11lW+U1dVWfnfltd/lN0NUj2oxgUTEfucaMHMXYsIXp3/SZ3lcxuYU6DYV8vUUwC0X6XlcUrkWbeUU7d7cF0MWCWF3zlsWrFcU8VMf6WpXwdAeQdiVgdeUiWmVjKKXKVCXF0aUXHIewxofve12fe4eVQ/eXccVWXEcomEdkdCkBWUfimyY0dhVuWg9YfIB8fkcOVBXCfo+uVQARWVQNX0WzkWRxUVVDf1eNe/fwctf9cdenkjf5U9cSVeX9c091cpBs91WRWqJIWAxWYtXroJH+AdXmykDdVz17sDX4BDUjVKj7vgGTVgHTWEGzXusmCLXLVRCv3YP/gGjAgA7ri7XbaPyR5HUjwUMcR5bXqg5vT+Anl4B/1v2IAm9m+7qWC0MgC+SaqjNWydYRY29VPOAO91Mw4NPgPBAlv3V/cx4sevUV4fVGxfVhA/VLt/VgAYAA1A2OIg3g2Q1kDQ02JbMZSI1jLI0wdoAxp4sY1RiBs41rB4122E35DE2050qApk0RJTJDDYr5i8301pCM3iAs1KrPVMkc2lLc0UGB8h5DWC1BSiSi2zri33MC5u0y0m3y2K27sq2LTq0ata062LR63aAG2LRG0nAm1m1b3W221aD21E39vZou0j7S2b1J2z29Wqtq9D2LrY9uHV1bX5N69RHeqQGGL71D6adVGP+ya5cBS685fOgB1JYl1dUZQcul3V1RY8pK/dRupVCHroCEOKoDurgItj4DMQhA6Ds3Uaqj0Eiipf6D/13p/9/aC9R1kAP3wgD16VRCAT6zjr0gk6sArQKhi8Yn0n2u9C+qLw+g31+8bSB+k/WtiG98mJvdbEM2/q9w3ealMPqdRyzANTsf8OZo0wgYMUUo68WBhzHgY7xAowUDRBgjsiRRnIfTEpueCKbm8CGZTYhnoMAbjwHwRg+pmAyATNMGG0QDxiw3DjsMGETCIrooB4YiNtS/DERB02EbhwxGcjCRlIwkRgBZGwiWRF02UY9NrEFfTRnY3zC6MlUzjOuOE3cbWpsmxuHxtYyNyJMKhwTaoYYwyZ1ComOUHJiMT8YtDyhDjFJh0PSaZN6h0TRobE2aG2NAmlQpxiqjCZuMTGEw3oVMNyauDPeBoP9J4M96W8ggFTcZraXD6bVZmV1WPqENuwVZaEMQ7hjGiUZmtihgKTYV6BOpDMTqZTasL4Lt63gTeIDTkC71Ug6CFALw1QDsJ95WB5mIAKROsBJACMasdWBrE1haxtYOsXWHrH1gGxDYRsY2CbFNhmxzYFsbQI6t6D8HnU10uYWAJ+BozigYGsoVzO5lhhvQEYSMNgCjAcy0i0s9I6GB5nVDMBvMSArRKvESDzkfw7MWsP3GFHWBeYqMa0AOGzQzJNYpBUwDUKegctxIhqXxOCELQKBA2scSWD7jtz8Aag3tIJm0ELATJVoScYhnCCPTaxhYQfJzBhgKAqhQQcIVQCbDvCRAKAwsGhPrFoC1YjQ9WRrM1laztZOs3WSQL1n6yDZhso2cbJNmmyzZ5si2M0L6K8gOxaAz2T7DmNzEOg0xycJOKQKeIB8DoQfE2DaI8YaQ4QozJOI8X+4wir8MITujUErHWpqx1YJOP4GLiiAkAoAQIPIDgCrRQcCAVwK4CAA="}
import { Hooks } from 'wagmi/tempo'
import { parseUnits } from 'viem'

const mintSync = Hooks.token.useMintSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
mintSync.mutate({
  amount: parseUnits('10.5', 6),
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Minted amount:', mintSync.data?.amount)
// @log: Minted amount: 10500000n
console.log('Recipient:', mintSync.data?.to)
// @log: Recipient: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.mint` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useMint.md","from":9735,"to":10348}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { parseUnits } from 'viem'
import { useWaitForTransactionReceipt } from 'wagmi'

const mint = Hooks.token.useMint()
const { data: receipt } = useWaitForTransactionReceipt({ hash: mint.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
mint.mutate({
  amount: parseUnits('10.5', 6),
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})

if (receipt) {
  const { args: { amount, to } } 
    = Actions.token.mint.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `token.mint` Return Type](/tempo/actions/token.mint#return-type)

### mutate/mutateAsync

See [Wagmi Action `token.mint` Parameters](/tempo/actions/token.mint#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`token.mint`](/tempo/actions/token.mint)

---

---
url: /tempo/hooks/token.usePause.md
---
# `token.usePause`

Pauses a TIP-20 token, preventing transfers. Requires appropriate permissions.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.usePause.md","from":153,"to":6131}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"b185b955305cbee6f008ea6d7efc12dbee30325aec9fb62314d68f7658e4fa9c","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6INYQYCKcWKIArnAwAMoYYNaIPHyCAHRoAvLpMTAACtGxCUnpAEo6UaRgACpeADwAwqEAZowKFJxRYPyQAO5gAHz+IuK6ACwAzLLySiouGuLaQZF5Jdb+JmZIAEw2dqQOTkgAbO6eOHiEJOQagUys7FwGgiOauqrqxrPKaotaOjwLyMW3Me2CByOfkQAEYABznaheK6+W4BegPNgcThZfjyN5jU4wmaKX6IL6aZZ4XH42SmMH7eyOaE7caIzCXPTXPx3DF6FrdRyMUJdWKFNaJaxNVrtTrdXoQAaDAAUkUOzB0ZDgAH4UsDMtkwLkxUV4pL0oV1ZrSHBpWA2h0uj1+kMAJR6tJwA14o15cXFc0VNBVWoNZr22VOhVKgA6YDAog1cEi1hgooKpvW/igEGsCD0L04LXYESKpgUnFEnBqAEl8jsLDjDek43GAHIQGgpGr4RhwTh9yucOCS/CkUIQGKcQgCHF2Lh9USMND94ukOdptCHMJHYVgONZTgAIzTpmsMiisCgnBFVaPMlz/GPMDXadIlWq5aH7+ToVi6X8MQFHzZBkBAOhEywOR/AAAzgldaDjFgsS4YBUkMThXCLcdmE4AByRcFGYRgAHoaEePDW3tQU0D3TgAEEsCwZVXU4YA404TgQjCVDOGYKIxBoTo+3yeQoC/LCAF50IyGlfRNCUkhYqjOPfYNqk4ZUOM4zh6iPASsn3MAdJ00JGhMax+Ek4AWM4STBj4gTRBoZU0LklI8IsWh0h8vDMNdVxtJM8S4FEe8YCgayRLE8tAuMnTBiCnT/RgJL6hI/S0EMxL4tdOM4rgmCQAAXQoMC1UTfwKo1Jx+wAWk4S1E2tL0SrKkA1JDIwAFknNokUfyiGQ0AA4rSpAUYJEQE4AHYSTmJAYXBSlAT0P1M0lTZ6V2RlDmZZxJgsdlkS5VFAPuPRuPCVYAySD1DG9HJ1sU6xyg/UMcDtB05WdRUhgJKaYROcZ5rJaRqCWVaQBus0ki27ZyV2qFnCOjwkU5HwbnOvkQFVcccA4DBWP4wSYBSZUiHERgwrkOAUhh9YLXsGqtS+9pBk6CAsH6sJdU4XrSYAeW5vdbQZwN3oANVEC8YE6AAhURYgAUVIcdSDqHBOnF0ompZm02YUDmoxdByAB8nVgNozCgVj7M4IgIEYKBs1zfMQB7NMSecuiBSSHnOAwScuNEYzrBlmROD6Zd8AdqmafgJscVIdptHXZQvb6ujQ+vLmeYjjBp09G9jNEKBxPzyPw5kGQjwcJ889FgDFmApBQOh5n/EplOE/q6t8DTbvqfC/sICPAArGBHCTyI4H7Q8M84GDvZ5gAxMAYNG9rqv8Ru/3SUI4iiaxUznzgGp7Qc/aFEVo5rotGHfKOB+MxeV7owc4GP0+4AFSOc6jowe+J5SxzwihuRygk9x4X7INYaW9yqdyoHvMIB8wCq3VuffuV8aJ0TvpHNoT9GAtAge/EU8gQjdFqpWYyZBMEAPwc+UBsRryLzoewBBHd1S7xFvvQ+Og0ByGvBfXsq5cG3yAQQx+aY+gv1IVnEUg4YAxzIMOb+8Bf5DRkIXFoOhbDgJLBQycYBqGh04Ow9cACQGzxYeYlR6cB6cCgM5Kshi1YcLamBd8zBxCvCoA1GsJCg5RD4qIPEjlhqMCgm+GAABHKI8AVydBgofdRc8YKAPvoQtMoRtGVhaE4CBMhnKJJDvfYJeESChNgC2MADV6L30XtXWu9ciziLCJpFJYAj4nw0TBZJoQMHsH6UvfhWUhEwVYuIQeTtrzXx5nAToADF6dWqOAymstMmRxAe0SA74oCjXGpNXQMIZog2+KSeYJx/hUj0CvXAdIEZfFsEyY4sJUYXG8NyNENAcZ4y5mQTArF3KcBjCALyDZrAWGhTC2FcL4UIsRRYMFAMTlwi+HIS5fwIYAiCHJeG5hrkQleSyY6GNvnYyCAmJMKY0xXQgHIOM3cuJ/gZWTTg4Y4BstdnmPAnsl70rkBk5g0AhppiwOOIgztE5VjgMhOQTiYD6QUAoL8grNzzgHP2OVxFinpwgBuOMAApUQlM4jWBTtzFlYQ2V8SnnYMAfZcISuINK68R5C59CVceccfRYg2lqXGflIqoBivMbQFC88+gGuTFPYhjBrAsseGYExdMqIACoGJL05WyjJ54lb9mjsoO1yhoDauPrHJWArWVyHSA+BQLERkwXVekCxjaaHXmbTWmA6RFzVHbcoZyIdjIgLyKwg1fQU40CTqHQuHYanj21VuGAiZamZvopwBQD466Ry7TaoVA4eKh1TNah0VRwGHkncuTcBrkAwRdT/dIIgcwCRgsVZU+AspYDpiREikBYCLoPloEiOY8wkWKTQEQdUiCsnSLQEiogsCkQfRo9In7mAyAAMQobns+ycaAplgCgHGO9OGvTProW+j9X6f1/ugDAQD7AFAgbduBkpUGYPjDgwhpDJEyNobQBh7D44f4UbVq6dI/c0xbrHjLat+6YB5rMaO2xRbCACQHI8DgX5F4wX/WTdVwrRW1qogAfXTemgA6uIR1igLOme7I4mTO7rVcoVWPSejgYElsIFAfs0zOBmHsa5vsNATHaLjCOJIY4JxThMOExeR5fX+oYvkGs88B6Fx/DAZg4VOh7MrE/DOhcrqhfkIIjAcYlajnHJAOLjBwkRxvBndc86e2LuHMuxMXpOBxBgBqtMd7IDTpFGRzgNYSKCyo5+tA37EC/v04x4DoG4Bscg2gaDsH4OIeQyJ1D6GsOiDqsNmAdVQh1TI3VYUrE1xxhFUQ+07AfE80Deg2gkEFUxB0057dcm91ucU4gKihVF1xhbfW5UeEB41wnewGQUA8KugANxxl/Y1FOqaUjQ4fFHOHUBOiHjwwJMH3a60QAbVDmAMPOAAFI4B4U6ARPHiOUdgDR/kDHK4sdU5x9G0g8OCcxrQC+tAJOFOtvcaQZUZg+icCGVLvClmZzfs6FymqvZFDHjLtORDOAbaI+R6jki6PTArnMZLu1c9RDaA7Z11pW4HA3s67ANWQO2fG84vLlISu+Aq+HBAdXX467XjsExeQEUjcmUrFwZAMANnFXJLCVQkeTJDvNZakapBug1lqKI8MvyuDS/o4gIgzBYSTB2LCOEeV3dR6HYLCeU9M/Z9z32fPgRNL6ZL2Xw6khECTGrynnSQ6u+m7IAmGQfG9tzxInQKeAk9yIBmjNWEkgh+cSHbH+PdVJ267INNRAOwdjr+j+YjZ6eomF9HyY8fMsp+5g0bP2g8+eZL5ONNCwNe0ep64NfpwE+SIfFTBZ8NlTMRAMcFBD9Jh+8qIrpf9mo7J8JLNJFOAygx5TAuUwA8JWcW0+0wBlQYIAARUONOTgAAEmAGpRgFcAAEJOBiDFAyAaDJlWd2dOc6Z6CSDVFkD740CjwMDQg6CGC04aDBdnc6E4xCoqJlZ3tWBPs5VNddMc0D180543dJC4JQckg/wuB8NEDlg4gutmA4gA8YBCA+gWIcCdDzd1xpIDCjCTCNRzDLCxdwhmAMBlC0xpIZdXM2V0hPDlR8NOg6FDcjJ3DPCycKdsdYd+cEdQi2DTcODojcdYixD8M7sPDScIdKdqc6cGd8I+d4cWdI8OdEjudqdCj8ck50iwBwjSc20fD5dIcfcuZFl/dA9Ndg8dcw99dXR4jjdSjMdOBkAvdOAWi/c1cdANcKwujQ89cIpSok4JCjI4DAsEDpJFcUC+CBCsDWc6jxc8CCDhDVEKCqDaDODGDSBmD+iTchjjj1weDI5tibUwAhCuCrixDljCpAJrcQIwJYgHkQBkAuUqhUx30Zs5tf1VVlAogjx0gQhmA6MANVt9MMpt0SJONuMTAjwSIW1F1XQSojl3hdhxhwRMUFol8bkoZ1UCUpAkZ9okAPl0YvkzpeQghlR1doBWIIiIckxQptA+ZZ1OgfID5eEJ89YODZ1kBip3QHZZlNIABqGEG8G4B8MuAkqgFbPAQYs3Q8GCInNADJNTQLGAPoUESTXqSJaJQrBQKIDUVNYdJhGxCKToY0jOOMQhcIMdSsDLcVFOHxUgQuPk63NMABJrMuCuPcOTb0qtL+I8EQZcBfUIJlGWBJbVFgIBcQJOUjTnFoZUSYV0abL9ebQA0OGaIDZjLYKIeDHxOpSIbQVbWsyYKfU3FodISYATDDGvZUReJYO08rfzJ+JrZ08dYYmCBfGQdINcZ7RtcEmjEsxbL0JjFjMDCDRJTbLjbbXjCczsrDCc6c5yA8jbJYOAPo17EHOAVwrgShExRA1QKw8XbIm8tAFIGnBHToZ8m4nUjg58lIdQJOA01wvwp84xF8/Iz81ggY9glIX8zgf8wnYXGoqQoyPrQbcc2iSco82c6jWbWjRcislc1bNcjjLbHjUiHcg7TDfcp7Q8mi48rQU8osEse7U8R7UgZ7PcZuCGVuFAf4s8QEogCwdIGEYS6FQk4QYkw/VQKwC5Ck6YHFW5YwcnWkhYYlPaN5BENGDkFkrGNkvAVYnWZIGSL0OSY0DMF6N6dSD6GAQ2H6aMf6CSwkQ/GaDFH4eYcGFaFYDaOGR5cwcGF5dS6ESYSYMlHSnkdEdkl1AmIFJxFxemby16IMEMaWTZC2boK2ekF2TUt2PlRxYpcIL+XpOeP+PJH8BlEga8ZxMQJihxTOKBUIV7INPKpWLgQqn+EqrLeAcq8BKqqsNceReqo0KiJqtMfK1qtJTRGuTqtzCq2K6q/qt+BRIaoyEazgMatRIqya0qrqmQWa3qmqgan2Bq1FXYdFUGeYc5TyvAXqlS/yyEBkxAKYUKlEXSiKvAf5aKomTgd8VMS/bsbcUKG+MACoX67mE6w/SQYkWSskOaBSqGH65RMG3yuktS5GJAcYNwLSk6TGcKgvd6qKwFL6h3HcIG7gJWfAFIGCLyCg8A2KDJNKojF8TKnld2MmuAWOCAEhZQQcYmwGnmcGnYSQcGckskGECkSGPFAG3cUINmlQZG1SgKtG8kGaZ6vQICfwKgvAetcGyYIGc6xkvSvQGoKWoGnXdmlILyJaSYcYVQWaOESQCwMKawK2K2m2u2h2p2l2nYa222mae2x2o8Z2l8V232/2z2l8FSmEKGxWh6o6caEIWATEJ4NiYyzCbCAPAo63YiMiHLNgSiFY6wwyxA/UUy56W6awZSIyNHRoJrZePqRTQ9b6+ANgMIJ3PISxU25UHtBQSTTKQyLiCyfgToactRI8YiOePcGvQy9Ie5VybSEFTyWgSFJFFe1ehFBnfKGvIC2tbI420OPmuiOwc2/I6e3q7UdIBGy/TIE2nmWWmvfwGqUQJAUAQIeQOVUIakBAVwVwIAA="}
import { Hooks } from 'wagmi/tempo'

const pauseSync = Hooks.token.usePauseSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
pauseSync.mutate({
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Transaction hash:', pauseSync.data?.receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.pause` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.usePause.md","from":6470,"to":6953}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const pause = Hooks.token.usePause()
const { data: receipt } = useWaitForTransactionReceipt({ hash: pause.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
pause.mutate({
  token: '0x20c0000000000000000000000000000000000000',
})

if (receipt) {
  const { args } 
    = Actions.token.pause.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `token.pause` Return Type](/tempo/actions/token.pause#return-type)

### mutate/mutateAsync

See [Wagmi Action `token.pause` Parameters](/tempo/actions/token.pause#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`token.pause`](/tempo/actions/token.pause)

---

---
url: /tempo/hooks/token.useRenounceRoles.md
---
# `token.useRenounceRoles`

Renounces roles from the caller for a TIP-20 token. [Learn more about token roles](https://docs.tempo.xyz/protocol/tip403/spec)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useRenounceRoles.md","from":210,"to":6413}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"b76e1df0be1a3b2792bb8c4a1ab224f7963d06a0ffa907fcd104f996453f6d0e","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6INYQYCKcpPIQAK5g1jAAShBycADKGHGIPHyCAHRoAvK50XCJUbHxSSnpcbkJOtGkYAAqXgA8AMKhAGaMChScsfyQAO5gAHz+IuK6ACwAzLLySiqIAIwA7Bri2kGRkBWJyfA11v4mZkgATDZ2pA5OSABs7p44eIQk5BqBTKzsXAMgimml0T0WxmWyjU2y0OjwQKMF3MN2CdwefkQVxeHmoXg+vm+AXofzYHE4BX48hBM2e0khimhiHU1B28L0lOpslMKNu9kcmPmV1eePeek+fh+JL03QqaEYoUGpXqBziR2qGWsnR6fQGQ1GEwAFFh7MwdGQ4AB+LKI/KFMDFZXlNVVE6a3IABVN5tIcG1YF6/UGYGGEDG4wAlDacnA7VSHSUyqrKsc0u76mhGi12l0A7rg6HwwAdMBgURmuAm+JKpMxF2p07+KAQawIPRAzjddgRZ3WUwKCKpzvd0ScZoASQ9VwsFPtuRLJYAchAaFlmvhGHBOJvOKO4Jr8KRQjEt4QBBS7FwRqJGGgt13SBeYBT7mEHgqwCWCpwAEbP0zWDI0SwFAnCKqOP4yC2/C/jAD7PpEmZNP2u49pWoSlLk/hiAobbIMgIB0OWWByP4AAGFF3rQJYsGSXDANkhicK4nZHswnAAOTXgozCMAA9DQ/wcQuAZyh+nAAIJYFghoRpwwAlpwnAhGE9GcMw0RiDQAybh68hQChLEALyMXknIJk6ybqm6cSySJSmIVmnCGopSmcG0P6aQUn5gG5bmhB0JjWPwRnALJnBGeM6maaINCGgx5lZBxFi0LkaUcQMR4pFkyAcZucDRGQHEALrMRGriuX5BlwKIkEwFAoW6fp/YVb5bnjJVbkqnW1aunAnVtHxnloN5HVtRGJatRRZEgMVFAESa9zMP4i3lj6W4ALScF6S3rVhc0EY5TRGAAsjF8qKpEBUyGg+1zSA0wSIgGwsnIjKrNOsK7HgibdYcfWNtylxYny9wCs48wABwipgYo+F82G/HoKnhPsPXWWmmSmbG5mOrW/0NumDRNK0OD+oGeohgakzCKCSBrJDVgMis9NbKycJ7L2GOA8YPIwmi/KPJYMP4uKhKI9KIDGkeOAcBgckaVpMBZIaRDiIwtXZT2VkA+6O1rU4fq5oG4wDBAWAXWE1qcGdSsAPIWx+fpowTGq1BmWYAGqiEBMADAAQqIpQAKKkEepCk372vo7rtT62ahvk30psFtTnAAD7BrAvRmFAcmRZwRAQIwUBNi2bYgOuz6K7F4mynElucBgMTKaIvnWD7MicCMt74IX6ua/As4vn02iPso1fneJbegebludxgnBnoIYG+aIUAGfPXcdzIMg/g4MFz07WHbLhSD4SAq3LVQaukBrdWbWO+DPrf98pGBP4AFYwI4w8mnAW5vwT04GRGulsABiYAyL7XmpfU0/gj4YVyKEVI0RrDxAAZwLa64dz10cOJHuu9OyMEiN3Z+vlgFgPEjuAq6D4BwFlF3Ge3dGBEL/Jwf+pRQKUKnqEDiW4rrRBujAha8CqCILCMgsAodw5YKfrgsSipCFd16KQxg3QnzRS0uJeQIRYiG13L5MgsjmHKNghwoOXDNHGPYCIuBS0EGOyQSgnQaA5CgWwRue8ijfJmNUc+EY5DNFUMVDuGAvcyCcFoRghhQiZCL26DoWw9UwKPl0XWAxbdOA2MfMw9hnCUnhInuPZ+nAoCxVHN2HJdjIjMHEMCKgW1xwaObtEdSogqTRRuowEiCEYAAEdCoiDgAMMiKC0ExLIiwoh/jV7xN3N0JwmiZCxXgFwHeXdWkcRIO02A84wBbQkkQ4BGz97BU7D4rchoxlgFQXQgBZFRmhBkewR5ICXEjXcWROS4gX7F1Angy2IzDHcNKUdXO/dfbTK7uwvokBIhQDurTWk6xJCQyWO9Z4X12QgDAbgIG5gWS2EFpiBmIs4YSiJDQSW0tzZkEwHJLK8AshFhAPlQqpBWXIGKjSJ6056RvRZsybFexUznD5ogJ4oMMTOGFLiWG3hKUSyCLS2WDLZzxhZSAFK05rAWH1Qaw1RrjUmtNRYVlvLdBXHmEzQVTIWSaG+hye04rgZs2JWDIWcq3iKvFlKIIZYKxVmfCjY4JZb7KQwscLIuY4DHDLq2PAVcQGhrkFM5g0AhHPiwEeIgJch57lonIMpMBPIKAUChVNz5lCxW3FuOALBWHiGHhPEsAApUQatUjWDvhbSNYRjjqR/nYMAm52I5uIPm0CP5F4jFLb+I8IxSi+n2SWZNGaoBZuybQOigCRgQCiTgPsvRrCRv+GYMAd5EAiQAFSSRAbG44UzAKWJYcoIdyhoD1rQX3IOKao1yFyFBBQsk3lkSrbkHJoGQX/oHYB68TRoM1vWVk9hiZuEHpGHfGgw826L2XHsz+9a0CRHLPsu9ElOAKCgvvLu4GAMwCmaYaYap+2BkaCk78WHbzVoPcgMiE6Ym5BEM2TSZFiqGnwCNLAcBEB8T4pAWARHkFaD4s2VsfEVk0BEBtIgVxZi5FoHxUQWB+KCfobkKTzAZAAGJzMAJEzENAPywBQBLPx+zsYRPGPE5J6Tsn5OKZgMp9gCg1Pl006snTemDNGZM2Zo8QmrO2c895sOEZchP2fNRiAtHYNxrTa3XyaGrE90/Zpbc/wOAoWAWRILiAq3pszYBkSAB9G9N6ADq4hR2KA661tcpSct5arR/b+jh+EfsIFALcvzOBmAiY+FGm4aCXviSWfccRDzHhKJwEwnTgE/kXcuySHpxyAOfovK6MBmB1QGPC3cpCJ6L2WyIeQbiMAliDgeI8Bwtz7efJ3MCxTOAEZgLkIjUSSMwHLLGTgqQYDVtKfxyAOHFSec4OOPidtfNSbQDJuTCnoDBdjKF8LGmtNrN0/pwzxnTN8U85ZtA1mbOiA2qjmAG1QgbU8xtBUckHwlgzWogM7A6mW1XdI2gxFi0lBq0NmjPt8tPuvT5aaRGSwQeA4aDiz9d6YfYDIKAHEIwAG4Szye2nfS9sml4wH193Q3UABjfkc5pTXDGgMQBA7r+3UFOAAFI4AZU4vu0gRuTfm7AJbj01ur124d2Ho3LuD1u7QB7uD4OoNmBGJwF5pAdedbPDJgYcaE4bkUL+deS8TM4Fzibs3Fu+JW9MHebJYduwVhqtoGD0xzkkYcLxqHsAw6q8t0pfPWQi98BL1EiA5eUL71AnYaS8h6pN78ruLgyAYBqxkMVZk6xVAb78rW7tvbbqkFiOOFoXjczUq4IaerRBmDrCFOsSGE1o/N9P1wO2X8f5L9r9b9Nx79AhnJn9X8bVJBEAoYv9x83Ja16tW8yAywZAGdEt6E+I6Af5NIPxnoNhUUT9EDt9d8fZioNosNa8yBJUsQrhiClJa0yCZBz8elH9kDL1UCfYMCWwsCcDrA8DQhnonhJULB4Cf8SD5tidEAUCmhuC6lTBsC99WsRBrcFAsR5hYCRIUYuBA1nwTIOJOtWEu4kgfxmM+Eo8IMEMwBrkAARNuMeTgAAEmAD0NcAAEJOB7DFAyB3Dvko8Y849bdvDHCjCiFTDzCwBPCQjfCU9h9jESxpoRJg5pdWBZcG1K9atH1CsX0AFVdEiKINc4gMIuAnMIoqMdBUhodyxUh58YBCARhZJLCSj29HwTJdgqjSNmBaizQGimiM9whmAMBsj9D5sYBc8IMRjDQnMBhjFG8fIhiRivcfc9d/ck9jd5jAjW9bdViDdw9ndh4nMhdhjPdtdfcHcg8Q8uIndI8N9Y9tishdjHd9i4ijiwBFjPds9xi88O8C9DDi9gUy8dAK8Bwl8a9V968IxNjm97ibccpJ9OBp9zZAS6jlBF9q8V8696o5ph4EifIdD5s1pyjDDjDOAIiB0wAOIo8PjM9chrC7CHDIkXC3DojGTSA/DoSW84SvC2TETSTyS40oieSfD2S4i8TppsJRAz4UACJSh8UQBkA41Gh4gJM8cCd5MK1lBogfxcgQhmAiclM4ADSYAhoaM+IYtacTAfw+IIMiMIxZp7pHorVIY2Y7VVg2ZHUcUq1XVzA1gmYPUZUkALByVfUEZ/U8BDRy9oA5Iljtcu8pSYBrY8MBg0pkEnE0D45bc8NuUoxC5/lnIABqNYMCL4KCdee0qgdTCuWEtvb8MiNPKZMrPuHPZETLM6bpXpR7BQaIM0G3IrcxApA4psp8EsVRcIdDXcC7bNO+OpUgReeMnvZhIHdeTeD8JXCcv9AqH8EQW8QQnyPfIZKJRtFZcePjATOPboQ0eYCMXHaTQnOpMADYFTMLC4aIIzB8nnBMo0h8+YDA1vboXIeYJnazL/Q0YBHYHs97WbUhIHQc4efjPAmQXIB8cXUDVU/zQnILELVTKsyLbTNAanWLOnfiRC4C2zRClC2KSiginYOAKEyXdXfqYo1SSNfRco1QZo2ks4vRS9LIAPY3AYHi5zAImEoIrIISrIdQYeNPAY44ZYnXCSkPISzkms23CSzgKS13NAUTdPKBCiESBHZ8BC+UJC6itCvzfHALY07CsLXCynaLGnOLenUi5LGzCisXKijymirQOi4cR8YXf8UXUgcXD8E+VkaUi+DI+IfwIgCwXINYeK/VB05FPlSQV6KEVYCET0oIYDH0+mf09EcGJAaGeVUWeGSUYkIIAkl2esN2awaMQwOMIoX6LmWOawOoYmbMMmY2fMfUMMCYS1JAIUW1DK1mEVPAGqlMOqvK9YAqklCGeYEMgkMMyqiMidNVeWMpCpLISa7mImJCMAb2KFTOWIbOHkUuSs8uJNUpFZcIaJehRheZK6ZIEgUCcpMQPy4JXhB0ESNdG6oOLge6gBR6q7eAF6lJd60cB8L67RUISXP658W6wGiZB6uJUGgrV6raj66GnhWGn6nyBGvbAGqJFG4GtGtCcGt6ipT63G2uOGwa2AqGDFIVWYcavQSGmav06VIq5kNYJasWFah/NamWelTayIeINgtcV8GqfBUIeoCWi2Bm+YWYVm5mJkD0tkTmBWhgAlfK7moWVQDYfm8qqlJGKWda0WuSAfN8WWsAbgIOfALIMiFKFw1QlqKZE61zOCc6hNCue2uAPuCADRNEwBaW98UIJW1QVEN0+mB1TWvAa2mWy2f2lQXW2a/WzEJ4VQY2nCfwPQvAXKlK3QeYJ4AVUaywcMvQZoMO22mvAOrIFKNYa1WYVQJ4DYSGSQCwWqawbOJu5W1u9uzu7u3u5ugejurun8HuuCPulutu8e4euCTm1EAMnm4M+6EIWAUkAEeSbGZiViefUPKU3iASG7NgYSfElo3atq8o20XGFqnWQmWyL/DfDoIHUBc6RjbcXyK6NgMIIfRMXJWuw0cHBQTLYabyZSIKfgAYFCkmn8XiABD8L/K+x+9qvFeKVyJlW3XKdlIqOaVyRKTiHVCwPVM1Mh8h41DKSaZ+5igrcHM46utuJO8SOweukPFBuq3ISGy0XIcW8JC2fIGu5Oh2r/fwBOUQJAUAQIeQBtCOjkBAVwVwIAA="}
import { Hooks } from 'wagmi/tempo'

const renounceRolesSync = Hooks.token.useRenounceRolesSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
renounceRolesSync.mutate({
  roles: ['issuer'],
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Transaction hash:', renounceRolesSync.data?.receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.renounceRoles` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useRenounceRoles.md","from":6760,"to":7303}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const renounceRoles = Hooks.token.useRenounceRoles()
const { data: receipt } = useWaitForTransactionReceipt({ hash: renounceRoles.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
renounceRoles.mutate({
  roles: ['issuer'],
  token: '0x20c0000000000000000000000000000000000000',
})

if (receipt) {
  const events 
    = Actions.token.renounceRoles.extractEvents(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `token.renounceRoles` Return Type](/tempo/actions/token.renounceRoles#return-type)

### mutate/mutateAsync

See [Wagmi Action `token.renounceRoles` Parameters](/tempo/actions/token.renounceRoles#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`token.renounceRoles`](/tempo/actions/token.renounceRoles)

---

---
url: /tempo/hooks/token.useRevokeRoles.md
---
# `token.useRevokeRoles`

Revokes roles from an address for a TIP-20 token. Requires appropriate permissions. [Learn more about token roles](https://docs.tempo.xyz/protocol/tip403/spec)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useRevokeRoles.md","from":240,"to":6685}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"feffa8dd71c04910b36e8e796cdfdc9026dde663ac6793cf3241ca53a1f00b9f","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6INYQYCKcpDBEAjAAShBycADKGGDWiDx8ggB0aDFg2QCucHFRMfGJKWnZsTqFpGAAKl4APADCoQBmjAoUnIVg/JAA7mAAfP4i4roALADMsvJKKogAjOrU4tpBkdH8cQnwVdb+JmZIAEw2dqQOTkgAbO6eOHiEJOQagUys7FwGgkmml0D1Wi0UyjUGi2OjwAKMZ3MV2CNzufkQFxmz2oXjevk+AXoPzYHE4eX2YCB00eAHZwcsoZstLC9OT5KdTEjrvZHOi5hZsZhXnp3n4vkS9J0Bo5GKF+iVansDpVUtZ2l0en0BkMIKMxgAKLD2Zg6MhwAD8GXhuXyRQVZX2FSOquyAAVjabSHB1WBur1+oMRuMAJRWrJwG0Uu2lJVO5Iu2poepNVodX2agM6vUAHTAYFEJrgRusMHlMfKh3jaX8UAg1gQegBnE67AiDtMCgilebrdEnEaAElXRcLGTbbncwA5CA0DKNfCMOCcRecPtwVX4UihCDFTiEARkuxcYaiRhoJct0iH0toW5hO6ysC5vKcABGpdM1hkhVgUE4cr7V8ZDrfg3xgS9S0iJMGg7Vc2yLUISmyfwxAUBtkGQEA6ALLA5H8AADQjz1oXMWBJLhgEyQxOFcZst2YTgAHITwUZhGAAehoX5GInX1pTQR9OAAQSwLB9WDThgFzThOBCMIKM4ZhCjEGg+kXV15CgWDaIAXionI2QKYpy0dStjnE3iZKg5NOH1aSZM4FpX2UvInzAByHNCNoTGsfgdOAcTOB0sZFOU0QaH1SjDIyRiLFobIEsYvpOnomK4oS7Ikq7RIMmQRjFzgQoyEYgBdGjg1ceyPK0uBRCAmAoH89TNI7Sr3IcsYqocxUYk4OMupadjnLQVzOva4Nczawj8JAEqKEwo1bmYfxFoLT0lwAWk4d0lvW5C5sw6yGiMABZMKBLlSJCpkNB9rmkApgkRAaQWYwlkhNYAA5oWZIJjJ60yVWrWROUublbl5Zw5ieDwcWFHwPhQ749Dk8JdgrIH0n0iNDOjAHlWdapE2TZocB9P0tUDXVxipJ7VhpB56Q+9Yfu2PB0cBwmThB85EA2WweXuSxBVxEV8SRiUQENLccA4DAJKUlSYAyfUiHERg6pyttYzMl0drWpxvTTP0xj6CAsAusJLU4M6lYAeQtx9vQ5gmq2sGo6gaAA1URvxgPoACFRBKABRUgt1IUn/e1jGubdD1DfJnpTczIMQoAHwDWBujMKAJOCzhokYKAazrBsQHnUtFfCwSpTSS3OAwHdZNEdzrF9mROGGM98EL9XNfgMcyVIHptCvZQq/OwTW7/c3LY7jA93Df93NEKAtPnzv25kGRXwcUC56d5DoTQpAMJAVblqoNWR4Hzb+3wUsb41+qlwgV8ACsYEcIejTgJcXwT04PhaulsABiYB8L7XmhfY0/hD6IWyKEJIhRrAln/pwLa84Vx1xlHKbuO9myMEiF3R+7kgGgMEiuQqaD4BwClJ3GeXdGCEPfJwP+JQ/wUKnqERiS4rqFButAhacCqAILCEgsAYcI6YIfjg/igkCGd26CQxgnRryhRUoJeQIQBiG1XO5MgMimFKLAuw4OnCNFGPYMI2BS14GO0QcgnQaA5B/iwQuC8Cj8EsOUcQ0swwyEaMoXKFcMAe5kE4DQ9B9DBEyEXp0HQtgGr/ivDoncYB9Gt04NYq8TC2EcJSeEie49H6cCgOFPsrZcm2MiMwcQgIqBbQHOopuhRFKiH2KFG6jBcKQRgAARyKiIOAfR8LINQTE/CzDCEqNLKEeJq5OhOA0TIcK8AuDb07m0xiJAOmwGyLmLaQlCFAK2XvXyzZvFhFsuMsAKDaH/3wmM0I0j2DPOAc4kabj8ISXEE/CAxcrn1ydn0JhQCjq5z7n7GZnc2E9EgJEKAd1hDAiQKsSQyI5AQhWIzJkbM9CgNwDzcw/NUSQ3RTDF43hRQEhoJLaW5syCYAkilCAzAMjZhAHFGkMwLhQDmKoNo1gHgPDmDMNoFhVBzAuJi1Qog5ivk+jMGYAdrCSBgDSVQkhVCdAsK+EOr5XxctproEcr1sUMkQDMVmLIQBsqvsYUGiA8UCwhkLC4It4a0olkERlssWXZXgJykABUiqkC5cgEqprLiqDpG9HFjJNAEpAFuRIHJebxrdWiZwnrYZChpeLcUfqsAy2ZfLMcFIQ1xRHNYCw9aG2Nqbc2ltraLAmtRdSDENJvoJqtRsZNdrDIZvML27NFKMResLYjYteB8yFmLKWVGhxcw31kohQ4GQ0xwEOKXeseBK7AOXXIaZzBoCCNLKW4gxdB5rjInIcpMBnIKAULBY9N4jzLiXHAFgLDxBDwnrmAAUqINWSRrAjwtuusIhxFLfzsGARcDEr1EBvX+V8i9hhPrfFuYYJQvSHLcoes9UAL05NoORABwwIBRJwNYNRjBrDrt+GYTJcBEC8QAFTCWAduw40yvwWOYcoODyhoDftQb3YOR6N1yGyMBBQ4kPn4XfdkXJSmDF/hU7JmA2QTwNA08ocKLd3JsOMlwmjwwR40CHq3Re04Dkf2/beGABZCPcaEpwBQwE96d20zBk9y55KtxLNBv09QUkvis2eG8NHkD4SvTE7IIhazKXwiVfU+ARpYHY+xdikBYBOaQVoditZ6zsTWTQEQG0iCYmyLQdiogsAcUS3Q7IWXmAyAAMStf/ilncaA/lgCgLmeLvWIwpaMelzL2Xcv5egDAIr7AFClbLhV9Z1XaszHq415r7FxvtbQJ1nrW4YmTfDsGbID9Szeffr7GTAWYACeyWZyx3cxPKWXL8DgsEgH4QK8rd9p7z1yd4gAfU45xgA6uIRDihIdg7nGU27vnoM7ofe/L+jg+GicIFAJc/zOBmAiVeVGi4aCZPibmdcaRNzbl3CYLpQDXy4fw8JV0A4AGP0XldGAzB6p9ERauEhE9F5k5EPIVxGBczBw3FuSADPGBdI7v+EpnAHO6ac1ElzBYIycCSDAD9pZ4uQBs3KcbnABzsTttNrLaAcuIDywDpbJWytwHW1VtANW6sNaay107bWOvddEBtU3MANqhA2uNjaspWXsFzGe1Rvp2D1MtoR3MIdaA4QfcUX7yOfP3f8+jp7HG3LTSc7mVTCn9SMUfjvSz7AZBQEYsGAA3LmPL20R5sYyHX4CXdG9QD6C+frylK86fkxARTteYD184AAUjgFlZig+W/t7AJ3103fzy99n/36jpAm/D5o6PtA4/HtqfDuwfUZhhicDeaQGvUP9w5b6Duk0yhYJ7z/HYUS8gGot5t4d7sRd6mDng5JX5XiFi1TaCaba77zDwOCxba6wDhyl6d4yQP4ZDP58Cv5RLso6ALiKBvhrx7hNY4C5zAEeSrhcDIBRC+wlR8xrCqBUEeTGbgaQa3SkADADhNCeJpj0pcA34LaIBEAcqrAypfQTQb4gFsFcB2yfzfxcE8F8GLgCGBC2QA6iEcr8iSCIBzCfTSEYEOTGZaFgFkD5gyD7YB7/zsR0DfzKSPjPQ0hrCSCsEmG0H0EyAlQbRWbkFkAuoYgXDuEyTGZeEcG9JCFmGZIWG+zWF1h0J2G0AOGWzPQPAuoWBGGyEeFE4iHmENBxH1KmB2FqwyBg4iDd4KAYhzD6G8SoxcDzqlh6SMRQ6+J9TvymA7pgCMTr6qb6ZgD6j4QAAircY8nAAAJMAI0a4AAIScAjGKBkAzG/Lr6b7b7sbzGjGRKtGELxCvidGhBzELFjwzHH4oFGK5jTS8SZ7Z6li57EF/Z8aBaCb/yl6XGEQV5pCIRcADZBReY6BJA67MBJAEGEDDDiS9HfEQFXh6TbCAmRAFggkmhgkQnn7hDMAYBPFNFE4wB36qZYn6gDZ9BGJAFuQYlYmT7T594N6H7N6klrFgEbHUkD60lnEDYJ6YkT7V4z5z6L7L4H5N5r5UFb6Mm75z4ClD5DzslgDkkT7qa3736QFP4v6jL4Ef5EGdjf5kF/65yAGrEgEik96cDIBYGcA4Hmyqnv6EFf6kG/4UENRzRDwXFuT1FE5rR/EtFtF7EHHdHr6ykX79GDHHGRKTHTFHFbGkDLH0kGnrEZDBlXg7GdzekwZgDhmLGRlnHOnTQoSiCnwoCYQlDEogDIA7r1AlgZZ24O55avrKCFCvjZAhDMDzaFbu4A5DQ+bsRbY7YmCvjsSqZObBizT3SPS6BzCCpMwrDxqDpBDvojropggoiCzogCj5qiwIxiiEh+rqnQASQUnV7QG5kwDWx2Z9AZTiK+z6zMAbF2ZRqhiFyAp/j6gADUqw/4HwwEa8g5VAbueAhp4BL4+Ep+0y72vct+iIV2Z0PSfSwuCghQJobGJmZihSkpIF14uYKi4Q5mq4XOl6I89SpAi8B5sBTCKua8G8j492WF0mhUr4IgZ4jhoQq6vswyUSv6ay48cWCW2+nQ+ocwwYtu2Wju7E9SYANIxWK2ZwhQDWIlUeh57uIlcw1hYBnQ2Qcwh2nW0h+oQCWwcFkuBOJCKuyFQ88WjhMg2Ql4qeSmFZs2QlzuEYy2q25WlWGy3u22vue2pl6l3WplFl4UvlXuWwcAwYl2vE5ecAaJmyGSXAekqgkJF+3JuimSGQ8+zefQiVg2+poBRp6VGQ6gQ8p+aJhwlJNeOVWU6V0ZWVO+66eiuVZxBVkChEvEBuxu+Enl/lVlM29uc2dl4ljl7uzlm2Puu2HEnlQeXWPlKeflk1AVWgQVPYUB7AH4yepAqej4x8mweZ58P6aQRZRAFg2QqwB19aQ5naT04qFq70Kwr005eACmc5awC546Qsn0U6eIM6m5eArpLscYxwYYhgkY8geMDorsxwHs0EKYZMxsGY2oacMa+hDwvalqzMA6MIOwwNP1qo91qwj15KQsY5r1Ys71gheA/q5aEkFSYgGQ31usRMnsYAPsMKmcAw2cnIJc35ZcB6ZSay4Q0SdCDCiyV0CQJAf4FNfYl4wSPCBQvEuYh63NXAvN/8/NPO8AQtKSot81EtWioQ6eRGXNwc8tkyfNcSyt6Owt5SlSGt3CWtUtbkMtetPNhtitxt8EqtItFt4tVtNc2tcNBhNqfaH0ftN1egotWNONS5zgMwbgq53qRaH1egpNcsEkkQJYkRc4d4tUeCYAtQKdFsPtkgVg/tk5tqaNOdDAJK854MOaagqgBN65dKyMUsV6AaFat4rcGdls3Awc+AGQ+EcUkxFRrU0yTNw24ErNe65cndcAvcEA6in+AC6dD4oQediNl16KKNv0eArd94mdk9Kg5dD1ldE6YqtdqE/gjRt1U+cNMwLMhdSABdxNegjQC9mdZBU9GQcUqwFw4qqgDwPa+ddU1g2cn939v9n0/9r4gD4EwDMwP9f9FgADQDX9MDoD4DkDnQWNr0T1y5rg90IQsAxIfwkk2MNEdE7KTELEbEnEfObAPELpUJ1NmMfx1ouM/06NNN1gFkbknebQKuIC50T2QW8EbAYQyBxkeSL9+oumCgV2w0rkskPk/AyUKeUSdZbE/8j40hDDccRKkU9kDqaUtAvK/Kgqwqoq4qkq0qsqFw8qiqyqqq6qmq2quq+qhqr4SU9kaawaxp+U/84apUFA9k0UTENaFgdaba4TETza7jYArg0hhVcm3JT9bdi97kdgb9WUWjbs2Qot5o2Qyd4SFsuQz9HdXd0h/gH+ogSAoAgQ8gP6S9rICArgrgQAA==="}
import { Hooks } from 'wagmi/tempo'

const revokeRolesSync = Hooks.token.useRevokeRolesSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
revokeRolesSync.mutate({
  from: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  roles: ['issuer'],
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Transaction hash:', revokeRolesSync.data?.receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.revokeRoles` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useRevokeRoles.md","from":7030,"to":7617}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const revokeRoles = Hooks.token.useRevokeRoles()
const { data: receipt } = useWaitForTransactionReceipt({ hash: revokeRoles.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
revokeRoles.mutate({
  from: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  roles: ['issuer'],
  token: '0x20c0000000000000000000000000000000000000',
})

if (receipt) {
  const events 
    = Actions.token.revokeRoles.extractEvents(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `token.revokeRoles` Return Type](/tempo/actions/token.revokeRoles#return-type)

### mutate/mutateAsync

See [Wagmi Action `token.revokeRoles` Parameters](/tempo/actions/token.revokeRoles#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`token.revokeRoles`](/tempo/actions/token.revokeRoles)

---

---
url: /tempo/hooks/token.useSetRoleAdmin.md
---
# `token.useSetRoleAdmin`

Sets the admin role for a specific role on a TIP-20 token. Requires appropriate permissions. [Learn more about token roles](https://docs.tempo.xyz/protocol/tip403/spec)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useSetRoleAdmin.md","from":250,"to":6583}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"c4dfbc1c2509d94e1eda6bf007b494a3199ae8c05d6345fb80ca7a05858d98eb","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6INYQYCKccDoAShByAIJQzKYAyhhg1og8fIIAdGgC8jkArpHJ0bEwCUlgqek5UTpFpGAAKl4APADCoQBmjAoUnEVg/JAA7mAAfP4i4roALADMsvJKKogAjABsGuLaQZFoMfGJKWnW/iZmSABMNnakDk5IW+6eOHiEJOQagUys7C4BkEM00ui2d2Mq2Ual2Wh0eGBRiu5khtnsjj8iBuqje1C8n18PwC9H+bA4nHy/HkoLmLwAHCtFDDEOpqHsEXoqTTZKZUfcMc9EIsNnjMB89F8/L9SXoesNHIxQkNSuUTtVatYur1+oNhqMIBNJgAKLD2Zg6MhwAD8mSReQKYGKqqOFSqZzqAAVzZbSHBtWA+gMhiNxlMAJR27JwB3Up0lGBlV3qj3WeqNZptHABoN60OGqYAHTAYFEFrgZusMBVibVlVONXO/igEGsCD0wM4PXYER0aFMCkp+GrogbnFIFS7PdEERw1kYfWs48npk4M5aAElPTcLJTHTli8WAHIQGiZFr4RhwThXtcRc74CeQEqcQgCIeiLhjUSMNDX7ukEO1ZoI8YRPEqYDFvknAAEbVqY1gyEUsBQJwyozjBMitvwsEwAB1akBmYADnehEVqEkQ5P4YgKO2yDICAdBllgcj+AABhxf60MWLDklwwBZIYnCuF2E7MJwADk34KEkAD0NAAhJh6Bgq/bKnEWBYMa4acMAxacJwIRhPxnDMEUYg0IMV6evIUAkSJAC8gm5Ny8Yusc9Yauc2nKQZhFoE0YCcMa+kGZw7QweZ+SQUFYUGaEnQmNY/AOcA2mcA5kymeZn4wMaAmuZkEkWLQORlRJgwTnIRVXnARRkBVa4Nh5RVmgmEnCeGrihXFdlwKImEwFAqXWbZA7dbFBmTD1YVJpwHmcO6MVxe0smRWg0XTbF4bFhNHFsSAAC6FAMWajzMP4Z1lr614ALScN6503VRx0Mf5gVGAAsjlalBWRRQyGgL3HSAswSIgADs8xMmsSAbNI7LwkECZJh5S2apcfK3AKjyYs4iwQ2KBKSkS1F/HoRnhIcaMNpqUaGLGhQo3W6PnOmAWZh03SBrqIYGkatLgxsEOMlCzLrNscL7Hg1NurTTa8tcrI408WIWETEo+N8ZOyiApoTjgHAYDpZkWTAmTGkQ4iMANchwJksspo2Xo+k4/rc0GkyDBAWC/TamTfWbADyvsQf6jueam7OBQAaqISEwIMABCoiRAAoqQE6kFmie9smkfO2mj3XW7Ob9F7fNhllAA+IawH0ZhQDpmWcEQECMFAzatu2IAXtWpufhBXaqUPGAQEUhmiEF1jxzInBjL++Ct9btvwHulKkP02iAco/c/UPU+oT7v2zxgr7RmhQWjnZJ9zzPMgyDBDg4cfYdUbstFIPRIBXRdVBW5vVed1OB92XoAwa14IAwQAFYwEcOvM0cBrzQV3pwNiA9foADEwBsReidH+5p/CvwojkUIyQijWCrEgzg90Ly3nlOkX689GAPy7IwQi89hxBVQRgoet46qUPgHAeUc9D7MNYXBTgiDIioR4fvUIElrz/UBng06hCqDELCKQsAGcs40JAZef8I9lQL1YX0DhC4gLZQskPeQIRhhuzXEFMgeixGmLnpI6RQ0rEuPYKogh50iGhxIWQvschUK0MMcPRhQ93FsI4WMLhVjeHKlvDAReZAIgUKocIgGMgz49B0LYbxPY7HjzAI4qenBfGATEZ41OMjqkZJ3sOTgUBPwzlKZnPxR18GEWYOIEEVB7obh6JwMeE8BnUmyoDRgLECIwAAI71REHAQYbEyHZKEWxcRc9zHVlCPktcPQnBWJkLlcI9854TIkiQUyo4YAHjAPdOIrDUFXKfslaJioKLBQ2TULZSC2LrNCLo9gwK0GhI2uEtiOlxDVjbh3b5ftBhiNQe9Zo3irYJ12bhG8ChICESgMDYQYI4aSDZHIcWLwpachABg3AitzBsnRLjIUwsNbeClMSGgut9Y+zIJgOFzUKiZELCAeuogAZoCWuKwWugdw7DFrDFwtKgijmqB5TGSslWstVs4G4nLCTaxlEEflhshXLmqpwcVtV6qkDlaSuk2JFiUuhOsaGiNpZ6Cqoy4wWNIYqzxrcI1JMTUkjNVgA2grjZ7jjGKkAJUdzWAsKmtN6aM2ZqzdmiwjrQZkuxKoZYyqWRsk0N66gjptXmFFnq4N2JQ1a2lBGvApZyyVmrJTCoxYAGGQoqKzg3M4AVC7m2PAoC2JdrkDs5g0AAbVijcQDua8ZxwF4nINpMBIoKAUCRKdwE7BcH4SwFh4h1672LAAKVEFbZI1hN6+z7WEScFp0TETgOJRdRBl2oRgmfMYW7YITjGJEP0TziygNnVAed1TaB8WQWMCAs44ELkYEuEIAIzAVPtspAAVItNBQ6Kg7MQg05hyhTI6EIFAa8Ail6pzQfunIWEFDaQhZO/tcgcg1LY041CHHn1ce/M0XjyhPyTyCpIhMsikNjE3jQdeU8z4nlgDkaBtGQIwDLE8/DcROAKCwk/OeAnh3TpvMZKeVYn1BiaN46CcnfzASQ8gNii6ck5BEC2cybFDrGnwBtLA9tZKyUgLAdTpCtCyRbG2WS5yaAiFukQG48wci0FkqILAjBZJuaETkfzzAZAAGIctIM8+PNAcKwBQGLC5krMZPMuJ835gLQWQvQBgOF9gCgovd1ixctAiXkupfS5l7LE53P5aK3Vhrmdww5AMdWAzUD46Mc4zAEjVSpONIXsocrN4AQcBIqgtioXzb7pnXOrjykAD6uHcMAHVxDEUUHd6755WlLaM0+0zByYFwLQIoyju2aNrg4WYZp32rw0Aqfk4scAHxPnHteEw0zUEwWA6BxanoNzIOHGfMiMBmCDUGIS0HB6YBn0plD+QaBYelnh+kR8oQkecBRyOVhp5hyARU489TERNNlhjJwMo5POAucgAp5UdXOAblkkHJr/m0CBcQMF07nXIvRbgH1+LA2kspbSxlrLdW8toAK4V0Qt0JcwFuqEW6dXbpKh0gBYss6LGBnYAM364GdG0GYhukoR2PuGZWyZ4jiBlL7XU8WJjLHjQSWHA/WT7AZBQAkuGAA3MWYLD1N7YcyAnrC89k9QEGNBMr5lo9reYxAVj8eYCJ84AAUjgI1KSxe0+Z7ANnz0ue/z5/r4XxDpAU+l6Q+XtAlfBOPJ42YMYnAwWkDj/dt8gXBjDotMoEiT9UJ2E0vIIaaeM9Z9kjn0wf5qndMAuWfq2g+P8+fhvBwTn+ewEzuHrvJ+DIL8yMvvgq+IgQAb6XiKCwSjivgZY4CNzH5xRrhcDIAwDYqHSsibCqDQFxTiZ3oPpAykDDAbitCGLcy8pcDGinaIBEDMCbCLA3CbD0g7Qf4wHiZBx/aOA5A4FgB4F0JwCEGBDBSkHkHCgWCSDCi0FoFhTiakFn5kClgyBjathCKyR0BwLmQQSQwQybCSCiEGTibwGIG3RyYQFkCIBbDYg3CaGwHVLYqYFzLEESEVJSHxyyE5IKG0BKG/SQzGFbAWB0HZ7oFcC2FODSGyQDKmAKHYrXYiC54KAurCjKSUx+HXQZSST3YsJzwxAwSmDDpgASSd5MbCZgDGhsQAAiU828nAAAJMAG2jAK4AAIScDFGKBkA1Gwqd7d6972z1ElGZLJGsJpEZGhB1ENHbw1Gj4v4uLFj7TKRpy+6sD+5rogHHZEZmakZILv4TEcRR7pAURcB7ZOT7DJAC7MDJCAEwCEBjDaQ5HbEX6AR7E6AHGERljHEWhnEXGT7hDMAYBLHVhOSz7fYVA5BfHGjlaDAuJH4xQfFfHV614F5J7D6p5gltFn4dEwlF5wmjHlYu6fFV6x514N7N6t5D4p4d7QE95In94N6Ekl7rwYlgAQlV4z4wBz4L5L4r5rIAFAFb5gG76QEH7hgIkn6kl55i7f6cC/4+xsnr5Uack74GGNzHTrzjExRxGcBVGJESQ9GpFQL9FZGd50lT45B5EFFDGZIVFVG1GdGNGkDNH8mn5CnGmAQanzRanPpgCDFdFWmjGKn7TUSiCfwoAMSRB+rIDDpNBVi+aK7K7Ba7rKBFAwQ5AYZtZhZa6nZrSGayR67DYmAwSyRMbqbhhHQgxgy6AihWAlrrAQxqp4D7rVpwwbBBpCjqweD4iazco6xmpAHQA6SQmx7X6+kwC2hOIYCDBlSkLBLSHFzMAdFKbICHSRitztyoTGgADUGwaE3wWEo4+ZVAmueAgp5+0EbE4+OyO2S8s+KI8230sy8yoOCgRQFo2GEmeKXiVJJ5QExY5i4Q0ma4uOC6m8AypAZ8vZt+Yis8TUN8EEK2X5DGdUMEIgv4yhoQPa8cKyEQJ65yO8zmrmvePQxoiw4YCuAWKuQRU8EMEW3WVwRQaWAyzyZo2gWu1FiwY2Z+PQOQiwJuBWdBxoqCewd5NO148Ka4rCz568LmyhMgOQAEnubG4ZLWRFauMYXWPWMWcW8AuuQ2Buo2Yl7FRWYlkln4elA2ewcAfJ3ukecAbxXA9iFSiRqglx+pOJVlaAmQjeqegwjlNpe5HRjlmQ6g684+bx/xDl5STljU7lrRAp7RmQ3lnAvlZeaAXmE+OCHEykIuYubEWlBl0lzWSurW8lZFSlWuKlCWGZGlWWWlk2hWulHu+l1VhlWgxlU4V+7A8E7upAnuEE787Ifp388xVY/gRAFgOQGwQ1qaBZTq4MIoosVKKqxa5adKLGNZmwdZwQDw+qSA9IjarZpqVZVxEcrM6Q9MLk+4zM+c+1aYDQHMrQXMOowY+oVc8qSAiwSwMMLIksXqdKe18s6Qi1Gwy1daQoiwiwm1pM21eg5qMaOk7SYgDsLMX151REccOKtcww9cfInc253c46rS5yVMgKuSD8+O8AsQJAqEUNM4AEyS8iToykEG2NqcXAAiOSIiRyZExN3iZNjVlNNioQ3utN1YONDNeNzNhNpmJNbSHSnNci3N1NMUfNrO9NWSgiSCwt44RNMgYtHNFNUtg8PND1wonhL1HqlZegZNP1f1q19aqgjZ7wXKINLaYNi6FqsahEVY1h54oE/UPyYADQrtvsetiwWwSq01LIFZ71QQLt6SftTKtZ9ZWIqgrwTZ4ott4aRBeA4NRsOkIEU8ntv03Aqc+AmQbEJUFRER40OyyNVWeEaNo6PcedcAS8EAYym+yCHt4EoQ/tUMhtcMZaHIQQWdYEXtddKg0dS1sdzgWw8wjaNE/gVReAC141xZkgy1wd6wpZqdegLQrdXt4B9dmQJUGwNwT18dIskgFgA01g9cB9R9WwJ9Z9MEF9eEV98wx99Ip959l9h9z9N9r9d9D9PQP1xa/1asrgIMIQsAZIgIukzk14IkPQYkkk0kckCkbASkSpu1sNXk6QiR9orkzotYp1cNPkMU2enQoF6CP0625mqt5EYQz+CYtS29xojyCg82600UhkSU/AgwklWSMESQSCEEdBn1mDaYDK+UoUGqpgLUkkkq0qS0FUoUvqNUSC9qCjsUhUkkSaFgKaOaujejmaajrgdBAVXGOJm92dbdQUdgu9jUwjUcZN1orBcCkdQM/dOdEEQ9dB/gG+ogSAoAgQ8ga67dXICArgrgQAA==="}
import { Hooks } from 'wagmi/tempo'

const setRoleAdminSync = Hooks.token.useSetRoleAdminSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
setRoleAdminSync.mutate({
  adminRole: 'defaultAdmin',
  role: 'issuer',
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Transaction hash:', setRoleAdminSync.data?.receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.setRoleAdmin` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useSetRoleAdmin.md","from":6929,"to":7494}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const setRoleAdmin = Hooks.token.useSetRoleAdmin()
const { data: receipt } = useWaitForTransactionReceipt({ hash: setRoleAdmin.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
setRoleAdmin.mutate({
  adminRole: 'defaultAdmin',
  role: 'issuer',
  token: '0x20c0000000000000000000000000000000000000',
})

if (receipt) {
  const { args } 
    = Actions.token.setRoleAdmin.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `token.setRoleAdmin` Return Type](/tempo/actions/token.setRoleAdmin#return-type)

### mutate/mutateAsync

See [Wagmi Action `token.setRoleAdmin` Parameters](/tempo/actions/token.setRoleAdmin#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`token.setRoleAdmin`](/tempo/actions/token.setRoleAdmin)

---

---
url: /tempo/hooks/token.useSetSupplyCap.md
---
# `token.useSetSupplyCap`

Sets the supply cap for a TIP-20 token. Requires appropriate permissions. [Learn more about roles](https://docs.tempo.xyz/protocol/tip20/spec#role-based-access-control)

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useSetSupplyCap.md","from":250,"to":7121}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"d3b1cd4a14575e906a78bb7cbc3171540f904daf431667513fb951963d8d9fc1","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUoiaicACUnABmAK5gjowQYJxY4nAwAKpgjGhwwURhcTCInCKkpgoUnLDWLGFwZWBxzABGZJFlbYwKpmgAOrms7FzppJk5eUZQENYIegCycTJojFgm8Jyi5WiVipykMFhHmWBiaymcEDHbnC3tZJxtGHd9JKl0bGbn17dtERgnAAjBZOMFQV8UvI0JEAHRDIYAWk4ABE5k1OPg0GgsE0APT4oiMGDMOFwfD42bzfFxNYmNbwfHjSa5fL+MQKBbIZAgOiiVhyfwsNgcTjANIZbJsuCcVyxUgQZicADkxNJKsRYBZ0umwRVABYAEwWFU1SSRIaEzjGix2+0OsAgAC6zuEml0BvUxnkShUiFBGnE2iCOqm7NkpnMwJsdlIDicUncnhweEIJHIGkCeGsKRE5R0AGU4lgNhgAMKiLCFjCJMoGQRwtACeRwuKZQtFktlyvV2vWOEAJR0cVIYAAKl4ADzllIxXo1BL8SAAdzAAD5/CJxLoAOy72S+5RIYEANiDWh0eEyaGLpZkFarNcS/hMZiQAGZY/ZHH5EKfk2oLw018TMAnoJgRjFBsjG3CQXHPH1FGPRBvU0EM8Bg18o0/b941/ZwjVUQDMFTPR0z8LMIL0EVRk4Zt+HkLcPRPCwjUPZD/TQ4Mrz0BimMjd9EC/EBbB/RNhOBEjgPI0COWzPR4kSS5UnbGBO1vbsH17Z9rBnOcF04JdVw3YJxgFHQyDgAB+es+EbfiwDbDsu3vR8+0SOEAAV7GYSyJn0sB52qIywGXCA13XLoeHsuAmxbJy1I0u8eyffshxHMdJxwQLgsXMKTPXIYwAsuB0msIEktc1KPOsfxqQWfR7NidgCxxKp6PwIE4C015rCrFrSDuccAEkvJNeiEoRMAhgAOQgGgynHfBGFlVa7jgft8EVSB2yxZrlFELgV1EaZBs6oE9lEMA4ATZIZvOCBniBUxrBkOJYCga5Uh2NoZDmfhnpidggSONBR1yA4dlOb5MjhDlRC5JAeT5WgBQ2XAqAAAxx/JaCGWixQlGC5QVJVVROhRmEYfEaBGTUHqUpIrgAQVLYJomAIZOE4XMbq4CVmDpI6YBqVavPkKAOvlABeGLDHixjEpczS3J0/sOa1HmwYh8FuZ5zgpzaOlmweg2DZScsTGsfgZeADnOBl9dOCFi4YGCCVHLKFULFoOF/bNcpet7MpQQdCxUlcSJXH182pduv6YCgO3xclqoY9SA2isz82NM4FKH04XtY8N/FjZxFJs55y0wAznGsZdCheXM5h/Bb/zZRRHz4z8pw4sb3kdbHIxlgue7DngFY0Hh113R3ViAA4OL9E9pGoHigiq1Wat07ChJEsT8Ikj9d2ksifAzeTqNEvMuBvAv3N0uyFcc5z1Oq7S0s84dway6dZyCoZYyEUNzMXnogI0wJ2JIRXgGRC6FeIgHvsHL+dVBLmEQofBMf4LBn28BRMCNBr5mUVDgDgGBoiuxFmUQo4hGCiETpiZBatUHeV8h3XKvR1w1AgFgFSNkyijxFgAeT4fdOAU5mE73Sj/CGAA1YootOAACFAQAFFSCKlINlJRUjP61TYT3DhADgrcNCuFSKnAAA+oVYDzjMFAaITtOBEAgIwKA9UMR4GWkCKhKlYgJGZqkDAEA4i82uuEmQMhOArjyPgFxdCGFyFlM2eilQFDaCGsoXxwt/HXS+rwlSYRC6EEMN9bYUApZFOif1KJAIbbXDEXmeGQYkYoGbr5fwRRKhJK2CiHxCSemMOuG0AAVjARwk1JRwBSU9bJnAsZ+PugAMTAFjGeTcQAt38IU8RcIUjFmsBVGZnB+krVlEzfxsSomxEYEcGJXVUjzKWVcdaPUjnwDgPEaJ+SYmMBuR0aZmQvrPNyfdFUspThTw2R0nuOymk3X2WADRWjTmcGWutS549rnRPnPcxgtxQVjyuPIXMCQ+7bE+Jo1qvycXPSBUnC6nAyBaJhVszpVBdnNIOToNAcgvpnMxYEq5/zcV3KBCuR5TKXmpHWjAOJTx3nHK+SsQuMQdC2EZa1UloTzhWUpcy6lQ1fmAvSDMxl8rslZK6rUI6OxtVGrZUcZg4hBD+BRCNW4ISwkusYi7Ke6w5ATwAI4lBEHAGoWMDlxA+TMrGfybl4qBCkQuogYhOCZTIEW+ZanRO9WqXxohYDTRRCzG58zc31MBlivM4Io1gEOcqrGkaUgovYM2hZPKcT8qxtEcQQJXHuICcpcRNRfnzKHg4hJ70JWivpb0SARwoAzzdEgliECjRrzkJxJA8CN54D8ZjYwOF/x4Wwc4YEp8PBAXPgQq+QQSG8LIJgaIPUWFYG6L0foYD4JGgNFYGBKE14IKCG+mqe9zAHlEnGc9SAjR4JApfKiD6wj0KiJKCYup8i0JnWUCoVQah1AaDITEDwOikGij0Po5wCZQTGFKcMMwvFLADRsEksodj4YOEcE48AYRHXHjcO4ZGngvDeIwD4zLaDfBhH8Z4gIQRgghBYKEPxYTTWRGiDEZRsS4gJESEkZIKRUgxLSekeR2PMgYzKBGbSUb8kFEewmAsMOsjOvKGIiplRqkMwzIYYYZT6ltIHC0Vp8Q2hNOHR0LpV1wV0ERGMgH/SBnXpeUM1npgQaQFBrBBETwfgQ7JJD4EH0nCfeQ6IXtOADBAL7E01gouNaa81xrNWf3xd3Fuo8XELwYT4glLLiAl7QfEn+eD17SL4LkshvAJU/JlQcECPmcAIByCGN03meZVulCLltoUVAGreJtVjZb2343MGgCsIEZXiSwA4+UEUQbYDGwyR1U7QbDpcDeSwf54gpnZKGAAKVEEUQs1hKh8M2zdbbLsJl2FyHAZUN33GMrEyuGAbRniKhXJkCYGmJw2ou1AK7UnRT5HoiuJ6ZUJkEsYNYTbIw1NNC1AAKk4CzBZACVtyHjW9CIspYnKFh8oaAsp3nxIiAs97MA4T/QUBzDtJ29sy5ZewBXlKvpK+h3IOEJ0xzq8++E1IgK1IgqeiuSoNApnXVePNYtoyxd7BgAKaabOOcKH+gCaJWvucwHjaYbciQlsGQUKORlqSLd5Euk9ZAWMyvKvJGgWYdIsbOmCLpvEiBCSQFgA7/ZWgTM0izTQEQSIiB/rhLQfEVYabx8+XCbEzAZAAGI68zJEMn2EGuhix7b3FDvLLU/p5xJn7P0AYB5/YAoQvcB8TF/gGgMvFeq81+ZIqBPjeW994H5o+E6KbUe4gF7qXyvecRJN8Cv5Iu6ScGcx1eZWMc+lGl+dy7OutQAH0Wcs4AOriEhgoN/h/ktAfp7mEFDr7iMuMo4BCsLoQFABxvcmYAqkNMtqtDQOcA+EMJtIkNtCkKErKCYH6vMm0Njrjuzl5CNCkl1K8KcKSInDUIutsPctkn1HmOgTCFgSVDgbYDtAQZwEQUCMUtcFapwHbjLg7rsEcAKHFPnDAJdDarHpAFblcH3pwCNPiMIkPhnvpk/pPgXg1HPtmovuXgaJXtXlgLXuvvXpvs3qIEiMoTAEiCkEiH3kiMkNEMDKQEMBdvikFOwC6ipPjmomjI5kZHAPfqAUfuAT7mdogFqPXA7kMNLrLhAPLiqF1FEubuwDIFACqJEAANxhacBeT7D5A6YwBZExI5FQA1CpId6hKDCJDK6pHpGZH/ScAACkcAgcKolOpAuR+RRRYA1opR/QmI7R2RAxtRUyDRdIyRLRqupAwQZgK4nAbayxKoP+pSeINQK2vcK0BwAIX0dgpY8gSc+RhRxRYx5wsoSxsOMyiMQhYAX024DSV0FUsxSeLK8RIx4WPMGxZQ2xfAux5QSoOghxCg8mJxVYOADixR5sR0nAyAMARQMgzoqEAYqgCJBsSJYOEO08pACQI0BOq0ACRCXAKx4+iARAzAAYH4RoAYC8Nc1oiJXAwiYyEyhJxJpJcA5JgQ4IT+NJdJH4FgkgwkzJOJPMSJQp/QZAJUMga+cwny+IdAEydI90iA+4AYkgUp2wXAKJaJzoSIFusJZA/4G6epSJqJYQ+J6wlJspeqY4YQSpyqqptA6pKkWpp4/4FgLJ/xuJXAjpTgCp+ILqpgqpaJH+XGCgECH4wkWoy2QZFkjsqoP+c6g4R+AeKQKowxKReuYAwQWMqI10mSnAAAJMAHNjAK4AAIRoillkC1m9rDGjFlGYglmKBPDpk3KZk9DQ5gD1mdmZK1l1FU7fGaJDD1xaghHoxBrtiRFAhYxc5na8xZozK/FTk4xJHNH8zXA35ywhiFhO4CiFjgmEArgcx5m3yGpDSHlFgnnMBnl+QXlXkLF7nMAVjK6pmrEQHbZwgrlyDBCNE1AspXEPSfmAUy5y76iTHVHTFDHXHtkVFVH9G5Fjn7lNGQUtEwUZGVEdHdG9FoV5HgVtnjEoUdHEUYWNE+Ffna4q5GorEwBrEbH6jAm8IRpgkHEdTHFYhmkOKXGtnhY3HlHImAmcDsWgn7EQk8VFp8VnEOJuhTIsqJk3nVmplbEZlZkDm5m0VQW67/5FnDlPCVnVl1kNldmkDNmkXCXIUWVlk9nRJ9nZmDn2VNkYUqVrI4y2bci8iZBHrIArajgVRp46FZ74h9DKBxBtBwi5jMD4h6Gz5P5lye5EjL5z6MBtD4gpEO6RAxZzzwQfgfiITbqwJQYgY5jK6DbAiJa5YSS4ITYyQXyUQlZ4DBAHHQDRD6UwXza3TaC2SUoYA1D+z7IIphDdwyFlA27IDOjRSDpfTBAADUwI1wGY/0RaeVB2zGIAIlsyCycxaA8agu8Sqxb4MunAywqwgaQhWgrQMIso/Uxu12/OScNQx1F0QweK+Ypu2w1B12lQLqpArwvVTxGu2wNyRaVS904BP1kuPUbQIgeQGpKQ62iiYuP2WaWSMeceZRMQwQH4kQ2hI+4VLqYAu4+e0+b4cQVepNrhTxs+pNH4a+/QMQcIH4DeaATeNcwQ8ywYd1txzBQhNyZql+qSseGpMgcIXhgRCuoVI+uh4++h0+hh8+peph5hq+EtHNTezeEt0tR0+ti+wYUQ8ICR25cA75OauqXAcsqg159FrR+oZK5wZQnReRNQztsIQlJRdlntZQ6gXxnelt/5uFftgcntNlPt5Fm25K/tGFB1W5WMWonYQI4t9IUtARR0stw+em4ViVFNM+RhJeJh6Vmt6dthetmdaAhtSIxtnhrUvhL0/hpAgR90LS68dmflr0R6RAFgcIwI/ddo+Va64CH4BoBoy8KEIkFVegcu1VtVMGeWQ2hWzVhCCkN8e5eij8/Yz8DkU0W8D86s38mUE4/8Ie+UFioCBVugxVXWO6cCvWiCW9R9aCx6QkNVZ6S9RVK9d6M2egj6ZCL6tqYgeGH829x9v8YACiM61itiMA9iScni8wR2QI65d8Mayq3yhcpwq2JAX0UAdq50RKAmKQ+OQwAyaDQcsaKqUStB8AuDjKBDYgRDhOYKpDWo5DNqlDSqnyWDdD3OeDwDOwXh0qbDTkHDBOqDEQ6D1DfDE8AjjDhDIjxDQR7Wn4C8JV3WSAE9qWfWIATDog89n9EkqgDVKYU2xWFJbVZWgDFCE8FU9pS08YN0d0KQw4DjfCajwkkg0CpVKE5V+6egRwHjDA6CJ4C9o2zgqgAEjVt602rV/9Njz6djV0LjQS3AEQ+AZQWMvslZMZrg8aNiCQdiUYHiW1yDegGTFIcmyg60qTt0QSXj/6AGfjyW3EaWeA9TrjYAVTKgYTAYETR8f4p4BoK9nI/g1ZeAc9192jl6k9/oAGVjeg44zjDT/idgFIZQvsUCY90Tu4C8kgFgDC1gdiOzXop4+zhzxzpzRouzFzBzRzbQJz8DZzezDz1z8D1VB8i99Vrgq6uYsAkEZO4o8sggpMnm5MfRiM1MtMpIbADMzmILAW7mZM3m6ozAfmu5+Yz9qCqZMEisrYB9KCtUmsD01olYNyiyuSfut+qQMMeY0e4RTw3T4IMuCgcIzwJsVwb0dO/ANQ0tQcbQ1MMy90NcOLBih6Hs+sYG+iZQyL2GKoYcDogcp4kQFA+sVWPstA9WLWureryr6rtcNcwdOuuFKz10az48GzWTgc4rukcIBj1kcIwT8qfCTYqz3TvTNc/gvchjiAoAgQ8gERKQnTCArgrgQAA==="}
import { Hooks } from 'wagmi/tempo'
import { parseUnits } from 'viem'

const setSupplyCapSync = Hooks.token.useSetSupplyCapSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
setSupplyCapSync.mutate({
  supplyCap: parseUnits('1000000', 6),
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Transaction hash:', setSupplyCapSync.data?.receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.setSupplyCap` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useSetSupplyCap.md","from":7467,"to":8058}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { parseUnits } from 'viem'
import { useWaitForTransactionReceipt } from 'wagmi'

const setSupplyCap = Hooks.token.useSetSupplyCap()
const { data: receipt } = useWaitForTransactionReceipt({ hash: setSupplyCap.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
setSupplyCap.mutate({
  supplyCap: parseUnits('1000000', 6),
  token: '0x20c0000000000000000000000000000000000000',
})

if (receipt) {
  const { args } 
    = Actions.token.setSupplyCap.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `token.setSupplyCap` Return Type](/tempo/actions/token.setSupplyCap#return-type)

### mutate/mutateAsync

See [Wagmi Action `token.setSupplyCap` Parameters](/tempo/actions/token.setSupplyCap#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`token.setSupplyCap`](/tempo/actions/token.setSupplyCap)

---

---
url: /tempo/hooks/token.useTransfer.md
---
# `token.useTransfer`

Transfers TIP-20 tokens from the caller to a recipient.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useTransfer.md","from":133,"to":11392}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"7775daec2b381b6bcd7a8eff1994271be08a51ae7321b1edd956fd4293c96767","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6IAAUoiaicACUnABmAK5gjowQYJxY4nAwAKpgjGhwwURhcTCInCKkpgoUnLDWLGFwZWBxzABGZJFlbYwKpmgAOrms7FzppJk5eUZQENYIegCycTJojFgm8Jyi5WiVipykMFhHmWBiaymcEDHbnC3tZJxtGHd9JKl0bGbn17dtERgnAAjBZOMFQV8UvI0JEAHRDIYAWk4ABE5k1OPg0GgsE0APT4oiMGDMOFwfD42bzfFxNYmNbwfHjSa5fL+MQKBbIZAgOiiVhyfwsNgcTjANIZbJsuCcVyxUgQZicADkxNJKsRYBZ0umwRVABYAEwWFU1SSRIaEzjGix2+0OsAgAC6zuEml0BvUxnkShUiFBGnE2iCOqm7NkpnMwJsdlIDicUncnhweEIJHIGkCeGsKREnD2ojAcBiZAAyhhEmUDII4WgBPI4XFMgAVePF0ukCuJOEAJR0cVIYBbXgAPABhFIxXo1BL8SAAdzAAD5/CJxLoAOyb2S+5RIYFGoNaHR4Qsd8uV6z+ExmJAAZlj9kcfkQADZk9QvGnfJmAvQmBGMUayMdcJBcI8fUUfdEG9TQQzwECbyjB8n3jF9nCNYFP0wVM9HTPwswAvQRVGAsGydd0NykAAOXdoP9ODg1PPR634eRkLvRBHxAWxn0TRAjU3HDv3w38OWzPR4kSS5UmbGA2yLEtL0SCcpxnTg50XFdgnGAUdDIOAAH5qz4Ws2MbeTFIvLsrzhAAFexmAMiY1LAadqk0sB5wgJdly6HgzLgOsKKbVt22U2ye37NBB2HMdJ3cjStN8lchjAfS4HSawgSsiLO27a8qGpBZ9DM2J2ALfKyH2BROBbABJeyTXI9ji3I7ZIGUJ5RCgKBTmCrUADkIBoMoW3wRhZSmu44CvfBFUgZssXK5RRC4BdRGmCrSALfAgXPOAE2SMAhnrZ4gVMawZDiWAoGuVIdjaGQ5n4C6YnYIEjliocqjuU5vkyOEOVELkkB5PlaAFDZcCoAADBH8loIZSLFCUQLlBUlVVTaFGYRh8RoEZNVO9yEiSK4AEEsCwYJomAIZOE4XNiy4CVmDpdaYBqKb7PkKA/vlABeQLDBCtqwoU6qousOmtSZ764vBRmmc4Uc2jpetSdV1WUnHExrH4IXgDpzgheXTgOYuGBgglesyhVCxaDhF2zW2ZgIASNAylBCxUlcSJXBVnWBaO56YCgY3ef5qog9SVXl2D1XrMipPR3xDWcRSRP48tMA44RuGXQoXk9OYfwy5c2UUUc+NnKcYLi95RWhyMZYLhOw54BWNBgddKjwNBA16L9A8mJPII8qUgqr048weL49CBPve8RLwnwMwk4jeLzLhDpnqtRfM0Kp5swq+wHIcRxwNyPNnbztNXAfdBNYeoNHgNIPgljqGlwq56QG+NCCZXwWDXt4Aif4aDb10oqHAHAMDRCtlzMohRxCMFEOHTE+8VLWAck5Kut9ejLhqBALAsljJlHblzAA8uQk6cBRw4JlhfH6YAABqxRuacAAEKAgAKKkEVKQa+3DmHn1rvpBuRCFAkK8j5PynAAA+XlYDTjMFAaI5tOBEAgIwKA/gSp4AmkCZBslYjk3MRgT2zMiy2JkDITgC48j4B0egzBchZTnT2L0bQu1uqW05uYos90yGyTCDIV4hBDAPW2H1PIJ0wj2JkACQ21x6F5mBkGMGKBS5OX8EUSoHitgohMW4opWDrhtAAFYwEcB1dIcAvEQD2kCOGZiToADEwBwz7iXEAZd/BhIYXCFIZY4jWByk0zgpTJqymkhTVIziHGxEYEcJx+1UgBI6VcGacAJlTJLCsTq91lmOI6JKJpEdWmBI7ikFUspTg9z6XkuuQyMnFlGWAQRwiZn1TmRYmSnczmrPWYwW42ygmd3kLmL2hlOqcBqpVEJTjGArIuY0zI90AlItIC8gZ+SqDDMyWMnQaA5D3VmTNBZ5iQXTnWQuTZNydmpBmjAFxTx9mTPgEchxrxSxoFsNcyqMLPbnHhXY3FJyLqXKxYijl/j9q1HWjsEVQj2D4qOMwcQgh/AogarcaxcRLaiHYoE1Y6w5BdwAI4lBEHAGocMxkHJ5XDVFKz6VAhSJE7YMQnA3JkFzfM1gImcCNWqUxvUYAIjACiSmKyAkhocakt6NKGHgidWAcZ3Kmlw0dSkH57A82cEzWWMlFK4bRHEECXR+jAWLIddKgJLcNFuJukCEFFzeiQCOFAPuboQBgRfsCHc78YJAOoMxIIZjYbGBQu+YBGEDyrw8F+dekCt5BFgWQsgmAq0ey9t0Xo/Q1weiQEaI0dEx3+gnd/IIAoxUMEjFxUdi8QGYXAT+TeREt1hAwVESUExdT5DQe2soFQqg1DqA0GQmIHgdFIAFHofRzgoyAmMKU4YZgYjwMsC1GwSSyh2BBg4RwTjwBhOtTuNw7jwaeC8N4jAPiItoN8GEfxniAhBGCCEFgoQ/FhDG5EaIMRlGxLiAkRISRkgpFSDEtJ6QJKZGGGUIMckQ35IKWdqM2aAdZNteUMRFTKjVNJkmQwVN6kNCaN2ForT4htCaB0zmnT90HWewS94J1yAYgeKwk6J54EsxGOdL7F0CVBJ+sS37/xbpODuhB0R7acAGCAJ2m5jRQHvKocc1g3xvnvAaccFhVD3iNJII0qhRD3jaDRA0BoeHWEkDATcqhJCqBiBYNo/C2htFS6e6igk3wxmvee48CFWIQAAYgK9b6l2CSixvQisW8DbvgXu1q8gyipadiaawzmDuHaO8du0/Xn4PmBDxHzH9x4TeoBRab0heJxnfeexbG6f14Ays5LKDggQszgBAOQQxCnMzzED0onBEqA6FMVHDegylwwBxDt1HsoArCBPF4ksAiPlBFFa2AGsFAobqsjq1a0uB7JYGi8QHVupDAAFKiCKGWawlRyFg+LBDy2dS7C5DgMqLH+jrkMYXDANozxFQLkyBMITw4lVo4xyx0U+QCwLhaVlOp4LGDWDByMATTQtQACpOCUxLdDlHzNA3TOccoHnyhoCyi5a4iIJayfRpegoOmxakfg7kHCXF3vpW+65/7zaQ4g8U9sakC58lsUtIXJUGgHUiyvBGrAOE1Snd7BgAKGNJuzcKBegCRxIeYcwDdaYdciR/vqQUIOa551E95AOi05AcN4uHPJGgWYdI4bOmCOJvEiBCSQFgFn0ZWg5M0kDTQEQSIiBGgNHCWg+JRBYAJp3nlcJsTMBkAAYi300kQvfYQnKGO3o/wUT81X74PnEw/R/QBgBP9gChp9wHxLP+AaAF9L5X2vhvsyIqF3rvgflfjfkIvCP8kCEXhACXm7n7hXtHjKnHqig7nSJwDpn9AEnDGPqUO7qjtABjnLgAPpG5G4ADq4guQigFBpB40SqcBCB7uVStSjgDy9uhAUARG6yZgCqnOcAU0NA5wkSQwc0iQC0KQnssoJgZqASbQUuMupu9kDUXi+0rwpwpI4cNQPa2w6y3UrwAOwhMIYhGUEhtgi0MhnAchQIoao0+0u06e0aWeuwRwAowUnAZaB0Sq7eXUXqqQV+nADU+INCd+Q+km+Br+U+JUX+Qav+i+y+q+6+m+IB2+YB++ogSI/hSIKQSIV+SIyQ0QH0pAQwHsYK7k7A2qskcu/CUMWmmkQhBwASzBSSZeKOiAWohcWeQw7ucInu+o+0DiCe7AMgUAKokQAA3PZpwPZPsPkGJjAMMU4qMVADUOdCfp7IMIkEgf0RAF7iqEMS9JwAAKRwBuwqjq6kBjETHTFgDWhzH9CYhHEjHXFrEdSbF0i9G7GB5mALicCFqkD6iUHRJ4g1CA71yTQHAAj3R2A0zyARwTFTEzGPHnCyhSo/ZHTaDSrrhpKFg5QfE941SdH3EOZMyAllAgl8BgnlBKg6BQl1QwlYjr44AaIzE6zrScDIAwBFAyDOiwQBiqDsmqycms7s69ykAJANTy5TSJTQJcDBD4GIBEDMABhlYBg0R5zWgclcA0I1J1ISlSkylwBymBDghKkqncQWCSDcSanClMyclKn9BkAZQyDAFzA8r4h0B1J0gnSIDbgBiSD2nbBcDcm8nOhIiJ4slkDviCRGjBmck8lhBinrAKlOnipDhhDumHJem0A+myT+lvjvgWBalkkilcDplOCun4jaqmBem8mkEkYKCebcRagA4Vn6RmyqiUFoqOK9jwFV73J3F9Hh5gDBBwyohFh+KcAAAkwA32MArgAAhGiFOWQEuZWncQ8fMZiJOYoE8D2Ssv2T0FzmACuXuX4kuesRrkSUIkMIXFqHUdDFas2DgUqnDBbnIG6tdBEIbqTN0XAN8azNcJgSLCGGWDngKGWHSYQAuHTMObvIikIl2eBZBcwNBc5LBfBUBfmMwBgJ+UCCLH8YIRDnCARcEFsTUDVMiaTHhQRXsQcS8SsW8bcSiTuYscsVcWMdeSBdsXRbsQMYcUsccWcRcVxeMTRduU8RxcceJTxVsWUfhT8eqkCcRYCcCaCY2hCfSX9EyXCayYiZEJJQ5qiQsVyRSZwFSWQlpXScoLpb1MyfCRom6B1DVG2YhQuV2SqIeX2QOaeSqHcfxaHtGqOeOReU8HOQucuaufuaQBucZbMexTFdOT5ZwMeYOWecleuTxW5T0gjGptyLyJkLOsgIDoODlAPhESPviH0MoHEG0HCLmMwPiFEZ/vgRnMXkSP/qviYG0PiH0VnpEC6AOkOg+JuP5tdjBKOnejmEgdNoeOFqAu9uJJ9noMEJCdANEPRQMZiaDDACZJ1BgDUC7KMh8mEJIswJiKnsgM6AFLWvdMEAANTAjXAZgvS9RDVw7zB4CmXNIlqfFoBuq26uJ/G3jRqcB4ZrAwz6H17ORokoEYq/kRw1DA2tJDD0r5hoGu4BInANCkCvC7XYkoqhq9QCzhKOJY1O71UiB5C+kpAg5cJO7U6Br+Jt4d7zExDBD3iRDhEP7VXapgCbiT7v63hxCr4C35F7Wf4C33jAH9AxBwj3g75oB755zBABLBitAwi8F2ErKYqN5s2+kyBwglHVHe6VUP6RHP7RHv6xHf7z6JEAEpEKZorK17775G2m3rRe2/7BhRDwhdEIw9E7HAWwq/AiyqAIXBUMX6hh3eynHjE1Bx0JW/VlBx1lDqCEmn44WkWCXp1uzJ1bkmVJXp2cCZ0bE94KV5VwxajeFclwxG0m1VHrTm334SbVWtXC0f5xFz4JHdWAEEyN0ZGe3N1oA+1Ih+3FGVTlGXSVGkDVEnRZKTrqZFVXSzpEAWBwjAhb12jDXnbcSbhXqTX+g8QzV6Ce7zWQRzYCQ0TLUxbymzXAXiJXimRiwWRgCSwpwHx4IxRxSiIyL3wKIrgDbgQGgWCQTH0HhfxTpnh/yzzPrRhX0vbzZlZ33LYP1rXxbraILKpiBlDP3RSXwcJcLKKqIwDqIRyGLw4gBlLW5cBcqHLxB8pdww4kD3RQAqo7TMpQopBy5DC0MRD0MupNJMM+qnBA5sO4M7AlHcN3If1aj8NKp0PlDCO8piPwASPXIcNiBcOQpyN8Py5AjKMMM8qiOaEaMyCSPaPSOVR6NUa8MgOejAjeiQOIBvxn0gDWOX2LXOBehoNQKSQhBYO7o4MPqHrPDHq/AqIJBqJRgGL73GgjauO3owN6BhPnDePPb8SviqDYSrq4QQIrUrZ6ALm/YEnu4M27Tu5lAEVUPfUI7vmEGWzEFWpC446zT45AiE5xDE5/SsFR5U74ws1077SM7M6iApkc6sHOR8T86C6KjY4i6vBi4S6KG+Qy6DSkxlKK5WpQgcBeLq7lA4D1DTi65NVsZokklDAF7m5IHfnW6yio0bU8EqO2DbCyjtH+4DE82Op9GB483B4jk0GR52BcAhox65RypN5J6t6HWcDOGZ7Z7uFkjXOm6cCtGl5NNV5iA16c4eQN7x5OIwsdSX5pFNLd6n683t1P7j7BRv7d32191JED3ZnpEq3gFktNKV10hVpgBQAX7s0enkuQGkBUuP4tXW10sxHyaMt/7MvO1X5u0ctCtcuwBQFwgwHovF5tFNPguoFyrA1bFYHoZvltJKlNM7PRpajkFUE0FVD0GMGwHauOKsHwHsFoCcHPM633DsrdRVN5gmGiEYDiHzRWHLS2E3JrPS5PCUyqHqEwDmOZDtByC6HIoGEaGCGBvkrBvmGhvSHhuMBmr2F+vwvP6ItuG56XUat10BJ+GjQBFpCcvBGhFitW20td123xFytO1AGKsZFZE5F5EFFFE7RlGfRYFz0L28OPn1HQ2vnNFMHOuIHBVwxXPV3B19GCVMXiWsWkmJXSVYjCWvHcVZ1V2bv7GDFHunHnE1CXGrG7tSWXOHucWrE8UA053+6/EwD/HqXeWaXgm2UMmcawnRkaJIlF37vw0Yk8p7U4liB4noSwsisknakAkqWUn/u0mQn2UgdOURwJmhlJl8kCnOMEdeFs6plwiSlgDSkTSykpDynmnP7KmqmXZGgamlk6whmcB6nutUdGl0cmkMdmmKnMeWn3jWm2mcc6n3DMfOmZlulX65n5l+kBnAhBl7sydhlhARlRnwmkCxkXpkdEeTNplycZnVlKfenWB01gCFnFnSflmyewCIDyfVm1n3FEeNk+KKAtn3juXAWeUizeW9lpV+WA5gABUfshXAsTlrm7SRX6TRXhVxWblsUHspeWWhfpWnnnnxdXlZ25UPmkxPkNHzt1S4EEX3O/lrsAU4VcBGtgU6AQXIsYUwBYU0XtlIW7RNdoAteVttcddR24VKXBVdnEV9HkWUXdc0WKXbUXtCUvssUp1JXbuvsdRV1BXl4x2LciU3s4z3srcHtrdvHyVfFgBbekVfs/sqUaXUk2XYfQkOX6UIkSVHdPvIAWVWU0naV2VPe4cGVQAuXnS5X1f3CdnBepU5cRdRcXejfbehVxexWznzlJd5exXxUQep1ZW7RQ/hcpDo+Xk5V3nV0FXgxFUwAlVlWkAVVt3iu1X4D1WNVKgSu0us8wAdXwFdXMu9X9W7GDV73uaDbGhPauPTWpM7zBXzULzIMCRgL5OiTL3+ALl4AX0JPlYjwwT+YYM0PSzuyPo+wlYubS8+NIDy8piFP32BPrX0mbVQ4CUXuE37VlCp7HUuzEqukXVXVgAYA3V3V6IPXPWvVkDvWaJ1OlS/UdRwwA1A0uI+sLhg0auQ2Wp2FaBa3w16uI1XLvGo305JQTBcCU03K43ar4085NKwfE0rKk0JIpBJJF/7JtA02xSyQM3tpM1DO07nSkvy1c080W24j81FhC30ui3i1FiS3aDS1Fiy243nAK1K1gFq0a1p9w2q7VrbB61I2Evt6N0+2t1VU0sv5Su20ytduO3JFAFD3sse30g+3j2T0B3/lB2AUh3BqPpdmR3Rc7el0nGJ1g5ex3uZlUuuXRvLZ03+udBbvnSTqPogBmIEAW+25bbFiuQwOurv3pBN156LdfvnTzbbH8O2Z/Xut20v6D0MBw9O/qPQf5aAAMMjGehOx9qL0yeuSQdGvQKSb1t6vsQXqNTcb3hR0rjU+hLzV6hZowMvbJs4FvoK910RTHXl1wIbWBX6x8CWKfEijnxf6V8BKHXkAaPxHGSAL0BNT3D+gFqAWO7HIJN5ZMl4r4LCP403SrZgmiWKRvgzgaEM2EnCdtKQxibkM4m4fYxEo0EavNGGKwdRqwy0acMZGdjGogo0MY2E/BJjERoEMTaaN2GoQ2xgrh4byNSYijIxjENUZmMWGiQqRro1SH6NIhAjfMLELUYJDLGIQnRmEKKH2MP6OgtxgVk17+h3GEvLxgg2XSm9uIBoawatSCZwIQmxRYzGUDhhOw5yTZVwG6miZ8tPBGiRoQaDfCi8DBug8bD/CMxKgzB19V8GAz6HFNwAmUbKLXmCqVMSKcgGpnNS+qlREcFrFppjgWbC5ccQhBot016YHB+moLLAh3xpys00aYAJnCzgo5TMkCPOWZlNHmbEBhc90UXOLklzrNDIcubZncOVyjADmGuY5trjOZKgLmCxY3Giw/J3Mrcv5dAq4i9avMXcHzc9l7h+bLttu/zN1Cik+YxcI8ALKPJn0hYG0iWLeFPD71LYZ5XCFQStvnjRYYtaRlubFkWHKZ14CWHUZvMnm76Csu8MfAfuK07r0tO2RAi/iyz7Y38ICSA3lvyzACksVWFLW/CqLwE20GW5/fugq05ZKtD8nLEVtATKSiimR35OxLHgNYuIjW2BBdma2Y63D0c/ua1hQWoK/Q6CRuBgpq1FGut9SHBWUGSI378ES2xhEQKYRzYWEpCS0WQoWx8JAgo2yhWNmoVaSJttCKbWTrtA36GFM2aYoNkMAiB5tsxNhXMZv0cQOEngCLAUWhU8I1tfCeBetrEiCIhEwi5ojupKwIEz5rR8rXtnaP7bZF62uRWNMOwgBT1SiF3cdqYAYHTsSus7F8k0Qq6Lt4COrO5rVxf7f8t2V7HdnAJkrHt3iFdcAVSMvbLFRKt7K8Vj1W6Xj1u94s9spWESKlv2aHP8X+3u4AdHujJZ7qB0MpwDuu09GDkTT5a7AHAb0fEkh1vIGdhSX3TDr9yA56VIJho1Dg6UI7hkSOQpTTk51M78caOxpU0vQCY4udLSbHDjmR144GlKJtHOZDRLM70TVSEnG0veDtJkTCJznUoG5yzJWc8yNnAsmpw04ETuO2nPkpGXjD6dDO8ZQSdxxM5AiuJIkizmJM5bKdJJqnIsm+BLJkdKyLpLMh53rJhBvOtUPzgF3zBBduy2XfHpF2G6kVEemXRLs5GS75c0ue7bHplzx4nkIuhPbKoVxJ4oDvku4yFqa1uYrsiRTSU8XDA3aIVGu6LZrmhUG6+RsKb/LgDVBQoZTWuMFbKZ10QqXcrURFACZNyQIUU6QVFKAncTm4O9GKn45bu+OO6tST250TbvD0gEtTnx+3O9m1PS5PsTuXUlpD1PorXdAJ7AO7tZVAk6V/ujlQHuBxGlmVPu6HSylhMA44dlpr3YHi0lB65TwezkLykFIyqw9ypzIsckj2nJeTFyoU1LteJx5ZcjyLkx6QVxB4RT8q2SQqoOkp7+BSqnsGnjAFHGEgGeTPJquzyzzs9OefVLUbzwGpRAuBHmA0K1haFIBxegWPQO7nmpvxthzgc3mum8Cchle+kVXvsQWHozRslgfoZ0hGGcB0smWbLLlnyyFZispWcrJVmqy1Z6sjWZrK1naydZusvWPGd0KJkFMv06Da3s8y2rNSbeFfbQAdVd6cATqHvc6k5G96+9bqZQe6uCCD6/hQ+n1TxtQ0j7nRo+SA2PnblBpRgk+PcFPjDXT6q52RsqZGiSL+EY1C+cqbGkqhL7iACacEuwghJJrxJyajRa5K7kb7N9bObfO1Hjk76/Ce+8/PvmKyH6C0u6Y/GshP3SBT8s5YAWfhzUVpKtl+SqTWmv29ahp9aO/BuhgP344DD+0Mk/laM1E2ir+ZAm/iPSwFj1R6E9agUZTlx1djpcdT/m5K+ZQCDeCdAurAPalPsEBp7c7o+JVDQCAB5wZ6XPO/HndIpaAmua7Trmtsxx7bdUYQJ/zECWW1/d2p3OqJUCuQq45phUS3ENDfp5PFgTXjYFb0d6FgFGcLxohXYVh3ENYUECEFg0Dw+M2Xq+AkEW8pZATbeLIKcHyCj4wUd+p/TgWsI/6GgpKJ5BSh+QFhkgN+K4yMEeNTBnQgMKArEEHg3Akgy3tLJgR2CNs1jRwdPFwSoKhwrgkoO4NmEUN4mJs+pjQ18FlCch8QvIVUKSE1CUhpiNIQY1KFCMc0FQoRVY2SGKpxFxQjIVEOMYCLmG4jYRQUNqFKL6hkivhdIoCEaKLG8i0RYotuR6LGhqgCwHwL/ltDsZnjFVGLPMGvZuIRoPYTrzWxDDyIow8YcAEmHTCyGnCqxZdgxmCQAFZ4KbMQuBCkKLBzgfiYtlJlUAVe59SmfvVya2LfMtM/YS2AgBlAmZRoLLDljywFYisJWMrBViqw1Y6sDWJrC1jawdYusPWNoPNQnQEyzergAdLmFgCAQVc4oBBZjA2EmZcY+MQmKSDYAkwdM/S4LLKEMzGZVQ6oZgOZmOlyCuyIEcWJZHCiMKZYcsUmNaHHChp2kQSZAqYBYaAxYW8kSsYsnBDRoFAGrTOFrCtw65+ANQU2iozaD4wmkJ0POHILhAzpbYKsdJvHRmX6hQQcIVQG7DfCRAKAKsZLI7FoAZZClLMkpezPKVcyqlvM2pQLIaXCzmlZoWFRRAdi7YLA+2E7GSvJX2h8V+cPOOeIW5f0eoB6c4IgDdi/LrGRkOEECrziLz6ZSoZlesRQVsqTaxmLlfLJVC5K+VVUbZefEFX1g84/geuKICQCgBAg8gIQikDPAIBXArgIAA="}
import { Hooks } from 'wagmi/tempo'
import { parseUnits } from 'viem'

const transferSync = Hooks.token.useTransferSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
transferSync.mutate({
  amount: parseUnits('10.5', 6),
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Transfer amount:', transferSync.data?.amount)
// @log: Transfer amount: 10500000n
console.log('From:', transferSync.data?.from)
// @log: From: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb
console.log('To:', transferSync.data?.to)
// @log: To: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.transfer` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useTransfer.md","from":11734,"to":12373}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { parseUnits } from 'viem'
import { useWaitForTransactionReceipt } from 'wagmi'

const transfer = Hooks.token.useTransfer()
const { data: receipt } = useWaitForTransactionReceipt({ hash: transfer.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
transfer.mutate({
  amount: parseUnits('10.5', 6),
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  token: '0x20c0000000000000000000000000000000000000',
})

if (receipt) {
  const { args: { amount, from, to } } 
    = Actions.token.transfer.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `token.transfer` Return Type](/tempo/actions/token.transfer#return-type)

### mutate/mutateAsync

See [Wagmi Action `token.transfer` Parameters](/tempo/actions/token.transfer#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`token.transfer`](/tempo/actions/token.transfer)

---

---
url: /tempo/hooks/token.useUnpause.md
---
# `token.useUnpause`

Unpauses a TIP-20 token, allowing transfers to resume. Requires appropriate permissions.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useUnpause.md","from":165,"to":6179}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"d93f9e8e1b5b8ad9644753f33d39aaff041fc2bd4761737cbca90bbd074879b5","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6INYQYCKcAK5gWKIRcDAAyhhg1og8fIIAdGgC8plxMACq0bHxSSmZAEo6EaRgACpeADwAwqEAZowKFJFg/JAA7mAAfP4i4roALADMsvJKKogAjEsa4tpBUTEF5db+JmZIAEw2dqQOTkgAbO6eOHiEJOQagUys7FwGgmOauqoA7HNFMo1GstDo8F8jAdzCdgmcLn5EEcLLdqF4Hr5ngF6G82BxODl+PIfhNrrNjPMQYh1NR1hC9ESSbJTLDTvZHEijjcPOj7npHn4Xri9O0oo5GKFIvFitsyslrK0Ol0elF+hAhsMABQxc7MHRkOAAfjSUOyuTA+RlJR2CsyAAV7PqnHAlWBOt1eurNQBKU0ZODm4mWgqy0qJO3VNC1BrNNrulVewYjAA6YDAon1cBi1hg0qKNvlKX8UAg1gQei+nHa7F6ctMCk4ok49QAkvaUYSLZk02mAHIQGhper4RhwThjpucOAK/CkUIQOKcQgCQl2LgDUSMNDjmukNd5tDnMIXSVgNM5TgAIzzpmsMgisCgnClzavMjL/GvMD3edINTqBsp3/bNQniTJ/DEBQK2QZAQDoTMsDkfwAAM0J3Wg0xYfEuGAdJDE4Vxq3nZhOAAck3BRmEYAB6Gh3jI3t3XFNAz04ABBLAsC1H1OGANNOE4EIwlwzhmAiMQaB6Md7XkKAgKIgBefCsiZENrTlCMUh4pjBP/aM6k4LUBMEzgmivCScnPMBTNM0IWhMax+EU4AeM4RThjEiTRBoLU8LUtIyIsWhMlCsjCJ9VwTNs+S4FEd8YCgFyZLkhsops0zhmi0ywwKbKmhoiy0CsrKMp9NN0rQlCQAAXQoODdUzfxGudQ1OAAWk4R09QNUhA1q+qQH0mMjAAWW81ipRAiIZDQCCarqkBxgkRArmkSlgUWJZJjBDY8FDQstL2FlDmRdlzk5ZxpiONFMH5Hwnkg149GE8ItnDXZ/UMIM8gOzTdiqADYxwN0PVVPpk1GYRfiQJYrgADiBBZYdWOlwU2Q7dn2VlQXhDlLksW6MQFLEnpFEAdXnHAOAwXjxMkmA0i1IhxEYeK5DgNJ3ttCpuszXrXXjD1hh6CAsEmsITU4caGYAeXFs9XW5otrEBgywAANVEB8YB6AAhUR4gAUVIedSEaHBwf+u0+davrQa6EWkw1EZOAAH16WBOjMKBeI8zgiAgRgoBLMsKxAEc83pny2LFFIJc4DBFyE0QbOsbWZE4AZt3wAPWfZ+Au0JUgum0fdlCjia2NT58xYljOMGXAMXxs0QoHk+vM/TmQZCvBwvzrxWILWaCkFgkAWv8FmS4L8dOsjvOZ4S8cICvAArGBHCLmI4HHS8K84FDo4lgAxMAUPmwbJ6oQewMyUIEgiaxc13jqW1HXcWLY7Oe+rRh/yzvgeQB4vKSTYpOOAT8X5wDFJnGuWdGC/xvJwHe8RnwH2PmeMi45pqzUvg1J0/hb5hHvmAE2Zs34jknHHCUUof6Z06AAxg7QQGYKlPIEIUQXRNhsmQCh8D6HfhQYbNBIC+HsHwRPQhN8FZ3wfjoNAchnzzw/tWL+dDEEMP/nmAYQCbIYKrlKScMAc5kGnFA+AMCZoyEbu0HQthEovn3BwxcYBuGp04OI/c8DkGoMcSYiu5cgGcCgD5ZstYvGSP/MwcQ3wqCdVbCwpOEQxKiGJF5WajAkJ/hgAARwiPAHcPQUIPwsbvFCCDf6MLzKEGxTZ2hOBATIHyhSU6/2SWREgqTYA9jAJ1div8D7d17v3NR8dFZGRKWAR+z9LEoWKaEch7B5mH3kcVJRKFeLiDzIHYOYzaFhB6PAg+w06iOJZjrSpmdkFdEgP+KA81FrLV0EseGVgNrI1WrtBkIBj64BOuYWkth8ZIiWDdXkd1vCCmxDQcmlMxZkEwLxAKnAUwgGCiiawFhsU4txXi/FBLCUWDRaSFaSxJCozkJtXGmg9qMgtNjU6VxzqImcOCu4ULSbCiCBmLMOY8yvQgHINM08hJgSFYzTg8Y4AStDuWPAC8UKCrkBU5g0AZp5iwPOIgwdC7NjgNhOQISYAWQUAoICyrDzrgnOOA11FmnlwgAeNMAApUQLMEjWBLuLMVYQJViU3nYMAY5SJauILq58V5G4DBNdeecAx4h9V6WmBeaqoAas8bQHCe8BhOuzJvZhjBrBiveGYNxnMmIACoOKH2lRKip94REIOUAG5Q0BbVP1zobQ+lrMgfgUDxFZSrxVyEyF4wdPDnzDr9aOzcdQJ3KB8inGyyCCjoKdQMEuNAi6p0bgOHpa9bVHhgJmXp1b2KcAUB+Pumdp0ypVROESqdcy+o9LURxl5N3bkPE65AKEw3QMyCIUsEkUI1S1PgYqWBOY0RopAWAh775aBoqWcsNFmk0BEO1IgRxJiZFoDRUQWBaIAcsZkSDzAZAAGJSO72A4uNAWywBQDTH+2jgZgN8LAxBqDMG4PQBgIh9gCgUNh3Qy0rDOG8MEaIyR+cgGKPUfY5x02PpMjvzzFe1e2se0jpgA2jxq7RHZzbRJCc7wOBAQPiheDjNLWqvVaOpiAB9StlaADq4hg2KDc854cwStM3t9femp69N5oGwa2wgUBxzbM4GYUx+5XpjhoG4mxaYZwpDnAuJcJh0kHyvPGxNHF7Stj3kAxuIEYDMASj0O5TYAEV0bslkQ8hFEYDTIbWc85IC5cYOkjOL5AmcH3TATIh7pzHszIGTgCQYBWrzH+yA26pTsc4K2GistuOQbQNBxAsHbNCeQ6huA4nMNoGw7h/DhHiM0XY+RtAlGqOiHastmA7VQjtXY+1SUvE9xpjVUw907AYkS2TWQ2giEjVxCswF69Om731sQExKqh60y9v7VqMiQCe4bvYDIKAZEfQAG40ywa6iXctaQccfizvjqAPRLz0YkujvTfaIADuxzAXHnAACkcAyI9AovTonpOwDk/tJTnc1Pue09zaQAnjO81oBA2gVnM6xvjrMAMTgSzSBY/cyuaDPQZXOlHIoa8bdlxEZwD7InJOyc0Qp6YHcnjTa1izHFbQk7JujKPA4H9k3YCm2R+Lp3gk9dpEN3wY304IBm6An3Z8dguLyESo72yTYuDIBgBcmqNJliqAz7ZJdnrvVzVIFEVsDQP7xlhVwLUtnEBEGYMsa6yx4blTD5npdsswuOEyJXsA1eqFwDr4EIyTeW+IGmBYSQM/O/F9MkupvLuyAZhkHd+TliaJ0E3hJM8iB/j/GWJIJfgkl057z+1TdNuyCrWREcc/WfPEXLL1khvq+3Hr+1lvssO+99rAD9Qgj8rhVoLAu9ycS8uAv8nAN8aIYlTBd8LlnMRBKcFBkRpgZ8mJXoYD+Z3JyJ3NNFOBKhV5TAZUwAyIxde050wAtQUIAARVOMuTgAAEmAF5RgFcAAEJOAmDFAyBuDNkxcJcpdOY+DmCzEiDf5SCrxyDQheD+Cy5uClcg8+E0wqomIjZIdWBocDULdrM60H1G1d5Q8NC0I0cUgwIuAGMCCNgEgptmAEh48YBCABgeJqDrC3d9xlJ7DHDnD9Q3CPD1dwhmAMAjC8xlJtdgsJVMgIitQGMeg+EHdrIwiIj2dOcac8cFdCcUjRCXdxCsi6ccjVCGMAdwi2dMcuced+dBdyJ5cCdRcM9JcCiZcecGiGci4yiwA0i2ctcYAdc9cDcjc4ATcXDlBE8rcU9bdEp7cRCncWiqdOBkBI9OBo8xZRi48E8Lck9rdU8fY6oi51DrJcD4t8DlIyJpDM5ZD5DKCxdeiNdMhaD6ClCzF2DOCeCJCBDSAhC8iFixC0hXj9wriSCyC/UwBFDJCfjVDjiqpIJRBR4UA4J4h/kQBkAZVahcxwMds9tYNzVlAIgrxMgQhmB+MENTtbNCpr0aIpNrsTArwaJe1D0fRaonkYZkRJhEYPlqRAQ0Y6Vgg9NGVzB1pgULoCZUQIViYHohQcQggtQzdoBeJ0jMdPcESYApZd0ehQp75ZEN9bZxDd1kAao/QA4g5nwtQABqJYF8J4D8NuFkqgE7PARY13S8FCZnNACpEzXObXGEdTcaTJbJBrBQCIfUctZdIRPxTo7051BMPqLgNdJscrTVEuGJUgRuVU73eBQbNuDuM8HTRM7tSBK8EQbcYA6yC5ApW1FgRBcQIuNjKXdoLUaYH0bbKDfbBA1Of4JDETA4CIAjGJPpGIbQU7Qc6YLfF3doTIaYB7SjLvLUA+dYUMtrWLABQbKM+slCA/GQTIPcUHQdbE3jDsw7QMYTUTNDDDQpS7aTG7Wibc2c6jbcvcnyZ8i7dYOAH0NTFHCwuAEIrgThNxAg1QTwx4qogCtANIXnQnHocCv453JY8CtIdQIuD0kI2IsC1xCCuo2C+Y+C6XMVLhJC1Q1C8+NCJiObRbLc1iHc18g8njXbPjE8ns8807S8yTK7GTW7e8xTKjJ8kHF8/it8rQD86sD3dgW8YHUgUHM8YeOkRE8efQ3MKeCwTIJYVS7FVk6GMkZEVQZlbkxYCkWlH5ftIUqQFlS6JAeGIme6aFMmIIU45WI6L6VSbsP6D6SMIGC2GAB2T0NUSGUlXQI4eGSlKkLaVGIyjGa2YsAFMyvGMUpEaYaYayzlR6blPAeFamJFEJMJLmTGDy9WLWS5D2KIL2VkEOR0sOBVYJZpcISBWZXeWBOpECIVEgZ8UJMQUSoJSuMBUIcHFNaqw2LgOq6BRqyreAFqxxdq5sPcVhQxS0JifqvMGqoaspKxHuMa+9Vq7KjqmagxHq+a6yRazgZa8xeqtapq8amQLaqazq2a/a2S55Y4SQCkKlT5HaPkn5Ka0ylwcygmSYVQZKzEVK2U9KsNTK2mTgf8XMD/YcY8OKA5aoaG8WAKp69aV6nk75IIKGkxZGmKn6uK1lNQJYQGkmYG+vUGqmRFCG/3E8A5bgQ2fANIFCYKdgtAtKCpYq5jH8MquVcOemuAXOCAFhCYveOG08UIFGmfCwXk9GraWkCKvAGm+GiWfmlQPGkUhECymkNwSU+6KCfwTgvAEyrSlaa6d62WpAd5cmvQeoMWg5a3AWtIYKMFaYf6q4f4eGSQCweKawL2F2t2j2r2n2v2o4V23SwO72q8X2n8f28Oz2yO6O9ob6lYX6pEVERaEIWAPED4PiFSccIidoEieohE6iOiarNgRiE4rwxy3YAgs0NSK0AsKK6wHSaycnFoQbI+CafTR9SG+ANgMIQPAobxe2rUMbBQdTIqKyISRyfgHoPc8xK8aiXeM8LvGuu0P5PyEyFFIKWgTFIlA+w+glQXCqLvNC0dKo221OZWtiOwR2uo9eioKao0QfTeHGuaJW8WsAVWrvfwZ0UQJAUAQIeQA1CWxkBAVwVwIAA="}
import { Hooks } from 'wagmi/tempo'

const unpauseSync = Hooks.token.useUnpauseSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
unpauseSync.mutate({
  token: '0x20c0000000000000000000000000000000000000',
})

console.log('Transaction hash:', unpauseSync.data?.receipt.transactionHash)
// @log: Transaction hash: 0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `token.unpause` action and wait for inclusion manually:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useUnpause.md","from":6520,"to":7013}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'
import { Actions } from 'viem/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const unpause = Hooks.token.useUnpause()
const { data: receipt } = useWaitForTransactionReceipt({ hash: unpause.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
unpause.mutate({
  token: '0x20c0000000000000000000000000000000000000',
})

if (receipt) {
  const { args } 
    = Actions.token.unpause.extractEvent(receipt.logs)
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `token.unpause` Return Type](/tempo/actions/token.unpause#return-type)

### mutate/mutateAsync

See [Wagmi Action `token.unpause` Parameters](/tempo/actions/token.unpause#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

* [`token.unpause`](/tempo/actions/token.unpause)

---

---
url: /tempo/hooks/token.useWatchAdminRole.md
---
# `token.useWatchAdminRole`

Watches for role admin update events on TIP20 tokens.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useWatchAdminRole.md","from":137,"to":4971}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"149a552ec742b4dd66646f0d767625b9e60928a7afe48d207c20bce63c3d7530","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXGgC8lGaugAssUmKymoamTp47fydeWZIRSC29o5+iABsVdRetb4NAfR4AGYArmCOjBBgnIdwMADqomi2AIJQzKYAShByADwAwuf7jAUAD4ABRYezMHRkOAAfkQnGAAB0LpxUQtTABJKBwzhgQ7MABGZE4AB9LmBYACzFAANzI1GozKw+FIlEMhmkT4wHEAAwstAAJMARKRTApXDzSZw+YLhWhRYoJcgALpSvEyGRS46U/K0+nshlmADuz1eYA+cl5/KFIrFEqlMpt8rtPJVasOGq1FJgVJgerZBuu3tIVtltsVkrJjrlCvFrtVZPVmrJ2p9urpAdcXp11Iz7P2nOYACEZBBrPwcQTAaYuCnvb7/ezzgBRUickPwkEgsjt+Gt9sASk4AF4gZwiBBGFAh3Wc37s2nc/rUWwNTj5YcYAuG9v08vOKuTIoMWAnERRDIcXjCcTZ4v53eG3mGecLTBTaYAKpYKD3P04rsmXhI17ieF53i5AA6R4tDgChOFLBRgNA/AP3NKCABkIAUIdR3HSdp13JcAwmeQcQAFQ6MAsQAeVIZ4oFIeA4CIv1nzRf5ARxP4wABBRWMbBl5FEAk5GxeECT4ORRAuR9dQEjNXAHeEJynZEwFESE4HBawtyuW4ULQt9/CgMsED0HJOH2dhOBAh58DFThyIxAAFAoLE4UiLk5OROFEcCLkOH8/zgSD/DEBRzOQZAQDoTSsDkfweWStA4FoZEQlaBFwkMTgswLCBmE4AByECFFeAB6GgWmK5FkSOE40DOC5HiwLAQSHVlURyUKvMg/S7nsoyuRBLqX3QuQ0O/X8aCgEEmU6/cOLAOAoMQkFirfPyAsuYLZsQYr4IW/d3H1JS6pRJi0EOUgLi+KBGCIIFBtsRzrNITgfK3fyzV2mb4EgwGvgqh6nuRVxkWSnkQGVCgYvBUpmH8BHNKhUgWIAWk4FyITR0KYdhkBogkRAemkYxkiGRAAEZEgyLQxj0AbDIC4zpkKYpFnKGmCnWTAaj0Oo/EaPY9DBTkcA4DAh1fLkpr2/9O3m2DkKG1moJgyL4MQ1WwLNN9IKwnCRzHVTCLk6kTLMvAfgvGQCQcfhPIgThTAnSZbPweQ/M+rltt+xgWKC/6oDC4RuiQeJqYGFIkGpgAOEYGaCWXJoC6a/ygfwj3Mfp5hKMpll5jwNgFnx6nCpoxZRyEnCHICEX3L74WjcM43Y3EYBNdW5Bb60YxdDug1gUg+7DZ0I0UroYikOY5EGVIeiTrI8CZbP8iQPOFlKJZnAKWI+c2QXtkr0WQDBXG64Q7DddQnuYEN7Dp5JyRE4phfN+XxnjCf9nP/zrmRc3Al35t4IWOwaBnw0lpHSW5rDnFWnIZE54PrwJWlyeEPFEG4CoKZaw5kQDkS9tKNB2DJTMGgB6LcWBORECnPAH2cAQi+VgASQ4CgFCOVIX7ZQ9xXYsSYa8GQ4hnaeS9siAAUqIc8ABlawoosBcG4b5SECwwCByKjQ4g9CoCcAJBgWyMACR6M5Eaa46NIIXSIVuChUAqGcDoKEVKnkjQu20jAawjAATWE4PAloZhTxwEQBdAAVJwR40osFcklNYYRcAWJGkYMoTgtdCBQAEYcWwfkWI8mUQ/daA4eTwVyQgqCPZ2AdUlDJXRJT0FyEgiBW6lSxF8OsDJPRelri6PaLZUUNBREyQMQAOWgA/AAVgI+UMBNKWLAGEiJChSwO01LUshrsVpiBOHAziCgbrzh6UaPpW4enIB5Fo3S8TIIiFMocNAPJlQgnwGgNAWAgkVQqpAWAEzILsAUCDMyFVhE0BEBjIgBQeiQVoBVUQWBGAVXOcxSCTzmAyAAMQIvidciAtz64UmRKcjFoVrk9nuY855rzEDvM+TAb5vz/n4MBSFNAoLwWQuhbC+FnILmhWRWiwlxK2wDkgk5YhiyIDLJIaUuQMT2lEkuF02ySTCC3Ndi0DgjllBbh5NSxAeTyGUPqRdAA+iEkJdxbpilNUa+E1jOBiolXkzg4qxkeLQMVFiqToAsXEFuMwSriSkMDjQU8MgMDIjgBgE4+BOSQCuAhRgHtNUmIgGY4kjwXIYhYpqgxTFriEjkPBSAH0fViJgAYwNIh5BoFDciUQEao0xuxSxEwHs7ZOs1R9EZsBIITM4CKaZzBQqcBkTAY5xDTmQH6ecA8XLmKcAxBVGipKnkvLeR80ZtKtD0rgIy4FzKwUQqhTCuFhKkVoBRai0QGNJ0wAxucDGhKMZnCHO9ZEFCmLrPeswe4zVZnImbLQeKvkrgatFUsi8kq6kwB5MEsAkNkoTORHkyC61ipew1C7VxpAZBQGKgODM7zsYKlSvCdDpZbLsBw/BHpWLblIalfk7CG0yMuwAKRwEOiVLDOG8MEYqkRmsQTOAsYo9hqA1G3FoBuWgejUHILlNICCY0nB+wVOKjcQgEBXnwVWqkxyDtdF2DavIP0eH8PIkIy5YjLEFMpOYqIbQfkKR9rEOWTyO9jmSZHqPCz/HUSqdHpwDTfBtN9sKjoByig9H+WEzCnA1JfMGj4cgGA54ZDKjSDTVQiX2R8LkQotAkFSDHBPEQwOPFIFcCU6MxARBmA01iAUGm8cBw5YZHwmiBIXWOCKyVsAZW4AVcCJwarsBav1diBYSQiBYgtba4yLgOqaxkA0jITlZZmIVToB425zVEDxHiDTSQ82/JcBS2l5UGNDlxbIKsRABQCgnb4ali8+XGCKJG0t08K2Lzre5Vt2gO2mrnH2ysVYFhWtgEI7lxbNXlu3V+9+0wW20tGrbvd2IM2LqkMW6jEcJUbiME9B8Ks6CwDFQzMhxpYAQQ8gACIyW0B9IU0CYCuAAIScAZ4oMg7OeTmah/xqzgn4Tc6Z0FonmoSemFWmATnYvecSZc95+DPILoAaA500DWqonSt8XEoJF0oaIZOAgrg2KuDDjtToGRUzNIyPC4QI0HVKdm4cW2fHWRbdMXt47lNLvZMiBSRgXXW4rfKeQ6HkEFv4I9gF2+kPDGUNMbQzADDomeMC8s9Z0jafyPcfE6Ii3CfQ/J4UMxvPbGOPwVKpR3DWehc5+E5XjPheenF7AMwRPcmFNKa7iptsangtabgmFvTUWDOxeM9SMzfGBOBPhMgAL8Jh+hd0xF/TMWjPxb9LDURPZsdu9Z/j9TkvODS7JxTkvSfqe04V8z4ArOOdc8Z7z/nc/hcL5fzzj6hPifipl3OHl1f1IHZyVwPzAChnCgcyihimuBwRAGQFWhul0geRXQpXeU4WUEOAJEgj8XXS+R3WpQqlEnFQqgPTZRMAJAqmQwmQHAJnDhnhpmpjnkplSDpk0BXj0DyXXhmFJk5h3m5h6EPjLnAVPiCBBE9UIlL3Wi0jgAc25HhEGXgkBh+UUWagvBxkRiE0GRVGUnwinBGwAGpqYnV6hSx/J6DcFrY9BP9nEekeRaM7lFVkljQc5hUABZD0JqBKb6LQfEKtFiNpC4OVcEeJP0eCRJZJTVeqRgdGLgfSXROtUtGdFgcQAxOQhQpzJIz0fyB6YHVbeVecZIuAHAkQJJXbc4ZBC8TcARFgInERE5M5YjfYEEWIQpNA8lSlCqb9MAeIH5LdI8Q4KFXoh9BQndXo2ITlGsfYSCWIM9FFSHEEJNTIAIwJPyD9NtMIhVJo3bGQSCL9e4SpTo1dbo6lTdP5PBHdIFeAfdVlI9DlPYhYtFPYw4tAN4jGBaIVI3BDOAQPJRbFU8fHVQV3OTVDeBY4NAeEVjXDeCCE08BvefEjXxQEqEzgdQURJwwPNaFPeEqEzjPExEuwoTPE+EDEmjKTDvKGC6EdLcU5J4t444slU4qlDdUKOlK43dW4llQ9dlOFJ43lVFV49gb9d4kU+4T42CF9Gyd9LcUwN439aAyKJAaKImUwXSfwIgCwSCamHUiwCwBgomCOHmKwd+WOGbL+IIRCXg8wJeABQQ5YFgkQsBE+EWCQmuNGeuFWRuAMZuaUfuNuCUDuY0YaXuf08eWMIM/cYeW7cMp0SMnkKeRgkmamWIPOeec0u0zg7+NeP+fg+0wuPeVQZ0rYCuN0vAcWLTMgTAIcLyCiKiWieiKARiOdC2P0K2fBPABiXNFiGyDEOnJ1fYFI5yNyDyPqZ+XQamHoFYGOKmdIbMoILyG0pAGcgs3eWYVwQmeBWAZoJxbKHqPKKyQsLjBzSqaqNgWqODMAHqSCPqZmNWfWEaMaVOd8dOBWKATsJkbWbCXCMcMaZabBMvDaICTjY6FEU6FELyeEYqfkdyawfUhCxCpC5ClC1C/Uw6cGKwkAWuUQJAUAQIeQJhc4cYBAVwVwIAA=="}
import { Hooks } from 'wagmi/tempo'

Hooks.token.useWatchAdminRole({
  onRoleAdminUpdated: (args, log) => {
    console.log('args:', args)
  },
  token: '0x20c0000000000000000000000000000000000000',
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `token.watchAdminRole` Parameters](/tempo/actions/token.watchAdminRole#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`token.setRoleAdmin`](/tempo/actions/token.setRoleAdmin)
* [`token.watchAdminRole`](/tempo/actions/token.watchAdminRole)

---

---
url: /tempo/hooks/token.useWatchApprove.md
---
# `token.useWatchApprove`

Watches for token approval events on TIP20 tokens.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useWatchApprove.md","from":132,"to":4824}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"1549f2859212b937c8657167655eeec354f9caa629bbd015ce5aa6a9316baad6","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXGgC8lGaugAssUmKymoamTp47fydeWZIRSC29o5+iABsVdRetb4NAfR4AGYArmCOjBBgnIdwMADqomi2AIJYWKS+ADwAwuf7jAoAfAAKLD2Zg6MhwAD8iE4wAAOhdOEiFqYAJJQaGcMCHZgAIzInAAPpcwLBfmYoABuBFIpGZKEw+GI2m0iAAdzMpExAAMLLQACTAESkUwKVzcomcXkCoVoEWKcXIAC6kuxMhkkuOZPyVJpLNpcBwpLIPL5guFovFkul5rllu5ytVh3VmuN5JguuZnFcru1FOpXv2b2YACEZBBrPxMbi/qYuMStTB3Z6WecAKKkN5cmGAwFkLMwjNZgCUnAAvP9OEQIIwoKWE26db6kzqAyy2OrMXLDjBm8m+629UiOyZFKiwE4iKIZJjsXiCQ2/R6B/6h5xzs9XsRp5jc/SYWz7k8Xm8SAA6R5aOAUTjhhQHo/4TenmBngAyEAUpYrVZrdZXHptrSEzyJiAAqHRgOiADypCPFAUCkPAcAASmtLWD8fyYt8YC/AoqFAUi8iiLicgYjCuJ8HIogXIuLYUgRCKuMWMLVrWCJgKIYKGg4vZXLcj7Pr4/hQBGCB6DknD7OwnCHg8+CipwYGogACgUFicCBFyiCe24ajAJATnAZ7+GICjicgyAgHQXFYHI/jco5aBwLQCIhK0sLhIY3pScGnAAOSHgozCMAA9DQLT+QiCJHCcaBnBcm6AqWTJIjkxlaWe/F3PJQkkICqWsmAeXToC9IpWuyLnHAEByGed6Av5JUyIg/k3uVa7uHqzHRYiSFoIcpAXO8UCMEQ/w5bYinSaQnA6VuU4yMZZ5nu8oWjeNTEIo53IgEqFBWSCpTMP4R1ceCpAoQAtJwKmghdxl7ftIDRBIiA9NIxjJEMiAAIzpJoWR4Nlgm6SQ/ijoUxSLOUf0FOsmA1HodR+I0ex6MCbw4BwGClhuYM7jmZVXg+uVg6+l7mTed6k8eC2vh+X7lpWbH/nRyYiWJeCfNOMi4g4/CaRAnCmNWkyyfg8hC5MYAoeIvbzS+UAmcI3RICsn1yIMqS/VYGRaGMej4wt04Q/kSD9PMJRlMs8MeBsSM+PUplNBjZ1gk4pb7rCa7spyMI2rK8pityhGcIa8iwKQAdmkH9ph1xEDHGgFGxhOAauF0MRIAAHHMWspEgPQjAbQT0mbMyIJbCylEszj/QjmzI9sLvoyAwL3Z7t6frTT7k++n5Z29Oc5wMhdVyXQN6HeFfmNX1t17Mv2N47KM7DQbecdxILWL2GGy7VMAIlOs37zVcgwjh5+4FQonWOJIBgZLUpn4fErMNAzq9gttbwHN4chDkJwWAuJDgKAUIpV+QDlD3BFihOALBGAyHEELTSksEQAClRBTgAMrWBFFgLgUDexggWGARgcBmCcB/rAKAnBcQYFkjAXE9C3hsmuJdM8vUn4kM/kAugoRnKaTZMLCO1hGC/GsJwDCLQzBGUQL1AAVJwR4Uor5v2kcguAKE2SMGUJwD2hAoDwMOLYOaKFuTEPqp+ZK3IbyWOqofM8+Z2C2LmqSF+ji6qHiGm4mBRCaL0L4tcOh7RZIihoKgmijCABy0BXwACt4FyhgFxLhYBlGqIUOGfmGoHEHzkBKUw0QTh70wgoQay4wlsgib2MJyBuRbl3tos8IhRKHDQNyJUgJ8BoDQFgOAiBQqhUgLAJJZ52AKHWmJUKyCaAiCukQAoPQzy0FCjpMKTTkJnl6cwGQABiLZ2i2lJzQF7UkCIGlHOMm0/MXSel9IGUMkZ8TxmTOmffWZ9x4BoEWcs1Z6ysCbLeM04yuyDnXNuZmYsZ4lLP2yRAXJniCkwAlNYQJ+JLghNknowgHSRYtA4IpZQvZuSjJgIgYh78+Gvl6gAfUUYou4Q1RSMrpTCHhnAEVIuIeuXECSYCOH8ihQx0A5ZISxDAXFBIz4UJoBOGQGAERwAwCcfAbxIBXFvIwcWJLWHsg4SolSqIUIksYUha4eI5A3kgLNeWaCYCMNlSIeQaBFUIlECqtVGqk4oRMOLXm64SWzTibAM8STw4pK4sZTgOCYB1Ofg0yAkTzjUJBchTgqJQrQXub0/pgzhnkreVoD5cAvnzN+UslZayNmhWuTstAez9miCusmmAV1zhXWuVdM4pYZoIg/hK0wM1mD3ASukhEaZaC2SAVcYl8KcnTmRdfbkCiwDbUckkhEViGr+UluqYWIjSAyCgP5YsAZhm3XlM5GE+7wyyXYCem8YSTkdO3V418u673CwAKRwDagFI9J6z0XtCleuMgzODfofceqAz7RFoHaWgd9KLnGZlcWYNknAiyuP8jcQgEABk3hqoYxS/M6F2BePID0Z7z0IkvSpa9KEXGzW4nAUQ2h3F0OiJGTStc6kIajtHejYGkQ4ejpwfDfAiPhwgKRxQ9DRAUfmtRqAIn9SwOQAZacSo0h/VUOplksC8EELQGeUgxxxxPwoThDeXBATksQEQZgf1YgFD+jnYshnaSwOgvywVZmLNQTANZuAtnAicAc/EpzLnYgWEkFXTz3m6RcEc3GMgnEZB1vTdo0KdBBUdISogeI8Q/qSGS3NLgWnFpKiujUlT0cViIAKAUCrsDtMyBM4wQhkW0sTgy9ObLEZkJ5doAV+K5xitNZWBYLzYBL1GdS9F9LQ1BujtMHlxadKLSKGa7EKuvUz6pfOuWAKNwkEagAEqIuKecfyAYrE+LAICbkAARGi2hZqCi3jAVwABCTg73FBkD+9yOj82wOMYgzCIHn3JMXc4NdmMB8wAA9hyD+DkahMbu5L1KdM7gnztJeowpmjPWDN6jtLdJxqpcFOadrIOCo3MBwXJmAhA2TJQe7Tzg+YGc6CZ0hLirOwQc65yhkQBiMAk97GWSVWGrEy8BKcm8+ZwcDulx+6xChGrQaA6e8HDGmO3pgAemDT7UGnI1zL7XuvTf3r/QBwKj6DegfA/IqD9vD0u8x1bsAzBNeoZYw5mAWHxONSk4R68sn5P4XI1BlTFJaNu6hx75A4mYSR5kyRnQCkFPx8o0aD0+1UH5kOzzn7p28MI6R7dsA93rda6ey99HX3gA/f+4Dj7IOwcp+N134Hs1zsulryjtH3fSB/cx2XsAO1TIcYslZa4N8QDIBqoNXe3S81POGRA5QhxcRnhkS8sZZbyWhVIoi0KVaAUmFxKFKxSTixPVVtnP6Fh87fVSIkfWU95gftniLmhlrlhh6BXm8DXlbiCEBFFX/BtwajYw4xgExGiRvBWgmUIQSmnDumOkg2iWVBYl/FrEiwAGpfp1x6hwwlNn9b4uY9BU8hEwluRX1OkcV9FMNIZYUABZZ0eKOyBWLQHEV1FCdFC4TFEEbRD0G8XRfRElGKRgS6LgfiOhT1B1NNFgcQRhRAzjGiFQl0JTUaCbTLLFZcVQuAA/EQPRQrc4Y+acHseBRBZBWaepRpa9fYQEWIYsXNR5Z5UdMAeICZEtUcQ4NZPwrtJAstPw2IbLOMfYM8WIBtPZObQEPVTIIQoyOaCVQNCQ7FFwwrGQM8Ede4WxLfR5AtE/GAYtKZO+MtOZH5P5atQFMKfIxIg5fIootADoq6cqGFSnTdOACXIhJOCcU7VQbnVDXdDCZOGEH9U9G8KYicQ3SHfvBYlOTgdQVBFgiXJxSY4YlOADVYpY93G9aRPYmEDYl9RDP3HaXqONXsBpFojokoh5fNZ5ItYyd5Go8teom/GtIFUKFo8FfZdo9gUdTo0E+4boq8PtGSQdXsYdCEowlWDIcyJASyF6UwXefwIgCwM8X6PEiwCwF/F6NWP6XWMeH6S2QGQ2YwQeaYcwYuK2GGZYX6O2aoCAluNGaA92C6L2EmH2L0P2MgGOGUHbEOMOCOY0CTQOMU8UBOD+aY+hNONADOIeXQVky2AuH6Rk6ksuK8QA96YAm2ZwAoVQcArYZ2LkvATGQjMgTAUsLScCSCGCOCBCC1FCdmHUTme+PAeCRCDNGSVEV7dcfYNQ5SNSDSTKNUpAX6WIFYCk1IAGUYIILSA0+MpkkA22VwZ6DCWAZoQRTydKHyIMOTQDDjEKcKGASKXqdKM8TKEGMmemAqPUY2U8acHMekamT8b8SsQqKqCYmxfyfcADDqRELqRELSGEfyPkdSawQk+chcxcpc5clcwktqJiGgkAD2UQJAUAQIeQBBc4cYBAVwVwIAA"}
import { Hooks } from 'wagmi/tempo'

Hooks.token.useWatchApprove({
  onApproval: (args, log) => {
    console.log('args:', args)
  },
  token: '0x20c0000000000000000000000000000000000000',
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `token.watchApprove` Parameters](/tempo/actions/token.watchApprove#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`token.approve`](/tempo/actions/token.approve)
* [`token.watchApprove`](/tempo/actions/token.watchApprove)

---

---
url: /tempo/hooks/token.useWatchBurn.md
---
# `token.useWatchBurn`

Watches for token burn events on TIP20 tokens.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useWatchBurn.md","from":125,"to":4714}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"6bdef3454b786456322850b22fda9f6b5e83f7c766139b4da151ac51f819efe7","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXGgC8lGaugAssUmKymoamTp47fydeWZIRSC29o5+iABsVdRetb4NAfR4AGYArmCOjBBgnIdwMADqomi2AEKHpGAAPADC5/uMCgB8AAosPZmDoyHAAPyITjAAA6F04iIWpgAklAoZwwIdmAAjMicAA+lzAsB+ZigAG54YjEZlIdC4QiaTT9qQIMwMQADCy0AAkwBEpFMClcnMJnG5fIFaCFilFyAAuuKsTIZOLjqT8pTqTTXOqSTAyTBtUzOKz2Y8ZBBrPwMTjfqYuESNYatVTTecAKKkNmkDEAgFkX3Q72+gCUnAAvH9OEQIIwoBHnQajVB9Zrye7mWxVRiZYcYOnXeSi6mszScyZFCiwE4iKIZBisbj8cmM8bS26dYjzs9Xv6AXToQB3e5PF5gAB0AEEtHAKJwrQoR2P8H2pwAZCAKCPR2PxxOdzPdzgTeQYgAqHTAaIA8qRp1AoKR4HAj8by0jvr8MV8wD8FHfE1mXkUQcTkdFoRxPg5FEC422LDsELLeFXDDaE4wTeEwFEUE4GBaxCyuW5V3XfwoGtBA9ByM12E4UcHnwYVOAvFEAAUCgsU9r04HEJ04GASFrOBJ38MQFCo5BkBAOhcKwOR/E5JS0DgWh4RCVoYXCQxOD1c1mE4AByUcFGYRgAHoaBaQz4XhI4TjQM4LmnLAsABCNGURHIRLPKdiLuRj1wBTyaV7CdBznDyTy/MA4AgORJyXAFDPXRBDIXOkwxPdwdTQ2yERfNB+LeKBGCIP4AtsZj9jovjXhEydJzeczSvK1D4SUzkQAVChpOBUpmH8frcLBUg3wAWk4NiQVGkTup6kBogkRAemkYxkiGRAAEY5k0LI8H80iJ38KtCmKRZym2gp1kwGo9DqPxGj2PQgTZHAOAwCMwv7aEAyHeijteGc5wXJcV0CidJy3HcoxjTDD2QrVyMovAPgbGQcQcfhuM4Uw40mej8HkbjJlizhxELOryVE4RuiQFYVgGFJ6ZGLQxj0b6wBO/IkH6eYSjKZZro8DY7p8eoxKaF7htBJwI3+kLEX06FJX5QVhVFT9yeYCBjjQKCHVrd1XC6GIkHidI5EGVIelZ/a9DpbmZkQPmFlKJZnC2rabs2e7tkl56QCBGa5cXbdwfHIHodN5aAA4tqZza+b29njG3J3zFdgWPaQLb4h9sWHp2GhA5wvCCMLaxzjiuR4XrUhOCr2L4pgaE/xr3AqAo6wqJAC8iYlJuO7FHWoEOOROCwNkiATeByc4OAQgn2A+IUBRmKHlvTzsLhGDfRezJkcQceUGB4QAKVEesAGVrCFLAuE3ifQQWMA94MqfiFntMcQweiYBxLxNkw5rhjUnPlfuhZR7j0LHQUIKlTzDggAvHA1hGA/GsI3dkbAzDCUQPlAAVJwacEp24tzFNYI+cA3zDkYMoTgstCBQH3ocWw5M3ycifjARK253KcgXJw6uLdJxBnYHw8mJJB5CISqOV44jlD3EbnBXiRFrhpnaPRIUNAcZwT/gAOWgNwgAVvvGUMBcLgLAEQkhCgrSYzVII5ucgxSmGiCcSu34FAvA7Bo4cWjCwaOQJyT+hFqGThEBRQ4aBOQKgBPgNAaAsBwEQOZcykBYAmMnOwBQLVKLmSPjQEQ40iAFB6JOWg5lRBYAsiE18k54nMBkAAYlqdQiJus0DyxJPCIJrSRIRKDDEuJCSkkpLSYYzJ2Tck93yfceAaBimlPKZU6p5k+n1LQI0lpbJQnULQLAH0YZJwsQHrYiA9ipFOJgBQ5ReJLhqPonQwgUTcYtA4MxU+Ep0mty4SPaAMDLHwgAPoEIIXcV4wpQVAuhJAzgZyLlcM4OcoxMBHCGTfIw6Ab4KaYhgE8/EQ8940FrDIDA8I4AYBOPgNkkAriLkYATT5OJgGgOIWxFEb5T5/xfNcXEcgFyQAbjirlWDYpEvkGgUl8JRAUqpTS3Wb4TAE3Rki0+DcDGwEnCYheZjcIiU4NfGAASB5BMgNo84k8dmvk4Cicyt4hnxMSck1J3zJlaGmXAWZhSFklLKRUqpNSrVhIac00Q40zUwHGuccafTxpnAjDVUg8IdYvlxv+dgzB7hOUBWAT0tA5ITyuB805diGyXOHvgsAHUlImPhFwnhChkpE1VMgpBpAZBQEMmGd0qSpqyhUtCZtVp6LsA7QuDR7Sol1ukdwpKhkh3IIAKRwHSkZNtHau09vMn2x0yTOALpHe2qA47kGTrQNOq5IifRiLMMOTgoYxGGRuIQCASSFxxUYcxTGaY7CuXkMaLt3b4S9rYv2t8oiG54TgKIbQEi0zRBtKed2ATT37KDJW3tiIH2kGhM+vgb6F7sh0ExRQvFRA/qqTgckwHt3MkUcgQSDYFRpG2qoGjzJyZcFvvfNAk5SDHBrP3Pef4S5cABN8xARBmDbViAUbascspgEwzSRRt4cQoscHxgTYAhNwBE4ETg4nDGSek7ECwkgXYKfY3RrgEnHRkBwjINZQbPV0FRVEpyiB4jxG2pIazKmuAMfrDIBU40/GUbIKsRABQCj+dpFwRjMhuOMAfoZuztYHMNmc9aV85k3PWA8+cLzKxVgWEU8p+LmJjP2deFlzNpg8vBaBerRQ0XYgu3ykPWzI0oxGRuIwVUnAABK5zXHnEMu6etsiwAAk5AAETgtoBu/Iy4wFcAAQk4AtxQZB1uciA0p7doHd3Qm20tzg/XBsjftM3MAm2zu7ZPTqg5SawCdXynmgtqji2Fk5GQ5xjcqHJPyp1WtJxq5cA6b1rI19dXMGvkRwgw53KTYhwJH00OdCw5fLhBHoIkco4vSIBhGB/uFkjLiu99aycAg6QuIMB3k2k5nQ2ptMAW2Ho3QdkDYHB3s+Heu49OMOlM7J6z+d/Ol0roXMZUdnbudHd5/uyXnOhcaJF2AZgzPL0QfEzAO92Hkp4dffOQjn7SPfv3RF8kgGt07rwZwZA2HcMvoIx+4jX7yNW7/eSHqOMgydbR6t3rT6Btqmu2NsAE3Rcs+m7Nh7y3gCrY21txbu39t2+Ow7hPF2w/DdG7d+7afSDraewHt7SkxIwcktJa4ncQDIDii8QisTHWjNSevZQhwcSTirswcZGTPXfPMuBc55lfXLJMDicy9aTFhnmrTM2LhLYbVSIkDIbMghcIzkgW2/MLrLB6AXbwRcA5BABJiw8YukpQZgzADEuiFyNSyQ/JyDZpoDT3boxU6F9wJkMwANRbRIr1BWjkbz5dwox6BZ4IIaKchnpii0L0K3qnTHIACy48jk8khYmQ2IEqb41gtyhYwI1CxoC4SB+A28Z8/4jAY0XAxEaYMqVBlqLA4gf8t+sGcEjBg25GpUjk5wZaDB7CC83eIgdChWVaYAwWBY+8LAA2x8gSwS/a+wAIsQYYDqIyYymaYA8QWS7qVYhwFS2hMad+nq2hsQzmjo+wk4sQGyjSimAInyuBoIwk5MqaKqJBDyihHmMgk4iamaaAfCreIyzqA+MAbqOS3cnqBS8yiyfqKyFkPhdhzSPh/h9waRCymURyIONacAROj8ustYvWqgqOl6c6Vces0Ii6naC4FRtYCu9uA6WClRnA6gOMZ6ROwi5RhR+sq6dRnSmeSu/R0IbRE6+yGu72khhqhYQSSRGRQRwyTqYyrqIkUyURXqsRE+/qqySRIaTSqRGa6RhxmRkUtEkG7AhYpgGR2aVeEkSAUki0pghE/gRAFgk4W07xFgFgC+i0dM20FgfMVszMLsdsqcS4O+K0507sl0O0x+WwEsT05+Mso08sc4DIJ4ysEoPIasMoGsnIWsuEPRBs68RsqEMcugXsjM601su+oJQQjs0w5ge+bsgszgBQqgcJfsCJuwSJb0ZAmAEYvkl414d4D4T4PKb4iM5IyMPceAj4z41qdEKIc2SK+wzBrEHEXEvkNMvxS+O0a0QJm06QKcQQvkEJVJLJOc0WrgC0VcsAzQ8CWk3kukZobIBkxkMGZklkMA1k+U3kk42ph0EMciIUnMv0dIoM24u4MYisoqHc4uQ4q6mUuUFAOovk0IhkPInE1gXxuZeZ+ZBZhZRZXx6UqEEBIAssogSAoAgQ8gi85w4wCArgrgQAA==="}
import { Hooks } from 'wagmi/tempo'

Hooks.token.useWatchBurn({
  onBurn: (args, log) => {
    console.log('args:', args)
  },
  token: '0x20c0000000000000000000000000000000000000',
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `token.watchBurn` Parameters](/tempo/actions/token.watchBurn#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`token.burn`](/tempo/actions/token.burn)
* [`token.watchBurn`](/tempo/actions/token.watchBurn)

---

---
url: /tempo/hooks/token.useWatchCreate.md
---
# `token.useWatchCreate`

Watches for new TIP20 token creation events on the TIP20 Factory.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useWatchCreate.md","from":146,"to":4766}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"ac42775d21c15bba9530036c843c3f7209edb0afc3fa66af279c7dfb7b6482f6","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXGgC8lGaugAssUmKymoamTp47fydeWZIRSC29o5+iABsVdRetb4NAfR4AGYArmCOjBBgnIdwMADqomi2AMKkMPcwADyP5/uMCgB8AAosPZmDoyHAAPyITjAAA6F04iIWpgAklAoZwwIdmAAjMicAA+lzAsB+ZigAG54YjEZlIdC4QiaTSJvIMQADCy0AAkwBEpFMClc7MJnE5PL5aAFimFyAAuqKsTIZKLjqT8pTqcyWR0wGiMTjfqYuETDQpjfLFYdlaqSTAyTBNUzOK5beryVTnftSBBmAAhGQQaz8A1GsAm4nux2e5nnACipB9pAxAIBZCT0ITSYAlJwALx/ThECCMKC5olq+0at1Vj1axFsZUYqWHGA1h1QdsamM0xsmRQo8NkIiiGQYrG4/EVu0drt153nAAquuerxo6Ohqbp0IA7vcni83gA6ACCWjgFE4gYUu/3+FXx4AMhAFLmC0WS2W59H65xrN9fgxL4wB+BRvydZl5FEHE5A3TgcT4ORRAuaco07VDax/MBXGzaFi1LeEwFEUE4GBaw2yuW47wfGh/CgIMED0HJOH2dhOD3B58EFTEYB3ThFxRAAFAoLE4VkwDgP9D3XI9/DEBRGOQZAQDoYisDkfx2S0tA4FoeEQlaGFwkMF0WJ9ZhOAAcj3BRmEYAB6GgWks+F4SOE40DOC4TywLAAVzRlERyOAj3Eo9KLuTiaJgAFAppJcV2kx0ATpALfyRc44AgOQj2vAFLOXSYLmsJKoEQSzL1S393C1HDXIRF40EOUgLneKBGCIP5ItsbjWNIMTdSktcvJCo8j3eez2s6+FXHhLT2RAOUKGU4FSmYfxVuIsFSEkgBaThBJBbaQsWpaQGiCREB6aRjGSIZEAARh6EYtDGPQIuopL/H7QpikWcpHoKdZMBqPQ6j8Ro9j0IEfRwDgMFzBKiuiuCt3PW8oqS09z0va8MYPNcYCPZ9X3zQt8K/DCOzohi8EeUcZBxBx+AGzhTGLSZ2PweROFEHi+IE4TRPEtnJJKwmoFk4RuiQFYAA4BhSJAnperI8CR+QUe+/IkH6eYSjKZYgY8DZQZ8eo5KaaHNtBJxc23GFf3E6FxV5flBWFHtEXEtFoTNY0vcxLboXdxRA7gDBcWykOpUFQPrGal4TgwGPpQUQOAEdDggGhCvkF2uTd2OZXZQPRCgOywALiVQ6FUuZq6GIkDl9I5EGVJnoyV6gjpbWZkQPWFlKJZnAetwTZB7xwZ2GgoZAIEjrtq8X3x+8sZJxvLskB7FfuvXNDVvRrz78xB4NkfZlUYHNjB7ZLbnoiSLItt/wk7KYHhEd+tfrK5GhYDf64CoPRawjEQCLm5mKH+78RTMGgNaNsWAfREFLPAXmnA4AhDkJwWAOJDgKHNIoP8mV35iTsFwRgklMF2RkOIVmygP5gAAFKiBHAAZRKowLAXBoHYNBAsMAlCLJIOIKgzsOIMDsRgDieCPodzXB2keeqEC2xwKgAgzgdBQg6TEjuCAGCcDWEYD8awxCWhmHDHARA9UABUnATxigATAv8tC4CSR3IwZQnBbaECgFQw4theaSXZLwomeVszskvCEkhOV0zsH8iKZCnZolvxynuFqCSyH3D/MheCFFridnaOxAUNBWbIUkQAOWgETAAVlQqUrxmBKLAHYhxChAxMxVCkwBIpTDRBOC/ACChmqOlZjuEpbYinIHZCI8ibijwiHoocNA7I5QAnwGgNAWArH2XspAWAdSjzsAUJNBi9laE0BELtIgBQehHloPZUQWAHKzPgCFDZzAZAAGJXluMWRAZZ9sSTwmmb8kKiz0yrPWZs7ZiBdn7JgIc45pzQHnLeFcm5dyHlPJeT6OZ7y0CfJ+Xit5ELEzZiPPxSB7SICdKgTEmAIprC5LxJcAp7FPGEGWWzFoHBuIMLFAixAoTYHwJyvVAA+jYmxdwWqCmlRK6EKjOA0rpaEzgtKakwEcJZSSPjoCSXEG2MwnL8Q/0oTQcMMgMDwgjicfAPpIBXCvIwTmAqcRyIUfYwSKJJIMMkS8a4uI5CXkgP1I1ZCYCSPNSIeQaBrXwlEHa2wjqAWSRMJzBmGqGH9SqbAI8dSMENOIiFTgbCYCTMgdMyApTzicDBZwFE9kADyUKNlbJ2Xs6pSKtAorgGiy5aBrm3PuY8559kwVHg+d80Qu0a0wF2ucXaYLdpnFzH1eEcCXhsxAuwZg9wvLNPhHGWgalsFXH5dSjpo56WpMZdYsAc0tJ1PhKE3KL58rc2VPovRpAZBQEstmT0uyDrSh0tCL9gZ2LsH/ZeIp/zlmvoZe+hQn6YDfs4AAUjgBVKyv7/2AeA/ZUDxorGcEgz+mDUA4P6IQ2gJDd6jxxNIACMwfEszxMsjcQgEBtmXiyj47iTNOx2F8vIR0gGgPwhA4JMDklmPeLeaIbQvMSRFuZmJYekzaNoFgImB9IHEQcdINCbjfA+MYN9DoLiRDhPkaeTgck0niPMmycgGAI4ZByjSI9VQzntTZI4QKbhR5SDHEHBAyhwFZ5cFY9UxARBmCPViAUR6ctsz+dc1wZtOItWOFC+FsAkW4DRcCJwOLsAEtJdiBYSQA90uZZpNkoVxoyBERkBOklbj7J0G1csryiB4jxEepIRrtIuDuc83KXa4yHNkFWIgAoBQxu8y4B50cQWuGxZa0OFqo5OtBjeT12gfXPLnEGysVYFgMtgEM01rgO2nDtfsvu0wPXPMStrot2IA96o/we1tfMVkbiMBtAAJVpX084llPRvvSWAAE7IAAiyFtD9V5I/GArgACEnAUeKDINj9kUnbvEdk6R6E+O0ecBB+DyHb8wC46p4TmjRa9OkCfeyeqJ6z35MvW2dkTi5BMtcVY+q80X0nEylwAFXA8wqp0Gw4tzA2FWcIDufysPpeaMTEDrISvDwq7VxADXJP/veIwELts8u2PEMY1bgEsvLzphJ5uy3yG8qWQo9Bv9AGScybkxB9DUH8PUdZrLt3VuUNoYw9h3D1kqOEf8+TyxQeMOh9ZxHsAzB3eMeY6x3inBjP5TM7xi8lnBO2fLvZsT5JJNEZI6nzgyBjOmZ4xZgT1mhPV9E45x0S1Wbpj+9rzHQOuOg5VBDw0DOYeR+Q/DxHzP0fAExzjvHqPCfE4byn8D6+Cf9Vp5P+nWVGd77R9j1nQ+wDzTkspxSylrhAJAMgLKzVyJrPbbC3Z5plCHBxEef8ZgLtA5ftBFeyGCWleyTFUdEwHEeyN9OpbMU6aWJuR6CwVuO6VIRILuQ+eYBlE+JATuIeQ2ZwHoa+M2aee+IIAEfVL8KPPKEiOAZTGADEcpS8MaI5bhLyUcQ6NaMjcpeUXCD8UscrAAageg1XqEDHLiQOAVpj0B3z9X0XZDoxFA8S8TYx+kpQAFlrRPJ1I2xMhsQ40xYWVEEk0ClLx1D8BI03JGAdouBKJOwk1I160BR91SBJFGDmDVNnCbRy52ozt2s2VRkXC4A/8RBPF+tzhP5RxWwqEWBQc6EpkZkwN9gARYgIkP8YU4UXtkJ4gjle1+xDgHl90wBl1mD+0yjYhOtjR9gjxYgp1CUZAbsAQBUjDQRLFeZt0s1gQ3FRkUj+sZAjw+p900AElsiO1ciEUe0TkQF+0Ll4Ah1oDsVx0himiiUhjRj7htih1UoKVxdn04AGMRBiFjg5dOBVAtdGNPd/xzjoRMMANLw7jwx/cydA8zjwxoR1BWY6MTj35o9LIXi0BypniAVXjt8PjgTvjWc/jr8tJ6py02xpl1jdiJjoUpj4Vu0QpkV5iB0ljh0sUx0HJ1jp0vkti90djKS9jzx102It02xTBdjD1b8FIkAlJzpTByJ/AiALAjwHp+SLALBkDzoZZHoHo9Y24lYB5VY3pjAXwCCro/ph4AYHpjZqgp475IZqCbZtp7Z0ZHZnRnYxRC5JQ05PYnZdRfZ4Iww0BA5MdU445fwI4o4ZBHSw5fwE5Ex5BrAU4i005M5s5c5dRq4i5zT65nRy5K5QyzSPYIzXBN5dA1SVhd4O5ZSe5zxFSiDz4AYCgr4zp/xYBmhtEjJgpTJvRfQ8NlM7JHIYBnJ6pgpQpdRwprhuo15CZYotQNYwAUZNw6RcYXw3xCw4oMobiP1LJtxcMqoEQapsJZCQBbZRAkBQBAh5BMFzhxgEBXBXAgA="}
import { Hooks } from 'wagmi/tempo'

Hooks.token.useWatchCreate({
  onTokenCreated: (args, log) => {
    console.log('args:', args)
  },
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `token.watchCreate` Parameters](/tempo/actions/token.watchCreate#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`token.create`](/tempo/actions/token.create)
* [`token.watchCreate`](/tempo/actions/token.watchCreate)

---

---
url: /tempo/hooks/token.useWatchMint.md
---
# `token.useWatchMint`

Watches for token mint events on TIP20 tokens.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useWatchMint.md","from":125,"to":4710}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"bca02bde7cbd2b13b68198315831f106355326a3a7bb259d3bedb8adc457d8c2","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXGgC8lGaugAssUmKymoamTp47fydeWZIRSC29o5+iABsVdRetb4NAfR4AGYArmCOjBBgnIdwMADqomi2ALKmaAA8AMLn+4wKAHwAFFh7MwdGQ4AB+RCcYAAHQunARC1MAEkoJDOGBDswAEZkTgAH0uYFg3zMUAA3HCEQjMhCobD4dTqe10QADCy0AAkwBEpFMClcrIJnHZXJ5aD5ikFyAAusLMTIZMLjiT8hSqdTXMriTBSTB1YzOPtSBBmAAhGQQaz8dHYn4vbWqsmUw3nACipBNpHR/3+ZC9UI9XoAlJwALy/ThECCMKChwkq3Vqx1J50ahFsRXoiWHGApvVQfNql1MzMmRTIsBOIiiGTozE4vEJnUFotp11gZ5Vn3/WlQgDu9yeLwAdABBLRwCicS0KAdD/BdtAjgAyEAUoYjUZjcbb+pLzI6YHRABUj6iAPKkMdQKCkeBwPcGpnWL4/dGfMDfBRPg8I+SiNicholC2J8HIogXM2Tr6r+cKuMGULRrGcJgKIIJwEC1h5lctwLku/hQFaCB6DkRrsJwg4PPg/KcCeyIAAoFBYnATPInDMA6MAkFWcAjv4YgKCRyDICAdDoVgcj+KyMloHAtBwiErTQuEhicFqxqmpwADkg4KJxAD0NAtNpcJwkcJxoGcFxjlgWD/KGDIIjkfFsWAI64Xc1FLv8TnUucPm0o56bUq+YBwBAcgjrO/zaUuiDadOQUhe4GoIWZ8L3mghykBcrxQIwRC/F5ti0fsFGcbxI7Va8BkFUV8FwjJrIgDKFCiUCpTMP4nXoaCpCPgAtJwDHAv1fGtW1IDRBIiA9NIxjJEMiAAIxzJoWR4J5+EvP45aFMUizlKtBTrJgNR6HUfiNHseiAiaOAcBgoYBS8PZ9pRO1VuOk7TrO87eaOa4buGkbIbu0GpvqhHEXg7y1jI2IOPwrEQJwpjRpMlH4OxbmPuIeaVTQUD8cI3RICsKwDCkFMjFoYx6K9VZ7fkSD9PMJRlMsp0eBsF0+PUAlNHdvUgk4oYfX5CLtFCorcry/KCn+nDoRAxxoKB9pVi6rhdDESDxOkciDKkPR05tei0izMyIOzCylEszgrStZ2bJd2xC7dICAmN4szuuAPDt9wN67NAAcK3U8t7MbQzxjrtb5h25zjtICt8Su/zV07DQXtoRhWF5mFEVyHCNakJwxeRTAUKfiXuBUER1gkSAJ44yKVdyEKzDQIccicFgJpELG8Aq5wcAhP3sDYocCgKLRnd5so9zo4+E+cTI4io6xONwgAUqINYAMrWHyWBcIvHEwAsYCMHAzAD0PI+FtiGCUTA2KcNiJr9tcA0jhlNuhNe79zoKEOSrF+xo0wtfRg3xrCV1NGwMwvFEAZQAFScDHCKOu1chTWE3nAR8/ZGDKCvsoaAa9Di2BVo+Vki9orrgcqyac9Dzj1xHP6dgzCVbEg7uw6uI5By5R4cvC+kEv44WuIWdolE+Q0G3pBN+AA5aAMARwACs14ShgOhABYBMHYIUJaJGSo2HhTwejcKYgThFzfAoHKsFZH9nkUvNGyBWSDytA+EcIgiKHDQKyGU/x8BoDQFgOAiADIGUgLALRI52AKDqsRAym8aAiEGkQAoPQRy0AMqILAjADJeOwkQkcoTmAyAAMQlIfH4tWaAJbEjhB42pZS/H+iCSEsJESokxLUfExJyTm6pPuPANAmTsm5PyYU4pJpSl8QqdUtpRC0CwE9MGEcdF27GIgKY/hFiu6VwkbiS40jKKkMIAE9GLQOC0WUHmVksSa6L27iA9RGUAD66D0F3FyvyH5nyoRAM4Ls/Zl89kaOvmgbSj4xaECgPje8GIYCXLxMXO+NAqwyAwHCOAGATj4BNJAK4M5GBYweV/H+f8sEMWRI+B5b97zXBxHIackAK4Ex3jAN+GKRDyDQDiuEoh8WEuJWrR8JgsYI04BAB5FdVGwE0do+86E+KcCPjAJe7cPGQAUecR+3iiGcGRAZC8XTQnhMidE55gytDDLgKM9JEysk5LyQUopKzyloEqVU0Qg09UwEGucQaKzBpnFDOVUgcIe7ItMFG5g9xrL6LhG6WgEl+5XHuTskxtYDn11ZGgsATUZJaLhAwmK2kcaKjRlA0gMgoDaWDC6aJI1JRyShNWy0lF2ANunLI+pATy0CKipWrtaMACkcBEo6TrQ2ptLaDJtpeJEzg46e31qgP26BayGnDsOeorhpB/hmH7JwIM3DtI3EIBACJ04IrwtokjQsdg7LyH1E25tcJW0MXbY+I9V8iGiG0Lwws0RrSsQdm48eaz/RFtbQiC9pAoTXr4He8epodA0UUF/UQL6Ck4DJN+pdTIV7IG4rWGUaRVqqGI0yFWXAT5n2XKQY4lY2530/LnLgJ61GICIMwVasQCirTDsGOjpGuAXmxFCxwI5WNgHYzROAXHAicF47AfjgnYgWEkLbMTEnqQr2eYgF4ZA0IyDmUax1dBr4BOsogeI8RVqSEMzSLg5GawyBlINFxBGyCrEQAUAobmGOcAozIJjjBz7qZM2Z3KtYrMLIMrZ6w9nziOZWKsCw4mwAIaM1wOLVZzOJcTaYFLXnPkK0UEF2ItsMrF0K31cMOkbiMEVJwAASns0wEUwDaRdAw4RYB/isgACKQW0BXbk+cYCuAAIScAm4oMg83WRfry0u39K6oTLam5wNrHXut2gsWARbe3Vvbpg+s6NYBmoZTTRmqR2bHm4KOQQkVkSMrNTLScdhXAGktayEfHR6Ej6YcIP2Byg3/vhc9EDnQIPVXMHByCSH0P90iA4hgN7eYwworPQw3H/wGnTn9BtmNOOR3qLHTAGtG750bZ/X+ztdPu1zq3dvPdYBmBU4PYwhQsV11TpnbpXtjamdbZZ2utntbxdXe57z3HnDPTcNPee1Xx6r03vQw+rDT68Nrv82ST9i7l2oM4MgJDKGddTgw4+nDz6jdvrJG1be/oGuw9my1q97WlTHd6+cAblPlfDdGxd6bwBZsLaW5N1b62zfbYtxHg7fuus9dO+duPpB5tXY93dmSAlgPCVEtcBuIBkARRythYJlrenRPnsoQ42IRyvmYP0uJjrnkGSAnsgyrrpkmGxAZBhWjgyTTJvrFwRslqpESBkemQRF6JyQGbDmR1lg9Ezt4bOnsgj/HhdAUMyuYoYTgMBmA6IlHTmqgk8+1layjS6qupRspELbljOpgA1CtWV9RLR4bj6Nywx6BJ4QKyKsiDqBIXJkKnr7RbKPB9xWSSR5iZBYgCqPjWAnJ5hAhEL6jTgkJkIPLmSMADRcC4SFgircqPwsDiBvxn4X6gYqwdZ4YFRWTnB5oUG0LjzN4iCkLpbFpgBea5hrwsDtZbyyKtLtr7D/CxDBgWo9J9KJpgDxAJL2rliHB5LKGhoX6OrKGxBzIvD7AjixDeqVK5b/CUpoEgi8QqzIoyq4HnKSGsj2YyAjgJr3DMK149LWod4wB2pJJNyOppLjKTJuozJFKuFmHVKuEeFoBxGDRBSbLfalpwCY4XxqxVgtaqAw786VqvjqxQgTqNrTgFFViS7m4dqIKFGcDqDbxQGY6CL5GZEawzplGNKJ7S7tFQh1EDq7pDoF6sgZSap5geJRFxFeHdJWp9K2p8RDJBFOqhED7uqzJRFLJVKxHsCJrxFbH3CJGTiRoVTsB5jxq7HsHuRF5CRIAiTTSmDYT+BEAWAjgrTPEWAWAT7TTkyrQWDszGw0y2zmxxyzgr5zSHQOzHRrTb5bCCw3T76iz9QSyTj0ghQywigcjywSiKysjKyqw1F2jzzazwShy6DOxUyLQmyr6AlBBWzTDmBr72xczOAFCqBQnuwwm7BwkPRkCYChhuSnjnhQBXg3h3gPhPgwzNx4DCnMqPgUTIhjayr7DUH0RMQsRuSkyfFT5rQLR/HLTpCxxBBuQglkkMmpxBauBTSviwDNDgIqQuTqRGgmgPy6TAaGTGRsCmSCEuQjhqnbSAxVi+QahMwazqa0h/TribiRhSyIJ5FMLaR9gzrJTwipTwhuRQjaQcjMTWBvHZk5m5l5n5kFlvGJTwRAEgBiyiBICgCBDyATznDjAICuCuBAA==="}
import { Hooks } from 'wagmi/tempo'

Hooks.token.useWatchMint({
  onMint: (args, log) => {
    console.log('args:', args)
  },
  token: '0x20c0000000000000000000000000000000000000',
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `token.watchMint` Parameters](/tempo/actions/token.watchMint#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`token.mint`](/tempo/actions/token.mint)
* [`token.watchMint`](/tempo/actions/token.watchMint)

---

---
url: /tempo/hooks/token.useWatchRole.md
---
# `token.useWatchRole`

Watches for role membership update events on TIP20 tokens.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useWatchRole.md","from":137,"to":4833}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"2a04f664116ac7d0cf34ca591cad47cbc06e1aab303131a088a76159faf54e6c","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXGgC8lGaugAssUmKymoamTp47fydeWZIRSC29o5+iABsVdRetb4NAfR4AGYArmCOjBBgnIdwMADqomi2AEoQcgA8AMLn+4wKAHwAFFh7MwdGQ4AB+RCcYAAHQunARC1MAEkoJDOGBDswAEZkTgAH0uYFg3zMUAA3HCEQjMhCobD4dTqaQXjB0QADCy0AAkwBEpFMClc7IJnE5PL5aAFimFyAAuqLMTIZKLjiT8hSqUzqQ5rBBjmgOVzefzBcLReKTVKzez5YrDsrVcSYKSYJrGdrrs7SEaJaaZSLCZbJdKhbaFYSlSrCWqXRrKR7XE71WSE0z9izmAAhGQQaz8dHYn6mLgx52u91M84AUVILJ9UP+/zI9ahtfrAEpOABeX6cIgQRhQLtllNu5Nx1NahFsZXoqWHGATivL+PTzizkyKZFgJxEUQydGYnF40eT8dnitp6nnZ5yACqWCg9zd6KbtKhAHd7k9WQA6ABBLQ4AoThcwUL8f3wO8YD/AAZCAFC7Xt+0HYdVynD0JnkdEABUOjAVEAHlSAAqAoFIeA4Awt1r0RL4fnRT4wG+BQaMral5FEbE5DRKFsT4ORRAuS8NXYhNXA7KEByHOEwFEEE4CBawlyuW4oJg/woDzBA9ByTh9nYThvwefBBU4XDkQABQKCxOGwi4WTkTgQRPUg4DMrBLifF84D/fwxAUXTkGQEA6AUrA5H8dkYrQOBaDhEJWmhcJDE4JMMwgZhOAAcm/BRmEYAB6GgWhyuE4SOE40DOC4AKwLB/i7BkERyPyHL/NS7lMmD/ham8wBgx9nxoKB/lpZr13osA4H/cD/hymDvJGt1EBy0CJvXdwtUkir4UotBDlIC5XigRgiF+brbHMwzSE4JzVJ8mg/L/P9XiKs6LrhVw4Ri9kQDlChQqBUpmH8EGFNBdzOAAWk4KzgShvyAcBkBogkRAemkYxkiGRAAEY5k0LI8C6jTWX8LdCmKRZygJgp1kwGo9DqPxGj2PRARZHAOAwLtb1ZYaXz4zh32AyCev/ICgtA8CJd/OR4MQ5C+xk9DRLJLSdLwd4DxkbEHH4eyIE4UwB0mYz8HkThRHu1kXJgNyPMYLzGGow4nrdfzhG6JAVhWAYUiQfH+gyLQxj0AWH09qBKfyJBQ4WUolmcBmPA2ZmfHqAKmk5iGQScLsP2M8nFelox0d0AAOOY5EGVIehGcOglpOOZkQROSjKZZ8arxnNhZ7Yc45kBAURwuwMQ+XoP/BCFC6GIkCrqvA7x0PiYj4xELb8xO9p5YCh6fvM9ZnYaBH+TFOUpc9Rm1k4X3O7b9muQoWYl/cCobTrF0kBcKtsUz9WQimYNAB0S4sAsiIEOeANtOBwBCM5WA2JDgKAUOZIBzllD3FNtRBBhUZDiGNvZK2cIABSoh9wAGVrACiwFwTBS4QQLDAG7bKkDiAwKgJwbEGBjIwGxDwlkn5rjuT/Htf+TCwHOToKEOK9lPwmyUjAawjBvjWE4HqFoZhdxwEQHtAAVJwACYp37AM0YQuA1FPyMGUA7ZQ0A8GHFsDbai7JGF/nmh2dkoF3HnA/n+Fs7AmoimEtwvxd9FbfmOiEkhODrDCR4apa43D2jGQFDQYhwk+EADloCwQAFZ4KlDABS4iwBGJMQoXMBsVQRI/iKUw0QTg3wYgoI6440mfgyUuNJyB2QcJUlYv8IhtKHDQOyOU/x8BoDQFgPRRUiqQFgEUv87AFAfR0kVQhz00AwyIIfP8tAiqiCwMVQZVE/wzOYDIAAxBcqxoz9RoCLsSOE/SHl+VGS2SZ0zZnzMQIs5ZMBVnrM2T/bZvk9kHJ6Eck5ZyiqfKuWgG59yWRDKsWgWAdYOx/gsgA6pEBamAP8eYhJFxcSXBScZWxhBxmmxaBwcyyglzsmBYgRhIDpGwT2gAfQMQYu4x1BQCt5VCSRnBCXEsYZwIlBSVFoBytRAuhAoDUXEEuMwtK8TPzdjQXcMgMBwjgBgE4+AWSQCuGBRgFsWVCIgCIvEAErLImoiyvhlFrg4jkKBSAd0NUkJgHw3VIh5BoENXCUQJqzUWv1NREwFs9aypZXdPJsA/xFPgSUhSflOBUJgL0gB/TICZPOBudFVFODIiKkRX5My5kLKWfk0FWhwVwEhbs/ZhzjmnPORW4Z1y7miBhiWmAMNzgw0+TDM4XZbpwlAZRU2LF2DMHuLVcpcJqy0Ais5K4zKCU1IPCSyJMB2T6LAL9GKRS4QePmjlK2yoTaKNIDIKAOUOwJkWfDaUcUoQPtzMZdgr7QJpKeeMm9pLFZ3v/SbAApHAdauVn2vvfZ+oq36Sx6M4DBwDL6oAgaUVi55EGT2BLrMEswn5ODtmCTlG4hAIDzNArNFV5kDbcLsA1eQbp30frhF+qyP7qJBLuopOAohtA22JFmw29lk69MI9i0g56v0Iho8pzg9G+BMfgVlHQZlFA8NEBx05OAyT8fQ0yHByAYD7hkHKNIBNVAWe1DgmhdC0B/lIMcHc/83bMXPlwf47KiDMAJrEAoBMq4dhc1ZrgRFsTyscF5nzYA/NwAC4EUWIWwuxAsJIDu0XYs6i4OyksZB5IyERf29tdAVHjNqogeI8QCaSGKzSLgNm7Nyhht00zZBViIAKAUdrNsuC2YPO5l2QWyu7gqweareYqJFTq9YBr5wmsrFWBYGLYBVMlYxPkxA5XjoLdXaYFbdneX+gggUWIHc9rP1K5DHsuUbiMEdM8Isd8wA5QTB46JYB/jsgACLCW0HdXkl8YCuAAIScDB4oMgsP2R8b2+hwTmGoSI4h5pj7KovtNPOPDnHyOCNZqU5e9ke0t07uSfu1lZi5AimsJYvRe0/rXpOP4rgzzXtZCodm5gVC9OEE/E1f7PPOAtn5zoQXlEFIi5BGLiXJGRAuQwEzpc3YMQwCox4rX/xnmgRbGj+dmvIOwWgzAR9uGUNo4E0Jv9NuAPIfw8Q4jYBmAW9I9b238HEN5SA2+h3GOnfYZd0+4P5PPfe612R+swW9fUfI6QBaWnGMgV06xwz7HsP9bJLxtDGHdFQmQOpqEGedMsf02x4z+euNkkBsQlsj2pfQ9e3R/HnBCc/b++b+PgPgek8h8AaHcOEfg+R6j4vmPS+T6R3dd7n2iVE7ACTqfpBYfk9b2AP6AUJPBVCtcT+IBkCzSOipKZ9aAWLPQcoQ42I/xaKbSs9twKio8SJUVGFcKTDYiKg8SKQ7BRh9kXgJgsFrlxlSESDDhJj0EYR3iQEbnmC7hTmQOPm8FPmHiCH+BVWgC7Hj3mjEwkzZChGyVAlejWXoVqgPARlBiw2yXlCklQiHFFgAGp8ZZV6hcxjMQCv5tY9A595E0l2QwMJkaU7FKMqY8UABZB0GqSKJcTILEMNaiclJJDcKNFJUCGxOxFlSqRgdyLgNSbhKNQNctFgcQPhEgyTMJG2R0YzM6Gqc4I9Uw1xeBR/EQWxdbC9MAOzRcPBFgD7IhPpAZH9fYf4WIbxa/f5QFIqVdMAeINZVtLcQ4Y5RIydUg9tRI2IarEsfYP8WIZFG5Xbf4O1FQkEXRG2RdJNIEKxTpE2fpBrGQP8W6VdNAEJWIhteI4FFtDZb+dtHZeAaFbteFYqFokou5Fo9o+4WYvZCaXFDnK9OANXBhfUXcV7VQSXX3RCBaPUA0KEWDN9UCA43cUPEvX9TRDYtAKEdQYhcQtXOaPYnKM424xDN4i44QrDN4u48nR4vfGKPafNJcZomqVo+Yrov5HooFZtPyMFQYjtEYrtWFHtBFSYwdW5GYldOYnEhY4CWdIyBdJcUweY9dA/IKJAEKNGUwFSfwIgCwP8fGJkiwCwUAtGX2AmfGKwHGeuBOJueAreeeaYcwFApObuZwQmTArYbOdmXA/OKGIucWEuSWMuYCBeDGQmUOOuIOTGAUzeVuEU5AmmZOOmAoVQaUweWU3YeU7mMgTALsByPCAiYiUiciT1aiDWN0LWH+PAMiCiStIyZEEHWVfYCwyyGyOyDqDU3QEOAOXk3U9IDeIIByJA1YE0iU2YVwVGPUWAZoORFKNqdKAyTMJDCTQqEqR2NgcqPwtqP8DqMmVUmAPqLUKOGAIWUaRsWkWWZWHsPsfqaaAJO9D8RDTaeEbaeEByKEHKLkWyawVkhcxcpc5clc1c1k9ab6fgkAAuUQJAUAQIeQBBc4cYBAVwVwIAA=="}
import { Hooks } from 'wagmi/tempo'

Hooks.token.useWatchRole({
  onRoleUpdated: (args, log) => {
    console.log('args:', args)
  },
  token: '0x20c0000000000000000000000000000000000000',
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `token.watchRole` Parameters](/tempo/actions/token.watchRole#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`token.grantRoles`](/tempo/actions/token.grantRoles)
* [`token.watchRole`](/tempo/actions/token.watchRole)

---

---
url: /tempo/hooks/token.useWatchTransfer.md
---
# `token.useWatchTransfer`

Watches for token transfer events on TIP20 tokens.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/hooks/token.useWatchTransfer.md","from":133,"to":4822}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"f4621a5648e0a663badc09437893499eb743897952bf9f61a7fc56fc1e4f1550","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIAJCCAawRU4aAIYckATioAbGGADmafEgCsVMaQUwGiELwFCQMxmFyIADFQDG+caOs1yiSQF8K6bOYLEylanS6ICxsHDx8gv4i4roAzADssvJKKojq1OLaQQaRsqbmAEw2dqQOTkgW7p44eIQk5BqBTKzsXGgC8lGaugAssUmKymoamTp47fydeWZIRSC29o5+iABsVdRetb4NAfR4AGYArmCOjBBgnIdwMADqomi2ACqlYHD7ZAA8AMLn+4wKAD4ABRYezMHRkOAAfkQnGAAB0LpxkQtTABJKAwzhgQ7MABGZE4AB9LmBYH8zFAANyI5HIzLQ2EIpF0un7UgQZhYgAGFloABJgCJSKYFK5ucTOLyBUK0CLFOLkABdSU4mQySXHcn5am01l09o8vmC4Wi8WS6UmuVm7nK1WHdWaskwCkwXUsziuJ3ayk0j3szkAIRkEGs/CxeP+pi4JK1Lp1ftZ5wAoqQOaQsUCgWR07DU+mAJScAC8AM4RAgjCgRdjztdUG98d9euRbHVWLlhxgjfrPYTLc4bZMijRYCcRFEMixOPxhNrPrdfebHvOz1Er3eGdhWYZsIA7vcni83mQAHQAQS0cAonBDCn3h/wa43Z4AMhAFEXS+XK9Wl27EwNDowCxR5gIxAB5UhzygKBSHgOB/3dVlrF+f4sR+MA/gUJDAOReRRDxORMVhPE+DkdckNwxFXALWEKyrREwFEcE4FBaxuyuW5H2fE8digUMED0HJOH2dhOAPB58FFThHjRAAFAoLE4CZ5BU49N04GASDHOBT38MQFCE5BkBAOgWKwOR/G5Gy0DgWhERCVo4XCQxPVEjlmE4AByA8FGYRgAHoaBabzEURI4TjQM4LnPLAsCBItmWRHI9NUsBTy4u4pN4zcgWSulVw0sggQZJKBxRc44AgORTzvIFvNyshEG8m8yoHdw9Vo8KkXgtBDlIC4PigRgiABbLbBksTSHU9c+L009Tw+QKRrGmjERs7kQCVChTNBUpmH8faWIhUhEIAWk4eSwVOvTtp2kBogkRAemkYxkiGRAAEYVhGLQxj0LKeOKnZh0KYpFnKb6CnWTAaj0Oo/EaPY9BBDkcA4DAiyKubN0zUqrwfHKQYvK8bzvImj1xt8Py/MsGL/ecmzdfwBOsISQC+ScZDxBx+BUiBOFMCtJgk/A1PSxDxG7OVqbTN19OEbokHiKx3sGVIvrVzQsjwHGX1B/IkH6eYSjKZYYY8DZ4Z8eoDKaVHjvBJwi13OEBwDZhYUtWV5TFbk8IF73jV9m1A5YiBjjQUiozHP1XC6GIkAADhNuQNaQHo/t1vQGX8MHjYh0olmcL7VFhzYEe2e2UZAEEbpd28P0pp8SffBRE+e5O3vTlJC4yf6gjvfOjcQE2FmLqGCi+iubcRnYaFr5jWPY7tUNeGqYERCcZvX6q5FhTD99wKg2Y5x5xalPfN4lZhoAdbssA5Igq3gThRE4OAQjkThYDxQ4FAKBktfH+yh7hC0Ql/AKMhxACxUuLREAApUQE4ADK1gRRYC4CA7s4IFhgEYHALyT9iCvwbHiDAEkYB4k4HiDke5rhnVPD1C+uD74/zoKEOyKk9yCzYjAawjA/jWE4KhFoZhdKIB6gAKk4OeKUR8b6iJgXARCe5GDKE4M7QgUBIGHFsO/RC3IcF1Q/IlbkN5jFVU3qeHM7BzHvzJFfaxtUDyDQcWA7BlECSXGuA2doEkRQ0DgeuShAA5aAMBTwACtIFyhgCxZhYBZHyIUCGXmGorEbzkBKUw0QThrzQgoAai4Al7iCTLQWyBuQkI4qo08IgBKHDQNyJUQJ8BoDQFgOAiBAqBUgLAWJp52AKBWoJQKMCaAiHOkQAoPRTy0ECqILAQVakIVPB05gMgADEazVGNMjmgV2ZJETVL2XpRpOZWntM6d03p/TIlDJGWM9mEz7jwDQDMuZCylkrMCucjZaAtm7I5HU1RaBYBpgLKeWSl80kQAyc47JMAJTWG8ZxPxEkNGEGaULFoHAZLKG7NyAZMBEA4NvuwqJPUAD60jpF3EGqKelNLYSsM4PCxFODOAIuiQItA3lELaOgFLeC2IYDYsJHvQhNAxwyAwIiOAGATj4A5JAK4t5GCiyJbQ+hjC5HyTRIhIllD4LXHxHIG8kAZrS3gTASh0qRDyDQPKxEoglUqrVZHRCJhRbcx5USmaETYAxLifBFielOCoJgDLS+1TIDBPOIOUFCFOBokChBa5HSuk9L6aSp5WgXlwDeVMz5sz5mLOWaslN9TNk7NEOdBNMBzrnHOuc86ZwizTURHfMVphprMHuDFJJiJky0Asj/K4hK4XpMnEi4+3IpFgA2jZWJiITH1W8uLdUgteGkBkFAbyBY/R9KuvKOysJt0hgkuwA9N4AkHOaeulxUTN1XsFgAUjgK1Hye6D1HpPYFM90YemcHfTe/dUB718IhYc59yLbFpnsWYPcnB8z2O8jcQgEBuk3mqtomSvMGx2HivIN0R7j2IlPfJc9iE7EzVYnAUQ2hHENmiGGWaHE4GXLTEu09yJ0OkFhFhvguHP6ch0NJRQtDRDEeWTgSkVGgOsnAcgbSk4lRpG+qoJT+pwHoMwWgU8pBjijgvoQzCi8uBAlJYgIgXsvqxAKN9ZOBZdMqa4BBPEfLHDGdM2AczcBLOBE4DZyJdmvaxAsJIMern3N0nAbZ6MZBmIyH+TW4tdABHNJiogeI8RvqSHi/SLgamJwyCVOdcp8nmorEQAUAoxX35cHUzIAzjAsGhaS2OFLk50uhgQoFLL1gcvnDy3VlYFg3NgH4wlrg3WnCpcCoO0wQ3ys0tNIoersQx49T3vNk6JYfI3EYI6AASgivJ5xvJ+hMW4sAQJuQABF1zaBmoKZeMBXAAEJOAvcUGQb73JKMzaAzRkDsJ/tvc4Cd87l2N5gF+1DwH0HP4QpzCu7kPUx0ToxdO4liicnKPdT0nqm010nCqlwQ5R2sioPiSxVBEnCB7kSrdqnWk0y050PT8NzAmfghZ2z+DIgtEYEJ92Ys4rUMmIl0CQ5N4cwg57eLl9piFANXA3+w9IPqO0cvTAHdEG71wLg2AZgquENvsN9er9P7fK3p14B4DkiwM293Y71HZuLcS8Q+mGzMBUOCYaiJnD15xMEek0RsDNXKQUed+D13yBBPCew2J/DknCOyZj6RykO04EY+XZT14B3wRHcw6djUF3IwI5uyr3393HvI/e8AT7P2/uvcB8DhP+uO8A5mrDqv8PqqI772977qPC+bQMsx4yplrgnxAMgaqA0OJtOzXcvpQDlCHDxKeMRDzBnFtJYFIiCLArlp+SYPEgUTGxILPdJWSdvoWDTh9VIiQB453mC+keMwXpFzmzOA9CzzeDzw1xBBAjCp/i+71SMbMYwBYihI3iLTDJYIxSTjXQHSgahLKh0Q/hVihYADUX0PK9QIYsmD+p8gkeAie3CAS3Ij6LSWKmiKGYMMKAAsg6NFJZN2JkLiM6ohGihcD4qCKom6DeOopokShFIwGdFwFxA2O6nasmiwOIJQvASxuuEoY6LJiNNFOcHOooYYp/LviIBoqNkXuVl2JAiwKdrAgEmcuevsECLEAWFmrcvcoOmAPEMMoWsOIcIst4W2ggcWt4bEOltGPsKeLEIClstNkCDqvweCLpO/GKv6mIZio4dyDljIKeAOvcOYuvrcrmofjAAWqMmfCWh8l8hWr8kFLkXETsrkQUWgK0edGVNCmTqunACLtgpHGOEdqoOzlbmYt5KhFHLCB+oejeBMWOLrmDr3nMdHJwOoNxrBk+sXsfOrg1MsS1LMQMUcj3hDqIocbCGsQ+hsWgJjj1NGt2NUo0a0UUTcjmvcvmnpM8lUZMjUZfpWn8o0XWtsi0ewIOm0SCfcB0VeF2uJL2t2P2uCQYRlDPkZEgCZI9KYBxP4EQBYKeF9LiRYBYI/o9MrN9F9F9AMH3GPNnADMYB+H/uYFnKbJDMsF9JbNUGAdXMjJAU7KdK7ITO7P6J5MHDKJtv7IHO0MKVaH7OKOHHfJMbQrHGgPHJ3LoKyYyb3J9IyTrDSXnNMAyYASXLMOXFbHDByXbFyXgGjDhmQJgEWOlKBOBFAFBDBHBKmkzPWKzDQXoC6WaohOJGiE9jyvsCoXJIpMpOlIrMSc/o5p/hqakOkNqUEOlPSUgL9EyZPBbK4A9KhLAM0Fwi5KlO5J7L+sxgFMFDAKFD1KlKeBGUDMTHLPlHqPrHxNuAyOTLTCWGWAVJVKMRrt5LuD+u1EiJ1EiOlLCN5HyEpNYASTObOXOfOQuYuQSa1DRFQSAM7KIEgKAIEPIF/OcOMAgK4K4EAA=="}
import { Hooks } from 'wagmi/tempo'

Hooks.token.useWatchTransfer({
  onTransfer: (args, log) => {
    console.log('args:', args)
  },
  token: '0x20c0000000000000000000000000000000000000',
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

## Parameters

See [Wagmi Action `token.watchTransfer` Parameters](/tempo/actions/token.watchTransfer#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

* [`token.transfer`](/tempo/actions/token.transfer)
* [`token.watchTransfer`](/tempo/actions/token.watchTransfer)

---

---
url: /tempo/actions/token.watchAdminRole.md
---
# `token.watchAdminRole`

Watches for role admin update events on TIP20 tokens.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchAdminRole.md","from":135,"to":5281}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"c420598bc27431292ec1a4b52f62cd46424331fc2b9c562b34ffb419fe3f27be","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGcNAQADWinxFRkNVJ9SQAFY/lSDCLxWA6T1EIzmadWYgAEyVBGYLk+WalGj8kAJNb8XGcYH2bhQZgWK4QBQAHiOWQAfEEOslUj7khROFhHMw9GQ4KkacIAHSqxQJx34Z2usDuhQJgAKkejpDg3uKSl9ET2B3wRxOwwuijQNzQd0eXlyYHEUbgEd4MAdVYzbo9uCoUAgvAQBn2IPgnAS7E4DwAkrn9dZhWLFJxSMPOOIXRZVlgoFt4AmLeIlJPkMgQHRO1gFKUAAavtBwXKCwrAaKkGCnkMlDDfA0DQLBOFcOcd2YTgAHIAAFNiUV0AHoYj/WDP0xb9hRgTEIKgiAYIQpDUPQmA0IcCw4EwvJsK4H94zgAiEmguDEMvMj2AomhMVo3IljiUtOAAXl/f8aEAoJgFyThoio4RUmQXi2AAXQoWThSGYQCnfVIZLAOS5OUvC2ATRgoFU1IQLAoIIg0wyIIc1wIlyATYlWDYq1Eng7RMJNNzAVMBwPLNhwDUswwMuShGzGBBzAABVY9TygVIQh0OAwzkCAlCiETfU4aKjKWYcExypQglguK91Co8TxoNLYLDVpIk09xchc3JX2fEB1NvCMhmYUpAyUTgAFp0lLc9+pAQbO1KeaoxGZjJvzIbCzgGaKFvP9m3uUxuDnW1jEMkVPLgFYACM4F4UhGCuvtWKI4V8D7GBLjQGb1LKAk+msRlZR+RBekqJUAQMNMErijVIWhXUXC1axjSRM1UUtQIQjCSIimEITEiDKaCZyOjdNxzpRD+kHekJeQ6mB5pqFaCGmVLWGGXh4ZEcqeUUdNFFeQxvAgiwHccA4DAomTMBUgeQKlygAB5UhnSgP84FMMcJ2pKA1fgZiFyXAARTgIASV6+2XVd12l89KalEGIVsL45UQRUmf+QJpfZxAwaZQYudGfU+e8AWLXRAwRbFshMCiWLhwS5KGpgNLOAyq9Uih0K4oTbhMuy3LM5CzMc4AGVy/LCqICALNKLXJxANJQjkK6nFFDdOAsavxQdN7DPEbdd33TNO+YlYUsau3fod3pGkZoGGhp8HAnjhRE4nlOffdnVA6QYOORNUOeXDq0RYLEYola/TNLkncFFSZ9rFoAASYAxHu5RXGfABuG/OEsdY0NhwPyfq/d+FglBf1/o5OScBFCwFICAl+b8TgQKgZ1SUbwabuwXkgP2lIWatS3pzWEe9egh2mMfeYmMlqFiiBVIuIIgE5nLkoTB+hejSH6C7YGjICGBAqsQ/2LJEb6nUBQ7k5pqF4A7F2HsfZSoKFyEQSQuM4DAKJuop8o5xwNweG9Tgz5FEwGfJwZg0AVgKHDDuIgFlZwDzgPkKxsArorCUEoCBajdyqC2KPTgjjXRyFUedVQMBcgAClxAqIAMp3UYFgfGWi+xRmZHkOAMFRbEDsVATgV0MAOhgFdXJO51hwKLAmNyjwDHmKgJY96tBdLMTQOsCA/icC8EYEkXgRRMSWGOLGSpAAqHghijhJNMbwIJGsHSMFUGYvQhAoDMUuvYPczEjEmDKhVOyz4wwbOEGVMgO5SA7L3GAHJ+yknBXuKcnxcRxCGUeqsOBOTzrrHujQDuDz8kADloAwATAAK2WScf8zAKlgGGUdJQOVW5yEMcY0x1EJBgF7OTZIdwU4d3ebMvs51kDPkyb2DWCYxBjhWGgZ8qkgg2SwLGFCKFICwGBQmdgSgUL1xQkEmgYhxpEENAmWgKFxBYEYChIl+sEwgWYHIAAxBKjWZKIAUsvuc3IBKFVbTJUcqlNLQJ0sQAyplMAWVso5borlp5eX8sqIK4VorxU7mJVtaVcrNXatIKQCICZFwGJhRAOFCLNkKAmQ83JfYVgvJmaoZVXAvwCGUBbQxxrECIrMRYnMlSAD6gzBn7HuBA3NWbZZ+thaELxViA2ApgPwWCzFlqLOYpIPslhZlvVIGoxgYgGxyAwLkOAGBUX4B3JASNnBzA91CcUiApSyA8FzEuJpb18nqzwldBQYZIAdubRbfJSwu00GOL23I4RB32BHcq5iE6+zN1NqEjtfzYBApBX+TsW1ODRJgHigxBLICfKENY8c+tOBLhQorXVtL6WMv+aanQ5qJyWp5WgPlAqhUirFZqqVaAZWyvEONP9MBxpCHGpq8aggojzlILkcxf5O6JHYMwLYuIIW5DOLQB8VjI2eKnf6wNlzhzPkQJUnqwL3IHJzNs2Cb05A5QdOwOQUBYIRGgQyzguYP56U4NJ2TLTSAKbDOdJVFKxNXMk9p1pABSGiYZYK6YU0plTKE1MadjFpmAMnWl2agAZ1pRm0AmcOZ69gQQAGcDOEFk5sFdiEAgHSsM6iG2eNbjkhwWAcCWEUxEZTuRVPqYsO+TgRyFxdjgJeG95z/ESF4O3WsaLDNoAQYgnLTm5LheOXsGLcX/FEQWUl/cWmRXpZTs1oyclfHIA+qEKy8oQbyhG6N3xsT7oJITKQNYS4qldprAENOKaiDMEdvqEGhJXJgFUwtrgisrrVv4Kt9bm24DbfoLt/5iB9tI2kFqE782jK+JTflsgHY5COqAxrFCdAa0UtxO8dQINpA/bG1wCbKi5CqXGu8wbZAmgGn1AjvcXBJtyCW/ErgIXXsA/uKEEHzrwe0Eh6dd4jQmjWFO+d37XB/vHEB1TxjFhwco6zeA5QBoIRakqYJf+nY+xiSi4wGTnB3RXWokIWC0DjHXLAEEZ8RsHm6A7a/WRMBXAAEJOA6+UGQY3z5stnac3l/pqRzd684LsOX8LFfK7AKbp3lufOVca91V8lS2McYjY4xNU7nxjIE9EKZAywCB+fKJ1FHlY0+TaNE0FnZok9cIOsOyauPJHPT3oTPr7mA56jHngvJmuDMAwNHqxYlQvq8bzAIIsawxHJt9RhvwaAVmfczp+TmXHPOfy658zcm9PeY7rG3vbfyq5SqlPqzzU4JeYcyN+3mmp9eb9/PsA9fF9FZOaFtrwWoudayt1xLibksDbS4oFOSmbe5Zc0pC/iCXfX/iz11QfWKWmOGW6kHcRy4uHkhuPksu8uHuByYAquC+/eGuWuPu+uwAhuJuZuuulu1uY+O+rmaBLubuCuAanu3uOBpAxufu4BYAPUF4V4SAN4ZQX6pQyA6idwvY1KkGhqKEHiqg10CYMQzA0GzKcAohFE66AaKENqdq5gV0aEyBwKEQfUP0rw+ga4+odMZIvwHsyorM4mI4Zg9ITQJCeoRoB8qMYc0ikcDa0AUQi+2yJWZWAA/KkN8mGAmF4bFqdKEOtG+u4WABgMgKpBWJwNXBZGnAANS9CmyzA5T7gqE6LawGAEEdzPh+amLrBtr/wwDrDdAAqcAACyliAgj4N6OgKwUY/S0QYaTyEYGsKcYY2RcyoSuQSQRYXAkaWK4QSaosLAkg+SzhugZyOSt6+4UAsyuI5a3RYxyy10YgsyUOQgyioQKws4AScuwSrSGqGmCQQQEIEQEG+qvBjGYA6grKcG3QKwQqZxJGZW4hZxEIjq+WCQCYEIWGMqp2QQU6rQVRDYTatGt6DRUa+Kz4UOcgCYlGjGaAOy3B+qUGxqsG7KnK3K8AyGshaGDqEJnxcqEJ0JWwBJyGrUWWLGdBr4yeEuMQawXAYk8ohehhS+lUsE1JxwqQFmimYYrJaAb+duH+RQNJqQioHcfmAWEmy+LJyqbJ6+3JvJ4+DuApbJnAwp9W5K/m5Jz4lSn6fYBKOJRJcJeqYEiJMGW0ZqqJVqGJqG9qYqOJrqsq+JDGhJjpxJmUFGxW3EdGRJzGDB14t44evYpQRA1gCYvQIZ1g1gqh9sbw+ovQzsuCWoy8eAgiYImojMO8pCIM+8kwR8UifINC58ZAl8mU18MCg898hioCKCH8kCP8f8ACzCMASCYCqCn8tZpZcC5yWOFZyCQuNZ0Crg7Ce8+ogM9MDQ+CzMgQRCKZVgaZAcGZ+ovMlh/MVCeZiwHkQIVY6Ulc4RNcUAg5BojQWhPC5IiZBgG5IIPsvQ3C6ZeoyMP0MQsAGIZMjEfkwgLEbEtmnEYqKkEAtE8aRU6KY0kEz0xECYihxM/EKeeMnkaYPkTEAUaowUTC2c4Uo0UUmk0sqQvQYAYYqmcsaoIGJsC4Ex6sH4jkq88UoUScqU6cN+FUUQxUck6ukmV86+JJ7Uzkp2I2pcp4pA8WIo4EaYECuQ559gdkpQy04gSAoAAQigjiQgeA74IArgrgQAA=="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.token.watchAdminRole(config, {
  token: 1n, // Token ID or address
  onRoleAdminUpdated(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

`() => void`

Returns a function to unsubscribe from the event.

## Parameters

### onRoleAdminUpdated

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchAdminRole.md","from":5495,"to":5753}<fsm-vh3gqscxm4e>
declare function onRoleAdminUpdated(args: Args, log: Log): void

type Args = {
  /** The role whose admin role is being changed */
  role: Hex
  /** The new admin role */
  newAdminRole: Hex
  /** The address that initiated the change */
  sender: Address
}
```

Callback to invoke when a role admin is updated.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP20 token to watch.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchAdminRole.md","from":5944,"to":6146}<fsm-vh3gqscxm4e>
type Args = {
  /** Filter by role */
  role?: Hex | Hex[] | null
  /** Filter by new admin role */
  newAdminRole?: Hex | Hex[] | null
  /** Filter by sender */
  sender?: Address | Address[] | null
}
```

Optional filter arguments to narrow down the events to watch.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchAdminRole.md","from":6348,"to":6393}<fsm-vh3gqscxm4e>
declare function onError(error: Error): void
```

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Enable polling mode.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`token.watchAdminRole`](https://viem.sh/tempo/actions/token.watchAdminRole)

---

---
url: /tempo/actions/token.watchApprove.md
---
# `token.watchApprove`

Watches for token approval events on TIP20 tokens.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchApprove.md","from":130,"to":5175}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"a50530b6c3dfb0005748890f9451c15c1c16886305459d01bf4b5b8957109244","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGcNAQADWinxFRkNVJ9SQAFY/lSDCLxWA6T1EIzmadWYgAEyVBGYLk+WalGj8kAJNb8XGcYH2bhYLCkXwAHiOWQAfEEOslUl7khROFhHMw9GQ4KkacIAHSqxRxx34Z2u3xxgAK4cjpDgnuKSm9ET2B3wRxOwwuijQNzQd0eXlyYHEEbgYd4MAdZbTbpIpSgEF4CAM+xB8E4CXYnAeAElM/rrMKxYpOOIXX3QpwYJc0HA4xbxEoR8hkCA6K2sApSgADO973KCwrAaKkGBbGBBpQh/BoNBYThXEnN1mE4AByAABTYlGYRgAHoYjfMDH0xZ9hRgTFAOAiBQMg6DYIQ9gYAQhwLDgZC8lQrgX1jOAsISEDwKgo8CMQ4iaExCjciWOJC04ABeV93xoL8gmAXJOGiUjhFSZAOLYABdCgJOFIZhAKPdUnEsBJMkuSMLYONGCgBTUl/f8ggiZSdMA6zXAiXJuNiVYNjLASeDtEwExXMBkx7DdfD9QsQ20yShF7YhQlSEIdDgEM5AgJQon471OFC3SlggBQ4wSpQgjAiKiCisCQ1aSIVPcXJ7NyO8bxAJSzzDIZmFKf0lE4ABadJCwPBqQCa1tSgGiMRjorrs2a3N93qigzzfet7lMbhJ1tYwdJFFy4BWAAjOBeFIRhtq7BicOFfAux3GteqUsoCT6axGVlH5EF6fUlQBAwU0K3AwU1bVBmGFwtWsY0kTNVFLUCEIwkiIphF4xIA26xGckojS4c6UQ7pe3pmi+OUmne9pCw1SFoV1IHKghUHTRRXlIbwIJ0xwDgMCiRMwFSB4fNnKAAHlSG4KAoDfOBTEHYdqWF0W6OnWcABFOAgBIzq7OcFyXDmDyxqUXv1Ql5DqZ7FWoVoPuoHzSaQSpycB0Z9Rp7w6YtdEDCZt0WcwKJwoCoq5GisrUi+32YDjbhYvixKg/89MSDjAAZRLktSogIGMgchxHEA0lCORtqcUVl04CxU/FB1zvWny6MkLt11jmAoG127dd6Sp+nx57elsU3/kCH3Y9CK3EBNnU7aQB2ORNJ2eRdq0mZzEYokDtKVLC9ZLFIVIb2sWgABJgDEA7lFcG8AG5V84dtFFgTfOG3veD5OCwlBP8+bMk1sIDWNBUm25ILDQG/Vwko3i9HlG9DuDQbY92VCAMqQ8R4A1hH0amk8wbO3mFDYauYoi5WjiCb6CdEogP0GAg2kCGREzwLlBBttkEvXGGg2mM9MF4BbG2DsXZMoKFyEVUgcM4BZRgIGEwQiM6SwMA8c6d9uEwBvJwZg0AVgKFDH2YyE5xCX3yCo2A20VhKCUM/ARQizpbGLnROALBGByEkEXVQMBcgAClxBFQAMr7UYFgBGgiVERmZHkOAoFY7qKgJwbaGAHQwG2mEt06w4BRjjI5R40jFFQGURdWgGk6JoHWBAS+OBeCMCSLwIomJLDHGjEkgAVDwO+RwfFyOiDYsWDpGCqAUXoQgUALErHsGuOiN5ZE5USpZG8IZBmiOymQN0pBRlrjAKEiZwghF+XuHM1QZjeDiB0kdVY8TQkbXWAdGgRdtkRIAHLQFDgAKwsScd8zBElgBqctJQCV85yBkZMxpZEJBgE7BjZIdwG5FyOW0rsG1kA3nTJ2MWcYxCDhWGgG8CkgjmSwNGOCcFICwFuXGdgSg4ISzgHBGxNAxAdSIIaOMtA4LrngjC+A+5fzMDkAAYkZWLBFX80BLwWbkKFnL9wIumSitFf4MWICxTimAeKCVEszqSj8FKqWVBpXSrADK3SwuZWgVlHLtVMpFaQUgEQ4wzmkW8iAHyvnLIUPIrZOyuwrH2a01QPLi5USMfYu+MrECyPkak9JTzcgAH0qlVP2PcZ+EbQ1c0te8rcsilbbWuTAfgYE6IjS6dXN8nBLBtPOvwpYjAxA1jkBgXIcAMD/PwG6SALrODmDLj67asT4n8O4JmWc2TzoRNFhhbaCgQyQH4TXVWESS1luOBW3I4Qa32HrV/Oizba5yE+RAex/DLmwDjLcy+9zWz7k4K4mAELpFQsgCcoQqihxMs4LOOCfMxXosxdiq5cqdAKuHEq8laBKXUtpfSuCQq4wsvZeIDqV6YAdSEB1IVHVBBRCnKQXIii80WBQ8wLYuIQ1gDOLQS8KiXXeoTdarcSyGk3kQEk2qtynJ2tDrlfK51115NyaQOQUAwIRDflizgmYj6aU4KxhKDp2BcZDBtblSKGMNOGXlMCom8kAFJyIhjAhxrjPG+NwQE0J6MImYBsfE5xqAUm8kybQHJlZ0z2BBEsOsTgZwTX2bArsQgEAMUhkEdmox+dQkOBdIoBuPHeO5H44JgBdE7P8LbHAI8tcFkHoLqpJwELLNoBvpvCLenJIuZmXsTz3nL44U6f58QgW64hagLl3SH8uDIB3KEUy8oXryjq/Vsx7iDpeLjKQNYs5kmlorAETgDmrmICIMwF6EJ9QvUJA5MA/GutcD5qm9NaB+uDeG3AUb9Bxt+um8DaQWpFudd0mYv1ACyAtjkCBw1Ys4J0HTUi3E7x1AMIuw1zgTW/YKQ6kc6rm9GgGn1N9tcXBmtyB654rgE3YCIBu/cUID271PZe7wN7Qh3ig8aNYJbK3LtcGu8cW7qPsMWGe37UNh9n4GghFqJJPF82ti7IJdz1jPlXGtWRIQYE35DM2Gsm88ttm6H4fvdhMBXAAEJOBi+UGQWXN5wvLb01FipqRFcS84LsLnnAed/2WWAeXOvlcWYPdlmqd4kkEaI86yxyhVZ1O+Q65plSwA25vPR/5zkPWCTaK4w9zBXFlcIOsSygvnLTPckHkPYeIwR6j3JrgzAMD1JMYJRzxjsqZ4UEEHlIZplq7Qxn75CmWPGbE1p7javIsGbMtX9jEnzNFx5WX/PTGRlKeb5wNTJVwK1503VzXwnlOmck+32TYB09d7jLFhzMAnMFbcx5iAXm4qlb887gLInquWDr/XjXjffur9vuvzfPmyuqAq1V4Lh+lJF2mcz5y0v3Kc/XYb3nJuBed4r8LmAEEKLuLmQJwFLmznLgrqAaQCrsfvptFtrjAXrgbkbnzqbtAUrrAZbi/mALVIeMeEgKeGUGeqUMgIIncJ2Kiq+lKnBIYqoDtHGDEMwO+riiSjKnBEOtanBKququYNtIRIxnupEPVDdK8KQo0CSEbOSFQgYLIkPHjKPPQkaEwtPOaKwm7NmtAFEPPsxvFolgAPypBnIhhxhmFeZrShATRHrGFgAYDIAKQlicCpzGTjYADUvQSsswCUlWEQ4iWcY+2SeSN4Vm8i6wha+ay+3QocnAAAssogIFeLXDoCsBGBUtENsmEl2GGGLA3CGOEe0vYrkEkHmFwC6iCuEC7q6CwJIBEvoboPMqErnGuMLG0riFuOUU0T0rtAIPWGtLwqECsBOJYrBDYvwpCtCkJgkEEBCBEC+hKrQdhmAOoPil+t0CsLSksfBoliSksRCA9gAgkHGBCGBnqnIEtkED6q0KkTWLmmup8jka6hMW9nIHGFhlsKMtQRKm+jKp+oSsSr+vAP+rwUBpqnBC8acfqi8e8WgDCR1GVBEGarRneL7izjEN/O5PKNHkIcxmBOiccKkCptxiGPibyrpggVrkUN/KkIqEXFZjZtlLiaSYgIPqSfAYEakMyZwLSdJllh3ngbbl7mAKel2FChCTCZ8eKv+D8R+vuPKgCWSkCQBmqqCfBBCeBmytCewNhrCdqVsPCbFMhtOOhl2JhnqWtE3BIIQSgGeE7p2KUEQNYHGL0M6dYNYKITrKAuoDKNIZQjAubDQr9FYIoUgnqK9I7NMCwnyFggvGQEvLFFpBfBAOvGQFvDvPvHTsfGfBfFfAsqmXfOmY/EfC/Nme/GuIotSWEv/McEAiQn0NIN3E9FArIXArFAoXQnqPqPKBGdyOodGYsM5ECGWNFMnM4WnFAHWWDlIWSL8P6YEEOSCEPL0O3EoXqCDDdDELABiOjDRJ5MIPRIxJpixPBPJBABRE+NRICu1EBCdLhHGIIVkFxH7vDC5CmO5LRN5GqH5AQiHEFCjCFCpBzKkNYGANZGFGAIVKEDFMeJHElCvGWUMriYHIPgiRVHZEtnVvHB+KQD5iKABCmM/LkAufYJZKUCNOIEgKAAEIoJYkIHgHuCAK4K4EAA=="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.token.watchApprove(config, {
  token: 0n,
  onApproval(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

`() => void`

Returns a function to unsubscribe from the event.

## Parameters

### onApproval

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchApprove.md","from":5381,"to":5600}<fsm-vh3gqscxm4e>
declare function onApproval(args: Args, log: Log): void

type Args = {
  /** Amount approved */
  amount: bigint
  /** Address of the token owner */
  owner: Address
  /** Address of the spender */
  spender: Address
}
```

Callback to invoke when tokens are approved.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP20 token to watch.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchApprove.md","from":5787,"to":5953}<fsm-vh3gqscxm4e>
type Args = {
  /** Filter by token owner address */
  owner?: Address | Address[] | null
  /** Filter by spender address */
  spender?: Address | Address[] | null
}
```

Filter events by owner and/or spender addresses.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchApprove.md","from":6142,"to":6187}<fsm-vh3gqscxm4e>
declare function onError(error: Error): void
```

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Enable polling mode.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`token.watchApprove`](https://viem.sh/tempo/actions/token.watchApprove)

---

---
url: /tempo/actions/token.watchBurn.md
---
# `token.watchBurn`

Watches for token burn events on TIP20 tokens.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchBurn.md","from":123,"to":5109}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"964634b1472c31080644e57c6495fef8eddfe7936d04a402712785277c2e7797","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGcNAQADWinxFRkNVJ9SQAFY/lSDCLxWA6T1EIzmadWYgAEyVBGYLk+WalGj8kAJNb8XGcYH2ABCdzAAB4jlkAHxBDrJVKe5IUThYRzMPRkOCpGnCAB0qsUscd+Bd91jAAUwxHSHAPcUlF6InsDvgjidhhdFGgbmhXU8cLkwOJw3BQ7wYA6S6n1VQoBBeAgDPsQfBOAl2JwHgBJdP66zCsWKTgAI1dnBglzQcFjFvESkHyGQIDozawClKAAMr1vcoLCsBoqQYFsYIGlMH8Gg0FhOK4x6QIGYTgAHIAAFNiUZhGAAehiJ9gNvTF72FGBMV/f9AJA8C9yg2D2BgWCHAsOAELyJCuAfGM4HQhIAKAsCINwuCCJoTFSNyJY4nzTgAF5H2fGg3yCYBck4aIiOEVJkFYtgAF0KFE4UhmEAot1SESwDEsTpNQthY0YKBZNST9vyCCIFM038LNcCJcg42JVg2EteJ4O0THjRcwCTLtXV9fNgw0sShG7VIQh0OBgzkCAlCiHivU4QKtKWCAFFjKKlCCYCQuA4NWkiRT3FyGzcivC8QHko9QyGZhSj9JROAAWnSfMdwqkAqubUoOvDEZqKazNquzbdyooI8n1re5TG4MdbWMTSRUcuAVmXOBeFIRhlw7WjMNUDsNyrVr5LKAk+msRlZR+MYlQBAxk27DVIWhXUXC1axjSRM1UUtQIQjCSIimELjEn9ZrgZyMjVIBzpRBOxBel6c66ku5pqFaG6mXzB6GSe4YXsqN6ORNbwUV5b68CCLAAJwDgMCiBMwFSB5PKnKAAHlSG4KAoCfOBTD7AdqS5nnqInKcABFOAgBJhXwDtp1ned6Z3GGpTh/VFS+OVEA1yl0fprHEEqHHYSQfV3tNEmLXRAwKapshMCiYLXVCvLUju11Y24cLIuit2fLTAAZaLYviogIAM0p+cHEA0lCORlycUUF04Cww/FB1ZfmzzqMkDtV3uGAoGV47Vd6eVCXkJGGhR3XAid+4DY1nVcdGM3CY+y35h+7rsyiV2EsUsTtuYVIL2sWgABJgDEdblFcC8AG5B84ZsIDWNBUmXZILDQJewFcSU3l6RoNYuhojdR/5Ajyxvjb1cZ24tnkratCmsxGKJ0r9kFu1jIOlEPvoXo6h+ia0uoyWueB0q3yZIMFufR5Tm2Js/LueAmwtjbB2ZKChchEEkADOAKUYABhMEQyO/Zo4PFlpwC82CYAXk4MwaAKwFAhgAkQAyo5xCcDgPkVhsBVxKCUBYeqdCZZbBTtRXhUE5D4IWrtXIAApcQeCADKa1GBYCBoQ1h4ZmR5DgEBSmxBOFQBXBgB0MBlwrgAusOAkZYx2UeNQphUAWF7VoKpaiaB1gQB4TgXgjAki8CKJiSwxwoxOIAFQ8BoUcHR9DoiyN5g6RgqhGF6EIFAKRKx7Ar2orQ0hqV0pmQvMGQpwgiGxjIABUgpSV5gDMRUhJ3l7j1NUBI3g4hNKbVWPYsxC11jrRoMnbpFiABy0AYCxgAFZSJOM+ZgjiwAxOmkoKKCc5A0LoQw4iEgwDtihskO4hdk5DLSR2BayALzGPbLzWMYg+wrDQBeWSQQTJYCjNBaCkBYBzNjOwJQ0Eo7QVkTQMQDUiCGljLQaC4gsAwVufAbcn5mByAAMRIt5o8teaA+6NNyNcrF25Hk1Nee8r8nzEDfN+TAf5gLgUUNBS+CFULKgwrhQi6CxLYyooxcS0lpBSARFjJOah6yICbO2UUxJXSekdhWP01JqhcUp3IiImWHYLy0sQDsxhzDUpOIAPpRKifse4IjTVGsZuKjZoQCFEMlsuGZMB+DAWoj1LJOcnycEsGk2WpACGMDEFWOQGBchwAwAc/AAFICKs4OYdOu0bEQDsWQHg6YpzeNlhYnmqFlwKGDJAQNudNUWKWMGmgxww25HCFG+wsa17UUTR2OOktdqBsmbAWZ8ynzNm3JwVRMBLnUOuZAEZQg2H9mRZwKc0FWbko+V8n5Uz6U6EZQOZl4K0CQuhbC+FiKAJ3JRWgNF6LxANXHTABqQgGrEoaoIKI45SC5CYT6iwz7mBbFxMs3IZxaCnlYYqjVyaJVSuaUQi8iAnGlTmfZSpxToqZVlnIKKDp2ByCgMBCIe9vmcHTLPNSnAUNod8aQTDwYFo4uefBlpJTgIkb8QAUhIsGYCZHMPYdw9BfDhGozEZgKhvxHGoCUb8dRtAtGqk1PYEESw6xOBnCFbJ4CuxCAQE+cGQhnqNUJzMQ4LAOBLBYYiDh3IeGCM72ojJwNLY4B7lbY0nhEheBJ3LIcqjaBYBCug2APDYklO1L2OpzTPDAKZN0+IfT8KjOF3MzxrSK8uDIA3KEIy8o4byni4lpLg6NFaNjKQNYU5nHBrLAETgcmpmICICPBG+o4aElsn5hLWkJGs2da6tAhXiulbgOV+glWdW1detILUTXsuJYkTqneZAmxyG5Ue5F0E6Cuuebid46g4bSEm215LqW5CyQakMmLZAmgGn1LtsSEiDvqPWloob1XZv3FCIt6dvMVu0DW3Nd4jQmjWGa/5vbvqnvHDm69r9FgVt4LkEameIiDQQi1E4zivrmwdj4qpxgqHOBXElcRIQwE950NaWAIIF4xbdN0IGqe6CYCuAAIScEp8oMgDOLxmZa7xqzqQWfU84LsbHWy8db0qWAJnfO2diec95l9YBSpOP/YBhVvDlCariTKhhvBkmRLACVK8cGDkOVVXxNoqiFnNlUeFwg6wzLE4cjUlyZuLfMCt+GG3dvaNcGYBgeJjq+LyYdalP3Cggi4uDDUznr7fcyrSkhhjgnSMYZM9x7nETjKJ+E8n6XuLo8h+mfRxjnAWM5RAiJrj2XLPp4E0J9D5HRPJ1z2AH3+fqnKbqYHwLKm1MQA0xFMLOm1d6eI6d4z2HOcWb41JLvpBgu99C9piLQ+osj8M4oQu8lk41JRw5OnLksc45FwTsARO8+x82G0inVP020/R4z5n1/SDs4nzxqvRHJeBsF4f/HYuJeP4Z9LtvvLleLuPuEgIeGUMOqUMgIQncO2G8kutStBMIqoMtLGDEMwCun8nAFgQRAWpKtBGyhyuYMuHhAhtMnMhEOVEdK8EAoSPqJXGSL8JfMqBjOQQbCjM3CbIbEgtMCgnyD9J6tAFEK3iUnZg5gAPypBjLBixhyEaZzShADT9rSFgAYDICyRFicBhwGSVYADUvQksswUUUWVBvYFCeAb+3ifiF4EmDC6w/qvqMA6w3Q0ynAAAsiwgIGeK2joCsOGBEtEN0iuB2KGLzIXMGA4ekgosDDmFwIqqcuEOrpTCwJIBYuIboA0mYm2lFlAGkriPagkdkTkitAILWHNLgqECsKONItjnIn4kSoRgkEEBCBEIupSkgV+mAOoACuut0CsLCl0Xeg5jgV0RCItjvAkLGBCLyqenIM1kEMmq0P4VWN6q2jjmEUqlcheOtnILGJ+lsKUggZSsurSmukCiCmCvADukQfulyrsbMWersQcWgC8Q1HlKZr+sAReIbqjjEOvC5PKPbuQXHhlMBP8ccKkExlhsGBCXiqnlYakHCakIqMnBJlJohmCciaXnCS/mnkRsiZwKiZ5k8pJt8U4kOh2Ncg8S8UcRSt+KcautuAypcSyjcXupyjBA8Xyuis8ewF+q8fyVsO8eFE+hOG+h2B+kKXNMXBIGASgEeKru2KUEQNYLGL0OqdYNYNQSrEfNILYGAg0BAmjIENAmCJqJwXAtwb0G3JMMguaKgjbD3B/CvOFOpMvMPKPOPFPPDnPIvMvKvOvJvNvMcHvAfLqfoHOIjEwYbNdNfOFBwXfC9OrLwdyA6QIYsA5ECCWKFCHNoeHFAIAqbJUAwYacwZAgYNmSCAbPDEmaMG9EdDELABiJDJRG5MIDRHRGXjhDBDJBAKRHeBREcvVH+MPCBLGGQVkOxEboDI5MmC5FRB5GqN5D/L5HVAFIpPTKkL0GAMGHhhOPTCvELMiopPXGTnlD7DFAPJZGJCTvRq7KXh8QVNZM1tlgHC+KQFpiKD+MmCIrkFWfYGZKUD1OIEgKAAEIoLwkIHgFuCAK4K4EAA"}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.token.watchBurn(config, {
  token: 1n, // or token address
  onBurn(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

`() => void`

Returns a function to unsubscribe from the event.

## Parameters

### onBurn

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchBurn.md","from":5311,"to":5478}<fsm-vh3gqscxm4e>
declare function onBurn(args: Args, log: Log): void

type Args = {
  /** Address whose tokens were burned */
  from: Address
  /** Amount burned */
  amount: bigint
}
```

Callback to invoke when tokens are burned.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP20 token.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchBurn.md","from":5654,"to":5740}<fsm-vh3gqscxm4e>
type Args = {
  /** Filter by burner address */
  from?: Address | Address[] | null
}
```

Optional filter arguments.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchBurn.md","from":5907,"to":5952}<fsm-vh3gqscxm4e>
declare function onError(error: Error): void
```

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Enable polling mode.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`token.watchBurn`](https://viem.sh/tempo/actions/token.watchBurn)

---

---
url: /tempo/actions/token.watchCreate.md
---
# `token.watchCreate`

Watches for new TIP20 token creation events on the TIP20 Factory.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchCreate.md","from":144,"to":5187}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"0fc1ecb422e1310805039e9f9c6a825260c57e6ebb91bb88edd178eeb92819a4","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGcNAQADWinxFRkNVJ9SQAFY/lSDCLxWA6T1EIzmadWYgAEyVBGYLk+WalGj8kAJNb8XGcYGHUgwLYwAA8RyyAD4gh1kqlPckKJwsI5mHoyHBUjThAA6VWKWOO/BpZ2u2MABTDEdIcA9xSUXoiewOKaEJ2GF0UaBuaDujy8uTA4nDcFDvBgDtLqZdNFKUAgvAQBn2IPgnAS7E4lnWnAeAEkM/rrMKxYo4NE0zQoLGLeIlMPkMgQHQW1gFKUAAbXtBwXKCwrATe9mCBpTB/BoNBYTiuCekCBmE4AByAABTYlGYRgAHoYmdYD70xR9hRgTFf3/QCQPA/coNg9gYFghwLDgBC8iQrgnxjDc/wSACgLAiDcLggiaExUjciWOIC04ABeZ9XTfIJgFyThoiI4RUmQVi2AAXQoEThSGYQClvVJhLAUTRKk1C2FjRgoBk1JP2/IIInkjTf3M1wIlyDjYlWDZS14ng7RMeM1zAJNuy3GBfQLYN1NEoQHg8ntXSgVIQh0OBgzkCAlCiHivU4QLNKWCAFFjOKlCCYCQrVfjt0QYDg1aSIFPcXJrNya9LxAOTj1DIZmFKP0lE4ABadIC13BqQCaltSgG8MRg3Lqs2anM4F6ihj2dOt7lMbgJ1tYwNJFBy4BWAAjOBeFIRhts7WjMNUTsYEuNBerksoCT6axGVlH5EF6fpqFaAEDGTMK+zBTVtUGYYXC1axjSRM1UUtQIQjCSIimELjEn9bqkZyMiVPhzpRDul7ekVL45SaJVPqZAsNUhaFdWByp9TB00UV5KG8CCLAAJwDgMCiYLQp8iLOCig9Um+nzY24aLYvioXvJfWMABl4sS5KiAgfT+0HYcQDSUI5G2pxRVXTgLGV8UHXwRROHEacYFnBclxXBMNMYDd9pfHdJTeXp9RlOpnt6SpicCbm1R+mAoHJpB/aZQHYSQWmORNbwGYtdEDBZ7MRiiMq1IU0SHdSS9rFoAASYAxAO5RXEvABuHPVzVec+e25ILDQGuLNE5tw1SMuLCUNvNM4OAMGYbaMu7k5e/7tK7mdMBeAwcfy772uAEcVggGh8sUfPC5LnuK+r2vxCgKCwB34vS4ng+29cd39D9/V5B9hpI8pEmyvDxBI51IHRl6dQ6aJx5MnK0adJoZ04NlKWIIQ5y3infPolRCRPzJAyAOeBsqf2/tHPU+oISAOmMA+YgRO7wHbJ2dKChchEEkPDOAGUYABhMAwtWQ48APDNpwS8lCYCXk4MwaAKwFAhgAkQfS45LZwHyMI2A20VhKCUL3OhDDhQOC4E7QeLBGByFoRtM6uQABS4gaEAGV9qMCwIjehwjwzMjyHAICrNiDiKgJwbaGAHQwG2m4gC6w4CRljLZR4nCBFQCEedWgKkNxoHWBAQeOBeCMCSLwIomJLDHCjEEgAVDwLhRxrG8OiDouAG51iMFUPwvQhAoAbi2vYC2G5uHMMytlUyl5gxNOEAw2MZAAKkDaRbMArjOkFK8vcAZqgtjRHEBpI6qx/GuI2usA6NADYzI8QAOWgDAWMAArWpJwXTMECWAHJy0lBxV1nILhPC+HEQkHPChBY7ihwNss8pnYNrIEvE4jsJTYxiAHCsNAl4ZJBGMlgKM0FoKQFgPs2M7AlDQQHEOaCOiaBiA6kQQ0sZaDQXEFgGCvz4DTU/MwOQABiYlJTAUQGBZnIZuRvnUumoC3poLwVfkhYgaFsKYDwsRci9WaLXSYuxZUXF+LCXQRZbGMllKWVstIKQCIsY5ycIuRAK5NzmmFN4DMtxnYVgLIdOUwgwLDbkSUWdLhfLEC3P4YIzKQSAD6WSsn7HuL3d1LrUgcM7Jq7VPDOBat2TAfgwENwjWqRuSQnZLBmrIHQp2NBjhyAwLkIec98AAUgMayBjATY2u2r4/xpAeAZnnNEs2HjnT+JHgoYMkBy1xtUTADxSwU3VnTbkcIGBs25rpRucwJttYhrOuWrZsA9kHLTMwaanATEwE+Zw75kBVlCBEYOElnB5zQQAPIcohVCmF2yBU6CFai9F8A0BYpxXiglRKAJ/NJWgclFLxAdXXTADqQgOoso6oIKIk5SC5AEc6Q2iR2DMC2LiE5uQzi0DPMI411qNWXNCDqrpChLyICCbVfZdlsM7NacBM2cg4oOnYHIKAwEIht2hZwDM5dVKcHI5R2JpAaPBg2rS4FRHRmkfY3EgApCRYMwFOM0bowx6CTGWNRjYzACjcSpNQB43EvjaABPdN6ewIIM5OBnGVfp4CuxCAQEhcGeh0alG61cQ4LAOBLC0YiPR3IjHmMtw3Hp8trY4D7k7DM1x5ReD6wrB2A2SrSB4bAIx0Sxm+l7As1ZwegEql2ePmxglznQ4ebkwPKZyALqhEMvKF68p8sDwtlwMxB1LGxlIGsecwSnZHChvzO1RBmAvQhPqF6hIbJxYK5pKZ+7tphv4I15rrW4DtYCJ17ZiBusg2kFqQbVXCtcDtS3MgzY5AyufSS6CdBw3AtxO8dQL1pCbdG1wYrNC5AyQ6ssnLZAmgGn1Ld0SUyStyDqxYrgBmlu7fuKEQ726SkndoGdta7xGhNGsEN+Ld3pwg+OHt8HMGLAncey6/eKQ8FaiCZxacLZOx8TM9o65VwtXESEMBNuPCxlgCCJeAAIjM3Q5aS6kNcAAQk4Jz5QZB+eXnc8N+T3nUjC+55wXY1POC06bl0sAgvZei404PNAsBlU1WvEExDyGjVSOUG2vJuq+G8GKZksA+vLyEbnvZOlXA+JtBMYclsJj0uEHWKZJn9lenOXd575g3vwy+/9wJrgzAMD5JUXxQzzP48KCCC74MvSJdgbj7qrK8VcrCao1x1zsmpcZKMspjj1H1MGxd9nlPJH89kcr6J8TIE1Myaq158vSmVNF+47X/jYBY8N56SZ/phnEumfMxASzMU0u2bN/Z7LTnFChzoxLzzCnJJT5i/LlL8+bMZaX1lxzuWDJa96ST+ypDnJU4o0runqvGf19z5scZHOudJt5+TgXQuv+kBi6b5ybd6sYa7loK4P7K705q7/4i6AGX565gC1R7gHhIBHhlDLqlDID0J3AdhgrHo8rQSKKqA7SxgxDMCnpwpwBUEETbSXLQTiqSrmDbR4TEYzoRD1Q3SvD3zygkjPy/DvT/DtC6qfz4w/wxxfwELcjmjELMzRrQBRCj6tL+aBYAD8qQ6ywYsYOhlma0oQE0LYim6yyAMkxYnAys+k/MAA1L0CGrMHFMfJwVQCihrKAdEnEpeFpnwmUhUjON0DspwAALJCICDnhBY6ArDhgZLTKzKdihglKhzBi+H4Btq5BJC5hcDGqvLhDm6swsCSAeKqG6CDKuJjrHxQDlK4iYbZFlG1I7RiDlLnZCDUKhArDjhSJQQ6LlpfI/IsYJBBAQgRBHpcpEEwZgDqAIoXrdArB4rjH/qBY0HjEQiHYtwJCxgQhypvpyBDZBA2qtBRHVixoQZjoJEmq9HnZyCxggYwZoBtIEFconp8rnpIquEioYq3pMEPrSqXFbHvqXE3FbCAm3plRubwbIHXiO6k4xBrCu6cDygB7sGkYwnHCpAia0bBgoloDAFl6sZYmpCKhRY6515O5IlN74klRFCwk4nuGpD4nwla5ab25BJLqdjfK/HAn3GcrfhPFnrTSCpvHXpir3pSowS/HyoUoAnQZAnSkgnRTAZTjgadgWDAlwaoGHjHim4dilBEDWCxi9D6nWDWBcHYxSgvSNDeyoJajoIGCYJ/RWDiE4LAyezSEQyMwpzBDDQ5iZzRTZztx1zbxcK7yXxLyVxTy5weQNypBNyKLHDhlk5dza5LzxlDwjxjxJmTy1y8AzyKDzyLyZn+lrwbwwBbxnxBkXwE5hlHwnwWDnx7xXxKBVlgC3ymkeyEi2AEzPSvwfSBAfz2kKiUy/yxzyiulJxyEGCk5AiliRSKwWEqxhytn6D6i9D8FWkUg9mAiOQgify9AdkSF6igw3QxCwAYgYyUSuTCDoQnT0SMQwTSQQCkQPgUSYzJBXl0QgSxhsFZDsSknLBTkgjORUTuRqheQwI+R+SowBQKRByKAhxQACzz7ZRRCpSiTM6kZZyUmgkVRWRDZVayyuikDWYig/jJi9y5D/n2CmSlAjTiBICgABDri4h4C3ggCuCuBAA==="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.token.watchCreate(config, {
  onTokenCreated(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

`() => void`

Returns a function to unsubscribe from the event.

## Parameters

### onTokenCreated

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchCreate.md","from":5397,"to":5809}<fsm-vh3gqscxm4e>
declare function onTokenCreated(args: Args, log: Log): void

type Args = {
  /** Address of the created token */
  token: Address
  /** ID of the created token */
  tokenId: bigint
  /** Name of the token */
  name: string
  /** Symbol of the token */
  symbol: string
  /** Currency of the token */
  currency: string
  /** Quote token address */
  quoteToken: Address
  /** Admin address */
  admin: Address
}
```

Callback to invoke when a new TIP20 token is created.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchCreate.md","from":5918,"to":6076}<fsm-vh3gqscxm4e>
type Args = {
  /** Filter by token address(es) */
  token?: Address | Address[] | null
  /** Filter by token ID(s) */
  tokenId?: bigint | bigint[] | null
}
```

Optional filter arguments to watch for specific tokens.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchCreate.md","from":6272,"to":6317}<fsm-vh3gqscxm4e>
declare function onError(error: Error): void
```

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Enable polling mode.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`token.watchCreate`](https://viem.sh/tempo/actions/token.watchCreate)

---

---
url: /tempo/actions/token.watchMint.md
---
# `token.watchMint`

Watches for token mint events on TIP20 tokens.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchMint.md","from":125,"to":5129}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"1e6861a9411f2b10135215821f2c629c4813bdfdb5bb1a235a11dc6a7b4e8738","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGcNAQADWinxFRkNVJ9SQAFY/lSDCLxWA6T1EIzmadWYgAEyVBGYLk+WalGj8kAJNb8XGcYH2ACyFjQAB4jlkAHxBDrJVKe5IUThYRzMPRkOCpGnCAB0qsUscd+Bdx1jAAUwxHSHAPcUlF6InsDvgjidhhdFGgbmg7o8vLkwOJw3BQ7wYA6S6mGFQoBBeAgDPsQfBOAl2JwHgBJdP66zCsWKTjMV2cGCXNBwWMW8RKQfIZAgOjNrAKUoAA0vm9ygsKwGipBgWxggaUwfwaDQWE4rjHpAgzCcAA5AAApsSgrgA9DEj5ATemJ3sKMCYj+f4AcBYG7lBMEwNBDgWHAcF5AhXD3jGcCoQk/6AaB4HYewuE0JiRG5EscT5pwAC8D5PjQr5BMAuScNE+HCKkyBMWwAC6FBCcKQzCAUm6pIJYDCcJEnIWwsaMFAUmpB+X5BBEslqT+pmuBEuSsbEqwbCWXE8HaJjxouYBJl2rq+vmwaqcJQjdqkIQ6HAwZyBAShRJxXqcH56lLBACixuFShBEBgVAcGrSRHJ7i5JZuSXueIAyYeoZDMwpR+konAALTpPm26lSA5XNqUrXhiMFH1ZmFXZluJUUIej61vcpjcGOtrGGpIp2XAKwAEZwLwpCMAtHZUehqgduuVZNTJZQEn01iMrKPxjEqAIGMm3YapC0K6i4WrWMaSJmqilqBCEYSREUwjsYk/oNYDOTEUpf2dKIR2IL0vSnXU53NNQrRXUy+Z3QyD3DE9lQvRyJreCivKfXgQRYP+OAcBgUQJmAqQPG5U5QAA8qQ3BQFAj5wKYfYDtSHNcxRE5TgAIpwEAJMK+AdtOs7zrT25Q1KMP6oqXxyogauUqjtMY4glRY7CSD6q9ppExa6IGGTFNkJgUQBa6QXZakN2urG3AhWFEUu55aYADIRVFMVEBAumlLzg4gGkoRyAtTiigunAWCH4oOtLM1uRRkgdiuxwwFAiuHcrvSErY6uI5dgQO8cetqzq2OjCb+Nveb8xfR12ZRM7sVycJIqpOe1i0AAJMAYircorjngA3L3nDNhAaxoKkC3JK6s9gK4kpvCXMoIw0BvI/8gTZbXht6uMzdmzyFtWmTWYjFEKU+yC3axgHSjb/ovTSPDZKY0fZUZgIpnyZIMBufR5Sm0JjfNueAmwtjbB2BKChchEEkH9OAiUYABhMNg8O/ZI4PGlpwc8KCYDnmXNAFYCgQz/iILpUc4hOBwHyLQ2AC0VhKCUBYGq5CpZbCThRVhK45AYNmttXIAApcQ6CADKK1GBYABlg2h4ZmR5DgIBcmxBGFQE4AtDADoYALQMf+dYcBIyxmso8EhzBqG0LoEpCiaB1gQBYTgXgjAki8CKJiSwxwow2IAFQ8FIUcVRFDohiO5g6Rgqhlx6EIFAYRKx7DzwomQvBSUUrGXPMGLJwhsGxjIP+UgeT55gH0YUyJHl7gVNUII3g4g1LrVWJY/Rs11irRoInFpRiABy0AYCxgAFbCJOE+Zg1iwChImkocKcc5CkPIZQgiEgwDtghskO4+dE7dPiR2WayBzw6PbNzWMYg+wrDQOeKSQRDJYCjJBSCkBYDjNjOwJQkEI6QTETQMQtUiCGljLQSC4gsCMEgmc+AW4PzMDkAAYhhdzK5i80BdyqbkE5KKtxXNKXch5n4nmIBeW8mAHyvk/MIX858gLgWVFBeCyF0L/znLhWgBFyK2WwvxaQUgERYyThIQsiASyVnZKic01pHYVgdLiaodFScSK8Klh2c85LECrKoVAGhIybEAH1gnBP2PcXhxqDX0xFYs0ImDsHiwWqMmA/AgIUU6skrOj5OCWHidLUgmDGBiCrHIDAuQ4AYE2fgf8kA5WcHMKnbaZiIAWLIDwdMU4XHSyMVzZCC0FDBkgP67OaqjFLEDTQY4IbcjhAjfYaNi8KLxo7DHcW21/VDNgGMiZj5mxbk4HImARySEnMgL0oQdD+yws4FOSCzNCWPOea84ZlKdDUoHLSgFaAgUgrBRCqFuLYzwqReIWqo6YC1SELVXFtVBBRHHKQXI9ivUWHvcwLYuIZm5DOLQE8tC5WqsTaK8VNTsHnkQDYoq4ybJFJyRFNK0s5DhQdOwOQUAgIRA3i8zg6YJ7KU4AhpDbjSCoeDLNNFNzoO1NyUBAj7iACkhFgxASI6h9DmHILYdw1GfDMBEPuJY1AUj7jyNoEo8U0p7AgiWHWJwM4/LJNAV2IQCATzgxYPdaquO+iHBYBwJYNDEQMO5Cwzh10FEJP+pbHAXczaqksIkLwBO5YtlkbQLAfl4GwBYeEnJspexlOqZYQBJJmnxDaYhXp/OxmOPqXnlwZA65Qj6XlDDeU0XYtxf7Yo5RsZSBrCnLYwNZYAicCk8MxARBmAwwhPqGGhIrJeZi+pQRzNHXOrQLl/LhW4DFfoKVzVlXnrSC1PV9LsXBGatdGQJschWWTu5pBOgzqbm4neOoGG0gxvNfi4luQUlardIi2QJoBp9RbeEoI3bCjVrKP6+Vqb9xQhzfZYt2gy3prvEaE0awDXvPbe9fdvOj3ZtvosIt9BcgDXj14QaCEWobFsW9c2Ds3FFOMEQ5wK4YqCJCCAhvchdSwBBHPCLFpuh/WjwQTAVwABCTgpPlBkBp+eIzjXONmdSAz8nnBdjo+WVj1eRSwB0650zoT9n3MPrAEVGx37f2ytYcoNV4TJWUN4DEoJYBCqXig5s2ySruJtDkZM5scjguEHWMZfHtlSmOSNyb5gZvwwW6t5RrgzAMARPtdxaTdqkpe4UEEdFwZSms8fZ7yVyU4M0d44RlDBn2Ps8CQZWP/H4/i/ReHgPIzqO0c4AxzKwEBNsfS6Z5PPG+PIeI4JxOmewAe+zyU+T5Tfe+YU0piAKnQpBY00rrT+Gjv6fQ6zkzXHxJt9IP5zvgX1Mhb72FgfunFD5xkonUpCPbJU8cmjjHAucdgDx1nyPmx6kk7J6mynyPaf0/P6QZnI+ONl7w6L/1vPd/Y6FyL2/NPxfr+l5eHcPcJAA8MoQdUoZALBO4dse5BdUlSCHhVQRaWMGIZgJdd5OANA3CPNMVSCBlJlcwBaaCSPcZCIEqA6V4fQOcQ+M6ckSuRYSVPWJGeuI2fWaBaYWBPkL6d1aAKIRvXJKzGzAAflSH6WDFjHEJU2mlCF6l7RELAAwGQCkiLE4BDl0lKwAGpehxZZhwowtSDexCE8An8XF3FzwRNKF1hfVvUYB1hugRlOAnQaEBBTxm0dAVhwxAlogWkDEOxQxuZ85gxLCElJFAYcwuA5U9lwhldyYWBJAjEBDdBKl9EW0wsoB4lcRbUIjkjUkloBBaxpo0FQgVhRwRF0dxF3EcVcMEgggIQIh51iU4C30wB1BPlV1ugVgwUmir0bMMCmiIRWVXQEhYwIRD1OU5AGsghE1Wh3CqxPVm0Mc/D5VjlzwVs5BYxX0tg8kYDiVF1yUV1vlfl/l4At08Dd0WVVjRiuVViNi0AbjapspDNP1/9zxddEcYgl5HJ5RrcYMc9o93jjhUg6M0Ngx/iMVE9jDUhQTUhFRE4RMxNYNUogIoTC9QSH8k88MoTOAYTXNrlRNnibEB0OwTkLibitiiUvxdjl0twqVDi6UTid1mUoULij1EVrj2A31bj2Sth7iQo70Jwn0OwX0uTppC4JAgCUBDxFd2xSgiBrBYxeh5TrBrAyClY3h9Reh9R5B94AFtZAgUpGDz4noNS2DuRzQ4ErYO5H554QoVI55+5SEh5R5odJ4Z454F4l4V415jgN4t5VTKDVYtT/59Y6CDBT4wRNQmDwEWDVYTT3piZLY0Z/o7Jkwgog4VDQ4oAv5jZGhqDtT3gQyQAgQSw9ZYZDTRgXoDoYhYAMRwYyJnJhBKJqIi8sIoVJIIAiJbxSJtkapfxNoaJYwiCQYWI9ckyiyQRHJyJXI1QPJX4vJqpfI5JaZUggIh45xeAlSNzNytztydzdzrBehMo5Jq40Bgo9wvZIoe4zJhICdqNnZC8HjcoLIGt0s/ZnxSA1MRRvxkxeFcgxz7BjJShOpxAkBQAAhFBWEhA8BNwQBXBXAgA"}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.token.watchMint(config, {
  token: '0x20c0000000000000000000000000000000000001',
  onMint(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

`() => void`

Returns a function to unsubscribe from the event.

## Parameters

### onMint

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchMint.md","from":5331,"to":5496}<fsm-vh3gqscxm4e>
declare function onMint(args: Args, log: Log): void

type Args = {
  /** Address that received the tokens */
  to: Address
  /** Amount minted */
  amount: bigint
}
```

Callback to invoke when tokens are minted.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP20 token to watch.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchMint.md","from":5681,"to":5768}<fsm-vh3gqscxm4e>
type Args = {
  /** Filter by recipient address */
  to?: Address | Address[] | null
}
```

Optional filter arguments.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchMint.md","from":5935,"to":5980}<fsm-vh3gqscxm4e>
declare function onError(error: Error): void
```

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Enable polling mode.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`token.watchMint`](https://viem.sh/tempo/actions/token.watchMint)

---

---
url: /tempo/actions/token.watchRole.md
---
# `token.watchRole`

Watches for role membership update events on TIP20 tokens.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchRole.md","from":135,"to":5153}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"4e73bd3d320afedbf0f32a0aefd66466de2992e0fa9666c2ae0e296a1f14a4da","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGcNAQADWinxFRkNVJ9SQAFY/lSDCLxWA6T1EIzmadWYgAEyVBGYLk+WalGj8kAJNb8XGcYH2K4QBQAHiOWQAfEEOslUh7khROFhHMw9GQ4KkacIAHSqxQxx34Z0KGMABVD4dIcHdxSUnoiewO+COJ2GF0UaBuaDujy8uTA4jDcBDvBgDuLKdwVCgEF4CAM+xB8E4CXYnAeAEk0/rrMKxYpOKQXe2w8wAEYR/CMLCrLBQLbwGMW8RKAfIZAgOhNrAKUoAA0faDguUFhWA0VIMEPAaUQfwaBoLurijsuzCcAA5AAApsSjMIwAD0MRfhBr6Yu+wowJinAgQkYGQTBp7wUh7AwEhDgWHAqF5OhXAftGcA4aBEDgdBsHEchZE0Ji1G5EscR5pwAC8n7fjQv5BMAuScNEFHCKkyDcWwAC6FDScKQzCAUz6pFJYAyTJilYWwMaMFAympABQFBBEan6ThdmuBEuR8bEqwbMWwk8HaJhxguYCJp2K4+nmQZ6TJQhdgAqvuh5QKkIQ6HAQZyBAShREJnqcOFBlLCuMapUoQQQV2e4HjQ8UQUGrSROp7i5E5uSPveICqZeIZDMwpS+konAALTpHmx5tSAHVNqUY1hiMjEDRmnVZnAw0UJeX41vcpjcKOtrGPpIruXAKzrnAvCkIwm7MeBqjtjAlxoMNqllASfTWIyso/GMSoAgYSZdhqkLQrqLhatYxpImaqKWoEIRhJERTCAJiR+oNiM5DR2lw50ohPYgvS9K9dTvc01CtF9TJ5n9DIA8MQOVCDHImt4KK8pDeBBFgy44BwGBRPGYCpA8/mTlAADypDcFAUBfnApi9v21IS1LjHjpOAAinAQAkwr4O2U4znOvPHljUo4/qipfHKiBm5SpO8xTiCVFTsJIPqoOmkzFrogYbMc2QmBRJFK4xeVMDxZwiVnqkP35dwSUpWlkdBamAAyaUZVlRAQGZpSywOIBpKEcjrk4orzpwFgZ+KDra/p4hLiunBrpu2bbrujCMSssUVYbj3G70HzyATDR459gQBwoQdxXbZs6tTowu/TYPu/MUOTVmUQ1QnIJdjGMdnpKby9NI+NkkgDvE/8gQ1VPjt6r07KTIzPIe1abOZiMUSFZvTr5SnSj7/oh8SSD0pufZUZg0rXyZIMWezt54P2mE/ZeeBGzNlbO2PKChchEEkHDOAK5/QmBXNnPsucHja04PeDBMB7wN2gCsBQwZlxEDMiOWucB8gMNgOuFYSglAWF6lQrWWwy6MXYfBOQOC9pXVyAAKXENggAyidHcCM8EMLDMyPIcBwLs2ICwqAnB1wYAdDAdchjlzrDgBGGMLlHjkOYHQhhdBtKMTQOsCAnAWwwF4IwJIvAiiYksMcSMtiABUPAKFHDUdQ6IEjpYOkYKoBuehCBQFESsewnBwgUKoQVNKNl7xBkoYQ1MZBlykAKVksABjinCHypse4lTVDCN4OIfS50VhWIMXtdYp0aClzacYgActAGAMYABWoiTjfmYDYsA4TNpKFSkXOQOSSkxMohIMAbYMbJDuCHUuvTEntj2sge8ui2zSxjGIXsKw0D3mUkEKyWBIwIQQpAWAkyYzsCUAhHOCEJE0DEH1IghoYy0AQuILAiELnwEWgBZgcgADEsLpY3IgHc9e1TchnNRYtG5ZSHlPMAi8xAbyPkwC+T8v5JCAWHmBaCyo4LIXQoQnimMCLkV4oJaQUgEQYwTnIUsiAKy1l1IUDQ1p7T2ydIOesRJhA7ll1ovwrW7Z7wUsQFQmhDioD0LGbYgA+qE0J+x7j8JNYa/mQrlmhFwfXEV4zvFoAgoxKaqTGKSHbJYBVZBcFtxoMcOQGBchwAwNs/Ay5ICdM4OYSuV1zEQEsX67gaZJyuO1sYqWWF1wKCDJAUgWSvxquMUsANlZg25HCOG+wUaMWMTje2Au6srqFpGbACZUyvxNkWpwBRMATnkLOZAfpQhGF9jhZwScCFhZEuea895oyqU6Bpf2OlQK0AgrBRCqFMLlyXPhWgRFSLxB9RHTAPqQg+p4r6oIKIY5SC5AccWiwD7mBbFxHM3IZxaA3gYZ01VCbhWitqdE+8iBbHNUma5cVYzCrFW1nIVKDp2ByCgBBCIABuXIbzOBplOsEyyMAkMePcaQNDQY9roruTB6JeSioQUQ8hgApFRIMEEyNoYw9hsAuH8MWB0pwJjpHUNQEox46jaBaP5TKewIIlh1icDOLyuTEFdiEAgC8oMeD3WqqLgYhwWAcCWHQxELDOGEJ4YI8+TgsnC3NjgKeJt1TPESF4CXMsOyqNoFgLyiDvHLMyWU+UvYGmtOeJYikvT4gDNQuMyHCzBkZLCOQDdUIFl5Q43lIlpLwilGnSwHdUgaxJx2LbqWAIYdNVEGYDjCE+ocaEmcgFpLWSuDC3XE6/gMZitgFK2Q8rQhIZVdGYgGrwNpBaiazlgywjNUCbII2OQbL91woQnQbxdzcTvHUDjaQM3ktcFS9guQyk+q9Li2QJoBp9QHba7Zk7+WVEjdgIgBb9xQgrYndLdbtBNs7XeI0Jo1hmu4dy1webxxFufffRYdbJ3DViAIykfUEItS2P4pwFB7YRJqcYEhzgzp1yUSEBBHjuSGlgCCPeFWbTdCFoACTAGx64AAhJwWnygyCs/vOZlr/HCMc7p363Y+PVlE5J2AdnnP6es/E653zj6wDNVsT+v9Mr2HKDVZE9Zkq4khLAE1R80HtluQxVwESbQFHTKbAoyLhB1g2XJ25MpXkrc2+YHbsMDune0a4MwDAUT64iQU/a1MQeFBBHN0GMpfOn2B/WfRhDxHkOcdMzxvj1nIxCZTyJ8jYnS7m/jxHuD+TGO584KxqqkE0/ccSwLwTwmUP5/l0XsAAeS8xjs/JmAinguqfUxATTyUIu6a1/poTl2TMYb55ngT2fkD99IKFof4WdNRfHzFyfRnFAh1UqXMpGO3LY68njgnEu6lgDJ8XxPlPqcy79Uzln0vhekB57PyzDfs8P8LaL8/IrJcX8uc395dD9ldHwTw94UBLwrFuwQBkA8E7g2xHl50yUEI+FVBDoYwYhmBF1Pk4A8CyJc0RUEJGVmVzB1wSJYNO0IhWoHpXh9B9RehbBzZ3oKQSZ2h1k7YiYZ4nZ7ZXZH5zQkEvZ3VoAohO94MHMnMAB+VIQZIMGMRQzTHaUIOaHtOQsADAZAZSQsTgDOMyMOAAal6HVlmFShi1oJ7BITwC/1LnvEkxoXlSSQU26DGU4AAFl6EBBbwm0dAVgwxglog2lDF2wQxpYQ4gwnD8A1VcgkhswuBZUDFskE12YWBJBjEpDdAqkkiCcYsoBElcQ7VEisl0kjoBAawdosFQgVgRwxF8dJEPFcVrMEgggIQIg50SU0D30wB1BvkV1ugVgIVujr0nMCDuiIQVsBMEgYwIQOUj05BmsggE1Wh/DKxPVi1m0wiulS4zkts5AYw30tgCkUCSUF0KVl1fl/lAV4BN0yCd1WU9i5jj09jDi0BXi+oaozMv1wD7wTdMcYg1gLdOB5RndqD4MIIATjhUhmN0MgxIS0AP8rN59Uh4TUhFRS5JNpNUxwTUTq94TESv8USMUoTgT5dMSfjbF+12xdiBB9jXjjjiUgIzil1FpqUrj6Vbjt0WVEJHjOUkUXj2B303jBStgPikp71xxn12xX0RSdpu4JAoCLwygLA2xSgiBrAYxehNTrBrA6CjY3gmDCQB4T4tQR48BCpuCb4gZeg4FORBCIZPZghV534i0I4Owt5o4kp/5nYIR+hWCGgz5rZL4vSwRNQeDoE+DTYBCEEhC+ROD4Z3IkwEo049DM4oBvSDR1AWC3pyQzSDAgRiw7ZcYrTRgQYHoYhYAMR0Z6IfJhAmI8IWIa8iJEIlIIBqI3w6JdlepcJ8IIIYwqCsheJTcEyCyQQvIGI/I1RAoPTI8eowp1JeZUgIJrBaBFCYxq9cNxZJZJ1lY1YNZtddZZx5w1R1Ix4YAJ4Kpw4R9CoogcoZJclwSN5q9Pi6pHJmtEsk5DxSBtMRRdwkx+FchRz7AbJSgppxAkBQAAhFB2EhA8BnwQBXBXAgA="}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.token.watchRole(config, {
  token: '0x...', // Address or ID of the TIP20 token
  onRoleUpdated(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

`() => void`

Returns a function to unsubscribe from the event.

## Parameters

### onRoleUpdated

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchRole.md","from":5362,"to":5720}<fsm-vh3gqscxm4e>
declare function onRoleUpdated(args: Args, log: Log): void

type Args = {
  /** Role being updated */
  role: Hex
  /** Account receiving or losing the role */
  account: Address
  /** Address that updated the role */
  sender: Address
  /** Whether the account has the role */
  hasRole: boolean
  /** Type of role update */
  type: 'granted' | 'revoked'
}
```

Callback to invoke when a role membership is updated.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP20 token.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchRole.md","from":5907,"to":6105}<fsm-vh3gqscxm4e>
type Args = {
  /** Filter by role */
  role?: Hex | Hex[] | null
  /** Filter by account */
  account?: Address | Address[] | null
  /** Filter by sender */
  sender?: Address | Address[] | null
}
```

Filter parameters for the watch subscription.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchRole.md","from":6291,"to":6336}<fsm-vh3gqscxm4e>
declare function onError(error: Error): void
```

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Enable polling mode.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`token.watchRole`](https://viem.sh/tempo/actions/token.watchRole)

---

---
url: /tempo/actions/token.watchTransfer.md
---
# `token.watchTransfer`

Watches for token transfer events on TIP20 tokens.

## Usage

::: code-group

```ts twoslash [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchTransfer.md","from":133,"to":5175}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"5deeee8975448d70c44695a3fbb88e51e915d6eeb68dabfc6d4cce676856c16d","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BLAWywlLQAIBBAYzUYQwCKnDQBDDkgCcVADYwwAczT4kAdioTSSmA0Qg+AoSJBzGYXIgAMVXvknj+ZGQF8K6bFYLEXWuvogABTi5uJwAJScvCZcMWAAZoxKiJwAwkJJSgA6YCxsHNGZyZQgYpL6ACyaZooqaogAbFqSuoHxWaXmlkgAjHYOpE405IjS7p44eIQk5P70ePFinACuYADu4mj2qQDqW/YZYGhD/ACiJMcASnorpGAAKl6l5VKI6rK1yqoaLTp6eDWm22ankFisAGYBo5nKNGhNqM8DDM/NQAkxWOwuEZBMIXtp9AAOT4Kb4NGraNp4HEmLrgpBQkD2GEjPrwjyIqbI3xzNELAz5LGcNAQADWinxFRkNVJ9SQAFY/lSDCLxWA6T1EIzmadWYgAEyVBGYLk+WalGj8kAJNb8XGcYH2B5DYQJMgAHiOWQAfEEOslUl7khROFhHMw9GQ4KkacIAHSqxRxx34Z3iV1kOMABXDkdIcE9xSU3oiewO+COJ2GF0UaBuaDujy8uTA4gjcDDvBgDvLaYzvKgEF4CAM+xB8E4CXYnAeAEks/rrMKxYphS64G7SJwYJc0HA4xbxEoR8hkCA6G2sApSgADO973KCwrAaKkGBbGBBpQh/BoNBYThXEnUgIGYTgAHIAAFNiUZhGAAehiN9wMfTFn2FGBMUA4DQIg6CjzgxD2BgRCHAsOAULyNCuBfWM4GwhIQLAqCYMIpCSJoTFKNyJY4iLTgAF5X3fGgvyCYBck4aIyOEVJkE4tgAF0KEktd0w7LFo04CSwCkqT5Mwtg40YKBFNSX9/yCCIVN0wCbNcCJch42JVg2ctBJ4O0TATFcwGTXt103P0ixDHSpKEPsNzIVIQh0OAQzkCAlCiATvW01SpKWCAFDjRKlCCcDIs3RBwJDVpIlU9xcgc3I7xvEBlLPMMhmYUp/SUTgAFp0iLA9GpAZq21KQaIxGejupzFq833BqKDPN8G3uUxuEnW1jF0kVXLgFYACM4F4UhGB27tGNw1Rux3Ws+uUsoCT6axGVlH5EF6RlKQBAwUyK1FukhaFdRcLVrGNJEzVRS1AhCMJIiKYQ+MSAMeoRnIqIKeHOlEO6Xt6GU6me5pqFaD6mSLDU/qZQZhkByojQ5E1vBRXkIbwIIsBAnAOAwKJEzAVIHl82coAAeVIbgoCgN84FMQdh2pcXJfo6dZwAEU4CAEmFfBuznBclx5g9MalF79RJPGGkVQn/kCHmyaQSp/qp0Z9RB01GYtdEDFZ9myEwKIIsC6LOFi49Ui+gPSDjbg4oSpLQ4C9TNzjAAZJKUrSogIBM0oZZHEA0lCOQdqcUVl04CwM/FB0tY23z6Mkbsq37N8oAN26jd6Sp9XkM37qVYn/YTn76UQC2dUdpBnbp0G3fmSGRrzKJytSMK9NO5hUhvaxaAAEmAMRDuUVwbwAbgy5cN633f94sJQj9P2ypLbCA1jQVIduSCw0Hv1xJTeXp5Uej3RA9tLbKhAOVW2I8Hawj6BCF2DMeTuytKzXMIwoh5TjiCb6EcU5KF/vof+psyQMj7oEPKkDR6UxgS9cYU9XaINnngVs7ZOzdiygoXIRBJCwzgNlGAgYTB8OzkOXODwtacBvOwmAN5ODMGgCsBQoYQJEBMhOcQnA4D5EUbAHaKwlBKBvjwvhmsthl3opouCchuGbXOrkAAUuILhABlA6jAsDw14YoiMzI8hwDAmzYgqioCcB2hgB0MAdohJAusOAUY4xOUeOIuRUAFEXVoGjeiaB1gQA0TgXgjAki8CKJiSwxxowJIAFQ8AkUcTx0johWKlg6RgqhZF6EIFAcxKx7CcHCBIqRuUkpWRvCGSRgicpkBAqQYZvSwDBLGcIPh/l7gzNUKY3g6YQndhWLE4Jm11iHRoKXdMYSABy0AYBxgAFbmJOO+Zg8SwBVJWkoRKRc5D9PGfU8iEgwBdlhlkO4MA9k5IOS0huOTkA3gCV2KWcYxCDhWGgG8ikggWSwNGeC8FICwBuXGdgSh4I53glYmgYhOpEENHGWg8FxBYAQjC+A+5fzMDkAAYkZVLBFz80CLzmbkKFnL9wIsmSitFf4MWICxTimAeKCVEpESSj85LKWVGpbS+l8EhVxhZeyoVIrSCkAiHGGc4jXkQHeZ8xZCgZEbN0sdVYuzmmqB5WXaihjzoSJlYgKRMjkmpMebkAA+hUip+x7g31DUGvmZq3mhCMYoi1VyYD8HAvRUaHS65vk4JYFpWstxLEYGIWscgMC5DgBgP5+AQKQB2ZwcwldPU7WibErc3AsyzkyVrMJktMI7QUCGSAW566axgGEwtxbjiltyOESt9ga3P3og27sBc1bnS3Oc2A1zblvjbPuTgTiYAN3EVCyARyhBKKHEyzgs54JCzFeizF2KLlyp0Aq4cSqyVoApVSmldKGUgVhcytArK2XiE6memAnUhCdSFZ1QQUQpykFyHI7NFgkPMC2LiQNYAzi0EvIonZHrY0WvjQsupN5EAJLqjc5y1rLl5QKlrOQiUHTsDkFAcCER75Ys4FmA+e5zIwBY6C9jUAQybW5UiujdTBn5XAsx1jABSCiIZwLZNIBxrjPH4J8YE1pRTonNPidLlJtAMmlmTPYEESw6xOBnENdZ8CuxCAQAxSGXhGbDFF2CQ4LAOBLCcYiNx3IvH+Of3olZrc7Y4BHhXXMjREheAlyrP8yTaBYCGqo2AXjUkHNTL2K59zGjQLtO8+IXzdKAvAtC7pvSvSuDIB3KEMy8oXrylq/VhrB7XHuLjKQNYs5ElFsrAEIO3qiDr1evqF6hJHI5bq3pUxQsdrJv4P1wbw24CjfoONi5iBJtA2kFqObnX6umO9Z/MgrY5BasA0y+CdAU1ItxO8dQNCztLca81uQilOoHKq9FRoBp9SfcflwH7LjDruL27ARAV37ihDu1eqWj3aDPfWu8YHjRrDzdy19nN+2Ec3fgphiwj2uFyCDdfZQBoIRagSbxHNbZuxCWc4wFjnArgWvIkIcC98BmbBWTeZW6ZdBbl3swmArgACEnBRfKDIDLm8IWFt6Yi6kBX4vOC7A5x87n79FlgDl1rpXEmckGuQ2AOqCS8MEe2Zo5Qo6alfNtY08pYBap3lo38lyrqhJtCcXctsTjSuEHWFZAXLlJkeUD8H5goeIzh8jzJrgzAMC1OMUJWzCbLmZ4UEEHlIZJmq5Qxnr5cmmPCdYxprTquwv6aEyJtjxnzdq2k2AdP+eGNDIU9XnJKnSoQVr0FnT6uylN5r2JtvPKy/d7jFFmzMA7P5acy5iAbn4ola807nznA/PVaC/X3T4WJ+cGQKv0ghWN/Fc82V3fFX9+A8C8pUukzGcuSlx5dnnODe87APznPhXkLmAEECLmLmQJwJLizrLvLhAaQMrsfuPoJnAYrluLrr/jzkbibvATLm3u/tbneIeMeEgKeGUEeqUMgLwncF2Kio+lKvBAYqoLtHGDEMwM+rinABwSRP2havBKququYDtERPRtuhEA1DdK8AQuoLYF8HKO8KQosF8pAgTGPNQrTJMAguaIwp7BmtAFEPPoxjFnFgAPypAnIhhxhWFubrShCTR7rmFgAYDICKSlicAZwmRBwADUvQasswiUFW4hVAOceAp+e4pcN4ZmMi6weaOay+v0JqAAsgogIFeCujoCsBGGUtEJsg6mGFLMCiGDEa0rYgjPmFwDssCr0l2t2GzCwJIGEsYboLMsEquhVlAC0riPGpUa0V0ntAIA2OtJwqECsBOBYhztYpCtCgJgkEEBCBEA+hKgwZhmAOoPim+t0CsDSisbBnFlwSsRCHdp/AkHGBCDqiBnIPNkEJ6q0JkbWFmiupzvkU6ptFCi9nIHGBhlsMMnQRKk+jKq+oSsSqSvAN+gIX+pqu8ecaBu8V8WgHCZ1OVMFjhjRnAKnkUC/B5PKFHqIYxuBDEC/KkEppxiGASccEgWEVpGSa/JwIqKZhlrPr7rib3tSSVKSc/OSWPpSakKybSW3mZl7jeAkoet2G8QIB8XCT8eKv+P8S+vuPKsCcqmCb+hqghFCbqmyrCewJhvCdqVsIiXFIhtOKht2OhnqetK3BICQSgGeI7l2KUEQNYHGL0M6dYNYBIYbH/OoISN3MQlqIoQYOQmCJqKoVQnqL0JPJodMAwnyHPKgmQIvHFMvGfGvBfDvHvCcDfHfGfCKGmVfJmYfCfGfE/ISSEh/McN/Pgn0NIP0HIc9CAu9IEBAsGVYKGSyIDPqPKPAtGdobGUoXDK5CmDFGnO4ZnFAFWXTrIU9OSAGSAECOWJAr0LWWoXqMDDdDELABiGjNpJ5OtPREBGvMPgRAhApBAJRE+DRACskAxExBBHGCIVkNxEycsPOSCB5HRD5GqP5FguHMFMjKFKpDzKkL0GADZOFI8L+eVDHMlOlA/LnpXuBEvEPkiZVPZPNp1knB+KQB5iKABCmDfLkK+fYFZKUKNOIEgKAAEIoJokIHgHuCAK4K4EAA"}
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
export const config = {} as Config
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.token.watchTransfer(config, {
  token: 1n,
  onTransfer(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})

```

:::

## Return Type

`() => void`

Returns a function to unsubscribe from the event.

## Parameters

### onTransfer

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchTransfer.md","from":5381,"to":5603}<fsm-vh3gqscxm4e>
declare function onTransfer(args: Args, log: Log): void

type Args = {
  /** Amount transferred */
  amount: bigint
  /** Address sending the tokens */
  from: Address
  /** Address receiving the tokens */
  to: Address
}
```

Callback to invoke when tokens are transferred.

### token

* **Type:** `Address | bigint`

Address or ID of the TIP20 token to watch.

### args (optional)

* **Type:** `object`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchTransfer.md","from":5793,"to":5958}<fsm-vh3gqscxm4e>
type Args = {
  /** Filter by sender address(es) */
  from?: Address | Address[] | null
  /** Filter by recipient address(es) */
  to?: Address | Address[] | null
}
```

Optional filter to watch only transfers from or to specific addresses.

### fromBlock (optional)

* **Type:** `bigint`

Block to start listening from.

### onError (optional)

* **Type:** `function`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/actions/token.watchTransfer.md","from":6169,"to":6214}<fsm-vh3gqscxm4e>
declare function onError(error: Error): void
```

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

* **Type:** `true`

Enable polling mode.

### pollingInterval (optional)

* **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

* [`token.watchTransfer`](https://viem.sh/tempo/actions/token.watchTransfer)

---

---
url: /tempo/connectors/webAuthn.md
---
# `webAuthn`

Connector for a WebAuthn EOA.

## Install

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/connectors/webAuthn.md","from":479,"to":528}<fsm-vh3gqscxm4e>
pnpm add accounts@{{connectorDependencyVersion}}
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/connectors/webAuthn.md","from":551,"to":603}<fsm-vh3gqscxm4e>
npm install accounts@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/connectors/webAuthn.md","from":627,"to":676}<fsm-vh3gqscxm4e>
yarn add accounts@{{connectorDependencyVersion}}
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/connectors/webAuthn.md","from":699,"to":747}<fsm-vh3gqscxm4e>
bun add accounts@{{connectorDependencyVersion}}
```

:::

## Usage

```ts [wagmi.config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/connectors/webAuthn.md","from":790,"to":1117}<fsm-vh3gqscxm4e>
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { webAuthn } from 'wagmi/tempo' // [!code focus]

export const config = createConfig({
  connectors: [webAuthn()], // [!code focus]
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})
```

Use `webAuthn({ authUrl: '/api/webauthn' })` if you want registration and authentication challenges to come from a server endpoint instead of the default local browser ceremony.

`webAuthn` is a thin wagmi wrapper around the root `accounts` package.

## Parameters

### authUrl (optional)

* **Type:** `string`

URL of a server-backed WebAuthn handler.

### ceremony (optional)

* **Type:** `WebAuthnCeremony`

Custom WebAuthn ceremony implementation.

### icon (optional)

* **Type:** `` `data:image/${string}` ``

Optional connector icon override.

### name (optional)

* **Type:** `string`

Optional connector display name.

### rdns (optional)

* **Type:** `string`

Optional reverse-DNS identifier.

### authorizeAccessKey (optional)

* **Type:** `() => { expiry: number, ... }`

Default access-key authorization parameters to attach to `wallet_connect`.

---

---
url: /cli/api/plugins/actions.md
---
# actions

Plugin for type-safe VanillaJS actions.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/actions.md","from":69,"to":114}<fsm-vh3gqscxm4e>
import { actions } from '@wagmi/cli/plugins'
```

## Usage

```ts{2,6}
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/actions.md","from":140,"to":294}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { actions } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    actions(),
  ],
})
```

## Configuration

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/actions.md","from":323,"to":379}<fsm-vh3gqscxm4e>
import { type ActionsConfig } from '@wagmi/cli/plugins'
```

### getActionName

``'legacy' | ((options: { contractName: string; type: 'read' | 'simulate' | 'watch' | 'write' }) => `use${string}`)``

* Function for setting custom hook names.
* Defaults to `` `${type}${contractName}` ``. For example, `readErc20`, `simulateErc20`, `watchErc20Event`, `writeErc20`.
* When `'legacy'` (deprecated), hook names are set to `@wagmi/cli@1` format.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/actions.md","from":772,"to":1081}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { actions } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    actions({
      getActionName({ contractName, type }) { // [!code focus]
        return `${contractName}__${type}` // [!code focus]
      }, // [!code focus]
    }),
  ],
})
```

### overridePackageName

`'@wagmi/core' | 'wagmi'`

* Override detected import source.
* Defaults to `'wagmi'` or `'@wagmi/core'` depending on which package is installed.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/actions.md","from":1264,"to":1478}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { actions } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    actions({
      overridePackageName: 'wagmi', // [!code focus]
    }),
  ],
})
```

---

---
url: /core/api/actions.md
---
# Actions

Actions for accounts, wallets, contracts, transactions, signing, ENS, and more.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions.md","from":323,"to":367}<fsm-vh3gqscxm4e>
import { getConnection } from '@wagmi/core'
```

## Available Actions

---

---
url: /react/api/actions.md
---
# Actions

Sometimes the declarative nature of React Hooks doesn't work for parts of your app. For those cases, you can use Wagmi Core Actions directly!

All the Wagmi Core Actions are importable using the `wagmi/actions` entrypoint. For example, you can use the `watchBlockNumber` action to watch for block number changes.

::: code-group

```ts [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/actions.md","from":358,"to":701}<fsm-vh3gqscxm4e>
import { useConfig } from 'wagmi'
import { watchBlockNumber } from 'wagmi/actions'
import { useEffect } from 'react'

function App() {
  const config = useConfig()

  useEffect(() => {
    return watchBlockNumber(config, {
      onBlockNumber(blockNumber) {
        console.log('Block number changed!', blockNumber)
      },
    })
  }, [])
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

See the [Wagmi Core docs](/core/api/actions) for more info on what actions are available.

---

---
url: /solid/api/actions.md
---
# Actions

`@wagmi/solid` exports all of the actions from `@wagmi/core`. These actions can be used for lower-level control or when you need to interact with Wagmi outside of Solid components.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/actions.md","from":210,"to":277}<fsm-vh3gqscxm4e>
import { getBalance, sendTransaction } from '@wagmi/solid/actions'
```

## Usage

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/actions.md","from":298,"to":449}<fsm-vh3gqscxm4e>
import { getBalance } from '@wagmi/solid/actions'
import { config } from './config'

const balance = await getBalance(config, {
  address: '0x...',
})
```

## Available Actions

See the [`@wagmi/core` Actions docs](/core/api/actions) for the full list of available actions and their documentation.

## When to Use Actions vs Primitives

**Use Primitives when:**

* You need reactive data in your Solid components
* You want automatic caching and refetching
* You're building UI that displays blockchain data

**Use Actions when:**

* You need imperative control over when data is fetched
* You're working outside of Solid components
* You need to chain multiple operations together
* You're building utilities or helper functions

## Example: Using Actions with Primitives

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/actions.md","from":1077,"to":1566}<fsm-vh3gqscxm4e>
import { useConnection } from '@wagmi/solid'
import { signMessage } from '@wagmi/solid/actions'
import { config } from './config'

function SignMessage() {
  const connection = useConnection()

  const handleSign = async () => {
    if (!connection.address) return
    
    const signature = await signMessage(config, {
      message: 'Hello, World!',
    })
    console.log('Signature:', signature)
  }

  return (
    <button onClick={handleSign}>
      Sign Message
    </button>
  )
}
```

---

---
url: /vue/api/actions.md
---
# Actions

Sometimes the declarative nature of Vue Composables doesn't work for parts of your app. For those cases, you can use Wagmi Core Actions directly!

All the Wagmi Core Actions are importable using the `@wagmi/vue/actions` entrypoint. For example, you can use the `watchBlockNumber` action to watch for block number changes.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/actions.md","from":368,"to":759}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { watchEffect } from 'vue'
import { useConfig } from '@wagmi/vue'
import { watchBlockNumber } from '@wagmi/vue/actions'

const config = useConfig()

watchEffect((onCleanup) => {
  const unwatch = watchBlockNumber(config, {
    onBlockNumber(blockNumber) {
      console.log('Block number changed!', blockNumber)
    },
  })

  onCleanup(unwatch)
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

See the [Wagmi Core docs](/core/api/actions) for more info on what actions are available.

---

---
url: /AGENTS.md
---
# Agent Guidelines

Agent guidance for the Wagmi documentation site.

> **Communication Style**: Be brief, concise. Maximize information density, minimize tokens. Incomplete sentences acceptable when clear. Remove filler words. Prioritize clarity over grammar.

## Tempo

* All Tempo documentation must be added under the `/tempo` sidebar item.

## Wagmi Actions

* **All documentation must be based on their corresponding Wagmi actions** from `@wagmi/core/tempo` (`packages/core/src/tempo/`)
* Make sure you update `site/tempo/actions/index.md` for new actions

### Query Actions

````md
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/AGENTS.md","from":589,"to":1466}<fsm-vh3gqscxm4e>
# `namespace.action`

description

## Usage

::: code-group
```ts twoslash [example.ts]
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
import { tempoTestnet } from 'wagmi/chains'
export const config = {} as Config<readonly [typeof tempoTestnet]>
// @filename: example.ts
// ---cut---
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const result = await Actions.amm.action(config, {
  foo: '0x...',
  bar: 123n,
})

console.log('Result:', result)
// @log: Result: 10500000000000000000n
```
<<< @/snippets/react/config-tempo.ts{ts} [config.ts]
:::

## Return Type

`bigint`

description

## Parameters

### foo

- **Type:** `Address`

description

### bar

- **Type:** `bigint`

description

### baz (optional)

- **Type:** `Hex`

description

## Viem

- [`namespace.action`](https://viem.sh/tempo/actions/namespace.action)
````

### Mutation Actions

````md
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/AGENTS.md","from":1501,"to":3127}<fsm-vh3gqscxm4e>
# `namespace.action`

description

## Usage

::: code-group
```ts twoslash [example.ts]
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
import { tempoTestnet } from 'wagmi/chains'
export const config = {} as Config<readonly [typeof tempoTestnet]>
// ---cut---
// @filename: example.ts
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const result =
  await Actions.namespace.actionSync(config, {
    foo: '0x...',
    bar: 123n,
  })

console.log('Foo:', result.foo)
// @log: Foo: 5250000000000000000n
```
<<< @/snippets/react/config-tempo.ts{ts} [config.ts]
:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `namespace.action` action and wait for inclusion manually:

```ts
import { Actions as viem_Actions } from 'viem/tempo'
import { Actions } from 'wagmi/tempo'
import { waitForTransactionReceipt } from 'wagmi/actions'

const hash = await Actions.namespace.action(config, {
  foo: '0x...',
  bar: 123n,
})
const receipt = await waitForTransactionReceipt(config, { hash })

const { args: { baz } } 
  = viem_Actions.namespace.action.extractEvent(receipt.logs)
```

## Return Type

description

```ts
type ReturnType = {
  /** description */
  baz: bigint
}
```

## Parameters

### foo

- **Type:** `Address`

description

### bar

- **Type:** `bigint`

description

<!--@include: @shared/tempo-write-parameters.md-->

## Viem

- [`namespace.action`](https://viem.sh/tempo/actions/namespace.action)
````

### Watch Actions

````md
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/AGENTS.md","from":3159,"to":4629}<fsm-vh3gqscxm4e>
# `namespace.watchAction`

description

## Usage

::: code-group
```ts twoslash [example.ts]
// @filename: config.ts
// @errors: 2322
import type { Config } from 'wagmi'
import { tempoTestnet } from 'wagmi/chains'
export const config = {} as Config<readonly [typeof tempoTestnet]>
// ---cut---
// @filename: example.ts
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const unwatch = Actions.namespace.watchAction(config, {
  onAction(args, log) {
    console.log('args:', args)
  },
})

// Later, stop watching
unwatch()
```
<<< @/snippets/react/config-tempo.ts{ts} [config.ts]
:::

## Return Type

`() => void`

Returns a function to unsubscribe from the event.

## Parameters

### onAction

- **Type:** `function`

```ts
declare function onBurn(args: Args, log: Log): void

type Args = {
  /** description */
  foo: bigint
  /** description */
  barBaz: bigint
}
```

Callback to invoke when action occurs.

### fromBlock (optional)

- **Type:** `bigint`

Block to start listening from.

### onError (optional)

- **Type:** `function`

```ts
declare function onError(error: Error): void
```

The callback to call when an error occurred when trying to get for a new block.

### poll (optional)

- **Type:** `true`

Enable polling mode.

### pollingInterval (optional)

- **Type:** `number`

Polling frequency (in ms). Defaults to Client's pollingInterval config.

## Viem

- [`namespace.action`](https://viem.sh/tempo/actions/namespace.action)
````

## Wagmi Hooks

* **All documentation must be based on their corresponding Wagmi hooks** from `wagmi/tempo` (`packages/react/src/tempo/`)
* Make sure you update `site/tempo/hooks/index.md` for new actions

### Query Hooks

An example of a generated hook set can be found in `hooks/amm.useLiquidityBalance.ts`. Template example:

````md
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/AGENTS.md","from":4971,"to":5879}<fsm-vh3gqscxm4e>
# `namespace.useHook`

description

## Usage

::: code-group
```ts twoslash [example.ts]
import { Hooks } from 'wagmi/tempo'

const { data: result } = Hooks.namespace.useHook({
  foo: '0x...',
  bar: 123n,
})

console.log('Result:', resut)
// @log: Result: ...
```
<<< @/snippets/react/config-tempo.ts{ts} [config.ts]
:::

## Return Type

See [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook return types.

### data

See [Wagmi Action `namespace.action` Return Type](/tempo/actions/namespace.action#return-type)

## Parameters

See [Wagmi Action `namespace.action` Parameters](/tempo/actions/namespace.action#parameters)

### query

See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) for more info hook parameters.

## Action

- [`namespace.action`](/tempo/actions/namespace.action)
````

### Mutation Hooks

````md
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/AGENTS.md","from":5912,"to":7969}<fsm-vh3gqscxm4e>
# `namespace.useHook`

description

## Usage

::: code-group
```ts twoslash [example.ts]
import { Hooks } from 'wagmi/tempo'

const actionNameSync = Hooks.namespace.useHookSync()

// Call `mutate` in response to user action (e.g. button click, form submission)
actionNameSync.mutate({
  foo: '0x...',
  bar: 123n,
})

console.log('Received baz:', actionNameSync.data?.baz)
// @log: Received baz: ...
```
<<< @/snippets/react/config-tempo.ts{ts} [config.ts]
:::

### Asynchronous Usage

The example above uses a `*Sync` variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync `amm.burn` action and wait for inclusion manually:

```ts
import { Actions } from 'viem/tempo'
import { Hooks } from 'wagmi/tempo'
import { useWaitForTransactionReceipt } from 'wagmi'

const actionName = Hooks.namespace.useHook()
const { data: receipt } = useWaitForTransactionReceipt({ hash: actionName.data })

// Call `mutate` in response to user action (e.g. button click, form submission)
actionName.mutate({
  foo: '0x...',
  bar: 123n,
})

if (receipt) {
  const { args: { baz } } 
    = Actions.namespace.action.extractEvent(receipt.logs)
}
```

## Return Type

See [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook return types.

### data

See [Wagmi Action `namespace.action` Return Type](/tempo/actions/namespace.action#return-type)

### mutate/mutateAsync

See [Wagmi Action `namespace.action` Parameters](/tempo/actions/namespace.action#parameters)

## Parameters

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

### mutation

See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) for more info hook parameters.

## Action

- [`namespace.action`](/tempo/actions/namespace.action)
````

### Watch Hooks

````md
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/AGENTS.md","from":7999,"to":8733}<fsm-vh3gqscxm4e>
# `namespace.useWatchHook`

description

## Usage

::: code-group
```ts twoslash [example.ts]
import { Hooks } from 'wagmi/tempo'

Hooks.amm.useWatchHook({
  onAction(args, log) {
    console.log('args:', args)
  },
})
```
<<< @/snippets/react/config-tempo.ts{ts} [config.ts]
:::

## Parameters

See [Wagmi Action `namespace.watchAction` Parameters](/tempo/actions/namespace.watchAction#parameters)

### config

`Config | undefined`

[`Config`](https://wagmi.sh/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](https://wagmi.sh/react/api/WagmiProvider).

## Action

- [`namespace.action`](/tempo/actions/namespace.action)
- [`namespace.watchAction`](/tempo/actions/namespace.watchAction)
````

---

---
url: /core/api/connectors/baseAccount.md
---

# baseAccount

Connector for the [Base Account SDK](https://github.com/base/account-sdk).

## Import

```ts-vue
import { baseAccount } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add @base-org/account@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install @base-org/account@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add @base-org/account@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add @base-org/account@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { baseAccount } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [baseAccount()], // [!code hl]
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

:::warning
Before going to production, it is highly recommended to set an [`appName`](#appname) and [`appLogoUrl`](#applogourl) for your application that can be displayed upon connection to the wallet.
:::

## Parameters

```ts-vue
import { type baseAccountParameters } from '{{connectorsPackageName}}'
```

Check out the [Base Account SDK docs](https://www.base.org/build/base-account) for more info.

### appName

`string`

Application name.

```ts-vue
import { baseAccount } from '{{connectorsPackageName}}'

const connector = baseAccount({
  appName: 'My Wagmi App', // [!code focus]
})
```

### appLogoUrl

`string | null | undefined`

Application logo image URL; favicon is used if unspecified.

```ts-vue
import { baseAccount } from '{{connectorsPackageName}}'

const connector = baseAccount({
  appName: 'My Wagmi App',
  appLogoUrl: 'https://example.com/myLogoUrl.png', // [!code focus]
})
```

---

---
url: /react/api/connectors/baseAccount.md
---

# baseAccount

Connector for the [Base Account SDK](https://github.com/base/account-sdk).

## Import

```ts-vue
import { baseAccount } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add @base-org/account@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install @base-org/account@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add @base-org/account@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add @base-org/account@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { baseAccount } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [baseAccount()], // [!code hl]
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

:::warning
Before going to production, it is highly recommended to set an [`appName`](#appname) and [`appLogoUrl`](#applogourl) for your application that can be displayed upon connection to the wallet.
:::

## Parameters

```ts-vue
import { type baseAccountParameters } from '{{connectorsPackageName}}'
```

Check out the [Base Account SDK docs](https://www.base.org/build/base-account) for more info.

### appName

`string`

Application name.

```ts-vue
import { baseAccount } from '{{connectorsPackageName}}'

const connector = baseAccount({
  appName: 'My Wagmi App', // [!code focus]
})
```

### appLogoUrl

`string | null | undefined`

Application logo image URL; favicon is used if unspecified.

```ts-vue
import { baseAccount } from '{{connectorsPackageName}}'

const connector = baseAccount({
  appName: 'My Wagmi App',
  appLogoUrl: 'https://example.com/myLogoUrl.png', // [!code focus]
})
```

---

---
url: /shared/connectors/baseAccount.md
---
# baseAccount

Connector for the [Base Account SDK](https://github.com/base/account-sdk).

## Import

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/baseAccount.md","from":267,"to":323}<fsm-vh3gqscxm4e>
import { baseAccount } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/baseAccount.md","from":550,"to":608}<fsm-vh3gqscxm4e>
pnpm add @base-org/account@{{connectorDependencyVersion}}
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/baseAccount.md","from":631,"to":692}<fsm-vh3gqscxm4e>
npm install @base-org/account@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/baseAccount.md","from":716,"to":774}<fsm-vh3gqscxm4e>
yarn add @base-org/account@{{connectorDependencyVersion}}
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/baseAccount.md","from":797,"to":854}<fsm-vh3gqscxm4e>
bun add @base-org/account@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/baseAccount.md","from":883,"to":1253}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { baseAccount } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [baseAccount()], // [!code hl]
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

:::warning
Before going to production, it is highly recommended to set an [`appName`](#appname) and [`appLogoUrl`](#applogourl) for your application that can be displayed upon connection to the wallet.
:::

## Parameters

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/baseAccount.md","from":1490,"to":1561}<fsm-vh3gqscxm4e>
import { type baseAccountParameters } from '{{connectorsPackageName}}'
```

Check out the [Base Account SDK docs](https://www.base.org/build/base-account) for more info.

### appName

`string`

Application name.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/baseAccount.md","from":1713,"to":1849}<fsm-vh3gqscxm4e>
import { baseAccount } from '{{connectorsPackageName}}'

const connector = baseAccount({
  appName: 'My Wagmi App', // [!code focus]
})
```

### appLogoUrl

`string | null | undefined`

Application logo image URL; favicon is used if unspecified.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/baseAccount.md","from":1970,"to":2157}<fsm-vh3gqscxm4e>
import { baseAccount } from '{{connectorsPackageName}}'

const connector = baseAccount({
  appName: 'My Wagmi App',
  appLogoUrl: 'https://example.com/myLogoUrl.png', // [!code focus]
})
```

---

---
url: /solid/api/connectors/baseAccount.md
---

# baseAccount

Connector for the [Base Account SDK](https://github.com/base/account-sdk).

## Import

```ts-vue
import { baseAccount } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add @base-org/account@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install @base-org/account@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add @base-org/account@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add @base-org/account@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { baseAccount } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [baseAccount()], // [!code hl]
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

:::warning
Before going to production, it is highly recommended to set an [`appName`](#appname) and [`appLogoUrl`](#applogourl) for your application that can be displayed upon connection to the wallet.
:::

## Parameters

```ts-vue
import { type baseAccountParameters } from '{{connectorsPackageName}}'
```

Check out the [Base Account SDK docs](https://www.base.org/build/base-account) for more info.

### appName

`string`

Application name.

```ts-vue
import { baseAccount } from '{{connectorsPackageName}}'

const connector = baseAccount({
  appName: 'My Wagmi App', // [!code focus]
})
```

### appLogoUrl

`string | null | undefined`

Application logo image URL; favicon is used if unspecified.

```ts-vue
import { baseAccount } from '{{connectorsPackageName}}'

const connector = baseAccount({
  appName: 'My Wagmi App',
  appLogoUrl: 'https://example.com/myLogoUrl.png', // [!code focus]
})
```

---

---
url: /vue/api/connectors/baseAccount.md
---

# baseAccount

Connector for the [Base Account SDK](https://github.com/base/account-sdk).

## Import

```ts-vue
import { baseAccount } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add @base-org/account@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install @base-org/account@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add @base-org/account@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add @base-org/account@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { baseAccount } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [baseAccount()], // [!code hl]
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

:::warning
Before going to production, it is highly recommended to set an [`appName`](#appname) and [`appLogoUrl`](#applogourl) for your application that can be displayed upon connection to the wallet.
:::

## Parameters

```ts-vue
import { type baseAccountParameters } from '{{connectorsPackageName}}'
```

Check out the [Base Account SDK docs](https://www.base.org/build/base-account) for more info.

### appName

`string`

Application name.

```ts-vue
import { baseAccount } from '{{connectorsPackageName}}'

const connector = baseAccount({
  appName: 'My Wagmi App', // [!code focus]
})
```

### appLogoUrl

`string | null | undefined`

Application logo image URL; favicon is used if unspecified.

```ts-vue
import { baseAccount } from '{{connectorsPackageName}}'

const connector = baseAccount({
  appName: 'My Wagmi App',
  appLogoUrl: 'https://example.com/myLogoUrl.png', // [!code focus]
})
```

---

---
url: /cli/api/plugins/blockExplorer.md
---
# blockExplorer

Plugin for fetching ABIs from block explorers that supports the `?module=contract&action=getabi` API format.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/blockExplorer.md","from":144,"to":195}<fsm-vh3gqscxm4e>
import { blockExplorer } from '@wagmi/cli/plugins'
```

## Usage

```ts{2,6-14}
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/blockExplorer.md","from":224,"to":592}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { blockExplorer } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    blockExplorer({
      baseUrl: 'https://api.etherscan.io/v2/api',
      contracts: [
        {
          name: 'Wagmigotchi',
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        },
      ],
    }),
  ],
})
```

## Configuration

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/blockExplorer.md","from":621,"to":683}<fsm-vh3gqscxm4e>
import { type BlockExplorerConfig } from '@wagmi/cli/plugins'
```

### apiKey

`string | undefined`

API key for block explorer. Appended to the request URL as query param `&apikey=${apiKey}`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/blockExplorer.md","from":821,"to":1251}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { blockExplorer } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    blockExplorer({
      apiKey: process.env.ETHERSCAN_API_KEY, // [!code focus]
      baseUrl: 'https://api.etherscan.io/v2/api',
      contracts: [
        {
          name: 'Wagmigotchi',
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        },
      ],
    }),
  ],
})
```

### baseUrl

`string`

Base URL for block explorer.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/blockExplorer.md","from":1315,"to":1700}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { blockExplorer } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    blockExplorer({
      baseUrl: 'https://api.etherscan.io/v2/api', // [!code focus]
      contracts: [
        {
          name: 'Wagmigotchi',
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        },
      ],
    }),
  ],
})
```

### cacheDuration

`number | undefined`

Duration in milliseconds to cache ABIs. Defaults to `1_800_000` (30 minutes).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/blockExplorer.md","from":1831,"to":2246}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { blockExplorer } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    blockExplorer({
      baseUrl: 'https://api.etherscan.io/v2/api',
      cacheDuration: 300_000, // [!code focus]
      contracts: [
        {
          name: 'Wagmigotchi',
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        },
      ],
    }),
  ],
})
```

### chainId

`number | undefined`

Chain ID for block explorer. Appended to the request URL as query param `&chainId=${chainId}`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/blockExplorer.md","from":2388,"to":2836}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { blockExplorer } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    blockExplorer({
      apiKey: process.env.ETHERSCAN_API_KEY,
      baseUrl: 'https://api.etherscan.io/v2/api',
      chainId: 1, // [!code focus]
      contracts: [
        {
          name: 'Wagmigotchi',
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        },
      ],
    }),
  ],
})
```

### contracts

`{ name: string; address?: Address | Record<number, Address> | undefined }[]`

Contracts to fetch ABIs for.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/blockExplorer.md","from":2972,"to":3442}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { blockExplorer } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    blockExplorer({
      baseUrl: 'https://api.etherscan.io/v2/api',
      contracts: [ // [!code focus]
        { // [!code focus]
          name: 'Wagmigotchi', // [!code focus]
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1', // [!code focus]
        }, // [!code focus]
      ], // [!code focus]
    }),
  ],
})
```

### getAddress

`((config: { address: Address | Record<number, Address> }) => Address) | undefined`

* Function to get address from contract config.
* Defaults to `({ address }) => typeof address === 'string' ? address : Object.values(address)[0]`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/blockExplorer.md","from":3703,"to":4277}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { blockExplorer } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    blockExplorer({
      baseUrl: 'https://api.etherscan.io/v2/api',
      contracts: [
        {
          name: 'Wagmigotchi',
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        },
      ],
      getAddress({ address }) { // [!code focus]
        if (typeof address === 'string') return address // [!code focus]
        return Object.values(address)[0] // [!code focus]
      }, // [!code focus]
    }),
  ],
})
```

### name

`string`

* Name of source.
* Defaults to `'Block Explorer'`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/blockExplorer.md","from":4361,"to":4771}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { blockExplorer } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    blockExplorer({
      baseUrl: 'https://api.etherscan.io/v2/api',
      contracts: [
        {
          name: 'Wagmigotchi',
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        },
      ],
      name: 'Etherscan', // [!code focus]
    }),
  ],
})
```

---

---
url: /core/api/actions/call.md
---
# call

Action for executing a new message call immediately without submitting a transaction to the network.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/call.md","from":237,"to":272}<fsm-vh3gqscxm4e>
import { call } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/call.md","from":319,"to":576}<fsm-vh3gqscxm4e>
import { call } from '@wagmi/core'
import { config } from './config'

await call(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/call.md","from":656,"to":1134}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"f9d98dd791931821ca041f2ffa5df1409ff16b6299b7878935aa5d977af43747","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAJMcvAMJtWABWalmAWxg1ScADwBjCGABm7AOa86NMFDjC1mnQF5jG7QD5eFka3GSZcskYBkw/M3ZgAklASUrLyKiY2ADpg7NJYEKRowqJBLvIIVHBokgyIAIwALFSsMGBaaPhIBVRZpFpyeA5Owa4KlCAcYLiIAAxUyt5SyvKV+QC+ALp90F0gMXEJvMD82DBJjikhbryjvOqkENK8AOQAAgDuzFrS7AD0qqQwR20hzEigeiVw7Gp4aAijoyAA"}
import { type CallParameters } from '@wagmi/core'
```

### account

`Account | Address | undefined`

The Account to call from.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/call.md","from":1244,"to":1518}<fsm-vh3gqscxm4e>
import { call } from '@wagmi/core'
import { config } from './config'

await call(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', // [!code focus]
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### data

`` `0x${string}` | undefined ``

A contract hashed method call with encoded args.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/call.md","from":1693,"to":1967}<fsm-vh3gqscxm4e>
import { call } from '@wagmi/core'
import { config } from './config'

await call(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', // [!code focus]
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### to

`Address | undefined`

The contract address or recipient.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/call.md","from":2116,"to":2390}<fsm-vh3gqscxm4e>
import { call } from '@wagmi/core'
import { config } from './config'

await call(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### accessList

`AccessList | undefined`

The access list.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/call.md","from":2532,"to":2893}<fsm-vh3gqscxm4e>
import { call } from '@wagmi/core'
import { config } from './config'

await call(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  accessList: [ // [!code focus:6] 
    {
      address: '0x1',
      storageKeys: ['0x1'],
    },
  ],
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### gas

`bigint | undefined`

The gas provided for transaction execution.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/call.md","from":3051,"to":3344}<fsm-vh3gqscxm4e>
import { call } from '@wagmi/core'
import { config } from './config'

await call(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
  gas: 1_000_000n, // [!code focus]
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### gasPrice

`bigint | undefined`

The price (in wei) to pay per gas. Only applies to [Legacy Transactions](https://viem.sh/docs/glossary/terms#legacy-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/call.md","from":3593,"to":3929}<fsm-vh3gqscxm4e>
import { call } from '@wagmi/core'
import { parseGwei } from 'viem'
import { config } from './config'

await call(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
  gasPrice: parseGwei('20'), // [!code focus]
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxFeePerGas

`bigint | undefined`

Total fee per gas (in wei), inclusive of `maxPriorityFeePerGas`. Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/call.md","from":4216,"to":4556}<fsm-vh3gqscxm4e>
import { call } from '@wagmi/core'
import { parseGwei } from 'viem'
import { config } from './config'

await call(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
  maxFeePerGas: parseGwei('20'), // [!code focus]
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxPriorityFeePerGas

`bigint | undefined`

Max priority fee per gas (in wei). Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/call.md","from":4821,"to":5201}<fsm-vh3gqscxm4e>
import { call } from '@wagmi/core'
import { parseGwei } from 'viem'
import { config } from './config'

await call(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
  maxFeePerGas: parseGwei('20'),
  maxPriorityFeePerGas: parseGwei('2'), // [!code focus]
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### nonce

`number | undefined`

Unique number identifying this transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/call.md","from":5361,"to":5649}<fsm-vh3gqscxm4e>
import { call } from '@wagmi/core'
import { config } from './config'

await call(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
  nonce: 420, // [!code focus]
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### value

`bigint | undefined`

Value (in wei) sent with this transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/call.md","from":5808,"to":6142}<fsm-vh3gqscxm4e>
import { call } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

await call(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: parseEther('1'), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`number | undefined`

The block number to perform the call against.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/call.md","from":6310,"to":6610}<fsm-vh3gqscxm4e>
import { call } from '@wagmi/core'
import { config } from './config'

await call(config, {
  blockNumber: 15121123n, // [!code focus]
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

The block tag to perform the call against.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/call.md","from":6822,"to":7116}<fsm-vh3gqscxm4e>
import { call } from '@wagmi/core'
import { config } from './config'

await call(config, {
  blockTag: 'safe', // [!code focus]
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

The block tag to perform the call against.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/call.md","from":7301,"to":7643}<fsm-vh3gqscxm4e>
import { call } from '@wagmi/core'
import { config } from './config'
import { mainnet } from '@wagmi/core/chains'

await call(config, {
  chainId: mainnet.id, // [!code focus]
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/call.md","from":7724,"to":8190}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"21d9f77d5084c8206ac7e44980e375eda94c1b843ad4d776e3c3ed3a076f7de7","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAJMcvAMJtWAJRhoArqTAAVbDF4BeXsAA6YXtt5RmaZol4AJOrwA+vKWFgAzdmBhQA3JoC+m9gFssEUmmFRCWlZBRxKEDgDfyQARgAWKlYYMABzNHw4xOpmUlTJPBFWcUkZeUUIjkckAAYqAGN8XOZ6mnJEBLcAXQboXEQQb19/NX5FQOLgsrClN15bUggvXgByAAEAd2ZUr3YAenq/GBWIr0lmJFA6GjA4dggwPDQENzcgA==="}
import { type CallReturnType } from '@wagmi/core'
```

`{ data: 0x${string} }`

The call data.

## Error

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/call.md","from":8261,"to":8966}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"b8acbdeab78439603d8a045b8f32426b8530ecc55b9057e0cccd65e1da03193a","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAJMcvAMJtWAUVKkIpACrYYvALy8A8gFt2aADwjW42jADGAVzTsIYCVNnyKvADohDzY3BiOAfLwBkvYPbBeIN5nVxhEXgAFZlI3AEFDQwhjMDQraTlBAB9eAEkwIjZ2KDioKFJ4OHSbbN4EpJS0AGU0ZhohCwAzDkM0yQz5Xhz8mgBzMhVTFU6AJWYwcerMhRym9gAvGDFaQxgYKDhosvYFtc2lwZyL2pa2mDi4OHZRsDUYVI6wbvZe65W8gpFKAAIQwNDgABl3qM0Pg/kNeAA6ZG8ABsAEZeGppApkYiEQBxGBoABy0C2/VIM2JxlIYGWAG4AgBfALsNRYaRoYSiP6UEBwVqkBiIdEAFiorGhsKQ6IAzFQheMRSBdOJKct+RwwLhEAAGKiGfAxZi9MiysXMgC6hvJeHZnOFfn4gzV8OZvE6UjUvAA5AABADuzFGGgA9EkKr7+W9WkhQHQaGAnhY8GgEMzmUA=="}
import { type CallErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`call`](https://viem.sh/docs/actions/public/call)

---

---
url: /core/guides/chain-properties.md
---
# Chain Properties

Some chains support additional properties related to blocks and transactions. This is powered by Viem's [formatters](https://viem.sh/docs/chains/formatters) and [serializers](https://viem.sh/docs/chains/serializers). For example, Celo, ZkSync, OP Stack chains support all additional properties. In order to use these properties in a type-safe way, there are a few things you should be aware of.

## Narrowing Parameters

When you pass your `config` to an action, you are ready to access chain-specific properties! For example, Celo's `feeCurrency` is available.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/chain-properties.md","from":615,"to":902}<fsm-vh3gqscxm4e>
import { parseEther } from 'viem'
import { simulateContract } from '@wagmi/core'
import { config } from './config'

const result = await simulateContract(config, {
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
  feeCurrency: '0x…', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { base, celo, mainnet } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [base, celo, mainnet],
  transports: {
    [base.id]: http(),
    [celo.id]: http(),
    [mainnet.id]: http(),
  },
})

```

This is great, but if you have multiple chains that support additional properties, your autocomplete could be overwhelmed with all of them. By setting the `chainId` property to a specific value (e.g. `celo.id`), you can narrow parameters to a single chain.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/chain-properties.md","from":1259,"to":1653}<fsm-vh3gqscxm4e>
import { parseEther } from 'viem'
import { simulateContract } from '@wagmi/core'
import { celo } from 'wagmi/chains'

const result = await simulateContract({
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
  chainId: celo.id, // [!code focus]
  feeCurrency: '0x…', // [!code focus]
  // ^? (property) feeCurrency?: `0x${string}` | undefined // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { base, celo, mainnet } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [base, celo, mainnet],
  transports: {
    [base.id]: http(),
    [celo.id]: http(),
    [mainnet.id]: http(),
  },
})

```

## Narrowing Return Types

Return types can also have chain-specific properties attached to them. There are a couple approaches for extracting these properties.

### `chainId` Parameter

Not only can you use the `chainId` parameter to [narrow parameters](#narrowing-parameters), you can also use it to narrow the return type.

::: code-group

```ts [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/chain-properties.md","from":2080,"to":2397}<fsm-vh3gqscxm4e>
import { waitForTransactionReceipt } from '@wagmi/core'
import { zkSync } from '@wagmi/core/chains'

const result = await waitForTransactionReceipt({
  chainId: zkSync.id,
  hash: '0x16854fcdd0219cacf5aec5e4eb2154dac9e406578a1510a6fc48bd0b67e69ea9',
})

result.logs
//     ^? (property) logs: ZkSyncLog[] | undefined
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { base, celo, mainnet } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [base, celo, mainnet],
  transports: {
    [base.id]: http(),
    [celo.id]: http(),
    [mainnet.id]: http(),
  },
})

```

### `chainId` Data Property

Wagmi internally will set a `chainId` property on return types that you can use to narrow results. The `chainId` is determined from the `chainId` parameter or global state (e.g. connector). You can use this property to help TypeScript narrow the type.

::: code-group

```ts [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/chain-properties.md","from":2779,"to":3116}<fsm-vh3gqscxm4e>
import { waitForTransactionReceipt } from '@wagmi/core'
import { zkSync } from '@wagmi/core/chains'

const result = await waitForTransactionReceipt({
  hash: '0x16854fcdd0219cacf5aec5e4eb2154dac9e406578a1510a6fc48bd0b67e69ea9',
})

if (result.chainId === zkSync.id) {
  result.logs
  //     ^? (property) logs: ZkSyncLog[] | undefined
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { base, celo, mainnet } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [base, celo, mainnet],
  transports: {
    [base.id]: http(),
    [celo.id]: http(),
    [mainnet.id]: http(),
  },
})

```

## Troubleshooting

If chain properties aren't working, make sure [TypeScript](/core/guides/faq#type-inference-doesn-t-work) is configured correctly. Not all chains have additional properties, to check which ones do, see the [Viem repo](https://github.com/wevm/viem/tree/main/src/chains) (chains that have a top-level directory under [`src/chains`](https://github.com/wevm/viem/tree/main/src/chains) support additional properties).

---

---
url: /react/guides/chain-properties.md
---
# Chain Properties

Some chains support additional properties related to blocks and transactions. This is powered by Viem's [formatters](https://viem.sh/docs/chains/formatters) and [serializers](https://viem.sh/docs/chains/serializers). For example, Celo, ZkSync, OP Stack chains all support additional properties. In order to use these properties in a type-safe way, there are a few things you should be aware of.

::: tip
Make sure you follow the TypeScript guide's [Config Types](/react/typescript#config-types) section before moving on. The easiest way to do this is to use [Declaration Merging](/react/typescript#declaration-merging) to "register" your `config` globally with TypeScript.

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { base, celo, mainnet } from 'wagmi/chains'

export const config = createConfig({
  chains: [base, celo, mainnet],
  transports: {
    [base.id]: http(),
    [celo.id]: http(),
    [mainnet.id]: http(),
  },
})

declare module 'wagmi' {
  interface Register {
    config: typeof config
  }
}

```

## Narrowing Parameters

Once your Config is registered with TypeScript, you are ready to access chain-specific properties! For example, Celo's `feeCurrency` is available.

::: code-group

```ts [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/chain-properties.md","from":971,"to":1210}<fsm-vh3gqscxm4e>
import { parseEther } from 'viem'
import { useSimulateContract } from 'wagmi'

const result = useSimulateContract({
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
  feeCurrency: '0x…', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { base, celo, mainnet } from 'wagmi/chains'

export const config = createConfig({
  chains: [base, celo, mainnet],
  transports: {
    [base.id]: http(),
    [celo.id]: http(),
    [mainnet.id]: http(),
  },
})

declare module 'wagmi' {
  interface Register {
    config: typeof config
  }
}

```

This is great, but if you have multiple chains that support additional properties, your autocomplete could be overwhelmed with all of them. By setting the `chainId` property to a specific value (e.g. `celo.id`), you can narrow parameters to a single chain.

::: code-group

```ts [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/chain-properties.md","from":1569,"to":1957}<fsm-vh3gqscxm4e>
import { parseEther } from 'viem'
import { useSimulateContract } from 'wagmi'
import { celo } from 'wagmi/chains'

const result = useSimulateContract({
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
  chainId: celo.id, // [!code focus]
  feeCurrency: '0x…', // [!code focus]
  // ^? (property) feeCurrency?: `0x${string}` | undefined // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { base, celo, mainnet } from 'wagmi/chains'

export const config = createConfig({
  chains: [base, celo, mainnet],
  transports: {
    [base.id]: http(),
    [celo.id]: http(),
    [mainnet.id]: http(),
  },
})

declare module 'wagmi' {
  interface Register {
    config: typeof config
  }
}

```

## Narrowing Return Types

Return types can also have chain-specific properties attached to them. There are a couple approaches for extracting these properties.

### `chainId` Parameter

Not only can you use the `chainId` parameter to [narrow parameters](#narrowing-parameters), you can also use it to narrow the return type.

::: code-group

```ts [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/chain-properties.md","from":2385,"to":2690}<fsm-vh3gqscxm4e>
import { useWaitForTransactionReceipt } from 'wagmi'
import { zkSync } from 'wagmi/chains'

const { data } = useWaitForTransactionReceipt({
  chainId: zkSync.id,
  hash: '0x16854fcdd0219cacf5aec5e4eb2154dac9e406578a1510a6fc48bd0b67e69ea9',
})

data?.logs
//    ^? (property) logs: ZkSyncLog[] | undefined
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { base, celo, mainnet } from 'wagmi/chains'

export const config = createConfig({
  chains: [base, celo, mainnet],
  transports: {
    [base.id]: http(),
    [celo.id]: http(),
    [mainnet.id]: http(),
  },
})

declare module 'wagmi' {
  interface Register {
    config: typeof config
  }
}

```

### `chainId` Data Property

Wagmi internally will set a `chainId` property on return types that you can use to narrow results. The `chainId` is determined from the `chainId` parameter or global state (e.g. connector). You can use this property to help TypeScript narrow the type.

::: code-group

```ts [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/chain-properties.md","from":3073,"to":3397}<fsm-vh3gqscxm4e>
import { useWaitForTransactionReceipt } from 'wagmi'
import { zkSync } from 'wagmi/chains'

const { data } = useWaitForTransactionReceipt({
  hash: '0x16854fcdd0219cacf5aec5e4eb2154dac9e406578a1510a6fc48bd0b67e69ea9',
})

if (data?.chainId === zkSync.id) {
  data?.logs
  //    ^? (property) logs: ZkSyncLog[] | undefined
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { base, celo, mainnet } from 'wagmi/chains'

export const config = createConfig({
  chains: [base, celo, mainnet],
  transports: {
    [base.id]: http(),
    [celo.id]: http(),
    [mainnet.id]: http(),
  },
})

declare module 'wagmi' {
  interface Register {
    config: typeof config
  }
}

```

## Troubleshooting

If chain properties aren't working, make sure [TypeScript](/react/guides/faq#type-inference-doesn-t-work) is configured correctly. Not all chains have additional properties, to check which ones do, see the [Viem repo](https://github.com/wevm/viem/tree/main/src/chains) (chains that have a top-level directory under [`src/chains`](https://github.com/wevm/viem/tree/main/src/chains) support additional properties).

---

---
url: /vue/guides/chain-properties.md
---
# Chain Properties

Some chains support additional properties related to blocks and transactions. This is powered by Viem's [formatters](https://viem.sh/docs/chains/formatters) and [serializers](https://viem.sh/docs/chains/serializers). For example, Celo, ZkSync, OP Stack chains support all support additional properties. In order to use these properties in a type-safe way, there are a few things you should be aware of.

::: tip
Make sure you follow the TypeScript guide's [Config Types](/vue/typescript#config-types) section before moving on. The easiest way to do this is to use [Declaration Merging](/vue/typescript#declaration-merging) to "register" your `config` globally with TypeScript.

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { base, celo, mainnet } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [base, celo, mainnet],
  transports: {
    [base.id]: http(),
    [celo.id]: http(),
    [mainnet.id]: http(),
  },
})

declare module '@wagmi/vue' {
  interface Register {
    config: typeof config
  }
}

```

## Narrowing Parameters

Once your Config is registered with TypeScript, you are ready to access chain-specific properties! For example, Celo's `feeCurrency` is available.

::: code-group

```ts [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/chain-properties.md","from":973,"to":1217}<fsm-vh3gqscxm4e>
import { parseEther } from 'viem'
import { useSimulateContract } from '@wagmi/vue'

const result = useSimulateContract({
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
  feeCurrency: '0x…', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { base, celo, mainnet } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [base, celo, mainnet],
  transports: {
    [base.id]: http(),
    [celo.id]: http(),
    [mainnet.id]: http(),
  },
})

declare module '@wagmi/vue' {
  interface Register {
    config: typeof config
  }
}

```

This is great, but if you have multiple chains that support additional properties, your autocomplete could be overwhelmed with all of them. By setting the `chainId` property to a specific value (e.g. `celo.id`), you can narrow parameters to a single chain.

::: code-group

```ts [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/chain-properties.md","from":1574,"to":1972}<fsm-vh3gqscxm4e>
import { parseEther } from 'viem'
import { useSimulateContract } from '@wagmi/vue'
import { celo } from '@wagmi/vue/chains'

const result = useSimulateContract({
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
  chainId: celo.id, // [!code focus]
  feeCurrency: '0x…', // [!code focus]
  // ^? (property) feeCurrency?: `0x${string}` | undefined // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { base, celo, mainnet } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [base, celo, mainnet],
  transports: {
    [base.id]: http(),
    [celo.id]: http(),
    [mainnet.id]: http(),
  },
})

declare module '@wagmi/vue' {
  interface Register {
    config: typeof config
  }
}

```

## Narrowing Return Types

Return types can also have chain-specific properties attached to them. There are a couple approaches for extracting these properties.

### `chainId` Parameter

Not only can you use the `chainId` parameter to [narrow parameters](#narrowing-parameters), you can also use it to narrow the return type.

::: code-group

```ts [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/chain-properties.md","from":2398,"to":2713}<fsm-vh3gqscxm4e>
import { useWaitForTransactionReceipt } from '@wagmi/vue'
import { zkSync } from '@wagmi/vue/chains'

const { data } = useWaitForTransactionReceipt({
  chainId: zkSync.id,
  hash: '0x16854fcdd0219cacf5aec5e4eb2154dac9e406578a1510a6fc48bd0b67e69ea9',
})

data?.logs
//    ^? (property) logs: ZkSyncLog[] | undefined
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { base, celo, mainnet } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [base, celo, mainnet],
  transports: {
    [base.id]: http(),
    [celo.id]: http(),
    [mainnet.id]: http(),
  },
})

declare module '@wagmi/vue' {
  interface Register {
    config: typeof config
  }
}

```

### `chainId` Data Property

Wagmi internally will set a `chainId` property on return types that you can use to narrow results. The `chainId` is determined from the `chainId` parameter or global state (e.g. connector). You can use this property to help TypeScript narrow the type.

::: code-group

```ts [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/chain-properties.md","from":3094,"to":3428}<fsm-vh3gqscxm4e>
import { useWaitForTransactionReceipt } from '@wagmi/vue'
import { zkSync } from '@wagmi/vue/chains'

const { data } = useWaitForTransactionReceipt({
  hash: '0x16854fcdd0219cacf5aec5e4eb2154dac9e406578a1510a6fc48bd0b67e69ea9',
})

if (data?.chainId === zkSync.id) {
  data?.logs
  //    ^? (property) logs: ZkSyncLog[] | undefined
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { base, celo, mainnet } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [base, celo, mainnet],
  transports: {
    [base.id]: http(),
    [celo.id]: http(),
    [mainnet.id]: http(),
  },
})

declare module '@wagmi/vue' {
  interface Register {
    config: typeof config
  }
}

```

## Troubleshooting

If chain properties aren't working, make sure [TypeScript](/vue/guides/faq#type-inference-doesn-t-work) is configured correctly. Not all chains have additional properties, to check which ones do, see the [Viem repo](https://github.com/wevm/viem/tree/main/src/chains) (chains that have a top-level directory under [`src/chains`](https://github.com/wevm/viem/tree/main/src/chains) support additional properties).

---

---
url: /core/api/chains.md
---
# Chains

## Import

Import via the `'@wagmi/core/chains'` entrypoint (proxies all chains from `'viem/chains'`).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/chains.md","from":309,"to":354}<fsm-vh3gqscxm4e>
import { mainnet } from '@wagmi/core/chains'
```

## Available Chains

Chain definitions as of `viem@{{viemVersion}}`. For `viem@latest`, visit the [Viem repo](https://github.com/wevm/viem/blob/main/src/chains/index.ts).

## Create Chain

Import the `Chain` type from Viem and create a new object that is asserted `as const` and `satisfies` the type. You can also use the `defineChain` function from Viem.

::: code-group

```ts twoslash [as const satisfies Chain]
// @twoslash-cache: {"v":1,"hash":"b104f720769e0d28b42cc38edb3952d146e5b9902d8a7bead95767460071c100","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAJMcvAML5m7MAB4AZhFIBbZmhqk4vOjTBRVIsWABishUrKqAPrwCummFPEwovALzDR4g/MXKzl67bD2KXgBjCzg0CDk1ehhNVQAlGCDZKAkw0nEAc0CrAGtIAHcwAD5ecytYP3snXgSk0hS0zOywPIhCkrLfOygS52AAHTBeYd4AI1YIIJyAUVosCdITAH5EXgGhkc3kHJgMVcawDIBdVZ1xACEJqdn52TIAbkHNzYrmC1Y0U9cwS8mZuYWDyeIwAvqUfBVuo8NsMkmA0KRmEE0HAVrwAAqLJTsKQYCTrZ4jba7fYIzInFy6IQQeGI5HggmE57IOAQCykIIwACSUFWYAsclGZApZzA1NpSLQ4PKNihwMJYM6kP8UGhmzBADI1vLnjE4AkMuw0hg0aLxQjJdKuiq1Uy9QBVMDsEgqNgJVmsF2m77mulSpWym06zZyd5odhBNisADM3qpNIt9IDlVVOpBHQhgfstuGADp87wAJy8OR3Xj53M53hSGDwONuWtwaSGTwmK3K+wZmUp6EgwbsORYWRS0WUEBhZikBiIACMABYqKwYhk0PgkABWKhoScZGDTkCjxd2JAABioQVEfrISHnIIo6GwuEQBGI1636jwcLCJd0/k+axBMcJynJA5wADkXZdVyQAB2Lcdz3PAFHEP8xw4fwkAAJnPS9JWvWdozvB8cDwQgXTHGh6DwAQYGCGlvz6QCqGA6cADYFxAJdDmgxBN2oBD9y/BgjwwxBsJAC9Jzw8gxMLIjqEfPAyFIWQgO3EDEBgs9OKgtdEELc9oCfGdo1Y7TbC45g5CfEBxFgWhcxRMd2CgJTSFIABaEyzI8sCYI8wsKI/Z8ABVH14AByYAQQi3goAgeBeEgKU4EUI1cX4fBaLoHBkSqGjItFCLc2BMLBCimLeCNEsjTgTJMtomRWAmfJ6qwFScCndhEqkFTIgKiKitWFzAjAKyYFGtKSCEdlFjAIIMECUgsCCe1SFYBBIJIVg3JU8gRKfcTJKvGTo3XeSaNI199uoYKQBYDguD4ArRWbDxjBUKINC0Sk3BbD7vG7bpqlFdwjC8dssygQIQjCCIvpiH7amSVIyUOZpWnaSGU2qZH6lR9J0Z8THimx7pem1GExiuf5bkWFQ0UZQliT2XgDmOL5dF+a4ATuUgqxeGw3g+TmLhpm5AX5tMyaDKm4UTFE0UxPdw1xfFgyJHZWfZkUfQTP0GQ15nWXZTkeT5AUhVIXX4wlJNMx7I3eEVB25SpzVKaZNQwH1GBDWNesxX1y1kzdr2HSdF1UtYd0IE9MhA99EPXdlr3Qw+CMo1jUWg7t/0U+zNMu2tQuqYrIsSzLCsqxrOsc70Rs3vBttQ5VYuO1TMA+ydQdh1+sA1MnacwO0riVz0vj1N3fdD0448xJwqS8pkudzqOQzYDwAchynNZ+HC0VnerPrIqIbq5AiwZBhyvuhJ/FC92qaLeC4OifZStK4FsRLZ+s7ckFAOoPU7AaTUQQCCEEQA="}
// @errors: 1360
import { type Chain } from 'viem'

export const mainnet = {} as const satisfies Chain
```

```ts twoslash [defineChain]
// @twoslash-cache: {"v":1,"hash":"51816265e78622b289e1e5f943b76d80bfbe0a867d81b51ec6327613f6e28499","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvWP3ZgYAYXzM5AHn4RSAW2ZoapOLzo0wUQ0pVgAYpp16ycCrxGS4aZ8rlH6MU+c9g6ra6+nAAfGGMIgGIHpbcsQAKpDB67PwYqgCCcHDsAOaBFmrCMnIwUGFO0ZYRADpg7FpYmu5l8sVglCBuzKQMiACcVKy++Wj4SACMU1RoffmpeO2KAd0c8kgADFQ1pMxiZEiDAL4U6Ni4iATER3PGeC5gbrw6cvJoscANvL+8AEasCAiADWAFFaFggSkDAB+L4/P5I5AgmAYWJuUhyfIAXVinQAQkDQRCoZoyABuRFI34yZiCVifXiE4ngyHQynU3gnXgAH14pRgsnkUD5AtMQvKUCpUj+TzQ+zEcHhvG+sppvGQtAxCuxeOZAQUkgVB3c/LVGo1yDgEEEpBEMAAklBYmBBFp/mR9Z0jWATWIxYLhRUZZbuYGJcHpVykb44AAlGD5diYjAqn3GxVm8UraPqmlxgCqjRIBjYiZtrFL6cNmdNEdzoctWgZ4hEbFYAGYa5Zff7s0GpU3fjz+YORcPeOwXbw3R7OfmAHTL3gADle5N4y8Xk/4MHgPbkVn3cFU27CDclE4aJ26vX6SAALMMQKMwONJogAOxzBZLa5vGAHzrOUSAAEy7MoWZHIgUydmcFw4HghClt0ND0EwbCcDw0hXqsliqJ0NjaCEDhOJ0hEBMRdihBEUQxAaBFEcE9gGGECSqlygLAmyZIwsqCL5siqLorwmJ6viAREjxpIcqQk5InSraSZY0kkuy5LyVyo45nhopjpGQ5cvKWYCZxQl/FqOpYu+3q1n6WZihaYaWTadoOs6rrup6pB2b2dYBgZjYxn8OnjiGIW/HGibJqmh5gH2jlBXpCl/EWJYOOW8AQFWZDxYl9bJVGqW/C2jLsO2rBdvlAUDoZ175mF9URUuK6DBuKRbsuu4nvFx7wGey4XkVRlgCcDRNC0/S4cGnR3vMD6IAArC+b4ftMszUH+AwgCsc0jKBiAQSAeymjBYHwec1CXHgZCkJo819AMX6bWtEzgbs0BXBdj5LVQshvswWhXCAciwLQi5oAgVDTrdpCkAAtD9S0I6uq5I2hDzXFkpD5O6vjuBA/C8JgOC8AA5MAJzk1OhiQO4XB5IUzCAjAJMQLwWB9EDqRkLwRMk5cFMUcxJGseE5OLoiAAqQuU9TtOvCmeTviT+BsxoVUQAA7tinP3Tg/TsPAAj3Vogtk+TItUSxtHk7E05OGAPNO7o7AkAodopKIGBOKQWAiIWpCsNDr4wCQrBw/d5AHZsR2QdzhzkIgnZLScOKfbAeCTa0qozeUnThvwZsU0QxtaOTDQNHQU3uE8LyAR8vAALz5x0ASMFT3DdMD8xIKAxhxhIXTXFDIAnCcQA=="}
// @errors: 2345
import { defineChain } from 'viem'

export const mainnet = defineChain({})
```

:::

Now, add the missing required properties to the object until the error goes away.

::: code-group

```ts twoslash [as const satisfies Chain]
// @twoslash-cache: {"v":1,"hash":"7eb538e5797ec32b451699fd0f71747694cdee2f09698daad95d805d237f68ce","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAJMcvAML5m7MAB4AZhFIBbZmhqk4vOjTBRVIsWABishUrKqAPrwCummFPEwovALzDR4g/MXKzl67bD2KXgBjCzg0CDk1ehhNVQAlGCDZKAkw0nEAc0CrAGtIAHcwAD5ecytYP3snXgSk0hS0zOywPIhCkrLfOygS52AAHTBeYd4AI1YIIJyAUVosCdITAH5EXgGhkc3kHJgMVcawDIBdVZ1xACEJqdn52TIAbkHNzYrmC1Y0U9cwS8mZuYWDyeIwAvqUfBVuo8NsMkmA0KRmEE0HAVrwAAqLJTsKQYCTrZ4jba7fYIzInFy6IQQeGI5HggmE57IOAQCykIIwACSUFWYAsclGZApZzA1NpSLQ4PKNihwMJYM6kP8UGhmzBADI1vLnjE4AkMuw0hg0aLxQjJdKuiq1Uy9QBVMDsEgqNgJVmsF2m77mulSpWym06zZyd5odhBNisADM3qpNIt9IDlVVOpBHQhgfstuGADp87wAJy8OR3Xj53M53hSGDwONuWtwaSGTwmK3K+wZmUp6EgwbsORYWRS0WUEBhZikBiIACMABYqKwYhk0PgkABWKhoScZGDTkCjxd2JAABioQVEfrISHnIIo6GwuEQBGI1636jwcLCJd0/k+2phXhFmYKAaVYDBeHYXleBnKtgNAsBwN4MBmDkGBVn6EBplXMgYAFTC4JgECwIglDwxIIR2UWMAgj2ACmSAoiEKQlC0IwrCcNIAjgxGeCSN4OAMEFCBWHY6YABUAAluMAzY+MQiDYCCAc2DgVYZwADirEFCOIhSgKwIJ7VIVg1Popl5KQ14w1WRkGOGSyIPwJQsFWRzeGQTDnLQLA1IAej8vd8FzNDSByJdc3YCBMKOKt1W03TmIg8Y/huQEVFsniHKY/jrI+TLZIsnL9NY9DeEw7D8BMSMwBk+zeOKpD2VE8qCBc/zAs4uAasi6KQDi0EEp1dy4UTFECoY9y9QNI0ETouz7PckCoEWOAzMwk9aBPbadt2k8hAAJmmE8AHY5xgIQADZCwAQRPKA9FGA7C0LE7zhuy6hBOqADpgGcYDqpkdKyxi9KQh0nRdOA3XgESXQm+rQaS3hltW9aQE26Y5xuoIoCgS7NNgaYABFzsun6pBPaNRkLUYpEug6oCCAnNL0IRbrnKBmEB+r3JSqYhGAmhoJnS6TpO6NxfXAbhmBwrsrBiDQw+CMo2jBH6orGXeDl+LBhBMcJynJA5w0xdl1XJATq3Hc9zwBRxD/McOH8JADvPS9JWvWdozvB8cDwQgXTHGh6CYLBSAgHApwwPgoL5AUhXIKhQKCBBny5YnIKGflBTIatDEN7djcQBnzcOS3EHd6hbf3KDnePRBow9ycvfIKu/eoR9A9fZPqA/Z9GAjqOyEwPhStJdJDjHVP05ASSBWYMAAFp4OYcYYGQ1DcCoI3pxOmdy5XNdEAXGvSF3fdSob13T5bq924OzuBCfF9g/fMPB+H6Ox638iLqojEWiXxdAADlFDOgAaQaitEZ6TDnpRaBQCIKhCqKMCCF5dBF0nNOQsh8QBLgrifecNsL522fGRSBiCYEYBvk+TcIBMEPzds/buz4g5vn7p/EAQ9I4/1jlvNiAkyTT13sXacM4TyFiPpXM+xdL54GvkeW+DCmFtzdieVhAd2G9xDgPHh39R4CMEsJFqBwMhwLTngA6y9LrBE9siNsExRHjnETeA6Z9CHHyQJdUhCjnwmNGCJOhG577qKbuuLRr8OF91DvuXhI8Y58CUipUyCc859z3jeaM0iCEWxPmbc+/iQApIUKZEJiBVEOOUBuTR94u7aLfpwuJ4c+FGL4KQQyxk0nmWGMSOi5iRTfDiF0kycAqx5X/KKEZRkxm9ksQgkSS5kRRSGBAKQNR0RCDUJoIc4gUTYJLjOdc1s8lEKtn48hIBOmzPKcop8vjGHVO9k/epL8e7vy4fEwxSTeCTJAeIGZ3SEBiJwTeE61cvGV1OfIq5kyKmnLUY49uc4okfOafohJ/C+DeVckjfi5jkBHEORIjSzczneLvkUq5uKEVhORTeSJby2FNNiZin5v9+b/FuIsFQaIFr9MnuSAFPwrjcvShMmwbx8qUguGKtKdxSC9nbFmKACy8DUlYMs8MNJeDrLGGKqIPKTAkrdgdBhULiFyNrngLlCreUgoIY3XJSKakd2ZY0mJejuFYvaX8qVNlZWitSgCRVpqq5zlOZai51L9zwvuTeM8TzW4MtPminRnyWlfzab8iewip4WNBSXc1hTo1UthVfbeFTJH0rdcc9NrLvXfJzb/ZqQqXFZKruLGRJ9yUVrwM1atSbXXe2jKij10TdEf2bYk3+o0/Sog1h5Wg7bjgit9JacwC0tisnZJyHk6Sk5DPjBKJMmYexphVRewC00YCGmNPWMUCY/RXrlDesAcBHSQNdKwd0cMyCPo3We7sb6QxhlVlq2M67n2bvPW+xUcGVTqufJq7Vqy9UbPnZKR1nbozHJ7UgXJ/bnxYeRI6l2T4ZzVxHY/BtXrp2tNnQI29965qAZg8B609hw3RmjJC/JN58HEZACx2apBaEJp9rW7247/aTszeyltAjUbwDMgAA02gAEmAOYkEamePrnJWWmFNrnwqbWtWs+NGfF0anV8xj2KdmfshiYGGHovTQdPf6RD3Gi3TjnDOXJZaDpJuExDb90Nf2w09JwijN5HnWbTRO9FbKfUcuU3jNGqwNO0G07p/TfmTZziCwJxAJmyH7nM+RxuM5EXPPbpdWzCm0tKb4FywWRFhZolzknV9SHCuVJrRSyuVHLn7na0LXzTrb6aWkw1prGKWtMb4MrcMkZIPsa831qbnb1xzgtaVobwnVsQZjBUkLc2TYLdSzOxzVXstaZ0yIjIenw3rkugd85ZWxt4Cq+d/BiXGvJYzYt27fqJudfsN1xO+dkzdHDQzR5ZbRuxttWKjrigptxartR+rNngeNoY8+F+wQaTfj6MNRqEF44wUSvxPNFVOJ4TkDzfFJUIEUUATReaIN3IM44lVLi/VedU4EkJIJLUKpSVZ3JUXpTVLqS0mmOn+kbnAqXbLxW/qpDSv/NuoqWvcVuVF55NqPkOpBRCmQcKMBeoxW1rrQalOtd2tDQ6jXDUtf/N6YtUX/PKrVSXjLg3yM22tVxRbrqPUorB9lkNQCI0OPjR95r5GonjQe8JEtTLqn2KbT2gXw6x0zoXWundB6T0XpvQ+l9H6f0AbC/ljrbWU0P1fqhm5/9pBM/PGzytXPrVMbY1xvjQmMASZkwplTGmdMGZMxZhpNmHMuax976LiHmORZiwllLB3LfRcnfWzGHvmwtYg0d3H/WCOxYEcqT9kjZOGCSfNZdyp12m1MDYJwHg/BHxBubB4MYCoFEBoFoEGu4EYF4Ntg4M4KKBAa2MAXDiqIECEGEBECATEGAbUMkKkM9s0K0O0NAdUNgfULgQWvgQUMUNAb0D7q7sanyj3oKvmsKkGr8NcG7kCE3t7qKGweKoqtpNAVWKRiiGiJiHuOGLiPiCDEwYMp5mNAyCDDumyByNyNBD1sKHIS+kgdmOfoIZelqPrsMOnmxpobBiBkGE3uFh3lFu5gBqYZxh2KmE3ofmrJtvIdoU4eqF2Fxp4SMBWEWCWGWGfoBDWHWCKnoI2AAZAW2B4d4Y4b2P2IOMOEGgjmSrfgwsJoeNNk+C/smswlXDOCCEcOeNAK/AOEOFOGsL/oIKKDrNWJHJEAAOREDsAwByCNGDCDB0AVFShfhSgOxgB/jVCMg06HzAh5qNEB6LACiNEUDjEc5QI0K2SCJlSTGcSzFi6mKrCTFSQbHy49KaQ6xzEbBq5jJLre7AC8BG4eSNER6IABSW6hQ269SNFHBHHAh3jAh0HpRmQLQXErHbFTHdRLwbFh63HtT3GdSC7AlgAvHvEbCfEbDCG/E6jGHiYe73a8CNH54F67RF6nTnRXS3T3SPTPSvTvSfTfS/T/SzFpjHGbBWGuY2Fd4Yk55rTbFD44x4wEwaREykwwDkwHSUzUy0z0yMzMwziszsw3SczMC0mFQb7CzqTb6SwnSbh0k6guGQasn97slYmbSRiSmjCwAnjrivQnSjDRiXR4aiwnQngHQaQaQMxCgHTMC1Y5InSXSGkzjymEiKn2DqRzjRiGaXQnhjGASImyzHFghcCk4fpSjQzhhwC2DwApFUBoTbhICgDqB6irJ4AHIggghAA==="}
import { type Chain } from 'viem'

export const mainnet = {
  id: 1,
  name: 'Ethereum',
  nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
  rpcUrls: {
    default: { http: ['https://eth.merkle.io'] },
  },
  blockExplorers: {
    default: { name: 'Etherscan', url: 'https://etherscan.io' },
  },
  contracts: {
    ensRegistry: {
      address: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
    },
    ensUniversalResolver: {
      address: '0xE4Acdd618deED4e6d2f03b9bf62dc6118FC9A4da',
      blockCreated: 16773775,
    },
    multicall3: {
      address: '0xca11bde05977b3631167028862be2a173976ca11',
      blockCreated: 14353601,
    },
  },
} as const satisfies Chain
```

```ts twoslash [defineChain]
// @twoslash-cache: {"v":1,"hash":"9dd120cd705dc697124cfe3fa80116ed4046ca81c57ffb5daa2cfd0b2775f253","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvWP3ZgYAYXzM5AHn4RSAW2ZoapOLzo0wUQ0pVgAYpp16ycCrxGS4aZ8rlH6MU+c9g6ra6+nAAfGGMIgGIHpbcsQAKpDB67PwYqgCCcHDsAOaBFmrCMnIwUGFO0ZYRADpg7FpYmu5l8sVglCBuzKQMiACcVKy++Wj4SACMU1RoffmpeO2KAd0c8kgADFQ1pMxiZEiDAL4U6Ni4iATER3PGeC5gbrw6cvJoscANvL+8AEasCAiADWAFFaFggSkDF8fn8ESlmFBJKwMNIYPxmIJWJ9eN8pAiib8kSiwGjeGBmFoYLE6iAwRMHCJmGB6QBueHExEwZGo9GCUisOkEPRYOCIAD0ktS+GZrIAdBIOVyiSdOYTfurVU80PsxBL8aqeXzyejfHAAEowfLsNykDBwzXckm8skU5FQFK5EVbWhbAOBoNbBQAJjBWwA7AAWRQANkGWS2UCs/1Dg0GkYAQlk4wpI1BQzApjAVc6Edry39SfyjM8AKqNEgGNjWuAQVjNp0uk3u9Ge72G+l+sHRrIiKBQONTAAcsDBABFY3HC/wtgBmf6Df78OOhqAiaezqwKRPRqDMMs96tu2uA4EghRImhQWJTOORyPrz8AVg1LsrF0azNV4cXEFlWFYddu2vXhgI9SdB19WgWRmf5YC2H9M0jf51zjdcZg/LZQxnGc93+GBQ2YKYv0zONUKmK9YPg9F71BJ9eRfN9o3XH88K2KZ/25QC/hE352FfXhBNVKkaRFRk5RSQQtCY34qXEEgFEFFJREdI0q1dU0KVk2leHpBSyFUokWN4OAMC0f4O3kgAVAAJKze1rWARCaNhDVnIStUC3gFVC3g41eTQYBC0Lgv4GB4AAfliTorASuBVFChUwl4AAfXhSkxcooA1E5ul6fokGjYYQFGMBxkmRBIzmBYlmuN4wA+dZyiQUNdmUfV9GmdczguHA8EIZtuhoegmDYTgeAxWQOgCVRUuCewDCcAlPJAiS32CmyTPkpklJUkBDtvED1PYTTtN8EQ9J27kjupUzzNOjybyM9E7IcpyzIZNyvsMvsMR8nRWH8mdgrEuCropUgsBEeshUNZ7iRsmRsVxGDrxs/AxViGzkHpQm0HFKUZQmBUaVIEFRiVCB6QAXWCitYcun6ASBUEIShKLYX0oCEfRbGwLxntXrkwGLIMFk2Qu40XtFgqhRFcnKelWV5TAJmQd4OG4Zs3VBvR5XQdrC1rVte0not6zVYHeAhxAP1gw9sMIxjeNE2TVN00zHM8wLIsSwNuHdopC1G1uhxW3gDsu2F5incQl3kNHcdJ2nOcYEXZdVw3Lcdz3A8jxnE8zwvA2o9Y3nH2fCo3w/L9f3Z0SO8tkCtDA9gIKgyWXSyrvDc5hoTkiGo5Elmz9qkrmweO2XTpgZSrNejTFHu3Sh++pe3pOxSDZsv7HOFWXgaVgz4e57zfKht8YdVY3VaRlG0b37uKXF3GU/x1Wmtiaq1JqKCmEptY0zpgzGA+sQBswdkbRed4G782hA4L+t8wa/zxBjKWqtl4fUUnABWtd961kFBfMmYoIHU2IQrOBo8kGqhNpIPUBw0DmxvjZa2No7R6ntjfOuvBnY+kBu7D2QYvZRljAoBMSYUxpgzNmXM+ZCzFlLNfACo8eENibPHVgbYk5kEwcI0RrsRxjgnFOWc84lwwBXKGNcm5ty7n3IeGYldTxZHPJeLRqduZsUbpxZuUlW7fkjH+RBOjVa91xP3Ngg9/49hHtEl+pUEjJNSWAE4DQmgtH6EtconRyrzEqogLCIwxgTGmLMagrUBggBWCUkYPVEB9RAHsDhRx2kjXONQS4E1bjkHuLNa4jAsCkAgDgfoGA+DzymKUvoAxIlVPqjU9pLVSCLEaRJbqmxEDrn6n0bp5B2mjQGeNa4k07jUAeOMyZ0yyCYD4IQhkq914gCWeUmc0Y1kNSqlsnZeATL7KuH8zpA1Tm9QuZgK5NwpqjMaRMqZMyXmUl0HHLSpAdKPVngQw+K9j7+O/r9ey58XLuRJVgryMAIZ+SfqVb5AwphbAhXVAFiApgQrKcC64N07o4oehgMFSAfzHMGj00MsLBnXOGdNe5IAUVPNma8wlRDLJfKoBVFloYOkco2TyhpIK3qioqRK6F7StgyvhTckZdyxlKseWiuZtlyUA3MlfZlw1mq1WqY1OMQK2o9HdawM14rIUnMOGc3iNqrgItuTNZFzrnmuvvpDaG3quU/n1f6pAM4g2NPTX5cNFro1iutf0uF8a7UKsdcql1fB36o0fskrGmIca4IdgTImNKQKgM1rQ2UtMyAwLgQg50lYyrarKSyyMOw/XrMar63lwbm1ozNYGyNkqznSqrbKhN9qk1MBTaqpanb8XcyAX2ikA6aFU2HdAxmyp4FMpncs6YM4I0GuXYW5YHawJmt9V08tiBoxxqGYih1ybUWpr4Nekm1DwEPqgaO59zN4FZqmIMLdP7AX1O2cGzWQGy1DWzRBuVUHj0PNg2eoJaDBZcOETgzB0t3rvPoayE+qtKEa3vZAzjesX3jxyVm0M64C2Ls5dyv91x6OQnQQYM1NUQNkb3WNGt8qkUnto+iljbaCUyw1fLLj1KbK8cBoOlDgnGETzE3GBdeGmqyaaQB3EZrWWkZ6eB/dtqtPQZ0yq9Fby5YkNM2JyMdSnNGsI400FrSDmee3ZaqYP4KOHrrTBoLrqLNIa1nQ3WcCxODEc3mw5LnKEeYXapnp64fMacg4mxVDa4PODYWbS9YNeG2wEaxtOXoM7iP9JIwM0ifZyL9oowOKiQ7qPDtS1+3MY76JbIYxOnYTHJLMenMRw5aBZ2sbnOxhcnHF1cWXDxx5vG+O44EhuHFdChPfJ+CJUTJ3IJ7n3Ae0EtvkJAuY5CDF0IwEwthXC+FCLzpImRUMFEqI0XXHRBit2wZBIe1xKSPE+IOeku9uz77ynrhIv8jZNVV2NNNhwhACWrhTA6TV3d6Xa3aZo9lvg3X+EOk67WAHQ2RujfDDI32CiA7KODmosOmi309FnUgOr36yszBcxzu2HmjnJdA/Vy5mmqPNdPei3ne3+cBjG7I+R/slFB1UaHDR9Is14Vw2VldxrrjmI8xChnSA4xM/89Rp1unXXLbjqtoxG3SDc/+ztix+2rE51sfnexjjnElzceXTxVcfE1zM6rNHTdJLPbbpE6XOqqpE5J41UMC7yd4CD82OACd2xh481uz3YGfe6/rfr11hu3Yx+zjYvOBcHFFxcaXdxFcM83a1TLj9YG9zl6QM72LeA3c0+mMBqFoHve+Z101zvAe+C55Cfn8Jv4s05vV05unLmj+PagB5yTrft8Nco3vrLjbQLxO+xHhCA3du96Bwwiwk/HBwIme2IlInIkomolokjHomokYmzzuwfHRyeyx34lx2nRn3KR/B/EkyvyrxdxADiXAkSXXDNUry8zOS12rUayPT1wPxESj0BwQOB1BxALwjAKImhygPh1gPgJmDtwJwGB/EjHwKdxc1X1qjaVDDqSf3bzf0Cw/1vwx25V4gwKzXwhqivw6Wrzk3uzzwoPp03zI29xZl2GgHjXyVaHxCKRWksENgECmS0F4AAHIiB2AYAtBXCGgGg6ACl3AngXgOoPheAABeOw1YSwRgZ6BZCgeEZeVwuWNebw+IwkAVbeIVXeWwxIuWVwpwM+AGJItyfI8GB+aGQ2NIkkZGFtJjP4fTYAXga9ZAVwqzATEdemdDVwlmSo+EM4eEeTAWGEOo34BojFGWJI06MLMAUoizVo/jArEzITCAVw3owkfowkSnA0SWFXXrX7XnVwiRfnU3YXC3abcXG3EsfIl+Kov4WvAxUPZOPBX4A4yxfvI7BPE7ZPc7cfdPa7C8a4qsFQp7U/VZG41UEghJSCH7Z4pgv/Q0Q4lCVgoAsHTgyHCAmHOHGAxHOAhiQE4kYE/PdAnHW4rUW4jYk4bgboGkeYJAUAYwC0CQLoa4ThEAE4E4IAA="}
import { defineChain } from 'viem'

export const mainnet = defineChain({
  id: 1,
  name: 'Ethereum',
  nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
  rpcUrls: {
    default: { http: ['https://eth.merkle.io'] },
  },
  blockExplorers: {
    default: { name: 'Etherscan', url: 'https://etherscan.io' },
  },
  contracts: {
    ensRegistry: {
      address: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
    },
    ensUniversalResolver: {
      address: '0xE4Acdd618deED4e6d2f03b9bf62dc6118FC9A4da',
      blockCreated: 16773775,
    },
    multicall3: {
      address: '0xca11bde05977b3631167028862be2a173976ca11',
      blockCreated: 14353601,
    },
  },
})
```

:::

The more properties you add, the better the chain will be to use with Wagmi. Most of these attributes exist within the [`ethereum-lists/chains` repository](https://github.com/ethereum-lists/chains/tree/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains).

* `id`: The chain ID for the network. This can be found by typing the network name into [ChainList](https://chainlist.org). Example: "Ethereum Mainnet" has a Chain ID of `1`.
* `name`: Human-readable name for the chain. Example: "Ethereum Mainnet"
* `nativeCurrency`: The native currency of the chain. Found from [`ethereum-lists/chains`](https://github.com/ethereum-lists/chains/blob/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains/eip155-56.json#L20-L24).
* `rpcUrls`: At least one public, credible RPC URL. Found from [`ethereum-lists/chains`](https://github.com/ethereum-lists/chains/blob/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains/eip155-56.json#L4-L18).
* `blockExplorers`: A set of block explorers for the chain. Found from [`ethereum-lists/chains`](https://github.com/ethereum-lists/chains/blob/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains/eip155-56.json#L30-L36).
* `contracts`: A set of deployed contracts for the chain. If you are deploying one of the following contracts yourself, make sure it is verified.
  * `multicall3` is optional, but it's address is most likely `0xca11bde05977b3631167028862be2a173976ca11` – you can find the deployed block number on the block explorer. Check out [`mds1/multicall`](https://github.com/mds1/multicall#multicall3-contract-addresses) for more info.
  * `ensRegistry` is optional – not all Chains have a ENS Registry. See [ENS Deployments](https://docs.ens.domains/ens-deployments) for more info.
  * `ensUniversalResolver` is optional – not all Chains have a ENS Universal Resolver.
* `sourceId`: Source Chain ID (e.g. the L1 chain).
* `testnet`: Whether or not the chain is a testnet.

---

---
url: /react/api/chains.md
---
# Chains

Viem `Chain` objects. More info at the [Viem docs](https://viem.sh/docs/chains/introduction).

## Import

Import via the `'wagmi/chains'` entrypoint (proxies all chains from `'viem/chains'`).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/chains.md","from":398,"to":437}<fsm-vh3gqscxm4e>
import { mainnet } from 'wagmi/chains'
```

## Available Chains

Chain definitions as of `viem@{{viemVersion}}`. For `viem@latest`, visit the [Viem repo](https://github.com/wevm/viem/blob/main/src/chains/index.ts).

## Create Chain

Import the `Chain` type from Viem and create a new object that is asserted `as const` and `satisfies` the type. You can also use the `defineChain` function from Viem.

::: code-group

```ts twoslash [as const satisfies Chain]
// @twoslash-cache: {"v":1,"hash":"b104f720769e0d28b42cc38edb3952d146e5b9902d8a7bead95767460071c100","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAJMcvAML5m7MAB4AZhFIBbZmhqk4vOjTBRVIsWABishUrKqAPrwCummFPEwovALzDR4g/MXKzl67bD2KXgBjCzg0CDk1ehhNVQAlGCDZKAkw0nEAc0CrAGtIAHcwAD5ecytYP3snXgSk0hS0zOywPIhCkrLfOygS52AAHTBeYd4AI1YIIJyAUVosCdITAH5EXgGhkc3kHJgMVcawDIBdVZ1xACEJqdn52TIAbkHNzYrmC1Y0U9cwS8mZuYWDyeIwAvqUfBVuo8NsMkmA0KRmEE0HAVrwAAqLJTsKQYCTrZ4jba7fYIzInFy6IQQeGI5HggmE57IOAQCykIIwACSUFWYAsclGZApZzA1NpSLQ4PKNihwMJYM6kP8UGhmzBADI1vLnjE4AkMuw0hg0aLxQjJdKuiq1Uy9QBVMDsEgqNgJVmsF2m77mulSpWym06zZyd5odhBNisADM3qpNIt9IDlVVOpBHQhgfstuGADp87wAJy8OR3Xj53M53hSGDwONuWtwaSGTwmK3K+wZmUp6EgwbsORYWRS0WUEBhZikBiIACMABYqKwYhk0PgkABWKhoScZGDTkCjxd2JAABioQVEfrISHnIIo6GwuEQBGI1636jwcLCJd0/k+axBMcJynJA5wADkXZdVyQAB2Lcdz3PAFHEP8xw4fwkAAJnPS9JWvWdozvB8cDwQgXTHGh6DwAQYGCGlvz6QCqGA6cADYFxAJdDmgxBN2oBD9y/BgjwwxBsJAC9Jzw8gxMLIjqEfPAyFIWQgO3EDEBgs9OKgtdEELc9oCfGdo1Y7TbC45g5CfEBxFgWhcxRMd2CgJTSFIABaEyzI8sCYI8wsKI/Z8ABVH14AByYAQQi3goAgeBeEgKU4EUI1cX4fBaLoHBkSqGjItFCLc2BMLBCimLeCNEsjTgTJMtomRWAmfJ6qwFScCndhEqkFTIgKiKitWFzAjAKyYFGtKSCEdlFjAIIMECUgsCCe1SFYBBIJIVg3JU8gRKfcTJKvGTo3XeSaNI199uoYKQBYDguD4ArRWbDxjBUKINC0Sk3BbD7vG7bpqlFdwjC8dssygQIQjCCIvpiH7amSVIyUOZpWnaSGU2qZH6lR9J0Z8THimx7pem1GExiuf5bkWFQ0UZQliT2XgDmOL5dF+a4ATuUgqxeGw3g+TmLhpm5AX5tMyaDKm4UTFE0UxPdw1xfFgyJHZWfZkUfQTP0GQ15nWXZTkeT5AUhVIXX4wlJNMx7I3eEVB25SpzVKaZNQwH1GBDWNesxX1y1kzdr2HSdF1UtYd0IE9MhA99EPXdlr3Qw+CMo1jUWg7t/0U+zNMu2tQuqYrIsSzLCsqxrOsc70Rs3vBttQ5VYuO1TMA+ydQdh1+sA1MnacwO0riVz0vj1N3fdD0448xJwqS8pkudzqOQzYDwAchynNZ+HC0VnerPrIqIbq5AiwZBhyvuhJ/FC92qaLeC4OifZStK4FsRLZ+s7ckFAOoPU7AaTUQQCCEEQA="}
// @errors: 1360
import { type Chain } from 'viem'

export const mainnet = {} as const satisfies Chain
```

```ts twoslash [defineChain]
// @twoslash-cache: {"v":1,"hash":"51816265e78622b289e1e5f943b76d80bfbe0a867d81b51ec6327613f6e28499","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvWP3ZgYAYXzM5AHn4RSAW2ZoapOLzo0wUQ0pVgAYpp16ycCrxGS4aZ8rlH6MU+c9g6ra6+nAAfGGMIgGIHpbcsQAKpDB67PwYqgCCcHDsAOaBFmrCMnIwUGFO0ZYRADpg7FpYmu5l8sVglCBuzKQMiACcVKy++Wj4SACMU1RoffmpeO2KAd0c8kgADFQ1pMxiZEiDAL4U6Ni4iATER3PGeC5gbrw6cvJoscANvL+8AEasCAiADWAFFaFggSkDAB+L4/P5I5AgmAYWJuUhyfIAXVinQAQkDQRCoZoyABuRFI34yZiCVifXiE4ngyHQynU3gnXgAH14pRgsnkUD5AtMQvKUCpUj+TzQ+zEcHhvG+sppvGQtAxCuxeOZAQUkgVB3c/LVGo1yDgEEEpBEMAAklBYmBBFp/mR9Z0jWATWIxYLhRUZZbuYGJcHpVykb44AAlGD5diYjAqn3GxVm8UraPqmlxgCqjRIBjYiZtrFL6cNmdNEdzoctWgZ4hEbFYAGYa5Zff7s0GpU3fjz+YORcPeOwXbw3R7OfmAHTL3gADle5N4y8Xk/4MHgPbkVn3cFU27CDclE4aJ26vX6SAALMMQKMwONJogAOxzBZLa5vGAHzrOUSAAEy7MoWZHIgUydmcFw4HghClt0ND0EwbCcDw0hXqsliqJ0NjaCEDhOJ0hEBMRdihBEUQxAaBFEcE9gGGECSqlygLAmyZIwsqCL5siqLorwmJ6viAREjxpIcqQk5InSraSZY0kkuy5LyVyo45nhopjpGQ5cvKWYCZxQl/FqOpYu+3q1n6WZihaYaWTadoOs6rrup6pB2b2dYBgZjYxn8OnjiGIW/HGibJqmh5gH2jlBXpCl/EWJYOOW8AQFWZDxYl9bJVGqW/C2jLsO2rBdvlAUDoZ175mF9URUuK6DBuKRbsuu4nvFx7wGey4XkVRlgCcDRNC0/S4cGnR3vMD6IAArC+b4ftMszUH+AwgCsc0jKBiAQSAeymjBYHwec1CXHgZCkJo819AMX6bWtEzgbs0BXBdj5LVQshvswWhXCAciwLQi5oAgVDTrdpCkAAtD9S0I6uq5I2hDzXFkpD5O6vjuBA/C8JgOC8AA5MAJzk1OhiQO4XB5IUzCAjAJMQLwWB9EDqRkLwRMk5cFMUcxJGseE5OLoiAAqQuU9TtOvCmeTviT+BsxoVUQAA7tinP3Tg/TsPAAj3Vogtk+TItUSxtHk7E05OGAPNO7o7AkAodopKIGBOKQWAiIWpCsNDr4wCQrBw/d5AHZsR2QdzhzkIgnZLScOKfbAeCTa0qozeUnThvwZsU0QxtaOTDQNHQU3uE8LyAR8vAALz5x0ASMFT3DdMD8xIKAxhxhIXTXFDIAnCcQA=="}
// @errors: 2345
import { defineChain } from 'viem'

export const mainnet = defineChain({})
```

:::

Now, add the missing required properties to the object until the error goes away.

::: code-group

```ts twoslash [as const satisfies Chain]
// @twoslash-cache: {"v":1,"hash":"7eb538e5797ec32b451699fd0f71747694cdee2f09698daad95d805d237f68ce","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAJMcvAML5m7MAB4AZhFIBbZmhqk4vOjTBRVIsWABishUrKqAPrwCummFPEwovALzDR4g/MXKzl67bD2KXgBjCzg0CDk1ehhNVQAlGCDZKAkw0nEAc0CrAGtIAHcwAD5ecytYP3snXgSk0hS0zOywPIhCkrLfOygS52AAHTBeYd4AI1YIIJyAUVosCdITAH5EXgGhkc3kHJgMVcawDIBdVZ1xACEJqdn52TIAbkHNzYrmC1Y0U9cwS8mZuYWDyeIwAvqUfBVuo8NsMkmA0KRmEE0HAVrwAAqLJTsKQYCTrZ4jba7fYIzInFy6IQQeGI5HggmE57IOAQCykIIwACSUFWYAsclGZApZzA1NpSLQ4PKNihwMJYM6kP8UGhmzBADI1vLnjE4AkMuw0hg0aLxQjJdKuiq1Uy9QBVMDsEgqNgJVmsF2m77mulSpWym06zZyd5odhBNisADM3qpNIt9IDlVVOpBHQhgfstuGADp87wAJy8OR3Xj53M53hSGDwONuWtwaSGTwmK3K+wZmUp6EgwbsORYWRS0WUEBhZikBiIACMABYqKwYhk0PgkABWKhoScZGDTkCjxd2JAABioQVEfrISHnIIo6GwuEQBGI1636jwcLCJd0/k+2phXhFmYKAaVYDBeHYXleBnKtgNAsBwN4MBmDkGBVn6EBplXMgYAFTC4JgECwIglDwxIIR2UWMAgj2ACmSAoiEKQlC0IwrCcNIAjgxGeCSN4OAMEFCBWHY6YABUAAluMAzY+MQiDYCCAc2DgVYZwADirEFCOIhSgKwIJ7VIVg1Popl5KQ14w1WRkGOGSyIPwJQsFWRzeGQTDnLQLA1IAej8vd8FzNDSByJdc3YCBMKOKt1W03TmIg8Y/huQEVFsniHKY/jrI+TLZIsnL9NY9DeEw7D8BMSMwBk+zeOKpD2VE8qCBc/zAs4uAasi6KQDi0EEp1dy4UTFECoY9y9QNI0ETouz7PckCoEWOAzMwk9aBPbadt2k8hAAJmmE8AHY5xgIQADZCwAQRPKA9FGA7C0LE7zhuy6hBOqADpgGcYDqpkdKyxi9KQh0nRdOA3XgESXQm+rQaS3hltW9aQE26Y5xuoIoCgS7NNgaYABFzsun6pBPaNRkLUYpEug6oCCAnNL0IRbrnKBmEB+r3JSqYhGAmhoJnS6TpO6NxfXAbhmBwrsrBiDQw+CMo2jBH6orGXeDl+LBhBMcJynJA5w0xdl1XJATq3Hc9zwBRxD/McOH8JADvPS9JWvWdozvB8cDwQgXTHGh6CYLBSAgHApwwPgoL5AUhXIKhQKCBBny5YnIKGflBTIatDEN7djcQBnzcOS3EHd6hbf3KDnePRBow9ycvfIKu/eoR9A9fZPqA/Z9GAjqOyEwPhStJdJDjHVP05ASSBWYMAAFp4OYcYYGQ1DcCoI3pxOmdy5XNdEAXGvSF3fdSob13T5bq924OzuBCfF9g/fMPB+H6Ox638iLqojEWiXxdAADlFDOgAaQaitEZ6TDnpRaBQCIKhCqKMCCF5dBF0nNOQsh8QBLgrifecNsL522fGRSBiCYEYBvk+TcIBMEPzds/buz4g5vn7p/EAQ9I4/1jlvNiAkyTT13sXacM4TyFiPpXM+xdL54GvkeW+DCmFtzdieVhAd2G9xDgPHh39R4CMEsJFqBwMhwLTngA6y9LrBE9siNsExRHjnETeA6Z9CHHyQJdUhCjnwmNGCJOhG577qKbuuLRr8OF91DvuXhI8Y58CUipUyCc859z3jeaM0iCEWxPmbc+/iQApIUKZEJiBVEOOUBuTR94u7aLfpwuJ4c+FGL4KQQyxk0nmWGMSOi5iRTfDiF0kycAqx5X/KKEZRkxm9ksQgkSS5kRRSGBAKQNR0RCDUJoIc4gUTYJLjOdc1s8lEKtn48hIBOmzPKcop8vjGHVO9k/epL8e7vy4fEwxSTeCTJAeIGZ3SEBiJwTeE61cvGV1OfIq5kyKmnLUY49uc4okfOafohJ/C+DeVckjfi5jkBHEORIjSzczneLvkUq5uKEVhORTeSJby2FNNiZin5v9+b/FuIsFQaIFr9MnuSAFPwrjcvShMmwbx8qUguGKtKdxSC9nbFmKACy8DUlYMs8MNJeDrLGGKqIPKTAkrdgdBhULiFyNrngLlCreUgoIY3XJSKakd2ZY0mJejuFYvaX8qVNlZWitSgCRVpqq5zlOZai51L9zwvuTeM8TzW4MtPminRnyWlfzab8iewip4WNBSXc1hTo1UthVfbeFTJH0rdcc9NrLvXfJzb/ZqQqXFZKruLGRJ9yUVrwM1atSbXXe2jKij10TdEf2bYk3+o0/Sog1h5Wg7bjgit9JacwC0tisnZJyHk6Sk5DPjBKJMmYexphVRewC00YCGmNPWMUCY/RXrlDesAcBHSQNdKwd0cMyCPo3We7sb6QxhlVlq2M67n2bvPW+xUcGVTqufJq7Vqy9UbPnZKR1nbozHJ7UgXJ/bnxYeRI6l2T4ZzVxHY/BtXrp2tNnQI29965qAZg8B609hw3RmjJC/JN58HEZACx2apBaEJp9rW7247/aTszeyltAjUbwDMgAA02gAEmAOYkEamePrnJWWmFNrnwqbWtWs+NGfF0anV8xj2KdmfshiYGGHovTQdPf6RD3Gi3TjnDOXJZaDpJuExDb90Nf2w09JwijN5HnWbTRO9FbKfUcuU3jNGqwNO0G07p/TfmTZziCwJxAJmyH7nM+RxuM5EXPPbpdWzCm0tKb4FywWRFhZolzknV9SHCuVJrRSyuVHLn7na0LXzTrb6aWkw1prGKWtMb4MrcMkZIPsa831qbnb1xzgtaVobwnVsQZjBUkLc2TYLdSzOxzVXstaZ0yIjIenw3rkugd85ZWxt4Cq+d/BiXGvJYzYt27fqJudfsN1xO+dkzdHDQzR5ZbRuxttWKjrigptxartR+rNngeNoY8+F+wQaTfj6MNRqEF44wUSvxPNFVOJ4TkDzfFJUIEUUATReaIN3IM44lVLi/VedU4EkJIJLUKpSVZ3JUXpTVLqS0mmOn+kbnAqXbLxW/qpDSv/NuoqWvcVuVF55NqPkOpBRCmQcKMBeoxW1rrQalOtd2tDQ6jXDUtf/N6YtUX/PKrVSXjLg3yM22tVxRbrqPUorB9lkNQCI0OPjR95r5GonjQe8JEtTLqn2KbT2gXw6x0zoXWundB6T0XpvQ+l9H6f0AbC/ljrbWU0P1fqhm5/9pBM/PGzytXPrVMbY1xvjQmMASZkwplTGmdMGZMxZhpNmHMuax976LiHmORZiwllLB3LfRcnfWzGHvmwtYg0d3H/WCOxYEcqT9kjZOGCSfNZdyp12m1MDYJwHg/BHxBubB4MYCoFEBoFoEGu4EYF4Ntg4M4KKBAa2MAXDiqIECEGEBECATEGAbUMkKkM9s0K0O0NAdUNgfULgQWvgQUMUNAb0D7q7sanyj3oKvmsKkGr8NcG7kCE3t7qKGweKoqtpNAVWKRiiGiJiHuOGLiPiCDEwYMp5mNAyCDDumyByNyNBD1sKHIS+kgdmOfoIZelqPrsMOnmxpobBiBkGE3uFh3lFu5gBqYZxh2KmE3ofmrJtvIdoU4eqF2Fxp4SMBWEWCWGWGfoBDWHWCKnoI2AAZAW2B4d4Y4b2P2IOMOEGgjmSrfgwsJoeNNk+C/smswlXDOCCEcOeNAK/AOEOFOGsL/oIKKDrNWJHJEAAOREDsAwByCNGDCDB0AVFShfhSgOxgB/jVCMg06HzAh5qNEB6LACiNEUDjEc5QI0K2SCJlSTGcSzFi6mKrCTFSQbHy49KaQ6xzEbBq5jJLre7AC8BG4eSNER6IABSW6hQ269SNFHBHHAh3jAh0HpRmQLQXErHbFTHdRLwbFh63HtT3GdSC7AlgAvHvEbCfEbDCG/E6jGHiYe73a8CNH54F67RF6nTnRXS3T3SPTPSvTvSfTfS/T/SzFpjHGbBWGuY2Fd4Yk55rTbFD44x4wEwaREykwwDkwHSUzUy0z0yMzMwziszsw3SczMC0mFQb7CzqTb6SwnSbh0k6guGQasn97slYmbSRiSmjCwAnjrivQnSjDRiXR4aiwnQngHQaQaQMxCgHTMC1Y5InSXSGkzjymEiKn2DqRzjRiGaXQnhjGASImyzHFghcCk4fpSjQzhhwC2DwApFUBoTbhICgDqB6irJ4AHIggghAA==="}
import { type Chain } from 'viem'

export const mainnet = {
  id: 1,
  name: 'Ethereum',
  nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
  rpcUrls: {
    default: { http: ['https://eth.merkle.io'] },
  },
  blockExplorers: {
    default: { name: 'Etherscan', url: 'https://etherscan.io' },
  },
  contracts: {
    ensRegistry: {
      address: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
    },
    ensUniversalResolver: {
      address: '0xE4Acdd618deED4e6d2f03b9bf62dc6118FC9A4da',
      blockCreated: 16773775,
    },
    multicall3: {
      address: '0xca11bde05977b3631167028862be2a173976ca11',
      blockCreated: 14353601,
    },
  },
} as const satisfies Chain
```

```ts twoslash [defineChain]
// @twoslash-cache: {"v":1,"hash":"9dd120cd705dc697124cfe3fa80116ed4046ca81c57ffb5daa2cfd0b2775f253","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvWP3ZgYAYXzM5AHn4RSAW2ZoapOLzo0wUQ0pVgAYpp16ycCrxGS4aZ8rlH6MU+c9g6ra6+nAAfGGMIgGIHpbcsQAKpDB67PwYqgCCcHDsAOaBFmrCMnIwUGFO0ZYRADpg7FpYmu5l8sVglCBuzKQMiACcVKy++Wj4SACMU1RoffmpeO2KAd0c8kgADFQ1pMxiZEiDAL4U6Ni4iATER3PGeC5gbrw6cvJoscANvL+8AEasCAiADWAFFaFggSkDF8fn8ESlmFBJKwMNIYPxmIJWJ9eN8pAiib8kSiwGjeGBmFoYLE6iAwRMHCJmGB6QBueHExEwZGo9GCUisOkEPRYOCIAD0ktS+GZrIAdBIOVyiSdOYTfurVU80PsxBL8aqeXzyejfHAAEowfLsNykDBwzXckm8skU5FQFK5EVbWhbAOBoNbBQAJjBWwA7AAWRQANkGWS2UCs/1Dg0GkYAQlk4wpI1BQzApjAVc6Edry39SfyjM8AKqNEgGNjWuAQVjNp0uk3u9Ge72G+l+sHRrIiKBQONTAAcsDBABFY3HC/wtgBmf6Df78OOhqAiaezqwKRPRqDMMs96tu2uA4EghRImhQWJTOORyPrz8AVg1LsrF0azNV4cXEFlWFYddu2vXhgI9SdB19WgWRmf5YC2H9M0jf51zjdcZg/LZQxnGc93+GBQ2YKYv0zONUKmK9YPg9F71BJ9eRfN9o3XH88K2KZ/25QC/hE352FfXhBNVKkaRFRk5RSQQtCY34qXEEgFEFFJREdI0q1dU0KVk2leHpBSyFUokWN4OAMC0f4O3kgAVAAJKze1rWARCaNhDVnIStUC3gFVC3g41eTQYBC0Lgv4GB4AAfliTorASuBVFChUwl4AAfXhSkxcooA1E5ul6fokGjYYQFGMBxkmRBIzmBYlmuN4wA+dZyiQUNdmUfV9GmdczguHA8EIZtuhoegmDYTgeAxWQOgCVRUuCewDCcAlPJAiS32CmyTPkpklJUkBDtvED1PYTTtN8EQ9J27kjupUzzNOjybyM9E7IcpyzIZNyvsMvsMR8nRWH8mdgrEuCropUgsBEeshUNZ7iRsmRsVxGDrxs/AxViGzkHpQm0HFKUZQmBUaVIEFRiVCB6QAXWCitYcun6ASBUEIShKLYX0oCEfRbGwLxntXrkwGLIMFk2Qu40XtFgqhRFcnKelWV5TAJmQd4OG4Zs3VBvR5XQdrC1rVte0not6zVYHeAhxAP1gw9sMIxjeNE2TVN00zHM8wLIsSwNuHdopC1G1uhxW3gDsu2F5incQl3kNHcdJ2nOcYEXZdVw3Lcdz3A8jxnE8zwvA2o9Y3nH2fCo3w/L9f3Z0SO8tkCtDA9gIKgyWXSyrvDc5hoTkiGo5Elmz9qkrmweO2XTpgZSrNejTFHu3Sh++pe3pOxSDZsv7HOFWXgaVgz4e57zfKht8YdVY3VaRlG0b37uKXF3GU/x1Wmtiaq1JqKCmEptY0zpgzGA+sQBswdkbRed4G782hA4L+t8wa/zxBjKWqtl4fUUnABWtd961kFBfMmYoIHU2IQrOBo8kGqhNpIPUBw0DmxvjZa2No7R6ntjfOuvBnY+kBu7D2QYvZRljAoBMSYUxpgzNmXM+ZCzFlLNfACo8eENibPHVgbYk5kEwcI0RrsRxjgnFOWc84lwwBXKGNcm5ty7n3IeGYldTxZHPJeLRqduZsUbpxZuUlW7fkjH+RBOjVa91xP3Ngg9/49hHtEl+pUEjJNSWAE4DQmgtH6EtconRyrzEqogLCIwxgTGmLMagrUBggBWCUkYPVEB9RAHsDhRx2kjXONQS4E1bjkHuLNa4jAsCkAgDgfoGA+DzymKUvoAxIlVPqjU9pLVSCLEaRJbqmxEDrn6n0bp5B2mjQGeNa4k07jUAeOMyZ0yyCYD4IQhkq914gCWeUmc0Y1kNSqlsnZeATL7KuH8zpA1Tm9QuZgK5NwpqjMaRMqZMyXmUl0HHLSpAdKPVngQw+K9j7+O/r9ey58XLuRJVgryMAIZ+SfqVb5AwphbAhXVAFiApgQrKcC64N07o4oehgMFSAfzHMGj00MsLBnXOGdNe5IAUVPNma8wlRDLJfKoBVFloYOkco2TyhpIK3qioqRK6F7StgyvhTckZdyxlKseWiuZtlyUA3MlfZlw1mq1WqY1OMQK2o9HdawM14rIUnMOGc3iNqrgItuTNZFzrnmuvvpDaG3quU/n1f6pAM4g2NPTX5cNFro1iutf0uF8a7UKsdcql1fB36o0fskrGmIca4IdgTImNKQKgM1rQ2UtMyAwLgQg50lYyrarKSyyMOw/XrMar63lwbm1ozNYGyNkqznSqrbKhN9qk1MBTaqpanb8XcyAX2ikA6aFU2HdAxmyp4FMpncs6YM4I0GuXYW5YHawJmt9V08tiBoxxqGYih1ybUWpr4Nekm1DwEPqgaO59zN4FZqmIMLdP7AX1O2cGzWQGy1DWzRBuVUHj0PNg2eoJaDBZcOETgzB0t3rvPoayE+qtKEa3vZAzjesX3jxyVm0M64C2Ls5dyv91x6OQnQQYM1NUQNkb3WNGt8qkUnto+iljbaCUyw1fLLj1KbK8cBoOlDgnGETzE3GBdeGmqyaaQB3EZrWWkZ6eB/dtqtPQZ0yq9Fby5YkNM2JyMdSnNGsI400FrSDmee3ZaqYP4KOHrrTBoLrqLNIa1nQ3WcCxODEc3mw5LnKEeYXapnp64fMacg4mxVDa4PODYWbS9YNeG2wEaxtOXoM7iP9JIwM0ifZyL9oowOKiQ7qPDtS1+3MY76JbIYxOnYTHJLMenMRw5aBZ2sbnOxhcnHF1cWXDxx5vG+O44EhuHFdChPfJ+CJUTJ3IJ7n3Ae0EtvkJAuY5CDF0IwEwthXC+FCLzpImRUMFEqI0XXHRBit2wZBIe1xKSPE+IOeku9uz77ynrhIv8jZNVV2NNNhwhACWrhTA6TV3d6Xa3aZo9lvg3X+EOk67WAHQ2RujfDDI32CiA7KODmosOmi309FnUgOr36yszBcxzu2HmjnJdA/Vy5mmqPNdPei3ne3+cBjG7I+R/slFB1UaHDR9Is14Vw2VldxrrjmI8xChnSA4xM/89Rp1unXXLbjqtoxG3SDc/+ztix+2rE51sfnexjjnElzceXTxVcfE1zM6rNHTdJLPbbpE6XOqqpE5J41UMC7yd4CD82OACd2xh481uz3YGfe6/rfr11hu3Yx+zjYvOBcHFFxcaXdxFcM83a1TLj9YG9zl6QM72LeA3c0+mMBqFoHve+Z101zvAe+C55Cfn8Jv4s05vV05unLmj+PagB5yTrft8Nco3vrLjbQLxO+xHhCA3du96Bwwiwk/HBwIme2IlInIkomolokjHomokYmzzuwfHRyeyx34lx2nRn3KR/B/EkyvyrxdxADiXAkSXXDNUry8zOS12rUayPT1wPxESj0BwQOB1BxALwjAKImhygPh1gPgJmDtwJwGB/EjHwKdxc1X1qjaVDDqSf3bzf0Cw/1vwx25V4gwKzXwhqivw6Wrzk3uzzwoPp03zI29xZl2GgHjXyVaHxCKRWksENgECmS0F4AAHIiB2AYAtBXCGgGg6ACl3AngXgOoPheAABeOw1YSwRgZ6BZCgeEZeVwuWNebw+IwkAVbeIVXeWwxIuWVwpwM+AGJItyfI8GB+aGQ2NIkkZGFtJjP4fTYAXga9ZAVwqzATEdemdDVwlmSo+EM4eEeTAWGEOo34BojFGWJI06MLMAUoizVo/jArEzITCAVw3owkfowkSnA0SWFXXrX7XnVwiRfnU3YXC3abcXG3EsfIl+Kov4WvAxUPZOPBX4A4yxfvI7BPE7ZPc7cfdPa7C8a4qsFQp7U/VZG41UEghJSCH7Z4pgv/Q0Q4lCVgoAsHTgyHCAmHOHGAxHOAhiQE4kYE/PdAnHW4rUW4jYk4bgboGkeYJAUAYwC0CQLoa4ThEAE4E4IAA="}
import { defineChain } from 'viem'

export const mainnet = defineChain({
  id: 1,
  name: 'Ethereum',
  nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
  rpcUrls: {
    default: { http: ['https://eth.merkle.io'] },
  },
  blockExplorers: {
    default: { name: 'Etherscan', url: 'https://etherscan.io' },
  },
  contracts: {
    ensRegistry: {
      address: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
    },
    ensUniversalResolver: {
      address: '0xE4Acdd618deED4e6d2f03b9bf62dc6118FC9A4da',
      blockCreated: 16773775,
    },
    multicall3: {
      address: '0xca11bde05977b3631167028862be2a173976ca11',
      blockCreated: 14353601,
    },
  },
})
```

:::

The more properties you add, the better the chain will be to use with Wagmi. Most of these attributes exist within the [`ethereum-lists/chains` repository](https://github.com/ethereum-lists/chains/tree/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains).

* `id`: The chain ID for the network. This can be found by typing the network name into [ChainList](https://chainlist.org). Example: "Ethereum Mainnet" has a Chain ID of `1`.
* `name`: Human-readable name for the chain. Example: "Ethereum Mainnet"
* `nativeCurrency`: The native currency of the chain. Found from [`ethereum-lists/chains`](https://github.com/ethereum-lists/chains/blob/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains/eip155-56.json#L20-L24).
* `rpcUrls`: At least one public, credible RPC URL. Found from [`ethereum-lists/chains`](https://github.com/ethereum-lists/chains/blob/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains/eip155-56.json#L4-L18).
* `blockExplorers`: A set of block explorers for the chain. Found from [`ethereum-lists/chains`](https://github.com/ethereum-lists/chains/blob/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains/eip155-56.json#L30-L36).
* `contracts`: A set of deployed contracts for the chain. If you are deploying one of the following contracts yourself, make sure it is verified.
  * `multicall3` is optional, but it's address is most likely `0xca11bde05977b3631167028862be2a173976ca11` – you can find the deployed block number on the block explorer. Check out [`mds1/multicall`](https://github.com/mds1/multicall#multicall3-contract-addresses) for more info.
  * `ensRegistry` is optional – not all Chains have a ENS Registry. See [ENS Deployments](https://docs.ens.domains/ens-deployments) for more info.
  * `ensUniversalResolver` is optional – not all Chains have a ENS Universal Resolver.
* `sourceId`: Source Chain ID (e.g. the L1 chain).
* `testnet`: Whether or not the chain is a testnet.

---

---
url: /solid/api/chains.md
---
# Chains

Viem `Chain` objects. More info at the [Viem docs](https://viem.sh/docs/chains/introduction).

## Import

Import via the `'@wagmi/solid/chains'` entrypoint (proxies all chains from `'viem/chains'`).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/chains.md","from":405,"to":451}<fsm-vh3gqscxm4e>
import { mainnet } from '@wagmi/solid/chains'
```

## Available Chains

Chain definitions as of `viem@{{viemVersion}}`. For `viem@latest`, visit the [Viem repo](https://github.com/wevm/viem/blob/main/src/chains/index.ts).

## Create Chain

Import the `Chain` type from Viem and create a new object that is asserted `as const` and `satisfies` the type. You can also use the `defineChain` function from Viem.

::: code-group

```ts twoslash [as const satisfies Chain]
// @twoslash-cache: {"v":1,"hash":"b104f720769e0d28b42cc38edb3952d146e5b9902d8a7bead95767460071c100","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAJMcvAML5m7MAB4AZhFIBbZmhqk4vOjTBRVIsWABishUrKqAPrwCummFPEwovALzDR4g/MXKzl67bD2KXgBjCzg0CDk1ehhNVQAlGCDZKAkw0nEAc0CrAGtIAHcwAD5ecytYP3snXgSk0hS0zOywPIhCkrLfOygS52AAHTBeYd4AI1YIIJyAUVosCdITAH5EXgGhkc3kHJgMVcawDIBdVZ1xACEJqdn52TIAbkHNzYrmC1Y0U9cwS8mZuYWDyeIwAvqUfBVuo8NsMkmA0KRmEE0HAVrwAAqLJTsKQYCTrZ4jba7fYIzInFy6IQQeGI5HggmE57IOAQCykIIwACSUFWYAsclGZApZzA1NpSLQ4PKNihwMJYM6kP8UGhmzBADI1vLnjE4AkMuw0hg0aLxQjJdKuiq1Uy9QBVMDsEgqNgJVmsF2m77mulSpWym06zZyd5odhBNisADM3qpNIt9IDlVVOpBHQhgfstuGADp87wAJy8OR3Xj53M53hSGDwONuWtwaSGTwmK3K+wZmUp6EgwbsORYWRS0WUEBhZikBiIACMABYqKwYhk0PgkABWKhoScZGDTkCjxd2JAABioQVEfrISHnIIo6GwuEQBGI1636jwcLCJd0/k+axBMcJynJA5wADkXZdVyQAB2Lcdz3PAFHEP8xw4fwkAAJnPS9JWvWdozvB8cDwQgXTHGh6DwAQYGCGlvz6QCqGA6cADYFxAJdDmgxBN2oBD9y/BgjwwxBsJAC9Jzw8gxMLIjqEfPAyFIWQgO3EDEBgs9OKgtdEELc9oCfGdo1Y7TbC45g5CfEBxFgWhcxRMd2CgJTSFIABaEyzI8sCYI8wsKI/Z8ABVH14AByYAQQi3goAgeBeEgKU4EUI1cX4fBaLoHBkSqGjItFCLc2BMLBCimLeCNEsjTgTJMtomRWAmfJ6qwFScCndhEqkFTIgKiKitWFzAjAKyYFGtKSCEdlFjAIIMECUgsCCe1SFYBBIJIVg3JU8gRKfcTJKvGTo3XeSaNI199uoYKQBYDguD4ArRWbDxjBUKINC0Sk3BbD7vG7bpqlFdwjC8dssygQIQjCCIvpiH7amSVIyUOZpWnaSGU2qZH6lR9J0Z8THimx7pem1GExiuf5bkWFQ0UZQliT2XgDmOL5dF+a4ATuUgqxeGw3g+TmLhpm5AX5tMyaDKm4UTFE0UxPdw1xfFgyJHZWfZkUfQTP0GQ15nWXZTkeT5AUhVIXX4wlJNMx7I3eEVB25SpzVKaZNQwH1GBDWNesxX1y1kzdr2HSdF1UtYd0IE9MhA99EPXdlr3Qw+CMo1jUWg7t/0U+zNMu2tQuqYrIsSzLCsqxrOsc70Rs3vBttQ5VYuO1TMA+ydQdh1+sA1MnacwO0riVz0vj1N3fdD0448xJwqS8pkudzqOQzYDwAchynNZ+HC0VnerPrIqIbq5AiwZBhyvuhJ/FC92qaLeC4OifZStK4FsRLZ+s7ckFAOoPU7AaTUQQCCEEQA="}
// @errors: 1360
import { type Chain } from 'viem'

export const mainnet = {} as const satisfies Chain
```

```ts twoslash [defineChain]
// @twoslash-cache: {"v":1,"hash":"51816265e78622b289e1e5f943b76d80bfbe0a867d81b51ec6327613f6e28499","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvWP3ZgYAYXzM5AHn4RSAW2ZoapOLzo0wUQ0pVgAYpp16ycCrxGS4aZ8rlH6MU+c9g6ra6+nAAfGGMIgGIHpbcsQAKpDB67PwYqgCCcHDsAOaBFmrCMnIwUGFO0ZYRADpg7FpYmu5l8sVglCBuzKQMiACcVKy++Wj4SACMU1RoffmpeO2KAd0c8kgADFQ1pMxiZEiDAL4U6Ni4iATER3PGeC5gbrw6cvJoscANvL+8AEasCAiADWAFFaFggSkDAB+L4/P5I5AgmAYWJuUhyfIAXVinQAQkDQRCoZoyABuRFI34yZiCVifXiE4ngyHQynU3gnXgAH14pRgsnkUD5AtMQvKUCpUj+TzQ+zEcHhvG+sppvGQtAxCuxeOZAQUkgVB3c/LVGo1yDgEEEpBEMAAklBYmBBFp/mR9Z0jWATWIxYLhRUZZbuYGJcHpVykb44AAlGD5diYjAqn3GxVm8UraPqmlxgCqjRIBjYiZtrFL6cNmdNEdzoctWgZ4hEbFYAGYa5Zff7s0GpU3fjz+YORcPeOwXbw3R7OfmAHTL3gADle5N4y8Xk/4MHgPbkVn3cFU27CDclE4aJ26vX6SAALMMQKMwONJogAOxzBZLa5vGAHzrOUSAAEy7MoWZHIgUydmcFw4HghClt0ND0EwbCcDw0hXqsliqJ0NjaCEDhOJ0hEBMRdihBEUQxAaBFEcE9gGGECSqlygLAmyZIwsqCL5siqLorwmJ6viAREjxpIcqQk5InSraSZY0kkuy5LyVyo45nhopjpGQ5cvKWYCZxQl/FqOpYu+3q1n6WZihaYaWTadoOs6rrup6pB2b2dYBgZjYxn8OnjiGIW/HGibJqmh5gH2jlBXpCl/EWJYOOW8AQFWZDxYl9bJVGqW/C2jLsO2rBdvlAUDoZ175mF9URUuK6DBuKRbsuu4nvFx7wGey4XkVRlgCcDRNC0/S4cGnR3vMD6IAArC+b4ftMszUH+AwgCsc0jKBiAQSAeymjBYHwec1CXHgZCkJo819AMX6bWtEzgbs0BXBdj5LVQshvswWhXCAciwLQi5oAgVDTrdpCkAAtD9S0I6uq5I2hDzXFkpD5O6vjuBA/C8JgOC8AA5MAJzk1OhiQO4XB5IUzCAjAJMQLwWB9EDqRkLwRMk5cFMUcxJGseE5OLoiAAqQuU9TtOvCmeTviT+BsxoVUQAA7tinP3Tg/TsPAAj3Vogtk+TItUSxtHk7E05OGAPNO7o7AkAodopKIGBOKQWAiIWpCsNDr4wCQrBw/d5AHZsR2QdzhzkIgnZLScOKfbAeCTa0qozeUnThvwZsU0QxtaOTDQNHQU3uE8LyAR8vAALz5x0ASMFT3DdMD8xIKAxhxhIXTXFDIAnCcQA=="}
// @errors: 2345
import { defineChain } from 'viem'

export const mainnet = defineChain({})
```

:::

Now, add the missing required properties to the object until the error goes away.

::: code-group

```ts twoslash [as const satisfies Chain]
// @twoslash-cache: {"v":1,"hash":"7eb538e5797ec32b451699fd0f71747694cdee2f09698daad95d805d237f68ce","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAJMcvAML5m7MAB4AZhFIBbZmhqk4vOjTBRVIsWABishUrKqAPrwCummFPEwovALzDR4g/MXKzl67bD2KXgBjCzg0CDk1ehhNVQAlGCDZKAkw0nEAc0CrAGtIAHcwAD5ecytYP3snXgSk0hS0zOywPIhCkrLfOygS52AAHTBeYd4AI1YIIJyAUVosCdITAH5EXgGhkc3kHJgMVcawDIBdVZ1xACEJqdn52TIAbkHNzYrmC1Y0U9cwS8mZuYWDyeIwAvqUfBVuo8NsMkmA0KRmEE0HAVrwAAqLJTsKQYCTrZ4jba7fYIzInFy6IQQeGI5HggmE57IOAQCykIIwACSUFWYAsclGZApZzA1NpSLQ4PKNihwMJYM6kP8UGhmzBADI1vLnjE4AkMuw0hg0aLxQjJdKuiq1Uy9QBVMDsEgqNgJVmsF2m77mulSpWym06zZyd5odhBNisADM3qpNIt9IDlVVOpBHQhgfstuGADp87wAJy8OR3Xj53M53hSGDwONuWtwaSGTwmK3K+wZmUp6EgwbsORYWRS0WUEBhZikBiIACMABYqKwYhk0PgkABWKhoScZGDTkCjxd2JAABioQVEfrISHnIIo6GwuEQBGI1636jwcLCJd0/k+2phXhFmYKAaVYDBeHYXleBnKtgNAsBwN4MBmDkGBVn6EBplXMgYAFTC4JgECwIglDwxIIR2UWMAgj2ACmSAoiEKQlC0IwrCcNIAjgxGeCSN4OAMEFCBWHY6YABUAAluMAzY+MQiDYCCAc2DgVYZwADirEFCOIhSgKwIJ7VIVg1Popl5KQ14w1WRkGOGSyIPwJQsFWRzeGQTDnLQLA1IAej8vd8FzNDSByJdc3YCBMKOKt1W03TmIg8Y/huQEVFsniHKY/jrI+TLZIsnL9NY9DeEw7D8BMSMwBk+zeOKpD2VE8qCBc/zAs4uAasi6KQDi0EEp1dy4UTFECoY9y9QNI0ETouz7PckCoEWOAzMwk9aBPbadt2k8hAAJmmE8AHY5xgIQADZCwAQRPKA9FGA7C0LE7zhuy6hBOqADpgGcYDqpkdKyxi9KQh0nRdOA3XgESXQm+rQaS3hltW9aQE26Y5xuoIoCgS7NNgaYABFzsun6pBPaNRkLUYpEug6oCCAnNL0IRbrnKBmEB+r3JSqYhGAmhoJnS6TpO6NxfXAbhmBwrsrBiDQw+CMo2jBH6orGXeDl+LBhBMcJynJA5w0xdl1XJATq3Hc9zwBRxD/McOH8JADvPS9JWvWdozvB8cDwQgXTHGh6CYLBSAgHApwwPgoL5AUhXIKhQKCBBny5YnIKGflBTIatDEN7djcQBnzcOS3EHd6hbf3KDnePRBow9ycvfIKu/eoR9A9fZPqA/Z9GAjqOyEwPhStJdJDjHVP05ASSBWYMAAFp4OYcYYGQ1DcCoI3pxOmdy5XNdEAXGvSF3fdSob13T5bq924OzuBCfF9g/fMPB+H6Ox638iLqojEWiXxdAADlFDOgAaQaitEZ6TDnpRaBQCIKhCqKMCCF5dBF0nNOQsh8QBLgrifecNsL522fGRSBiCYEYBvk+TcIBMEPzds/buz4g5vn7p/EAQ9I4/1jlvNiAkyTT13sXacM4TyFiPpXM+xdL54GvkeW+DCmFtzdieVhAd2G9xDgPHh39R4CMEsJFqBwMhwLTngA6y9LrBE9siNsExRHjnETeA6Z9CHHyQJdUhCjnwmNGCJOhG577qKbuuLRr8OF91DvuXhI8Y58CUipUyCc859z3jeaM0iCEWxPmbc+/iQApIUKZEJiBVEOOUBuTR94u7aLfpwuJ4c+FGL4KQQyxk0nmWGMSOi5iRTfDiF0kycAqx5X/KKEZRkxm9ksQgkSS5kRRSGBAKQNR0RCDUJoIc4gUTYJLjOdc1s8lEKtn48hIBOmzPKcop8vjGHVO9k/epL8e7vy4fEwxSTeCTJAeIGZ3SEBiJwTeE61cvGV1OfIq5kyKmnLUY49uc4okfOafohJ/C+DeVckjfi5jkBHEORIjSzczneLvkUq5uKEVhORTeSJby2FNNiZin5v9+b/FuIsFQaIFr9MnuSAFPwrjcvShMmwbx8qUguGKtKdxSC9nbFmKACy8DUlYMs8MNJeDrLGGKqIPKTAkrdgdBhULiFyNrngLlCreUgoIY3XJSKakd2ZY0mJejuFYvaX8qVNlZWitSgCRVpqq5zlOZai51L9zwvuTeM8TzW4MtPminRnyWlfzab8iewip4WNBSXc1hTo1UthVfbeFTJH0rdcc9NrLvXfJzb/ZqQqXFZKruLGRJ9yUVrwM1atSbXXe2jKij10TdEf2bYk3+o0/Sog1h5Wg7bjgit9JacwC0tisnZJyHk6Sk5DPjBKJMmYexphVRewC00YCGmNPWMUCY/RXrlDesAcBHSQNdKwd0cMyCPo3We7sb6QxhlVlq2M67n2bvPW+xUcGVTqufJq7Vqy9UbPnZKR1nbozHJ7UgXJ/bnxYeRI6l2T4ZzVxHY/BtXrp2tNnQI29965qAZg8B609hw3RmjJC/JN58HEZACx2apBaEJp9rW7247/aTszeyltAjUbwDMgAA02gAEmAOYkEamePrnJWWmFNrnwqbWtWs+NGfF0anV8xj2KdmfshiYGGHovTQdPf6RD3Gi3TjnDOXJZaDpJuExDb90Nf2w09JwijN5HnWbTRO9FbKfUcuU3jNGqwNO0G07p/TfmTZziCwJxAJmyH7nM+RxuM5EXPPbpdWzCm0tKb4FywWRFhZolzknV9SHCuVJrRSyuVHLn7na0LXzTrb6aWkw1prGKWtMb4MrcMkZIPsa831qbnb1xzgtaVobwnVsQZjBUkLc2TYLdSzOxzVXstaZ0yIjIenw3rkugd85ZWxt4Cq+d/BiXGvJYzYt27fqJudfsN1xO+dkzdHDQzR5ZbRuxttWKjrigptxartR+rNngeNoY8+F+wQaTfj6MNRqEF44wUSvxPNFVOJ4TkDzfFJUIEUUATReaIN3IM44lVLi/VedU4EkJIJLUKpSVZ3JUXpTVLqS0mmOn+kbnAqXbLxW/qpDSv/NuoqWvcVuVF55NqPkOpBRCmQcKMBeoxW1rrQalOtd2tDQ6jXDUtf/N6YtUX/PKrVSXjLg3yM22tVxRbrqPUorB9lkNQCI0OPjR95r5GonjQe8JEtTLqn2KbT2gXw6x0zoXWundB6T0XpvQ+l9H6f0AbC/ljrbWU0P1fqhm5/9pBM/PGzytXPrVMbY1xvjQmMASZkwplTGmdMGZMxZhpNmHMuax976LiHmORZiwllLB3LfRcnfWzGHvmwtYg0d3H/WCOxYEcqT9kjZOGCSfNZdyp12m1MDYJwHg/BHxBubB4MYCoFEBoFoEGu4EYF4Ntg4M4KKBAa2MAXDiqIECEGEBECATEGAbUMkKkM9s0K0O0NAdUNgfULgQWvgQUMUNAb0D7q7sanyj3oKvmsKkGr8NcG7kCE3t7qKGweKoqtpNAVWKRiiGiJiHuOGLiPiCDEwYMp5mNAyCDDumyByNyNBD1sKHIS+kgdmOfoIZelqPrsMOnmxpobBiBkGE3uFh3lFu5gBqYZxh2KmE3ofmrJtvIdoU4eqF2Fxp4SMBWEWCWGWGfoBDWHWCKnoI2AAZAW2B4d4Y4b2P2IOMOEGgjmSrfgwsJoeNNk+C/smswlXDOCCEcOeNAK/AOEOFOGsL/oIKKDrNWJHJEAAOREDsAwByCNGDCDB0AVFShfhSgOxgB/jVCMg06HzAh5qNEB6LACiNEUDjEc5QI0K2SCJlSTGcSzFi6mKrCTFSQbHy49KaQ6xzEbBq5jJLre7AC8BG4eSNER6IABSW6hQ269SNFHBHHAh3jAh0HpRmQLQXErHbFTHdRLwbFh63HtT3GdSC7AlgAvHvEbCfEbDCG/E6jGHiYe73a8CNH54F67RF6nTnRXS3T3SPTPSvTvSfTfS/T/SzFpjHGbBWGuY2Fd4Yk55rTbFD44x4wEwaREykwwDkwHSUzUy0z0yMzMwziszsw3SczMC0mFQb7CzqTb6SwnSbh0k6guGQasn97slYmbSRiSmjCwAnjrivQnSjDRiXR4aiwnQngHQaQaQMxCgHTMC1Y5InSXSGkzjymEiKn2DqRzjRiGaXQnhjGASImyzHFghcCk4fpSjQzhhwC2DwApFUBoTbhICgDqB6irJ4AHIggghAA==="}
import { type Chain } from 'viem'

export const mainnet = {
  id: 1,
  name: 'Ethereum',
  nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
  rpcUrls: {
    default: { http: ['https://eth.merkle.io'] },
  },
  blockExplorers: {
    default: { name: 'Etherscan', url: 'https://etherscan.io' },
  },
  contracts: {
    ensRegistry: {
      address: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
    },
    ensUniversalResolver: {
      address: '0xE4Acdd618deED4e6d2f03b9bf62dc6118FC9A4da',
      blockCreated: 16773775,
    },
    multicall3: {
      address: '0xca11bde05977b3631167028862be2a173976ca11',
      blockCreated: 14353601,
    },
  },
} as const satisfies Chain
```

```ts twoslash [defineChain]
// @twoslash-cache: {"v":1,"hash":"9dd120cd705dc697124cfe3fa80116ed4046ca81c57ffb5daa2cfd0b2775f253","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvWP3ZgYAYXzM5AHn4RSAW2ZoapOLzo0wUQ0pVgAYpp16ycCrxGS4aZ8rlH6MU+c9g6ra6+nAAfGGMIgGIHpbcsQAKpDB67PwYqgCCcHDsAOaBFmrCMnIwUGFO0ZYRADpg7FpYmu5l8sVglCBuzKQMiACcVKy++Wj4SACMU1RoffmpeO2KAd0c8kgADFQ1pMxiZEiDAL4U6Ni4iATER3PGeC5gbrw6cvJoscANvL+8AEasCAiADWAFFaFggSkDF8fn8ESlmFBJKwMNIYPxmIJWJ9eN8pAiib8kSiwGjeGBmFoYLE6iAwRMHCJmGB6QBueHExEwZGo9GCUisOkEPRYOCIAD0ktS+GZrIAdBIOVyiSdOYTfurVU80PsxBL8aqeXzyejfHAAEowfLsNykDBwzXckm8skU5FQFK5EVbWhbAOBoNbBQAJjBWwA7AAWRQANkGWS2UCs/1Dg0GkYAQlk4wpI1BQzApjAVc6Edry39SfyjM8AKqNEgGNjWuAQVjNp0uk3u9Ge72G+l+sHRrIiKBQONTAAcsDBABFY3HC/wtgBmf6Df78OOhqAiaezqwKRPRqDMMs96tu2uA4EghRImhQWJTOORyPrz8AVg1LsrF0azNV4cXEFlWFYddu2vXhgI9SdB19WgWRmf5YC2H9M0jf51zjdcZg/LZQxnGc93+GBQ2YKYv0zONUKmK9YPg9F71BJ9eRfN9o3XH88K2KZ/25QC/hE352FfXhBNVKkaRFRk5RSQQtCY34qXEEgFEFFJREdI0q1dU0KVk2leHpBSyFUokWN4OAMC0f4O3kgAVAAJKze1rWARCaNhDVnIStUC3gFVC3g41eTQYBC0Lgv4GB4AAfliTorASuBVFChUwl4AAfXhSkxcooA1E5ul6fokGjYYQFGMBxkmRBIzmBYlmuN4wA+dZyiQUNdmUfV9GmdczguHA8EIZtuhoegmDYTgeAxWQOgCVRUuCewDCcAlPJAiS32CmyTPkpklJUkBDtvED1PYTTtN8EQ9J27kjupUzzNOjybyM9E7IcpyzIZNyvsMvsMR8nRWH8mdgrEuCropUgsBEeshUNZ7iRsmRsVxGDrxs/AxViGzkHpQm0HFKUZQmBUaVIEFRiVCB6QAXWCitYcun6ASBUEIShKLYX0oCEfRbGwLxntXrkwGLIMFk2Qu40XtFgqhRFcnKelWV5TAJmQd4OG4Zs3VBvR5XQdrC1rVte0not6zVYHeAhxAP1gw9sMIxjeNE2TVN00zHM8wLIsSwNuHdopC1G1uhxW3gDsu2F5incQl3kNHcdJ2nOcYEXZdVw3Lcdz3A8jxnE8zwvA2o9Y3nH2fCo3w/L9f3Z0SO8tkCtDA9gIKgyWXSyrvDc5hoTkiGo5Elmz9qkrmweO2XTpgZSrNejTFHu3Sh++pe3pOxSDZsv7HOFWXgaVgz4e57zfKht8YdVY3VaRlG0b37uKXF3GU/x1Wmtiaq1JqKCmEptY0zpgzGA+sQBswdkbRed4G782hA4L+t8wa/zxBjKWqtl4fUUnABWtd961kFBfMmYoIHU2IQrOBo8kGqhNpIPUBw0DmxvjZa2No7R6ntjfOuvBnY+kBu7D2QYvZRljAoBMSYUxpgzNmXM+ZCzFlLNfACo8eENibPHVgbYk5kEwcI0RrsRxjgnFOWc84lwwBXKGNcm5ty7n3IeGYldTxZHPJeLRqduZsUbpxZuUlW7fkjH+RBOjVa91xP3Ngg9/49hHtEl+pUEjJNSWAE4DQmgtH6EtconRyrzEqogLCIwxgTGmLMagrUBggBWCUkYPVEB9RAHsDhRx2kjXONQS4E1bjkHuLNa4jAsCkAgDgfoGA+DzymKUvoAxIlVPqjU9pLVSCLEaRJbqmxEDrn6n0bp5B2mjQGeNa4k07jUAeOMyZ0yyCYD4IQhkq914gCWeUmc0Y1kNSqlsnZeATL7KuH8zpA1Tm9QuZgK5NwpqjMaRMqZMyXmUl0HHLSpAdKPVngQw+K9j7+O/r9ey58XLuRJVgryMAIZ+SfqVb5AwphbAhXVAFiApgQrKcC64N07o4oehgMFSAfzHMGj00MsLBnXOGdNe5IAUVPNma8wlRDLJfKoBVFloYOkco2TyhpIK3qioqRK6F7StgyvhTckZdyxlKseWiuZtlyUA3MlfZlw1mq1WqY1OMQK2o9HdawM14rIUnMOGc3iNqrgItuTNZFzrnmuvvpDaG3quU/n1f6pAM4g2NPTX5cNFro1iutf0uF8a7UKsdcql1fB36o0fskrGmIca4IdgTImNKQKgM1rQ2UtMyAwLgQg50lYyrarKSyyMOw/XrMar63lwbm1ozNYGyNkqznSqrbKhN9qk1MBTaqpanb8XcyAX2ikA6aFU2HdAxmyp4FMpncs6YM4I0GuXYW5YHawJmt9V08tiBoxxqGYih1ybUWpr4Nekm1DwEPqgaO59zN4FZqmIMLdP7AX1O2cGzWQGy1DWzRBuVUHj0PNg2eoJaDBZcOETgzB0t3rvPoayE+qtKEa3vZAzjesX3jxyVm0M64C2Ls5dyv91x6OQnQQYM1NUQNkb3WNGt8qkUnto+iljbaCUyw1fLLj1KbK8cBoOlDgnGETzE3GBdeGmqyaaQB3EZrWWkZ6eB/dtqtPQZ0yq9Fby5YkNM2JyMdSnNGsI400FrSDmee3ZaqYP4KOHrrTBoLrqLNIa1nQ3WcCxODEc3mw5LnKEeYXapnp64fMacg4mxVDa4PODYWbS9YNeG2wEaxtOXoM7iP9JIwM0ifZyL9oowOKiQ7qPDtS1+3MY76JbIYxOnYTHJLMenMRw5aBZ2sbnOxhcnHF1cWXDxx5vG+O44EhuHFdChPfJ+CJUTJ3IJ7n3Ae0EtvkJAuY5CDF0IwEwthXC+FCLzpImRUMFEqI0XXHRBit2wZBIe1xKSPE+IOeku9uz77ynrhIv8jZNVV2NNNhwhACWrhTA6TV3d6Xa3aZo9lvg3X+EOk67WAHQ2RujfDDI32CiA7KODmosOmi309FnUgOr36yszBcxzu2HmjnJdA/Vy5mmqPNdPei3ne3+cBjG7I+R/slFB1UaHDR9Is14Vw2VldxrrjmI8xChnSA4xM/89Rp1unXXLbjqtoxG3SDc/+ztix+2rE51sfnexjjnElzceXTxVcfE1zM6rNHTdJLPbbpE6XOqqpE5J41UMC7yd4CD82OACd2xh481uz3YGfe6/rfr11hu3Yx+zjYvOBcHFFxcaXdxFcM83a1TLj9YG9zl6QM72LeA3c0+mMBqFoHve+Z101zvAe+C55Cfn8Jv4s05vV05unLmj+PagB5yTrft8Nco3vrLjbQLxO+xHhCA3du96Bwwiwk/HBwIme2IlInIkomolokjHomokYmzzuwfHRyeyx34lx2nRn3KR/B/EkyvyrxdxADiXAkSXXDNUry8zOS12rUayPT1wPxESj0BwQOB1BxALwjAKImhygPh1gPgJmDtwJwGB/EjHwKdxc1X1qjaVDDqSf3bzf0Cw/1vwx25V4gwKzXwhqivw6Wrzk3uzzwoPp03zI29xZl2GgHjXyVaHxCKRWksENgECmS0F4AAHIiB2AYAtBXCGgGg6ACl3AngXgOoPheAABeOw1YSwRgZ6BZCgeEZeVwuWNebw+IwkAVbeIVXeWwxIuWVwpwM+AGJItyfI8GB+aGQ2NIkkZGFtJjP4fTYAXga9ZAVwqzATEdemdDVwlmSo+EM4eEeTAWGEOo34BojFGWJI06MLMAUoizVo/jArEzITCAVw3owkfowkSnA0SWFXXrX7XnVwiRfnU3YXC3abcXG3EsfIl+Kov4WvAxUPZOPBX4A4yxfvI7BPE7ZPc7cfdPa7C8a4qsFQp7U/VZG41UEghJSCH7Z4pgv/Q0Q4lCVgoAsHTgyHCAmHOHGAxHOAhiQE4kYE/PdAnHW4rUW4jYk4bgboGkeYJAUAYwC0CQLoa4ThEAE4E4IAA="}
import { defineChain } from 'viem'

export const mainnet = defineChain({
  id: 1,
  name: 'Ethereum',
  nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
  rpcUrls: {
    default: { http: ['https://eth.merkle.io'] },
  },
  blockExplorers: {
    default: { name: 'Etherscan', url: 'https://etherscan.io' },
  },
  contracts: {
    ensRegistry: {
      address: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
    },
    ensUniversalResolver: {
      address: '0xE4Acdd618deED4e6d2f03b9bf62dc6118FC9A4da',
      blockCreated: 16773775,
    },
    multicall3: {
      address: '0xca11bde05977b3631167028862be2a173976ca11',
      blockCreated: 14353601,
    },
  },
})
```

:::

The more properties you add, the better the chain will be to use with Wagmi. Most of these attributes exist within the [`ethereum-lists/chains` repository](https://github.com/ethereum-lists/chains/tree/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains).

* `id`: The chain ID for the network. This can be found by typing the network name into [ChainList](https://chainlist.org). Example: "Ethereum Mainnet" has a Chain ID of `1`.
* `name`: Human-readable name for the chain. Example: "Ethereum Mainnet"
* `nativeCurrency`: The native currency of the chain. Found from [`ethereum-lists/chains`](https://github.com/ethereum-lists/chains/blob/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains/eip155-56.json#L20-L24).
* `rpcUrls`: At least one public, credible RPC URL. Found from [`ethereum-lists/chains`](https://github.com/ethereum-lists/chains/blob/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains/eip155-56.json#L4-L18).
* `blockExplorers`: A set of block explorers for the chain. Found from [`ethereum-lists/chains`](https://github.com/ethereum-lists/chains/blob/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains/eip155-56.json#L30-L36).
* `contracts`: A set of deployed contracts for the chain. If you are deploying one of the following contracts yourself, make sure it is verified.
  * `multicall3` is optional, but it's address is most likely `0xca11bde05977b3631167028862be2a173976ca11` – you can find the deployed block number on the block explorer. Check out [`mds1/multicall`](https://github.com/mds1/multicall#multicall3-contract-addresses) for more info.
  * `ensRegistry` is optional – not all Chains have a ENS Registry. See [ENS Deployments](https://docs.ens.domains/ens-deployments) for more info.
  * `ensUniversalResolver` is optional – not all Chains have a ENS Universal Resolver.
* `sourceId`: Source Chain ID (e.g. the L1 chain).
* `testnet`: Whether or not the chain is a testnet.

---

---
url: /tempo/chains.md
---
# Chains

The following Tempo chains are available:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/chains.md","from":59,"to":203}<fsm-vh3gqscxm4e>
import {
  tempo, // [!code hl]
  tempoDevnet, // [!code hl]
  tempoLocalnet, // [!code hl]
  tempoTestnet, // [!code hl]
} from 'wagmi/chains'
```

## Default Fee Token

It is possible to set a default fee token for a Tempo chain by adding a `feeToken` property as an extension to the chain.

Once set, all transactions will use this token as the default fee token, unless an override is provided at the transaction level.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/chains.md","from":490,"to":618}<fsm-vh3gqscxm4e>
import { tempo } from 'wagmi/chains'

const chain = tempo.extend({
  feeToken: '0x20c0000000000000000000000000000000000001',
})
```

---

---
url: /vue/api/chains.md
---
# Chains

Viem `Chain` objects. More info at the [Viem docs](https://viem.sh/docs/chains/introduction).

## Import

Import via the `'@wagmi/vue/chains'` entrypoint (proxies all chains from `'viem/chains'`).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/chains.md","from":403,"to":447}<fsm-vh3gqscxm4e>
import { mainnet } from '@wagmi/vue/chains'
```

## Available Chains

Chain definitions as of `viem@{{viemVersion}}`. For `viem@latest`, visit the [Viem repo](https://github.com/wevm/viem/blob/main/src/chains/index.ts).

## Create Chain

Import the `Chain` type from Viem and create a new object that is asserted `as const` and `satisfies` the type. You can also use the `defineChain` function from Viem.

::: code-group

```ts twoslash [as const satisfies Chain]
// @twoslash-cache: {"v":1,"hash":"b104f720769e0d28b42cc38edb3952d146e5b9902d8a7bead95767460071c100","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAJMcvAML5m7MAB4AZhFIBbZmhqk4vOjTBRVIsWABishUrKqAPrwCummFPEwovALzDR4g/MXKzl67bD2KXgBjCzg0CDk1ehhNVQAlGCDZKAkw0nEAc0CrAGtIAHcwAD5ecytYP3snXgSk0hS0zOywPIhCkrLfOygS52AAHTBeYd4AI1YIIJyAUVosCdITAH5EXgGhkc3kHJgMVcawDIBdVZ1xACEJqdn52TIAbkHNzYrmC1Y0U9cwS8mZuYWDyeIwAvqUfBVuo8NsMkmA0KRmEE0HAVrwAAqLJTsKQYCTrZ4jba7fYIzInFy6IQQeGI5HggmE57IOAQCykIIwACSUFWYAsclGZApZzA1NpSLQ4PKNihwMJYM6kP8UGhmzBADI1vLnjE4AkMuw0hg0aLxQjJdKuiq1Uy9QBVMDsEgqNgJVmsF2m77mulSpWym06zZyd5odhBNisADM3qpNIt9IDlVVOpBHQhgfstuGADp87wAJy8OR3Xj53M53hSGDwONuWtwaSGTwmK3K+wZmUp6EgwbsORYWRS0WUEBhZikBiIACMABYqKwYhk0PgkABWKhoScZGDTkCjxd2JAABioQVEfrISHnIIo6GwuEQBGI1636jwcLCJd0/k+axBMcJynJA5wADkXZdVyQAB2Lcdz3PAFHEP8xw4fwkAAJnPS9JWvWdozvB8cDwQgXTHGh6DwAQYGCGlvz6QCqGA6cADYFxAJdDmgxBN2oBD9y/BgjwwxBsJAC9Jzw8gxMLIjqEfPAyFIWQgO3EDEBgs9OKgtdEELc9oCfGdo1Y7TbC45g5CfEBxFgWhcxRMd2CgJTSFIABaEyzI8sCYI8wsKI/Z8ABVH14AByYAQQi3goAgeBeEgKU4EUI1cX4fBaLoHBkSqGjItFCLc2BMLBCimLeCNEsjTgTJMtomRWAmfJ6qwFScCndhEqkFTIgKiKitWFzAjAKyYFGtKSCEdlFjAIIMECUgsCCe1SFYBBIJIVg3JU8gRKfcTJKvGTo3XeSaNI199uoYKQBYDguD4ArRWbDxjBUKINC0Sk3BbD7vG7bpqlFdwjC8dssygQIQjCCIvpiH7amSVIyUOZpWnaSGU2qZH6lR9J0Z8THimx7pem1GExiuf5bkWFQ0UZQliT2XgDmOL5dF+a4ATuUgqxeGw3g+TmLhpm5AX5tMyaDKm4UTFE0UxPdw1xfFgyJHZWfZkUfQTP0GQ15nWXZTkeT5AUhVIXX4wlJNMx7I3eEVB25SpzVKaZNQwH1GBDWNesxX1y1kzdr2HSdF1UtYd0IE9MhA99EPXdlr3Qw+CMo1jUWg7t/0U+zNMu2tQuqYrIsSzLCsqxrOsc70Rs3vBttQ5VYuO1TMA+ydQdh1+sA1MnacwO0riVz0vj1N3fdD0448xJwqS8pkudzqOQzYDwAchynNZ+HC0VnerPrIqIbq5AiwZBhyvuhJ/FC92qaLeC4OifZStK4FsRLZ+s7ckFAOoPU7AaTUQQCCEEQA="}
// @errors: 1360
import { type Chain } from 'viem'

export const mainnet = {} as const satisfies Chain
```

```ts twoslash [defineChain]
// @twoslash-cache: {"v":1,"hash":"51816265e78622b289e1e5f943b76d80bfbe0a867d81b51ec6327613f6e28499","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvWP3ZgYAYXzM5AHn4RSAW2ZoapOLzo0wUQ0pVgAYpp16ycCrxGS4aZ8rlH6MU+c9g6ra6+nAAfGGMIgGIHpbcsQAKpDB67PwYqgCCcHDsAOaBFmrCMnIwUGFO0ZYRADpg7FpYmu5l8sVglCBuzKQMiACcVKy++Wj4SACMU1RoffmpeO2KAd0c8kgADFQ1pMxiZEiDAL4U6Ni4iATER3PGeC5gbrw6cvJoscANvL+8AEasCAiADWAFFaFggSkDAB+L4/P5I5AgmAYWJuUhyfIAXVinQAQkDQRCoZoyABuRFI34yZiCVifXiE4ngyHQynU3gnXgAH14pRgsnkUD5AtMQvKUCpUj+TzQ+zEcHhvG+sppvGQtAxCuxeOZAQUkgVB3c/LVGo1yDgEEEpBEMAAklBYmBBFp/mR9Z0jWATWIxYLhRUZZbuYGJcHpVykb44AAlGD5diYjAqn3GxVm8UraPqmlxgCqjRIBjYiZtrFL6cNmdNEdzoctWgZ4hEbFYAGYa5Zff7s0GpU3fjz+YORcPeOwXbw3R7OfmAHTL3gADle5N4y8Xk/4MHgPbkVn3cFU27CDclE4aJ26vX6SAALMMQKMwONJogAOxzBZLa5vGAHzrOUSAAEy7MoWZHIgUydmcFw4HghClt0ND0EwbCcDw0hXqsliqJ0NjaCEDhOJ0hEBMRdihBEUQxAaBFEcE9gGGECSqlygLAmyZIwsqCL5siqLorwmJ6viAREjxpIcqQk5InSraSZY0kkuy5LyVyo45nhopjpGQ5cvKWYCZxQl/FqOpYu+3q1n6WZihaYaWTadoOs6rrup6pB2b2dYBgZjYxn8OnjiGIW/HGibJqmh5gH2jlBXpCl/EWJYOOW8AQFWZDxYl9bJVGqW/C2jLsO2rBdvlAUDoZ175mF9URUuK6DBuKRbsuu4nvFx7wGey4XkVRlgCcDRNC0/S4cGnR3vMD6IAArC+b4ftMszUH+AwgCsc0jKBiAQSAeymjBYHwec1CXHgZCkJo819AMX6bWtEzgbs0BXBdj5LVQshvswWhXCAciwLQi5oAgVDTrdpCkAAtD9S0I6uq5I2hDzXFkpD5O6vjuBA/C8JgOC8AA5MAJzk1OhiQO4XB5IUzCAjAJMQLwWB9EDqRkLwRMk5cFMUcxJGseE5OLoiAAqQuU9TtOvCmeTviT+BsxoVUQAA7tinP3Tg/TsPAAj3Vogtk+TItUSxtHk7E05OGAPNO7o7AkAodopKIGBOKQWAiIWpCsNDr4wCQrBw/d5AHZsR2QdzhzkIgnZLScOKfbAeCTa0qozeUnThvwZsU0QxtaOTDQNHQU3uE8LyAR8vAALz5x0ASMFT3DdMD8xIKAxhxhIXTXFDIAnCcQA=="}
// @errors: 2345
import { defineChain } from 'viem'

export const mainnet = defineChain({})
```

:::

Now, add the missing required properties to the object until the error goes away.

::: code-group

```ts twoslash [as const satisfies Chain]
// @twoslash-cache: {"v":1,"hash":"7eb538e5797ec32b451699fd0f71747694cdee2f09698daad95d805d237f68ce","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAJMcvAML5m7MAB4AZhFIBbZmhqk4vOjTBRVIsWABishUrKqAPrwCummFPEwovALzDR4g/MXKzl67bD2KXgBjCzg0CDk1ehhNVQAlGCDZKAkw0nEAc0CrAGtIAHcwAD5ecytYP3snXgSk0hS0zOywPIhCkrLfOygS52AAHTBeYd4AI1YIIJyAUVosCdITAH5EXgGhkc3kHJgMVcawDIBdVZ1xACEJqdn52TIAbkHNzYrmC1Y0U9cwS8mZuYWDyeIwAvqUfBVuo8NsMkmA0KRmEE0HAVrwAAqLJTsKQYCTrZ4jba7fYIzInFy6IQQeGI5HggmE57IOAQCykIIwACSUFWYAsclGZApZzA1NpSLQ4PKNihwMJYM6kP8UGhmzBADI1vLnjE4AkMuw0hg0aLxQjJdKuiq1Uy9QBVMDsEgqNgJVmsF2m77mulSpWym06zZyd5odhBNisADM3qpNIt9IDlVVOpBHQhgfstuGADp87wAJy8OR3Xj53M53hSGDwONuWtwaSGTwmK3K+wZmUp6EgwbsORYWRS0WUEBhZikBiIACMABYqKwYhk0PgkABWKhoScZGDTkCjxd2JAABioQVEfrISHnIIo6GwuEQBGI1636jwcLCJd0/k+2phXhFmYKAaVYDBeHYXleBnKtgNAsBwN4MBmDkGBVn6EBplXMgYAFTC4JgECwIglDwxIIR2UWMAgj2ACmSAoiEKQlC0IwrCcNIAjgxGeCSN4OAMEFCBWHY6YABUAAluMAzY+MQiDYCCAc2DgVYZwADirEFCOIhSgKwIJ7VIVg1Popl5KQ14w1WRkGOGSyIPwJQsFWRzeGQTDnLQLA1IAej8vd8FzNDSByJdc3YCBMKOKt1W03TmIg8Y/huQEVFsniHKY/jrI+TLZIsnL9NY9DeEw7D8BMSMwBk+zeOKpD2VE8qCBc/zAs4uAasi6KQDi0EEp1dy4UTFECoY9y9QNI0ETouz7PckCoEWOAzMwk9aBPbadt2k8hAAJmmE8AHY5xgIQADZCwAQRPKA9FGA7C0LE7zhuy6hBOqADpgGcYDqpkdKyxi9KQh0nRdOA3XgESXQm+rQaS3hltW9aQE26Y5xuoIoCgS7NNgaYABFzsun6pBPaNRkLUYpEug6oCCAnNL0IRbrnKBmEB+r3JSqYhGAmhoJnS6TpO6NxfXAbhmBwrsrBiDQw+CMo2jBH6orGXeDl+LBhBMcJynJA5w0xdl1XJATq3Hc9zwBRxD/McOH8JADvPS9JWvWdozvB8cDwQgXTHGh6CYLBSAgHApwwPgoL5AUhXIKhQKCBBny5YnIKGflBTIatDEN7djcQBnzcOS3EHd6hbf3KDnePRBow9ycvfIKu/eoR9A9fZPqA/Z9GAjqOyEwPhStJdJDjHVP05ASSBWYMAAFp4OYcYYGQ1DcCoI3pxOmdy5XNdEAXGvSF3fdSob13T5bq924OzuBCfF9g/fMPB+H6Ox638iLqojEWiXxdAADlFDOgAaQaitEZ6TDnpRaBQCIKhCqKMCCF5dBF0nNOQsh8QBLgrifecNsL522fGRSBiCYEYBvk+TcIBMEPzds/buz4g5vn7p/EAQ9I4/1jlvNiAkyTT13sXacM4TyFiPpXM+xdL54GvkeW+DCmFtzdieVhAd2G9xDgPHh39R4CMEsJFqBwMhwLTngA6y9LrBE9siNsExRHjnETeA6Z9CHHyQJdUhCjnwmNGCJOhG577qKbuuLRr8OF91DvuXhI8Y58CUipUyCc859z3jeaM0iCEWxPmbc+/iQApIUKZEJiBVEOOUBuTR94u7aLfpwuJ4c+FGL4KQQyxk0nmWGMSOi5iRTfDiF0kycAqx5X/KKEZRkxm9ksQgkSS5kRRSGBAKQNR0RCDUJoIc4gUTYJLjOdc1s8lEKtn48hIBOmzPKcop8vjGHVO9k/epL8e7vy4fEwxSTeCTJAeIGZ3SEBiJwTeE61cvGV1OfIq5kyKmnLUY49uc4okfOafohJ/C+DeVckjfi5jkBHEORIjSzczneLvkUq5uKEVhORTeSJby2FNNiZin5v9+b/FuIsFQaIFr9MnuSAFPwrjcvShMmwbx8qUguGKtKdxSC9nbFmKACy8DUlYMs8MNJeDrLGGKqIPKTAkrdgdBhULiFyNrngLlCreUgoIY3XJSKakd2ZY0mJejuFYvaX8qVNlZWitSgCRVpqq5zlOZai51L9zwvuTeM8TzW4MtPminRnyWlfzab8iewip4WNBSXc1hTo1UthVfbeFTJH0rdcc9NrLvXfJzb/ZqQqXFZKruLGRJ9yUVrwM1atSbXXe2jKij10TdEf2bYk3+o0/Sog1h5Wg7bjgit9JacwC0tisnZJyHk6Sk5DPjBKJMmYexphVRewC00YCGmNPWMUCY/RXrlDesAcBHSQNdKwd0cMyCPo3We7sb6QxhlVlq2M67n2bvPW+xUcGVTqufJq7Vqy9UbPnZKR1nbozHJ7UgXJ/bnxYeRI6l2T4ZzVxHY/BtXrp2tNnQI29965qAZg8B609hw3RmjJC/JN58HEZACx2apBaEJp9rW7247/aTszeyltAjUbwDMgAA02gAEmAOYkEamePrnJWWmFNrnwqbWtWs+NGfF0anV8xj2KdmfshiYGGHovTQdPf6RD3Gi3TjnDOXJZaDpJuExDb90Nf2w09JwijN5HnWbTRO9FbKfUcuU3jNGqwNO0G07p/TfmTZziCwJxAJmyH7nM+RxuM5EXPPbpdWzCm0tKb4FywWRFhZolzknV9SHCuVJrRSyuVHLn7na0LXzTrb6aWkw1prGKWtMb4MrcMkZIPsa831qbnb1xzgtaVobwnVsQZjBUkLc2TYLdSzOxzVXstaZ0yIjIenw3rkugd85ZWxt4Cq+d/BiXGvJYzYt27fqJudfsN1xO+dkzdHDQzR5ZbRuxttWKjrigptxartR+rNngeNoY8+F+wQaTfj6MNRqEF44wUSvxPNFVOJ4TkDzfFJUIEUUATReaIN3IM44lVLi/VedU4EkJIJLUKpSVZ3JUXpTVLqS0mmOn+kbnAqXbLxW/qpDSv/NuoqWvcVuVF55NqPkOpBRCmQcKMBeoxW1rrQalOtd2tDQ6jXDUtf/N6YtUX/PKrVSXjLg3yM22tVxRbrqPUorB9lkNQCI0OPjR95r5GonjQe8JEtTLqn2KbT2gXw6x0zoXWundB6T0XpvQ+l9H6f0AbC/ljrbWU0P1fqhm5/9pBM/PGzytXPrVMbY1xvjQmMASZkwplTGmdMGZMxZhpNmHMuax976LiHmORZiwllLB3LfRcnfWzGHvmwtYg0d3H/WCOxYEcqT9kjZOGCSfNZdyp12m1MDYJwHg/BHxBubB4MYCoFEBoFoEGu4EYF4Ntg4M4KKBAa2MAXDiqIECEGEBECATEGAbUMkKkM9s0K0O0NAdUNgfULgQWvgQUMUNAb0D7q7sanyj3oKvmsKkGr8NcG7kCE3t7qKGweKoqtpNAVWKRiiGiJiHuOGLiPiCDEwYMp5mNAyCDDumyByNyNBD1sKHIS+kgdmOfoIZelqPrsMOnmxpobBiBkGE3uFh3lFu5gBqYZxh2KmE3ofmrJtvIdoU4eqF2Fxp4SMBWEWCWGWGfoBDWHWCKnoI2AAZAW2B4d4Y4b2P2IOMOEGgjmSrfgwsJoeNNk+C/smswlXDOCCEcOeNAK/AOEOFOGsL/oIKKDrNWJHJEAAOREDsAwByCNGDCDB0AVFShfhSgOxgB/jVCMg06HzAh5qNEB6LACiNEUDjEc5QI0K2SCJlSTGcSzFi6mKrCTFSQbHy49KaQ6xzEbBq5jJLre7AC8BG4eSNER6IABSW6hQ269SNFHBHHAh3jAh0HpRmQLQXErHbFTHdRLwbFh63HtT3GdSC7AlgAvHvEbCfEbDCG/E6jGHiYe73a8CNH54F67RF6nTnRXS3T3SPTPSvTvSfTfS/T/SzFpjHGbBWGuY2Fd4Yk55rTbFD44x4wEwaREykwwDkwHSUzUy0z0yMzMwziszsw3SczMC0mFQb7CzqTb6SwnSbh0k6guGQasn97slYmbSRiSmjCwAnjrivQnSjDRiXR4aiwnQngHQaQaQMxCgHTMC1Y5InSXSGkzjymEiKn2DqRzjRiGaXQnhjGASImyzHFghcCk4fpSjQzhhwC2DwApFUBoTbhICgDqB6irJ4AHIggghAA==="}
import { type Chain } from 'viem'

export const mainnet = {
  id: 1,
  name: 'Ethereum',
  nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
  rpcUrls: {
    default: { http: ['https://eth.merkle.io'] },
  },
  blockExplorers: {
    default: { name: 'Etherscan', url: 'https://etherscan.io' },
  },
  contracts: {
    ensRegistry: {
      address: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
    },
    ensUniversalResolver: {
      address: '0xE4Acdd618deED4e6d2f03b9bf62dc6118FC9A4da',
      blockCreated: 16773775,
    },
    multicall3: {
      address: '0xca11bde05977b3631167028862be2a173976ca11',
      blockCreated: 14353601,
    },
  },
} as const satisfies Chain
```

```ts twoslash [defineChain]
// @twoslash-cache: {"v":1,"hash":"9dd120cd705dc697124cfe3fa80116ed4046ca81c57ffb5daa2cfd0b2775f253","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvWP3ZgYAYXzM5AHn4RSAW2ZoapOLzo0wUQ0pVgAYpp16ycCrxGS4aZ8rlH6MU+c9g6ra6+nAAfGGMIgGIHpbcsQAKpDB67PwYqgCCcHDsAOaBFmrCMnIwUGFO0ZYRADpg7FpYmu5l8sVglCBuzKQMiACcVKy++Wj4SACMU1RoffmpeO2KAd0c8kgADFQ1pMxiZEiDAL4U6Ni4iATER3PGeC5gbrw6cvJoscANvL+8AEasCAiADWAFFaFggSkDF8fn8ESlmFBJKwMNIYPxmIJWJ9eN8pAiib8kSiwGjeGBmFoYLE6iAwRMHCJmGB6QBueHExEwZGo9GCUisOkEPRYOCIAD0ktS+GZrIAdBIOVyiSdOYTfurVU80PsxBL8aqeXzyejfHAAEowfLsNykDBwzXckm8skU5FQFK5EVbWhbAOBoNbBQAJjBWwA7AAWRQANkGWS2UCs/1Dg0GkYAQlk4wpI1BQzApjAVc6Edry39SfyjM8AKqNEgGNjWuAQVjNp0uk3u9Ge72G+l+sHRrIiKBQONTAAcsDBABFY3HC/wtgBmf6Df78OOhqAiaezqwKRPRqDMMs96tu2uA4EghRImhQWJTOORyPrz8AVg1LsrF0azNV4cXEFlWFYddu2vXhgI9SdB19WgWRmf5YC2H9M0jf51zjdcZg/LZQxnGc93+GBQ2YKYv0zONUKmK9YPg9F71BJ9eRfN9o3XH88K2KZ/25QC/hE352FfXhBNVKkaRFRk5RSQQtCY34qXEEgFEFFJREdI0q1dU0KVk2leHpBSyFUokWN4OAMC0f4O3kgAVAAJKze1rWARCaNhDVnIStUC3gFVC3g41eTQYBC0Lgv4GB4AAfliTorASuBVFChUwl4AAfXhSkxcooA1E5ul6fokGjYYQFGMBxkmRBIzmBYlmuN4wA+dZyiQUNdmUfV9GmdczguHA8EIZtuhoegmDYTgeAxWQOgCVRUuCewDCcAlPJAiS32CmyTPkpklJUkBDtvED1PYTTtN8EQ9J27kjupUzzNOjybyM9E7IcpyzIZNyvsMvsMR8nRWH8mdgrEuCropUgsBEeshUNZ7iRsmRsVxGDrxs/AxViGzkHpQm0HFKUZQmBUaVIEFRiVCB6QAXWCitYcun6ASBUEIShKLYX0oCEfRbGwLxntXrkwGLIMFk2Qu40XtFgqhRFcnKelWV5TAJmQd4OG4Zs3VBvR5XQdrC1rVte0not6zVYHeAhxAP1gw9sMIxjeNE2TVN00zHM8wLIsSwNuHdopC1G1uhxW3gDsu2F5incQl3kNHcdJ2nOcYEXZdVw3Lcdz3A8jxnE8zwvA2o9Y3nH2fCo3w/L9f3Z0SO8tkCtDA9gIKgyWXSyrvDc5hoTkiGo5Elmz9qkrmweO2XTpgZSrNejTFHu3Sh++pe3pOxSDZsv7HOFWXgaVgz4e57zfKht8YdVY3VaRlG0b37uKXF3GU/x1Wmtiaq1JqKCmEptY0zpgzGA+sQBswdkbRed4G782hA4L+t8wa/zxBjKWqtl4fUUnABWtd961kFBfMmYoIHU2IQrOBo8kGqhNpIPUBw0DmxvjZa2No7R6ntjfOuvBnY+kBu7D2QYvZRljAoBMSYUxpgzNmXM+ZCzFlLNfACo8eENibPHVgbYk5kEwcI0RrsRxjgnFOWc84lwwBXKGNcm5ty7n3IeGYldTxZHPJeLRqduZsUbpxZuUlW7fkjH+RBOjVa91xP3Ngg9/49hHtEl+pUEjJNSWAE4DQmgtH6EtconRyrzEqogLCIwxgTGmLMagrUBggBWCUkYPVEB9RAHsDhRx2kjXONQS4E1bjkHuLNa4jAsCkAgDgfoGA+DzymKUvoAxIlVPqjU9pLVSCLEaRJbqmxEDrn6n0bp5B2mjQGeNa4k07jUAeOMyZ0yyCYD4IQhkq914gCWeUmc0Y1kNSqlsnZeATL7KuH8zpA1Tm9QuZgK5NwpqjMaRMqZMyXmUl0HHLSpAdKPVngQw+K9j7+O/r9ey58XLuRJVgryMAIZ+SfqVb5AwphbAhXVAFiApgQrKcC64N07o4oehgMFSAfzHMGj00MsLBnXOGdNe5IAUVPNma8wlRDLJfKoBVFloYOkco2TyhpIK3qioqRK6F7StgyvhTckZdyxlKseWiuZtlyUA3MlfZlw1mq1WqY1OMQK2o9HdawM14rIUnMOGc3iNqrgItuTNZFzrnmuvvpDaG3quU/n1f6pAM4g2NPTX5cNFro1iutf0uF8a7UKsdcql1fB36o0fskrGmIca4IdgTImNKQKgM1rQ2UtMyAwLgQg50lYyrarKSyyMOw/XrMar63lwbm1ozNYGyNkqznSqrbKhN9qk1MBTaqpanb8XcyAX2ikA6aFU2HdAxmyp4FMpncs6YM4I0GuXYW5YHawJmt9V08tiBoxxqGYih1ybUWpr4Nekm1DwEPqgaO59zN4FZqmIMLdP7AX1O2cGzWQGy1DWzRBuVUHj0PNg2eoJaDBZcOETgzB0t3rvPoayE+qtKEa3vZAzjesX3jxyVm0M64C2Ls5dyv91x6OQnQQYM1NUQNkb3WNGt8qkUnto+iljbaCUyw1fLLj1KbK8cBoOlDgnGETzE3GBdeGmqyaaQB3EZrWWkZ6eB/dtqtPQZ0yq9Fby5YkNM2JyMdSnNGsI400FrSDmee3ZaqYP4KOHrrTBoLrqLNIa1nQ3WcCxODEc3mw5LnKEeYXapnp64fMacg4mxVDa4PODYWbS9YNeG2wEaxtOXoM7iP9JIwM0ifZyL9oowOKiQ7qPDtS1+3MY76JbIYxOnYTHJLMenMRw5aBZ2sbnOxhcnHF1cWXDxx5vG+O44EhuHFdChPfJ+CJUTJ3IJ7n3Ae0EtvkJAuY5CDF0IwEwthXC+FCLzpImRUMFEqI0XXHRBit2wZBIe1xKSPE+IOeku9uz77ynrhIv8jZNVV2NNNhwhACWrhTA6TV3d6Xa3aZo9lvg3X+EOk67WAHQ2RujfDDI32CiA7KODmosOmi309FnUgOr36yszBcxzu2HmjnJdA/Vy5mmqPNdPei3ne3+cBjG7I+R/slFB1UaHDR9Is14Vw2VldxrrjmI8xChnSA4xM/89Rp1unXXLbjqtoxG3SDc/+ztix+2rE51sfnexjjnElzceXTxVcfE1zM6rNHTdJLPbbpE6XOqqpE5J41UMC7yd4CD82OACd2xh481uz3YGfe6/rfr11hu3Yx+zjYvOBcHFFxcaXdxFcM83a1TLj9YG9zl6QM72LeA3c0+mMBqFoHve+Z101zvAe+C55Cfn8Jv4s05vV05unLmj+PagB5yTrft8Nco3vrLjbQLxO+xHhCA3du96Bwwiwk/HBwIme2IlInIkomolokjHomokYmzzuwfHRyeyx34lx2nRn3KR/B/EkyvyrxdxADiXAkSXXDNUry8zOS12rUayPT1wPxESj0BwQOB1BxALwjAKImhygPh1gPgJmDtwJwGB/EjHwKdxc1X1qjaVDDqSf3bzf0Cw/1vwx25V4gwKzXwhqivw6Wrzk3uzzwoPp03zI29xZl2GgHjXyVaHxCKRWksENgECmS0F4AAHIiB2AYAtBXCGgGg6ACl3AngXgOoPheAABeOw1YSwRgZ6BZCgeEZeVwuWNebw+IwkAVbeIVXeWwxIuWVwpwM+AGJItyfI8GB+aGQ2NIkkZGFtJjP4fTYAXga9ZAVwqzATEdemdDVwlmSo+EM4eEeTAWGEOo34BojFGWJI06MLMAUoizVo/jArEzITCAVw3owkfowkSnA0SWFXXrX7XnVwiRfnU3YXC3abcXG3EsfIl+Kov4WvAxUPZOPBX4A4yxfvI7BPE7ZPc7cfdPa7C8a4qsFQp7U/VZG41UEghJSCH7Z4pgv/Q0Q4lCVgoAsHTgyHCAmHOHGAxHOAhiQE4kYE/PdAnHW4rUW4jYk4bgboGkeYJAUAYwC0CQLoa4ThEAE4E4IAA="}
import { defineChain } from 'viem'

export const mainnet = defineChain({
  id: 1,
  name: 'Ethereum',
  nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
  rpcUrls: {
    default: { http: ['https://eth.merkle.io'] },
  },
  blockExplorers: {
    default: { name: 'Etherscan', url: 'https://etherscan.io' },
  },
  contracts: {
    ensRegistry: {
      address: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
    },
    ensUniversalResolver: {
      address: '0xE4Acdd618deED4e6d2f03b9bf62dc6118FC9A4da',
      blockCreated: 16773775,
    },
    multicall3: {
      address: '0xca11bde05977b3631167028862be2a173976ca11',
      blockCreated: 14353601,
    },
  },
})
```

:::

The more properties you add, the better the chain will be to use with Wagmi. Most of these attributes exist within the [`ethereum-lists/chains` repository](https://github.com/ethereum-lists/chains/tree/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains).

* `id`: The chain ID for the network. This can be found by typing the network name into [ChainList](https://chainlist.org). Example: "Ethereum Mainnet" has a Chain ID of `1`.
* `name`: Human-readable name for the chain. Example: "Ethereum Mainnet"
* `nativeCurrency`: The native currency of the chain. Found from [`ethereum-lists/chains`](https://github.com/ethereum-lists/chains/blob/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains/eip155-56.json#L20-L24).
* `rpcUrls`: At least one public, credible RPC URL. Found from [`ethereum-lists/chains`](https://github.com/ethereum-lists/chains/blob/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains/eip155-56.json#L4-L18).
* `blockExplorers`: A set of block explorers for the chain. Found from [`ethereum-lists/chains`](https://github.com/ethereum-lists/chains/blob/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains/eip155-56.json#L30-L36).
* `contracts`: A set of deployed contracts for the chain. If you are deploying one of the following contracts yourself, make sure it is verified.
  * `multicall3` is optional, but it's address is most likely `0xca11bde05977b3631167028862be2a173976ca11` – you can find the deployed block number on the block explorer. Check out [`mds1/multicall`](https://github.com/mds1/multicall#multicall3-contract-addresses) for more info.
  * `ensRegistry` is optional – not all Chains have a ENS Registry. See [ENS Deployments](https://docs.ens.domains/ens-deployments) for more info.
  * `ensUniversalResolver` is optional – not all Chains have a ENS Universal Resolver.
* `sourceId`: Source Chain ID (e.g. the L1 chain).
* `testnet`: Whether or not the chain is a testnet.

---

---
url: /core/api/connectors/coinbaseWallet.md
---
# coinbaseWallet

Connector for the [Coinbase Wallet SDK](https://github.com/coinbase/coinbase-wallet-sdk).

## Import

```ts-vue
import { coinbaseWallet } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add @coinbase/wallet-sdk@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install @coinbase/wallet-sdk@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add @coinbase/wallet-sdk@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add @coinbase/wallet-sdk@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { coinbaseWallet } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [coinbaseWallet()], // [!code hl]
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

:::warning
Before going to production, it is highly recommended to set an [`appName`](#appname) and [`appLogoUrl`](#applogourl) for your application that can be displayed upon connection to the wallet.
:::

## Parameters

```ts-vue
import { type CoinbaseWalletParameters } from '{{connectorsPackageName}}'
```

Check out the [Coinbase Wallet SDK docs](https://github.com/coinbase/coinbase-wallet-sdk) for more info.

### appName

`string`

Application name.

```ts-vue
import { coinbaseWallet } from '{{connectorsPackageName}}'

const connector = coinbaseWallet({
  appName: 'My Wagmi App', // [!code focus]
})
```

### appLogoUrl

`string | null | undefined`

Application logo image URL; favicon is used if unspecified.

```ts-vue
import { coinbaseWallet } from '{{connectorsPackageName}}'

const connector = coinbaseWallet({
  appName: 'My Wagmi App',
  appLogoUrl: 'https://example.com/myLogoUrl.png', // [!code focus]
})
```

### preference&#x20;

Preference for the type of wallet to display.

```ts-vue
import { coinbaseWallet } from '{{connectorsPackageName}}'

const connector = coinbaseWallet({
  appName: 'My Wagmi App',
  preference: { // [!code focus]
    options: 'smartWalletOnly' // [!code focus]
  }, // [!code focus]
})
```

#### attribution&#x20;

``{ auto?: boolean | undefined; dataSuffix?: `0x${string}` | undefined }``

This option only applies to Coinbase Smart Wallet. When a valid data suffix is supplied, it is appended to the `initCode` and `executeBatch` calldata. Coinbase Smart Wallet expects a 16 byte hex string. If the data suffix is not a 16 byte hex string, the Smart Wallet will ignore the property. If auto is true, the Smart Wallet will generate a 16 byte hex string from the apps origin.

#### keysUrl&#x20;

`string`

* The URL for the keys popup.
* By default, `https://keys.coinbase.com/connect` is used for production. Use `https://keys-dev.coinbase.com/connect` for development environments.

#### options&#x20;

`"all" | "eoaOnly" | "smartWalletOnly"`

Preference for the type of wallet to display.

* `'eoaOnly'`: Uses EOA Browser Extension or Mobile Coinbase Wallet.
* `'smartWalletOnly'`: Displays Smart Wallet popup.
* `'all'` (default): Supports both `'eoaOnly'` and `'smartWalletOnly'` based on context.

---

---
url: /react/api/connectors/coinbaseWallet.md
---
# coinbaseWallet

Connector for the [Coinbase Wallet SDK](https://github.com/coinbase/coinbase-wallet-sdk).

## Import

```ts-vue
import { coinbaseWallet } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add @coinbase/wallet-sdk@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install @coinbase/wallet-sdk@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add @coinbase/wallet-sdk@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add @coinbase/wallet-sdk@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { coinbaseWallet } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [coinbaseWallet()], // [!code hl]
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

:::warning
Before going to production, it is highly recommended to set an [`appName`](#appname) and [`appLogoUrl`](#applogourl) for your application that can be displayed upon connection to the wallet.
:::

## Parameters

```ts-vue
import { type CoinbaseWalletParameters } from '{{connectorsPackageName}}'
```

Check out the [Coinbase Wallet SDK docs](https://github.com/coinbase/coinbase-wallet-sdk) for more info.

### appName

`string`

Application name.

```ts-vue
import { coinbaseWallet } from '{{connectorsPackageName}}'

const connector = coinbaseWallet({
  appName: 'My Wagmi App', // [!code focus]
})
```

### appLogoUrl

`string | null | undefined`

Application logo image URL; favicon is used if unspecified.

```ts-vue
import { coinbaseWallet } from '{{connectorsPackageName}}'

const connector = coinbaseWallet({
  appName: 'My Wagmi App',
  appLogoUrl: 'https://example.com/myLogoUrl.png', // [!code focus]
})
```

### preference&#x20;

Preference for the type of wallet to display.

```ts-vue
import { coinbaseWallet } from '{{connectorsPackageName}}'

const connector = coinbaseWallet({
  appName: 'My Wagmi App',
  preference: { // [!code focus]
    options: 'smartWalletOnly' // [!code focus]
  }, // [!code focus]
})
```

#### attribution&#x20;

``{ auto?: boolean | undefined; dataSuffix?: `0x${string}` | undefined }``

This option only applies to Coinbase Smart Wallet. When a valid data suffix is supplied, it is appended to the `initCode` and `executeBatch` calldata. Coinbase Smart Wallet expects a 16 byte hex string. If the data suffix is not a 16 byte hex string, the Smart Wallet will ignore the property. If auto is true, the Smart Wallet will generate a 16 byte hex string from the apps origin.

#### keysUrl&#x20;

`string`

* The URL for the keys popup.
* By default, `https://keys.coinbase.com/connect` is used for production. Use `https://keys-dev.coinbase.com/connect` for development environments.

#### options&#x20;

`"all" | "eoaOnly" | "smartWalletOnly"`

Preference for the type of wallet to display.

* `'eoaOnly'`: Uses EOA Browser Extension or Mobile Coinbase Wallet.
* `'smartWalletOnly'`: Displays Smart Wallet popup.
* `'all'` (default): Supports both `'eoaOnly'` and `'smartWalletOnly'` based on context.

---

---
url: /shared/connectors/coinbaseWallet.md
---
# coinbaseWallet

Connector for the [Coinbase Wallet SDK](https://github.com/coinbase/coinbase-wallet-sdk).

## Import

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/coinbaseWallet.md","from":285,"to":344}<fsm-vh3gqscxm4e>
import { coinbaseWallet } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/coinbaseWallet.md","from":597,"to":658}<fsm-vh3gqscxm4e>
pnpm add @coinbase/wallet-sdk@{{connectorDependencyVersion}}
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/coinbaseWallet.md","from":681,"to":745}<fsm-vh3gqscxm4e>
npm install @coinbase/wallet-sdk@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/coinbaseWallet.md","from":769,"to":830}<fsm-vh3gqscxm4e>
yarn add @coinbase/wallet-sdk@{{connectorDependencyVersion}}
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/coinbaseWallet.md","from":853,"to":913}<fsm-vh3gqscxm4e>
bun add @coinbase/wallet-sdk@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/coinbaseWallet.md","from":942,"to":1318}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { coinbaseWallet } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [coinbaseWallet()], // [!code hl]
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

:::warning
Before going to production, it is highly recommended to set an [`appName`](#appname) and [`appLogoUrl`](#applogourl) for your application that can be displayed upon connection to the wallet.
:::

## Parameters

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/coinbaseWallet.md","from":1555,"to":1629}<fsm-vh3gqscxm4e>
import { type CoinbaseWalletParameters } from '{{connectorsPackageName}}'
```

Check out the [Coinbase Wallet SDK docs](https://github.com/coinbase/coinbase-wallet-sdk) for more info.

### appName

`string`

Application name.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/coinbaseWallet.md","from":1792,"to":1934}<fsm-vh3gqscxm4e>
import { coinbaseWallet } from '{{connectorsPackageName}}'

const connector = coinbaseWallet({
  appName: 'My Wagmi App', // [!code focus]
})
```

### appLogoUrl

`string | null | undefined`

Application logo image URL; favicon is used if unspecified.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/coinbaseWallet.md","from":2055,"to":2248}<fsm-vh3gqscxm4e>
import { coinbaseWallet } from '{{connectorsPackageName}}'

const connector = coinbaseWallet({
  appName: 'My Wagmi App',
  appLogoUrl: 'https://example.com/myLogoUrl.png', // [!code focus]
})
```

### preference&#x20;

Preference for the type of wallet to display.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/coinbaseWallet.md","from":2351,"to":2579}<fsm-vh3gqscxm4e>
import { coinbaseWallet } from '{{connectorsPackageName}}'

const connector = coinbaseWallet({
  appName: 'My Wagmi App',
  preference: { // [!code focus]
    options: 'smartWalletOnly' // [!code focus]
  }, // [!code focus]
})
```

#### attribution&#x20;

``{ auto?: boolean | undefined; dataSuffix?: `0x${string}` | undefined }``

This option only applies to Coinbase Smart Wallet. When a valid data suffix is supplied, it is appended to the `initCode` and `executeBatch` calldata. Coinbase Smart Wallet expects a 16 byte hex string. If the data suffix is not a 16 byte hex string, the Smart Wallet will ignore the property. If auto is true, the Smart Wallet will generate a 16 byte hex string from the apps origin.

#### keysUrl&#x20;

`string`

* The URL for the keys popup.
* By default, `https://keys.coinbase.com/connect` is used for production. Use `https://keys-dev.coinbase.com/connect` for development environments.

#### options&#x20;

`"all" | "eoaOnly" | "smartWalletOnly"`

Preference for the type of wallet to display.

* `'eoaOnly'`: Uses EOA Browser Extension or Mobile Coinbase Wallet.
* `'smartWalletOnly'`: Displays Smart Wallet popup.
* `'all'` (default): Supports both `'eoaOnly'` and `'smartWalletOnly'` based on context.

---

---
url: /vue/api/connectors/coinbaseWallet.md
---
# coinbaseWallet

Connector for the [Coinbase Wallet SDK](https://github.com/coinbase/coinbase-wallet-sdk).

## Import

```ts-vue
import { coinbaseWallet } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add @coinbase/wallet-sdk@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install @coinbase/wallet-sdk@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add @coinbase/wallet-sdk@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add @coinbase/wallet-sdk@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { coinbaseWallet } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [coinbaseWallet()], // [!code hl]
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

:::warning
Before going to production, it is highly recommended to set an [`appName`](#appname) and [`appLogoUrl`](#applogourl) for your application that can be displayed upon connection to the wallet.
:::

## Parameters

```ts-vue
import { type CoinbaseWalletParameters } from '{{connectorsPackageName}}'
```

Check out the [Coinbase Wallet SDK docs](https://github.com/coinbase/coinbase-wallet-sdk) for more info.

### appName

`string`

Application name.

```ts-vue
import { coinbaseWallet } from '{{connectorsPackageName}}'

const connector = coinbaseWallet({
  appName: 'My Wagmi App', // [!code focus]
})
```

### appLogoUrl

`string | null | undefined`

Application logo image URL; favicon is used if unspecified.

```ts-vue
import { coinbaseWallet } from '{{connectorsPackageName}}'

const connector = coinbaseWallet({
  appName: 'My Wagmi App',
  appLogoUrl: 'https://example.com/myLogoUrl.png', // [!code focus]
})
```

### preference&#x20;

Preference for the type of wallet to display.

```ts-vue
import { coinbaseWallet } from '{{connectorsPackageName}}'

const connector = coinbaseWallet({
  appName: 'My Wagmi App',
  preference: { // [!code focus]
    options: 'smartWalletOnly' // [!code focus]
  }, // [!code focus]
})
```

#### attribution&#x20;

``{ auto?: boolean | undefined; dataSuffix?: `0x${string}` | undefined }``

This option only applies to Coinbase Smart Wallet. When a valid data suffix is supplied, it is appended to the `initCode` and `executeBatch` calldata. Coinbase Smart Wallet expects a 16 byte hex string. If the data suffix is not a 16 byte hex string, the Smart Wallet will ignore the property. If auto is true, the Smart Wallet will generate a 16 byte hex string from the apps origin.

#### keysUrl&#x20;

`string`

* The URL for the keys popup.
* By default, `https://keys.coinbase.com/connect` is used for production. Use `https://keys-dev.coinbase.com/connect` for development environments.

#### options&#x20;

`"all" | "eoaOnly" | "smartWalletOnly"`

Preference for the type of wallet to display.

* `'eoaOnly'`: Uses EOA Browser Extension or Mobile Coinbase Wallet.
* `'smartWalletOnly'`: Displays Smart Wallet popup.
* `'all'` (default): Supports both `'eoaOnly'` and `'smartWalletOnly'` based on context.

---

---
url: /cli/api/commands.md
---
# Commands

## Available Commands

* [`init`](/cli/api/commands/init) Creates configuration file.
* [`generate`](/cli/api/commands/generate) Generates code based on configuration, using `contracts` and `plugins`.

## Display Info

### `-h`, `--help`

Show help message when `-h`, `--help` flags appear.

::: code-group

```bash [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/commands.md","from":334,"to":352}<fsm-vh3gqscxm4e>
pnpm wagmi --help
```

```bash [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/commands.md","from":371,"to":388}<fsm-vh3gqscxm4e>
npx wagmi --help
```

```bash [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/commands.md","from":408,"to":426}<fsm-vh3gqscxm4e>
yarn wagmi --help
```

```bash [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/commands.md","from":445,"to":462}<fsm-vh3gqscxm4e>
bun wagmi --help
```

:::

### `-v`, `--version`

Show version number when `-v`, `--version` flags appear.

::: code-group

```bash [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/commands.md","from":582,"to":603}<fsm-vh3gqscxm4e>
pnpm wagmi --version
```

```bash [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/commands.md","from":622,"to":642}<fsm-vh3gqscxm4e>
npx wagmi --version
```

```bash [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/commands.md","from":662,"to":683}<fsm-vh3gqscxm4e>
yarn wagmi --version
```

```bash [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/commands.md","from":702,"to":722}<fsm-vh3gqscxm4e>
bun wagmi --version
```

:::

---

---
url: /react/comparisons.md
---
# Comparison

There are multiple options when it comes to React libraries for Ethereum that help manage wallet connections, provide utility methods/hooks, etc.

::: tip
Comparisons strive to be as accurate and as unbiased as possible. If you use any of these libraries and feel the information could be improved, feel free to suggest changes.
:::

## Overview

|                      | [wagmi](https://github.com/wagmi-dev/wagmi)                                                     | [web3-react](https://github.com/NoahZinsmeister/web3-react)                                             | [useDApp](https://github.com/EthWorks/useDApp)                                                     |
| -------------------- | :---------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------- |
| GitHub Stars         | ![wagmi star count](https://img.shields.io/github/stars/wagmi-dev/wagmi?colorB=27292E\&label=)   | ![web3-react star count](https://img.shields.io/github/stars/Uniswap/web3-react?colorB=27292E\&label=)   | ![useDApp star count](https://img.shields.io/github/stars/EthWorks/useDApp?colorB=27292E\&label=)   |
| Open Issues          | ![wagmi issue count](https://img.shields.io/github/issues/wagmi-dev/wagmi?colorB=27292E\&label=) | ![web3-react issue count](https://img.shields.io/github/issues/Uniswap/web3-react?colorB=27292E\&label=) | ![useDApp issue count](https://img.shields.io/github/issues/EthWorks/useDApp?colorB=27292E\&label=) |
| Downloads            | ![wagmi downloads](https://img.shields.io/npm/dw/wagmi?colorB=27292E\&label=)                    | ![web3-react downloads](https://img.shields.io/npm/dw/@web3-react/core?colorB=27292E\&label=)            | ![useDApp downloads](https://img.shields.io/npm/dw/@usedapp/core?colorB=27292E\&label=)             |
| License              | ![wagmi license](https://img.shields.io/github/license/wagmi-dev/wagmi?colorB=27292E\&label=)    | ![web3-react license](https://img.shields.io/github/license/Uniswap/web3-react?colorB=27292E\&label=)    | ![useDApp license](https://img.shields.io/github/license/EthWorks/useDApp?colorB=27292E\&label=)    |
| Their Comparison     | –                                                                                               | none                                                                                                    | none                                                                                               |
| Supported Frameworks | React, Vanilla JS                                                                               | React                                                                                                   | React                                                                                              |
| Documentation        | ✅                                                                                              | 🛑                                                                                                      | ✅                                                                                                 |
| TypeScript           | ✅                                                                                              | 🔶                                                                                                      | 🔶                                                                                                 |
| EIP-6963 Support     | ✅                                                                                              | 🔴                                                                                                      | 🔴                                                                                                 |
| Test Suite           | ✅                                                                                              | 🔶                                                                                                      | 🔶                                                                                                 |
| Examples             | ✅                                                                                              | 🔶                                                                                                      | ✅                                                                                                 |

::: details Comparison Key

1. Documentation

* Comprehensive documentation for all library features ✅
* No documentation 🔴

2. Typescript

* Infer types from ABIs, EIP-712 Typed Data, etc. ✅
* Can add types with explicit generics, type annotations, etc. 🔶

3. Test Suite

* Runs against forked Ethereum network(s) ✅
* Mocking functionality (i.e. RPC calls) is 🔶

4. EIP-6963 Support

* Fully compatible with EIP-6963 ✅
* Not compatible with EIP-6963 🔴

5. Examples

* Has multiple examples ✅
* Has single example 🔶
  :::

## [Wagmi](https://github.com/wagmi-dev/wagmi)

### Pros

* 20+ hooks for working with wallets, ENS, contracts, transactions, signing, etc.
* Built-in wallet connectors for injected providers (EIP-6963 support), WalletConnect, MetaMask, Coinbase Wallet
* Caching, request deduplication, and persistence powered by TanStack Query
* Auto-refresh data on wallet, block, and network changes
* Multicall support
* Test suite running against forked Ethereum networks
* TypeScript ready (infer types from ABIs and EIP-712 Typed Data)
* Extensive documentation and examples
* Used by Coinbase, Stripe, Shopify, Uniswap, Optimism, ENS, Sushi, and [many more](https://github.com/wagmi-dev/wagmi/discussions/201)
* MIT License

### Cons

* Not as many built-in connectors as `web3-react`

## [web3-react](https://github.com/Uniswap/web3-react)

### Pros

* Supports many different connectors (conceptually similar to Wagmi's connectors)
* Basic hooks for managing account

### Cons

* Need to set up connectors and method for connecting wallet on your own
* Need to install connectors separately
* Almost no tests or documentation; infrequent updates
* GPL-3.0 License

## [useDApp](https://github.com/EthWorks/useDApp)

### Pros

* Auto-refresh on new blocks and wallet changes
* Multicall support
* Transaction notifications
* Chrome extension and Firefox add-on
* MIT License

### Cons

* Non-standard hook API

---

---
url: /vue/api/composables.md
---
# Composables

Vue Composables for accounts, wallets, contracts, transactions, signing, ENS, and more.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables.md","from":336,"to":379}<fsm-vh3gqscxm4e>
import { useConnection } from '@wagmi/vue'
```

## Available Composables

---

---
url: /cli/config/options.md
---
# Config Options

Configuration options for Wagmi CLI.

## contracts

`ContractConfig[] | undefined`

Array of contracts to use when running [commands](/cli/api/commands). `abi` and `name` are required, all other properties are optional.

### address

`Address | Record<chainId, Address> | undefined`

Contract address or addresses. Accepts an object `{ [chainId]: address }` for targeting specific chains.

::: code-group

```ts {6,11-14} [wagmi.config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/config/options.md","from":457,"to":739}<fsm-vh3gqscxm4e>
export default {
  out: 'src/generated.ts',
  contracts: [
    {
      abi: […],
      address: '0x…',
      name: 'MyCoolContract',
    },
    {
      abi: […],
      address: {
        1: '0xfoo…',
        5: '0xbar…',
      },
      name: 'MyCoolMultichainContract'
    }
  ],
}
```

:::

### abi

`Abi`

ABI for contract. Used by [plugins](/cli/api/plugins) to generate code base on properties.

::: code-group

```ts {5} [wagmi.config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/config/options.md","from":899,"to":1023}<fsm-vh3gqscxm4e>
export default {
  out: 'src/generated.ts',
  contracts: [
    {
      abi: […],
      name: 'MyCoolContract'
    },
  ],
}
```

:::

### name

`string`

Name of contract. Must be unique. Used by [plugins](/cli/api/plugins) to name generated code.

::: code-group

```ts {6} [wagmi.config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/config/options.md","from":1190,"to":1314}<fsm-vh3gqscxm4e>
export default {
  out: 'src/generated.ts',
  contracts: [
    {
      abi: […],
      name: 'MyCoolContract'
    },
  ],
}
```

:::

## out

`string`

Path to output generated code. Must be unique per config. Use an [Array Config](/cli/config/configuring-cli#array-config) for multiple outputs.

::: code-group

```ts {2} [wagmi.config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/config/options.md","from":1529,"to":1653}<fsm-vh3gqscxm4e>
export default {
  out: 'src/generated.ts',
  contracts: [
    {
      abi: […],
      name: 'MyCoolContract'
    },
  ],
}
```

:::

## plugins

`Plugin[] | undefined`

Plugins to use and their configuration.

Wagmi CLI has multiple [built-in plugins](/cli/api/plugins) that are used to manage ABIs, generate code, etc.

::: code-group

```ts {1,5-20} [wagmi.config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/config/options.md","from":1898,"to":2353}<fsm-vh3gqscxm4e>
import { etherscan, react } from '@wagmi/cli/plugins'

export default {
  out: 'src/generated.js',
  plugins: [
    etherscan({
      apiKey: process.env.ETHERSCAN_API_KEY,
      chainId: 5,
      contracts: [
        {
          name: 'EnsRegistry',
          address: {
            1: '0x314159265dd8dbb310642f98f50c066173c1259b',
            5: '0x112234455c3a32fd11230c42e7bccd4a84e02010',
          },
        },
      ],
    }),
    react(),
  ],
}
```

:::

---

---
url: /cli/config/configuring-cli.md
---
# Configuring CLI

When running `wagmi` from the command line, `@wagmi/cli` will automatically try to resolve a config file named `wagmi.config.js` or `wagmi.config.ts` inside the project root. The most basic config file looks like this:

::: code-group

```js [wagmi.config.js]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/config/configuring-cli.md","from":278,"to":317}<fsm-vh3gqscxm4e>
export default {
  // config options
}
```

:::

Note `@wagmi/cli` supports using ES modules syntax in the config file even if the project is not using native Node ESM, e.g. `"type": "module"` in package.json. In this case, the config file is auto pre-processed before load.

You can also explicitly specify a config file to use with the `--config`/`-c` CLI option (resolved relative to the current directory):

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/config/configuring-cli.md","from":697,"to":725}<fsm-vh3gqscxm4e>
wagmi --config my-config.js
```

To scaffold a config file quickly, check out the [`init`](/cli/api/commands/init) command.

## Config Intellisense

Since Wagmi CLI ships with TypeScript typings, you can use your editor's intellisense with [JSDoc](https://jsdoc.app) type hints:

::: code-group

```js [wagmi.config.js]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/config/configuring-cli.md","from":1016,"to":1087}<fsm-vh3gqscxm4e>
/** @type {import('@wagmi/cli').Config} */
export default {
  // ...
}
```

:::

Alternatively, you can use the `defineConfig` utility which should provide intellisense without the need for JSDoc annotations:

::: code-group

```js [wagmi.config.js]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/config/configuring-cli.md","from":1264,"to":1349}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'

export default defineConfig({
  // ...
})
```

:::

Wagmi CLI also directly supports TypeScript config files. You can use `wagmi.config.ts` with the `defineConfig` helper as well.

## Conditional Config

If the config needs to conditionally determine options based on the environment, it can export a function instead:

::: code-group

```js [wagmi.config.js]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/config/configuring-cli.md","from":1665,"to":1862}<fsm-vh3gqscxm4e>
export default defineConfig(() => {
  if (process.env.NODE_ENV === 'dev') {
    return {
      // dev specific config
    }
  } else {
    return {
      // production specific config
    }
  }
})
```

:::

## Async Config

If the config needs to call async function, it can export a async function instead:

::: code-group

```js [wagmi.config.js]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/config/configuring-cli.md","from":2012,"to":2120}<fsm-vh3gqscxm4e>
export default defineConfig(async () => {
  const data = await asyncFunction()
  return {
    // ...
  }
})
```

:::

This can be useful for resolving external resources from the network or filesystem that are required for configuration ahead of running a command.

## Array Config

The config can also be represented either as a pre-defined array or returned as an array from a function:

::: code-group

```js [wagmi.config.js]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/config/configuring-cli.md","from":2440,"to":2519}<fsm-vh3gqscxm4e>
export default defineConfig([
  {
  // config 1
  },
  {
  // config 2
  },
])
```

:::

## Environment Variables

Environmental Variables can be obtained from `process.env` as usual.

Note that Wagmi CLI doesn't load `.env` files by default as the files to load can only be determined after evaluating the config. However, you can use the exported `loadEnv` utility to load the specific `.env` files if needed.

::: code-group

```js [wagmi.config.js]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/config/configuring-cli.md","from":2891,"to":3096}<fsm-vh3gqscxm4e>
import { defineConfig, loadEnv } from '@wagmi/cli'

export default defineConfig(() => {
  const env = loadEnv({
    mode: process.env.NODE_ENV,
    envDir: process.cwd(),
  })
  return {
    // ...
  }
})
```

:::

---

---
url: /core/api/actions/connect.md
---
# connect

Action for connecting accounts with [connectors](/core/api/connectors).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/connect.md","from":217,"to":255}<fsm-vh3gqscxm4e>
import { connect } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/connect.md","from":302,"to":484}<fsm-vh3gqscxm4e>
import { connect } from '@wagmi/core'
import { injected } from '@wagmi/connectors'
import { config } from './config'

const result = await connect(config, { connector: injected() })
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/connect.md","from":555,"to":608}<fsm-vh3gqscxm4e>
import { type ConnectParameters } from '@wagmi/core'
```

### chainId

`number | undefined`

Chain ID to connect to.

Not all connectors support connecting directly to a `chainId` (e.g. they don't support programmatic chain switching). In those cases, the connector will connect to whatever chain the connector's provider is connected to.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/connect.md","from":927,"to":1197}<fsm-vh3gqscxm4e>
import { connect } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { injected } from '@wagmi/connectors'
import { config } from './config'

const result = await connect(config, {
  chainId: mainnet.id, // [!code focus]
  connector: injected(),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`CreateConnectorFn | Connector`

[Connector](/core/api/connectors) to connect with.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/connect.md","from":1379,"to":1598}<fsm-vh3gqscxm4e>
import { connect } from '@wagmi/core'
import { injected } from '@wagmi/connectors' // [!code focus]
import { config } from './config'

const result = await connect(config, {
  connector: injected(), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### withCapabilities

`boolean | undefined`

* Exposes [capabilities](https://eips.ethereum.org/EIPS/eip-7846#capabilities) on return type.
* Defaults to `false`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/connect.md","from":1844,"to":2117}<fsm-vh3gqscxm4e>
import { connect } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { injected } from '@wagmi/connectors'
import { config } from './config'

const result = await connect(config, {
  connector: injected(),
  withCapabilities: true, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/connect.md","from":2189,"to":2242}<fsm-vh3gqscxm4e>
import { type ConnectReturnType } from '@wagmi/core'
```

::: tip
When [`withCapabilities: false | undefined`](#withcapabilities):

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/connect.md","from":2326,"to":2395}<fsm-vh3gqscxm4e>
type ConnectReturnType = {
  accounts: readonly Address[]
  // ...
}
```

When [`withCapabilities: true`](#withcapabilities):

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/connect.md","from":2457,"to":2578}<fsm-vh3gqscxm4e>
type ConnectReturnType = {
  accounts: readonly { address: Address; capabilities: Record<string, unknown> }[]
  // ...
}
```

:::

### accounts

`readonly [Address, ...Address[]]`

Connected accounts from connector.

### chainId

`number`

Connected chain ID from connector.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/connect.md","from":2748,"to":2800}<fsm-vh3gqscxm4e>
import { type ConnectErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

---

---
url: /react/guides/connect-wallet.md
---
# Connect Wallet

The ability for a user to connect their wallet is a core function for any Dapp. It allows users to perform tasks such as: writing to contracts, signing messages, or sending transactions.

Wagmi contains everything you need to get started with building a Connect Wallet module. To get started, you can either use a [third-party library](#third-party-libraries) or [build your own](#build-your-own).

## Third-party Libraries

You can use a pre-built Connect Wallet module from a third-party library such as:

* [ConnectKit](https://docs.family.co/connectkit) - [Guide](https://docs.family.co/connectkit/getting-started)
* [Dynamic](https://www.dynamic.xyz/) - [Guide](https://docs.dynamic.xyz/quickstart)
* [Privy](https://privy.io) - [Guide](https://docs.privy.io/guide/react/wallets/usage/wagmi)

The above libraries are all built on top of Wagmi, handle all the edge cases around wallet connection, and provide a seamless Connect Wallet UX that you can use in your Dapp.

## Build Your Own

Wagmi provides you with the Hooks to get started building your own Connect Wallet module.

It takes less than five minutes to get up and running with Browser Wallets, WalletConnect, and Coinbase Wallet.

### 1. Configure Wagmi

Before we get started with building the functionality of the Connect Wallet module, we will need to set up the Wagmi configuration.

Let's create a `config.ts` file and export a `config` object.

::: code-group

```tsx [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/connect-wallet.md","from":1471,"to":1929}<fsm-vh3gqscxm4e>
import { http, createConfig } from 'wagmi'
import { base, mainnet, optimism } from 'wagmi/chains'
import { injected, metaMask, safe, walletConnect } from 'wagmi/connectors'

const projectId = '<WALLETCONNECT_PROJECT_ID>'

export const config = createConfig({
  chains: [mainnet, base],
  connectors: [
    injected(),
    walletConnect({ projectId }),
    metaMask(),
    safe(),
  ],
  transports: {
    [mainnet.id]: http(),
    [base.id]: http(),
  },
})
```

:::

In the above configuration, we want to set up connectors for Injected (browser), WalletConnect (browser + mobile), MetaMask, and Safe wallets. This configuration uses the **Mainnet** and **Base** chains, but you can use whatever you want.

::: warning

Make sure to replace the `projectId` with your own WalletConnect Project ID, if you wish to use WalletConnect!

[Get your Project ID](https://cloud.reown.com/)

:::

### 2. Wrap App in Context Provider

Next, we will need to wrap our React App with Context so that our application is aware of Wagmi & React Query's reactive state and in-memory caching.

::: code-group

```tsx [app.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/connect-wallet.md","from":2580,"to":3068}<fsm-vh3gqscxm4e>
 // 1. Import modules
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { WagmiProvider } from 'wagmi'
import { config } from './config'

// 2. Set up a React Query client.
const queryClient = new QueryClient()

function App() {
  // 3. Wrap app with Wagmi and React Query context.
  return (
    <WagmiProvider config={config}>
      <QueryClientProvider client={queryClient}> 
        {/** ... */} 
      </QueryClientProvider> 
    </WagmiProvider>
  )
}
```

```tsx [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/connect-wallet.md","from":3092,"to":3550}<fsm-vh3gqscxm4e>
import { http, createConfig } from 'wagmi'
import { base, mainnet, optimism } from 'wagmi/chains'
import { injected, metaMask, safe, walletConnect } from 'wagmi/connectors'

const projectId = '<WALLETCONNECT_PROJECT_ID>'

export const config = createConfig({
  chains: [mainnet, base],
  connectors: [
    injected(),
    walletConnect({ projectId }),
    metaMask(),
    safe(),
  ],
  transports: {
    [mainnet.id]: http(),
    [base.id]: http(),
  },
})
```

:::

### 3. Display Wallet Options

After that, we will create a `WalletOptions` component that will display our connectors. This will allow users to select a wallet and connect.

Below, we are rendering a list of `connectors` retrieved from `useConnect`. When the user clicks on a connector, the `connect` function will connect the users' wallet.

::: code-group

```tsx [wallet-options.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/connect-wallet.md","from":3948,"to":4305}<fsm-vh3gqscxm4e>
import * as React from 'react'
import { Connector, useConnect, useConnectors } from 'wagmi'

export function WalletOptions() {
  const { connect } = useConnect()
  const connectors = useConnectors()

  return connectors.map((connector) => (
    <button key={connector.uid} onClick={() => connect({ connector })}>
      {connector.name}
    </button>
  ))
}
```

```tsx [app.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/connect-wallet.md","from":4327,"to":4813}<fsm-vh3gqscxm4e>
 // 1. Import modules
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { WagmiProvider } from 'wagmi'
import { config } from './config'

// 2. Set up a React Query client.
const queryClient = new QueryClient()

function App() {
  // 3. Wrap app with Wagmi and React Query context.
  return (
    <WagmiProvider config={config}>
      <QueryClientProvider client={queryClient}> 
        {/* ... */}
      </QueryClientProvider> 
    </WagmiProvider>
  )
}
```

```tsx [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/connect-wallet.md","from":4837,"to":5295}<fsm-vh3gqscxm4e>
import { http, createConfig } from 'wagmi'
import { base, mainnet, optimism } from 'wagmi/chains'
import { injected, metaMask, safe, walletConnect } from 'wagmi/connectors'

const projectId = '<WALLETCONNECT_PROJECT_ID>'

export const config = createConfig({
  chains: [mainnet, base],
  connectors: [
    injected(),
    walletConnect({ projectId }),
    metaMask(),
    safe(),
  ],
  transports: {
    [mainnet.id]: http(),
    [base.id]: http(),
  },
})
```

:::

### 4. Display Connection

Lastly, if an connection is made, we want to show some basic information, like the connected address and ENS name and avatar.

Below, we are using hooks like `useConnection`, `useEnsAvatar` and `useEnsName` to extract this information.

We are also utilizing `useDisconnect` to show a "Disconnect" button so a user can disconnect their wallet.

::: code-group

```tsx [connection.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/connect-wallet.md","from":5717,"to":6264}<fsm-vh3gqscxm4e>
import { useConnection, useDisconnect, useEnsAvatar, useEnsName } from 'wagmi'

export function Connection() {
  const { address } = useConnection()
  const { disconnect } = useDisconnect()
  const { data: ensName } = useEnsName({ address })
  const { data: ensAvatar } = useEnsAvatar({ name: ensName! })

  return (
    <div>
      {ensAvatar && <img alt="ENS Avatar" src={ensAvatar} />}
      {address && <div>{ensName ? `${ensName} (${address})` : address}</div>}
      <button onClick={() => disconnect()}>Disconnect</button>
    </div>
  )
}
```

```tsx [wallet-options.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/connect-wallet.md","from":6297,"to":7081}<fsm-vh3gqscxm4e>
import * as React from 'react'
import { Connector, useConnect, useConnectors } from 'wagmi'

export function WalletOptions() {
  const { connect } = useConnect()
  const connectors = useConnectors()

  return connectors.map((connector) => (
    <WalletOption
      key={connector.uid}
      connector={connector}
      onClick={() => connect({ connector })}
    />
  ))
}

function WalletOption({
  connector,
  onClick,
}: {
  connector: Connector
  onClick: () => void
}) {
  const [ready, setReady] = React.useState(false)

  React.useEffect(() => {
    ;(async () => {
      const provider = await connector.getProvider()
      setReady(!!provider)
    })()
  }, [connector])

  return (
    <button disabled={!ready} onClick={onClick}>
      {connector.name}
    </button>
  )
}
```

```tsx [app.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/connect-wallet.md","from":7103,"to":7589}<fsm-vh3gqscxm4e>
 // 1. Import modules
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { WagmiProvider } from 'wagmi'
import { config } from './config'

// 2. Set up a React Query client.
const queryClient = new QueryClient()

function App() {
  // 3. Wrap app with Wagmi and React Query context.
  return (
    <WagmiProvider config={config}>
      <QueryClientProvider client={queryClient}> 
        {/* ... */}
      </QueryClientProvider> 
    </WagmiProvider>
  )
}
```

```tsx [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/connect-wallet.md","from":7613,"to":8071}<fsm-vh3gqscxm4e>
import { http, createConfig } from 'wagmi'
import { base, mainnet, optimism } from 'wagmi/chains'
import { injected, metaMask, safe, walletConnect } from 'wagmi/connectors'

const projectId = '<WALLETCONNECT_PROJECT_ID>'

export const config = createConfig({
  chains: [mainnet, base],
  connectors: [
    injected(),
    walletConnect({ projectId }),
    metaMask(),
    safe(),
  ],
  transports: {
    [mainnet.id]: http(),
    [base.id]: http(),
  },
})
```

:::

### 5. Wire it up!

Finally, we can wire up our Wallet Options and Connection components to our application's entrypoint.

::: code-group

```tsx [app.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/connect-wallet.md","from":8237,"to":8977}<fsm-vh3gqscxm4e>
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { WagmiProvider, useConnection } from 'wagmi'
import { config } from './config'
import { Connection } from './connection' // [!code ++]
import { WalletOptions } from './wallet-options' // [!code ++]

const queryClient = new QueryClient()

function ConnectWallet() { // [!code ++]
  const { isConnected } = useConnection() // [!code ++]
  if (isConnected) return <Connection /> // [!code ++]
  return <WalletOptions /> // [!code ++]
} // [!code ++]

function App() {
  return (
    <WagmiProvider config={config}>
      <QueryClientProvider client={queryClient}> 
        <ConnectWallet /> // [!code ++]
      </QueryClientProvider> 
    </WagmiProvider>
  )
}
```

```tsx [connection.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/connect-wallet.md","from":9006,"to":9553}<fsm-vh3gqscxm4e>
import { useConnection, useDisconnect, useEnsAvatar, useEnsName } from 'wagmi'

export function Connection() {
  const { address } = useConnection()
  const { disconnect } = useDisconnect()
  const { data: ensName } = useEnsName({ address })
  const { data: ensAvatar } = useEnsAvatar({ name: ensName! })

  return (
    <div>
      {ensAvatar && <img alt="ENS Avatar" src={ensAvatar} />}
      {address && <div>{ensName ? `${ensName} (${address})` : address}</div>}
      <button onClick={() => disconnect()}>Disconnect</button>
    </div>
  )
}
```

```tsx [wallet-options.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/connect-wallet.md","from":9586,"to":10370}<fsm-vh3gqscxm4e>
import * as React from 'react'
import { Connector, useConnect, useConnectors } from 'wagmi'

export function WalletOptions() {
  const { connect } = useConnect()
  const connectors = useConnectors()

  return connectors.map((connector) => (
    <WalletOption
      key={connector.uid}
      connector={connector}
      onClick={() => connect({ connector })}
    />
  ))
}

function WalletOption({
  connector,
  onClick,
}: {
  connector: Connector
  onClick: () => void
}) {
  const [ready, setReady] = React.useState(false)

  React.useEffect(() => {
    ;(async () => {
      const provider = await connector.getProvider()
      setReady(!!provider)
    })()
  }, [connector])

  return (
    <button disabled={!ready} onClick={onClick}>
      {connector.name}
    </button>
  )
}
```

```tsx [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/connect-wallet.md","from":10394,"to":10852}<fsm-vh3gqscxm4e>
import { http, createConfig } from 'wagmi'
import { base, mainnet, optimism } from 'wagmi/chains'
import { injected, metaMask, safe, walletConnect } from 'wagmi/connectors'

const projectId = '<WALLETCONNECT_PROJECT_ID>'

export const config = createConfig({
  chains: [mainnet, base],
  connectors: [
    injected(),
    walletConnect({ projectId }),
    metaMask(),
    safe(),
  ],
  transports: {
    [mainnet.id]: http(),
    [base.id]: http(),
  },
})
```

:::

### Playground

Want to see the above steps all wired up together in an end-to-end example? Check out the below StackBlitz playground.

---

---
url: /solid/guides/connect-wallet.md
---
# Connect Wallet

This guide covers how to connect and disconnect wallets using `@wagmi/solid`.

## Overview

Connecting a wallet allows your app to interact with the user's Ethereum accounts. Wagmi provides primitives to handle the entire connection flow.

## Connecting

Use the `useConnect` primitive to connect a wallet:

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/guides/connect-wallet.md","from":333,"to":691}<fsm-vh3gqscxm4e>
import { useConnect } from '@wagmi/solid'
import { injected } from '@wagmi/solid/connectors'

function Connect() {
  const connect = useConnect()

  return (
    <button
      disabled={connect.isPending}
      onClick={() => connect.mutate({ connector: injected() })}
    >
      {connect.isPending ? 'Connecting...' : 'Connect Wallet'}
    </button>
  )
}
```

## Displaying Available Connectors

Use the `useConnectors` primitive to get a list of configured connectors:

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/guides/connect-wallet.md","from":814,"to":1291}<fsm-vh3gqscxm4e>
import { useConnect, useConnectors } from '@wagmi/solid'
import { For } from 'solid-js'

function Connect() {
  const connect = useConnect()
  const connectors = useConnectors()

  return (
    <div>
      <For each={connectors()}>
        {(connector) => (
          <button
            disabled={connect.isPending}
            onClick={() => connect.mutate({ connector })}
          >
            {connector.name}
          </button>
        )}
      </For>
    </div>
  )
}
```

## Checking Connection Status

Use the `useConnection` primitive to check if a wallet is connected:

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/guides/connect-wallet.md","from":1404,"to":1716}<fsm-vh3gqscxm4e>
import { useConnection } from '@wagmi/solid'
import { Show } from 'solid-js'

function ConnectionStatus() {
  const connection = useConnection()

  return (
    <Show
      when={connection.isConnected}
      fallback={<p>Not connected</p>}
    >
      <p>Connected to {connection.address}</p>
    </Show>
  )
}
```

## Disconnecting

Use the `useDisconnect` primitive to disconnect:

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/guides/connect-wallet.md","from":1796,"to":2050}<fsm-vh3gqscxm4e>
import { useDisconnect } from '@wagmi/solid'

function Disconnect() {
  const disconnect = useDisconnect()

  return (
    <button
      disabled={disconnect.isPending}
      onClick={() => disconnect.mutate()}
    >
      Disconnect
    </button>
  )
}
```

## Complete Example

Here's a complete example combining all the pieces:

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/guides/connect-wallet.md","from":2136,"to":3262}<fsm-vh3gqscxm4e>
import { useConnect, useConnection, useConnectors, useDisconnect } from '@wagmi/solid'
import { For, Show } from 'solid-js'

function WalletConnection() {
  const connection = useConnection()
  const connectors = useConnectors()
  const connect = useConnect()
  const disconnect = useDisconnect()

  return (
    <div>
      <Show
        when={connection.isConnected}
        fallback={
          <div>
            <p>Connect your wallet:</p>
            <For each={connectors()}>
              {(connector) => (
                <button
                  disabled={connect.isPending}
                  onClick={() => connect.mutate({ connector })}
                >
                  {connector.name}
                </button>
              )}
            </For>
            {connect.isError && <p>Error: {connect.error?.message}</p>}
          </div>
        }
      >
        <div>
          <p>Connected: {connection.address}</p>
          <p>Chain ID: {connection.chainId}</p>
          <button onClick={() => disconnect.mutate()}>
            Disconnect
          </button>
        </div>
      </Show>
    </div>
  )
}
```

## Connection Effects

Use `useConnectionEffect` to react to connection state changes:

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/guides/connect-wallet.md","from":3362,"to":3628}<fsm-vh3gqscxm4e>
import { useConnectionEffect } from '@wagmi/solid'

function ConnectionLogger() {
  useConnectionEffect(() => ({
    onConnect(data) {
      console.log('Connected!', data)
    },
    onDisconnect() {
      console.log('Disconnected!')
    },
  }))

  return null
}
```

## Next Steps

* [useConnect](/solid/api/primitives/useConnect) - Learn more about the connect primitive
* [useDisconnect](/solid/api/primitives/useDisconnect) - Learn more about the disconnect primitive
* [useConnection](/solid/api/primitives/useConnection) - Learn more about connection state

---

---
url: /vue/guides/connect-wallet.md
---
# Connect Wallet

The ability for a user to connect their wallet is a core function for any Dapp. It allows users to perform tasks such as: writing to contracts, signing messages, or sending transactions.

Wagmi contains everything you need to get started with building a Connect Wallet module. To get started, follow the [build your own](#build-your-own) walkthrough.

## Build Your Own

Wagmi provides you with the Composables to get started building your own Connect Wallet module.

It takes less than five minutes to get up and running with Browser Wallets, WalletConnect, and Coinbase Wallet.

### 1. Configure Wagmi

Before we get started with building the functionality of the Connect Wallet module, we will need to set up the Wagmi configuration.

Let's create a `config.ts` file and export a `config` object.

::: code-group

```tsx [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/connect-wallet.md","from":855,"to":1328}<fsm-vh3gqscxm4e>
import { http, createConfig } from '@wagmi/vue'
import { base, mainnet, optimism } from '@wagmi/vue/chains'
import { injected, metaMask, safe, walletConnect } from '@wagmi/vue/connectors'

const projectId = '<WALLETCONNECT_PROJECT_ID>'

export const config = createConfig({
  chains: [mainnet, base],
  connectors: [
    injected(),
    walletConnect({ projectId }),
    metaMask(),
    safe(),
  ],
  transports: {
    [mainnet.id]: http(),
    [base.id]: http(),
  },
})
```

:::

In the above configuration, we want to set up connectors for Injected (browser), WalletConnect (browser + mobile), MetaMask, and Safe wallets. This configuration uses the **Mainnet** and **Base** chains, but you can use whatever you want.

::: warning

Make sure to replace the `projectId` with your own WalletConnect Project ID, if you wish to use WalletConnect!

[Get your Project ID](https://cloud.walletconnect.com/)

:::

### 2. Inject the WagmiPlugin onto your App

Next, we will need to inject our App with plugins so that our application is aware of Wagmi & Vue Query's reactive state and in-memory caching.

::: code-group

```ts [main.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/connect-wallet.md","from":1988,"to":2360}<fsm-vh3gqscxm4e>
// 1. Import modules.
import { VueQueryPlugin } from '@tanstack/vue-query'
import { WagmiPlugin } from '@wagmi/vue'
import { createApp } from 'vue'

import App from './App.vue'
import { config } from './wagmi'

createApp(App)
  // 2. Inject the Wagmi plugin.
  .use(WagmiPlugin, { config })
  // 3. Inject the Vue Query plugin.
  .use(VueQueryPlugin, {})
  .mount('#app')
```

```vue [App.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/connect-wallet.md","from":2382,"to":2441}<fsm-vh3gqscxm4e>
<script setup lang="ts">
</script>

<template>
</template>
```

```ts [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/connect-wallet.md","from":2464,"to":2937}<fsm-vh3gqscxm4e>
import { http, createConfig } from '@wagmi/vue'
import { base, mainnet, optimism } from '@wagmi/vue/chains'
import { injected, metaMask, safe, walletConnect } from '@wagmi/vue/connectors'

const projectId = '<WALLETCONNECT_PROJECT_ID>'

export const config = createConfig({
  chains: [mainnet, base],
  connectors: [
    injected(),
    walletConnect({ projectId }),
    metaMask(),
    safe(),
  ],
  transports: {
    [mainnet.id]: http(),
    [base.id]: http(),
  },
})
```

:::

### 3. Display Wallet Options

After that, we will create a `Connect` component that will display our connectors. This will allow users to select a wallet and connect.

Below, we are rendering a list of `connectors` retrieved from `useConnect`. When the user clicks on a connector, the `connect` function will connect the users' wallet.

::: code-group

```vue [Connect.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/connect-wallet.md","from":3322,"to":3678}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useChainId, useConnect, useConnectors } from '@wagmi/vue'

const chainId = useChainId()
const { connect } = useConnect()
const connectors = useConnectors()
</script>

<template>
  <button
    v-for="connector in connectors"
    @click="connect({ connector, chainId })"
  >
    {{ connector.name }}
  </button>
</template>
```

```vue [App.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/connect-wallet.md","from":3700,"to":3759}<fsm-vh3gqscxm4e>
<script setup lang="ts">
</script>

<template>
</template>
```

```ts [main.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/connect-wallet.md","from":3780,"to":4152}<fsm-vh3gqscxm4e>
// 1. Import modules.
import { VueQueryPlugin } from '@tanstack/vue-query'
import { WagmiPlugin } from '@wagmi/vue'
import { createApp } from 'vue'

import App from './App.vue'
import { config } from './wagmi'

createApp(App)
  // 2. Inject the Wagmi plugin.
  .use(WagmiPlugin, { config })
  // 3. Inject the Vue Query plugin.
  .use(VueQueryPlugin, {})
  .mount('#app')
```

```ts [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/connect-wallet.md","from":4175,"to":4648}<fsm-vh3gqscxm4e>
import { http, createConfig } from '@wagmi/vue'
import { base, mainnet, optimism } from '@wagmi/vue/chains'
import { injected, metaMask, safe, walletConnect } from '@wagmi/vue/connectors'

const projectId = '<WALLETCONNECT_PROJECT_ID>'

export const config = createConfig({
  chains: [mainnet, base],
  connectors: [
    injected(),
    walletConnect({ projectId }),
    metaMask(),
    safe(),
  ],
  transports: {
    [mainnet.id]: http(),
    [base.id]: http(),
  },
})
```

:::

### 4. Display Connection

Lastly, if an connection is made, we want to show some basic information, like the connected address and ENS name and avatar.

Below, we are using hooks like `useConnection`, `useEnsAvatar` and `useEnsName` to extract this information.

We are also utilizing `useDisconnect` to show a "Disconnect" button so a user can disconnect their wallet.

::: code-group

```vue [Connection.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/connect-wallet.md","from":5070,"to":5421}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnection, useDisconnect } from '@wagmi/vue'

const { address, connector } = useConnection()
const { disconnect } = useDisconnect()
</script>

<template>
  <div>Address: {{ address }}</div>
  <div>Connected to {{ connector?.name }} Connector.</div>
  <button @click="disconnect()">Disconnect</button>
</template>
```

```vue [Connect.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/connect-wallet.md","from":5447,"to":5803}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useChainId, useConnect, useConnectors } from '@wagmi/vue'

const chainId = useChainId()
const { connect } = useConnect()
const connectors = useConnectors()
</script>

<template>
  <button
    v-for="connector in connectors"
    @click="connect({ connector, chainId })"
  >
    {{ connector.name }}
  </button>
</template>
```

```vue [App.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/connect-wallet.md","from":5825,"to":5884}<fsm-vh3gqscxm4e>
<script setup lang="ts">
</script>

<template>
</template>
```

```ts [main.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/connect-wallet.md","from":5905,"to":6277}<fsm-vh3gqscxm4e>
// 1. Import modules.
import { VueQueryPlugin } from '@tanstack/vue-query'
import { WagmiPlugin } from '@wagmi/vue'
import { createApp } from 'vue'

import App from './App.vue'
import { config } from './wagmi'

createApp(App)
  // 2. Inject the Wagmi plugin.
  .use(WagmiPlugin, { config })
  // 3. Inject the Vue Query plugin.
  .use(VueQueryPlugin, {})
  .mount('#app')
```

```ts [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/connect-wallet.md","from":6300,"to":6773}<fsm-vh3gqscxm4e>
import { http, createConfig } from '@wagmi/vue'
import { base, mainnet, optimism } from '@wagmi/vue/chains'
import { injected, metaMask, safe, walletConnect } from '@wagmi/vue/connectors'

const projectId = '<WALLETCONNECT_PROJECT_ID>'

export const config = createConfig({
  chains: [mainnet, base],
  connectors: [
    injected(),
    walletConnect({ projectId }),
    metaMask(),
    safe(),
  ],
  transports: {
    [mainnet.id]: http(),
    [base.id]: http(),
  },
})
```

:::

### 5. Wire it up!

Finally, we can wire up our Connect and Connection components to our application's entrypoint.

::: code-group

```vue [App.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/connect-wallet.md","from":6932,"to":7267}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnection } from '@wagmi/vue'
import Connection from './Connection.vue' // [!code ++]
import Connect from './Connect.vue' // [!code ++]

const { isConnected } = useConnection()
</script>

<template>
  <Connection v-if="isConnected" /> // [!code ++]
  <Connect v-else /> // [!code ++]
</template>

```

```vue [Connection.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/connect-wallet.md","from":7296,"to":7647}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnection, useDisconnect } from '@wagmi/vue'

const { address, connector } = useConnection()
const { disconnect } = useDisconnect()
</script>

<template>
  <div>Address: {{ address }}</div>
  <div>Connected to {{ connector?.name }} Connector.</div>
  <button @click="disconnect()">Disconnect</button>
</template>
```

```vue [Connect.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/connect-wallet.md","from":7673,"to":8029}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useChainId, useConnect, useConnectors } from '@wagmi/vue'

const chainId = useChainId()
const { connect } = useConnect()
const connectors = useConnectors()
</script>

<template>
  <button
    v-for="connector in connectors"
    @click="connect({ connector, chainId })"
  >
    {{ connector.name }}
  </button>
</template>
```

```ts [main.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/connect-wallet.md","from":8050,"to":8422}<fsm-vh3gqscxm4e>
// 1. Import modules.
import { VueQueryPlugin } from '@tanstack/vue-query'
import { WagmiPlugin } from '@wagmi/vue'
import { createApp } from 'vue'

import App from './App.vue'
import { config } from './wagmi'

createApp(App)
  // 2. Inject the Wagmi plugin.
  .use(WagmiPlugin, { config })
  // 3. Inject the Vue Query plugin.
  .use(VueQueryPlugin, {})
  .mount('#app')
```

```ts [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/connect-wallet.md","from":8445,"to":8918}<fsm-vh3gqscxm4e>
import { http, createConfig } from '@wagmi/vue'
import { base, mainnet, optimism } from '@wagmi/vue/chains'
import { injected, metaMask, safe, walletConnect } from '@wagmi/vue/connectors'

const projectId = '<WALLETCONNECT_PROJECT_ID>'

export const config = createConfig({
  chains: [mainnet, base],
  connectors: [
    injected(),
    walletConnect({ projectId }),
    metaMask(),
    safe(),
  ],
  transports: {
    [mainnet.id]: http(),
    [base.id]: http(),
  },
})
```

:::

### Playground

Want to see the above steps all wired up together in an end-to-end example? Check out the below StackBlitz playground.

---

---
url: /core/api/connectors.md
---
# Connectors

Connectors for popular wallet providers and protocols.

## Import

Available via the `'@wagmi/connectors'` package.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/connectors.md","from":410,"to":455}<fsm-vh3gqscxm4e>
import { injected } from '@wagmi/connectors'
```

## Built-In Connectors

::: tip
Some connectors require third-party packages. See the "Install" section on each connector's page for more info on license, version, and more.
:::

---

---
url: /react/api/connectors.md
---
# Connectors

Connectors for popular wallet providers and protocols.

## Import

Import via the `'wagmi/connectors'` entrypoint.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/connectors.md","from":410,"to":454}<fsm-vh3gqscxm4e>
import { injected } from 'wagmi/connectors'
```

## Available Connectors

::: tip
Some connectors require third-party packages. See the "Install" section on each connector's page for more info on license, version, and more.
:::

---

---
url: /solid/api/connectors.md
---
# Connectors

Connectors for popular wallet providers and protocols.

## Import

Import via the `'@wagmi/solid/connectors'` entrypoint.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/connectors.md","from":417,"to":468}<fsm-vh3gqscxm4e>
import { injected } from '@wagmi/solid/connectors'
```

## Available Connectors

::: tip
Some connectors require third-party packages. See the "Install" section on each connector's page for more info on license, version, and more.
:::

---

---
url: /tempo/connectors.md
---
# Connectors

Supported Tempo connectors are thin Wagmi wrappers around the root `accounts` package.

* [**`tempoWallet`**](/tempo/connectors/tempoWallet) Connector for the Tempo Wallet dialog
* [**`webAuthn`**](/tempo/connectors/webAuthn) Connector for a WebAuthn EOA
* [**`dangerous_secp256k1`**](/tempo/connectors/dangerous_secp256k1) Connector for a secp256k1 (private key) EOA

---

---
url: /vue/api/connectors.md
---
# Connectors

Connectors for popular wallet providers and protocols.

## Import

Import via the `'@wagmi/vue/connectors'` entrypoint.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/connectors.md","from":413,"to":462}<fsm-vh3gqscxm4e>
import { injected } from '@wagmi/vue/connectors'
```

## Available Connectors

::: tip
Some connectors require third-party packages. See the "Install" section on each connector's page for more info on license, version, and more.
:::

---

---
url: /dev/contributing.md
---
# Contributing

Thanks for your interest in contributing to Wagmi! Please take a moment to review this document **before submitting a pull request.**

## Overview

This guide is intended to help you get started with contributing. By following these steps, you will understand the development process and workflow. If you want to contribute, but aren't sure where to start, you can create a [new discussion](https://github.com/wevm/wagmi/discussions/new/choose).

:::warning
**Please ask first before starting work on any significant new features. This includes things like adding new hooks, actions, connectors, etc.**

It's never a fun experience to have your pull request declined after investing time and effort into a new feature. To avoid this from happening, we request that contributors first create a [feature request](https://github.com/wevm/wagmi/discussions/new?category=ideas) to discuss any API changes or significant new ideas.
:::

## 1. Cloning the repository

To start contributing to the project, clone it to your local machine using git:

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/dev/contributing.md","from":1247,"to":1291}<fsm-vh3gqscxm4e>
git clone https://github.com/wevm/wagmi.git
```

Or the [GitHub CLI](https://cli.github.com):

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/dev/contributing.md","from":1350,"to":1375}<fsm-vh3gqscxm4e>
gh repo clone wevm/wagmi
```

## 2. Installing Node.js and pnpm

Wagmi uses Node.js with [pnpm workspaces](https://pnpm.io/workspaces) to manage multiple projects. You can run the following command in your terminal to check your local Node.js version.

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/dev/contributing.md","from":1611,"to":1619}<fsm-vh3gqscxm4e>
node -v
```

If **`node@{{nodeVersion}}`** is not installed, you can install via [fnm](https://github.com/Schniz/fnm) or from the [official website](https://nodejs.org).

Once Node.js is installed, run the following to install [Corepack](https://nodejs.org/api/corepack.html). Corepack automatically installs and manages **`{{packageManager}}`**.

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/dev/contributing.md","from":1967,"to":1983}<fsm-vh3gqscxm4e>
corepack enable
```

## 3. Installing dependencies

Once in the project's root directory, run the following command to install pnpm (via Corepack) and the project's dependencies:

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/dev/contributing.md","from":2155,"to":2168}<fsm-vh3gqscxm4e>
pnpm install
```

After the install completes, pnpm links packages across the project for development and [git hooks](https://github.com/toplenboren/simple-git-hooks) are set up.

## 4. Adding the env variables

The [dev playgrounds](#_5-running-the-dev-playgrounds) and [test suite](#_6-running-the-test-suite) require environment variables to be set. Copy over the following environment variables to `.env`, and fill them out.

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/dev/contributing.md","from":2593,"to":2912}<fsm-vh3gqscxm4e>
VITE_MAINNET_FORK_URL=https://eth.merkle.io
VITE_OPTIMISM_FORK_URL=https://mainnet.optimism.io

NEXT_PUBLIC_WC_PROJECT_ID=3fbb6bba6f1de962d911bb5b5c9dba88
NUXT_PUBLIC_WC_PROJECT_ID=3fbb6bba6f1de962d911bb5b5c9dba88
VITE_WC_PROJECT_ID=3fbb6bba6f1de962d911bb5b5c9dba88

NEXT_TELEMETRY_DISABLED=1
NUXT_TELEMETRY_DISABLED=1
```

You might want to change `*_FORK_URL` to a paid RPC provider for better performance.

## 5. Running the dev playgrounds

To start the local development playgrounds, run one of the following commands. These commands run playground apps, located at `./playgrounds`, that are set up for trying out code while making changes.

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/dev/contributing.md","from":3248,"to":3659}<fsm-vh3gqscxm4e>
pnpm dev              # `wagmi` playground
pnpm dev:core         # `@wagmi/core` playground
pnpm dev:create-wagmi # `create-wagmi` cli tool
pnpm dev:cli          # `@wagmi/cli` tool
pnpm dev:next         # `wagmi` playground with Next.js
pnpm dev:nuxt         # `@wagmi/vue` playground with Nuxt.js
pnpm dev:react        # `wagmi` playground (same as `pnpm dev`)
pnpm dev:vue          # `@wagmi/vue` playground
```

Once a playground dev server is running, you can make changes to any of the package source files (e.g. `packages/react`) and it will automatically update the playground.

## 6. Running the test suite

Wagmi uses [Vitest](https://vitest.dev) to run tests and [Prool](https://github.com/wevm/prool) to execute tests against locally running chain forks. First, make sure you have Docker ([OrbStack](https://orbstack.dev) works great!) and install [Anvil](https://github.com/foundry-rs/foundry/tree/master/crates/anvil) via [Foundryup](https://book.getfoundry.sh/getting-started/installation).

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/dev/contributing.md","from":4263,"to":4317}<fsm-vh3gqscxm4e>
curl -L https://foundry.paradigm.xyz | bash
foundryup
```

You'll also need to install [Playwright](https://playwright.dev/) browser binaries:

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/dev/contributing.md","from":4415,"to":4444}<fsm-vh3gqscxm4e>
pnpm exec playwright install
```

Next, make sure you have set up your [env variables](#_4-adding-the-env-variables). Now you are ready to run the tests! You have the following options for running tests:

* `pnpm test [package?]` — runs tests in watch mode
* `pnpm test:cov` — runs tests and reports coverage

When adding new features or fixing bugs, it's important to add test cases to cover the new or updated behavior. If snapshot tests fail, you can run the `test:update` command to update the snapshots.

## 7. Writing documentation

Documentation is crucial to helping developers of all experience levels use Wagmi. Wagmi uses [VitePress](https://vitepress.dev) for the documentation site (located at `./site`). To start the site in dev mode, run:

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/dev/contributing.md","from":5178,"to":5192}<fsm-vh3gqscxm4e>
pnpm docs:dev
```

Try to keep documentation brief and use plain language so folks of all experience levels can understand. If you think something is unclear or could be explained better, you are welcome to open a pull request.

## 8. Submitting a pull request

When you're ready to submit a pull request, you can follow these naming conventions:

* Pull request titles use the [Imperative Mood](https://en.wikipedia.org/wiki/Imperative_mood) (e.g., `Add something`, `Fix something`).
* [Changesets](#versioning) use past tense verbs (e.g., `Added something`, `Fixed something`).

When you submit a pull request, GitHub will automatically lint, build, and test your changes. If you see an ❌, it's most likely a bug in your code. Please, inspect the logs through the GitHub UI to find the cause.

**Please make sure that "Allow edits from maintainers" is enabled so the core team can make updates to your pull request if necessary.**

## 9. Versioning

When adding new features or fixing bugs, we'll need to bump the package versions. We use [Changesets](https://github.com/changesets/changesets) to do this.

::: tip
Only changes to the codebase that affect the public API or existing behavior (e.g. bugs) need changesets.
:::

Each changeset defines which packages should be published and whether the change should be a major/minor/patch release, as well as providing release notes that will be added to the changelog upon release.

To create a new changeset, run `pnpm changeset`. This will run the Changesets CLI, prompting you for details about the change. You’ll be able to edit the file after it’s created — don’t worry about getting everything perfect up front.

Even though you can technically use any markdown formatting you like, headings should be avoided since each changeset will ultimately be nested within a bullet list. Instead, bold text should be used as section headings.

If your PR is making changes to an area that already has a changeset (e.g. there’s an existing changeset covering theme API changes but you’re making further changes to the same API), you should update the existing changeset in your PR rather than creating a new one.

### Releasing to npm

The first time a PR with a changeset is merged after a release, a new PR will automatically be created called `chore: version packages`. Any subsequent PRs with changesets will automatically update this existing version packages PR. Merging this PR triggers the release process by publishing to npm and cleaning up the changeset files.

### Creating a snapshot release

If a PR has changesets, you can create a [snapshot release](https://github.com/changesets/changesets/blob/main/docs/snapshot-releases.md) by [manually dispatching](https://github.com/wevm/wagmi/actions/workflows/canary.yml) the Canary workflow. This publishes a tagged version to npm with the PR branch name and timestamp.

## 10. Updating dependencies

Use [Taze](https://github.com/antfu/taze) by running:

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/dev/contributing.md","from":8148,"to":8316}<fsm-vh3gqscxm4e>
pnpm deps       # prints outdated deps
pnpm deps patch # print outdated deps with new patch versions
pnpm deps -w    # updates deps (best done with clean working tree)
```

Update GitHub Actions via [Actions Up!](https://github.com/azat-io/actions-up) by running:

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/dev/contributing.md","from":8421,"to":8434}<fsm-vh3gqscxm4e>
pnpm deps:ci
```

[Socket](https://socket.dev) checks pull requests for vulnerabilities when new dependencies and versions are added, but you should also be vigilant! When updating dependencies, you should check release notes and source code as well as lock versions when possible.

---

---
url: /core/api/utilities/cookieToInitialState.md
---

# cookieToInitialState

Helper to convert a cookie string into [initial state](/react/api/WagmiProvider#initialstate).

## Import

```ts-vue
import { cookieToInitialState } from '{{packageName}}'
```

## Usage

::: code-group

```ts-vue [server.ts]
import { cookieToInitialState } from '{{packageName}}'
import config from './config'

function handler(req: Request) {
  const initialState = cookieToInitialState(config, req.headers.cookie)
  // ...
}
```

```ts-vue [config.ts]
import { 
  createConfig, 
  http, 
  cookieStorage,
  createStorage
} from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  ssr: true,
  storage: createStorage({ 
    storage: cookieStorage,
  }), 
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

:::

## Parameters

### config

`Config`

Wagmi Config

### cookie

`string | null | undefined`

The cookie string.

## Return Type

`State`

Initial state.

---

---
url: /react/api/utilities/cookieToInitialState.md
---

# cookieToInitialState

Helper to convert a cookie string into [initial state](/react/api/WagmiProvider#initialstate).

## Import

```ts-vue
import { cookieToInitialState } from '{{packageName}}'
```

## Usage

::: code-group

```ts-vue [server.ts]
import { cookieToInitialState } from '{{packageName}}'
import config from './config'

function handler(req: Request) {
  const initialState = cookieToInitialState(config, req.headers.cookie)
  // ...
}
```

```ts-vue [config.ts]
import { 
  createConfig, 
  http, 
  cookieStorage,
  createStorage
} from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  ssr: true,
  storage: createStorage({ 
    storage: cookieStorage,
  }), 
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

:::

## Parameters

### config

`Config`

Wagmi Config

### cookie

`string | null | undefined`

The cookie string.

## Return Type

`State`

Initial state.

---

---
url: /shared/utilities/cookieToInitialState.md
---
# cookieToInitialState

Helper to convert a cookie string into [initial state](/react/api/WagmiProvider#initialstate).

## Import

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/utilities/cookieToInitialState.md","from":204,"to":259}<fsm-vh3gqscxm4e>
import { cookieToInitialState } from '{{packageName}}'
```

## Usage

::: code-group

```ts-vue [server.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/utilities/cookieToInitialState.md","from":312,"to":514}<fsm-vh3gqscxm4e>
import { cookieToInitialState } from '{{packageName}}'
import config from './config'

function handler(req: Request) {
  const initialState = cookieToInitialState(config, req.headers.cookie)
  // ...
}
```

```ts-vue [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/utilities/cookieToInitialState.md","from":541,"to":913}<fsm-vh3gqscxm4e>
import { 
  createConfig, 
  http, 
  cookieStorage,
  createStorage
} from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  ssr: true,
  storage: createStorage({ 
    storage: cookieStorage,
  }), 
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

:::

## Parameters

### config

`Config`

Wagmi Config

### cookie

`string | null | undefined`

The cookie string.

## Return Type

`State`

Initial state.

---

---
url: /cli/create-wagmi.md
---
# create-wagmi

## Overview

create-wagmi is a command line interface (CLI) for scaffolding new Wagmi projects.

## Usage

::: code-group

```bash [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/create-wagmi.md","from":153,"to":171}<fsm-vh3gqscxm4e>
pnpm create wagmi
```

```bash [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/create-wagmi.md","from":189,"to":213}<fsm-vh3gqscxm4e>
npm create wagmi@latest
```

```bash [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/create-wagmi.md","from":232,"to":250}<fsm-vh3gqscxm4e>
yarn create wagmi
```

```bash [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/create-wagmi.md","from":268,"to":285}<fsm-vh3gqscxm4e>
bun create wagmi
```

:::

## Options

### `-t`, `--template`

You can specify a custom [template](#templates) by passing the `--template`/`-t` flag:

::: code-group

```bash [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/create-wagmi.md","from":448,"to":482}<fsm-vh3gqscxm4e>
pnpm create wagmi --template next
```

```bash [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/create-wagmi.md","from":500,"to":540}<fsm-vh3gqscxm4e>
npm create wagmi@latest --template next
```

```bash [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/create-wagmi.md","from":559,"to":593}<fsm-vh3gqscxm4e>
yarn create wagmi --template next
```

```bash [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/create-wagmi.md","from":611,"to":644}<fsm-vh3gqscxm4e>
bun create wagmi --template next
```

:::

### `--bun`/`--npm`/`--pnpm`/`--yarn`

Use a specific package manager to install dependencies. By default, `create-wagmi` will use the package manager you used to run the command.

### `-h`, `--help`

Prints the help message.

### `-v`, `--version`

Prints the CLI version.

## Templates

`create-wagmi` currently comes with the following templates:

* `next`: A Next.js Wagmi project.
* `nuxt`: A Nuxt Wagmi project.
* `vite-react`: A Vite (React) Wagmi project.
* `vite-vanilla`: A Vite Wagmi Core project.
* `vite-vue`: A Vite (Vue) Wagmi project.

If you do not specify the template on the command line, you will be prompted to select a framework and variant.

* **React** : A React project.
  * **Vite** : A React + Vite Wagmi project (`vite-react`).
  * **Next** : A React + Next Wagmi project (`next`).
* **Vue**: A Vue project.
  * **Vite**: A Vue + Vite Wagmi project (`vite-vue`).
  * **Nuxt**: A Vue + Nuxt Wagmi project (`nuxt`).
* **Vanilla**: A Vite Wagmi project without React (`vite-vanilla`).

---

---
url: /core/api/createConfig.md
---

# createConfig

Creates new [`Config`](#config) object.

## Import

```ts-vue
import { createConfig } from '{{packageName}}'
```

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

::: tip Integrating a Viem Client

Instead of using [`transports`](#transports), it's possible to provide a function that returns a Viem [`Client`](https://viem.sh/docs/clients/custom) via the [`client`](#client) property for more fine-grained control over Wagmi's internal `Client` creation.

```ts-vue {3,7-9}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { createClient } from 'viem'

const config = createConfig({
  chains: [mainnet, sepolia],
  client({ chain }) {
    return createClient({ chain, transport: http() })
  },
})
```

:::

## Parameters

```ts-vue
import { type CreateConfigParameters } from '{{packageName}}'
```

### chains

`readonly [Chain, ...Chain[]]`

* Chains used by the `Config`.
* See Chains for more details about built-in chains and the `Chain` type.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia], // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### connectors

`CreateConnectorFn[] | undefined`

Connectors used by the `Config`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { injected } from '{{connectorsPackageName}}' // [!code focus]

const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()], // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### multiInjectedProviderDiscovery

`boolean | undefined`

* Enables discovery of injected providers via [EIP-6963](https://eips.ethereum.org/EIPS/eip-6963) using the [`mipd`](https://github.com/wevm/mipd) library and converting to injected connectors.
* Defaults to `true`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  multiInjectedProviderDiscovery: false, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### ssr

`boolean | undefined`

Flag to indicate if the config is being used in a server-side rendering environment. Defaults to `false`.

```ts-vue
import { createConfig, http } from '{{packageName}}' // [!code focus]
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  ssr: true, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### storage

`Storage | null | undefined`

* `Storage` used by the config. Persists `Config`'s [`State`](#state-1) between sessions.
* Defaults to `createStorage({ storage: typeof window !== 'undefined' && window.localStorage ? window.localStorage : noopStorage })`.

```ts-vue
import { createConfig, createStorage, http } from '{{packageName}}' // [!code focus]
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  storage: createStorage({ storage: window.localStorage }), // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### syncConnectedChain

`boolean | undefined`

* Keep the [`State['chainId']`](#chainid) in sync with the current connection.
* Defaults to `true`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  syncConnectedChain: false, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

***

### batch

`{ multicall?: boolean | { batchSize?: number | undefined; wait?: number | undefined } | undefined } | { [_ in chains[number]["id"]]?: { multicall?: boolean | { batchSize?: number | undefined; wait?: number | undefined } | undefined } | undefined } | undefined`

* Batch settings. See [Viem docs](https://viem.sh/docs/clients/custom#batch-optional) for more info.
* Defaults to `{ multicall: true }`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  batch: { multicall: true }, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### cacheTime

`number | { [_ in chains[number]['id']]?: number | undefined } | undefined`

* Frequency in milliseconds for polling enabled features. See [Viem docs](https://viem.sh/docs/clients/public#cachetime-optional) for more info.
* Defaults to [`pollingInterval`](#pollinginterval) or `4_000`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  cacheTime: 4_000, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### pollingInterval

`number | { [_ in chains[number]['id']]?: number | undefined } | undefined`

* Frequency in milliseconds for polling enabled features. See [Viem docs](https://viem.sh/docs/clients/custom#pollinginterval-optional) for more info.
* Defaults to `4_000`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  pollingInterval: 4_000, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### transports

`Record<chains[number]['id'], Transport>`

Mapping of [chain IDs](#chains) to `Transport`s. This mapping is used internally when creating chain-aware Viem [`Client`](https://viem.sh/docs/clients/custom) objects. See the Transport docs for more info.

```ts-vue
import { createConfig, fallback, http } from '{{packageName}}' // [!code focus]
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: { // [!code focus]
    [mainnet.id]: fallback([ // [!code focus]
      http('https://...'), // [!code focus]
      http('https://...'), // [!code focus]
    ]), // [!code focus]
    [sepolia.id]: http('https://...'), // [!code focus]
  }, // [!code focus]
})
```

***

### client

`(parameters: { chain: chains[number] }) => Client<Transport, chains[number]>`

Function for creating new Viem [`Client`](https://viem.sh/docs/clients/custom) to be used internally. Exposes more control over the internal `Client` creation logic versus using the [`transports`](#transports) property.

```ts-vue
import { createClient, http } from 'viem' // [!code focus]
import { createConfig } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  client({ chain }) { // [!code focus]
    return createClient({ chain, transport: http('https://...') }) // [!code focus]
  }, // [!code focus]
})
```

::: warning
When using this option, you likely want to pass `parameters.chain` straight through to [`createClient`](https://viem.sh/docs/clients/custom#createclient) to ensure the Viem `Client` is in sync with any active connections.
:::

## Return Type

```ts-vue
import { type Config } from '{{packageName}}'
```

## Config

Object responsible for managing Wagmi state and internals.

```ts-vue
import { type Config } from '{{packageName}}'
```

### chains

`readonly [Chain, ...Chain[]]`

[`chains`](#chains) passed to `createConfig`.

### connectors

`readonly Connector[]`

Connectors set up from passing [`connectors`](#connectors) and [`multiInjectedProviderDiscovery`](#multiinjectedproviderdiscovery) to `createConfig`.

### state

`State<chains>`

The `Config` object's internal state. See [`State`](#state-1) for more info.

### storage

`Storage | null`

[`storage`](#storage) passed to `createConfig`.

### getClient

`(parameters?: { chainId?: chainId | chains[number]['id'] | undefined }): Client<transports[chainId], Extract<chains[number], { id: chainId }>>`

Creates new Viem [`Client`](https://viem.sh/docs/clients/custom) object.

::: code-group

```ts-vue [index.ts]
import { config } from './config'

const client = config.getClient({ chainId: 1 })
```

```ts-vue [config.ts]
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

:::

### setState

`(value: State<chains> | ((state: State<chains>) => State<chains>)) => void`

Updates the `Config` object's internal state. See [`State`](#state-1) for more info.

::: code-group

```ts-vue [index.ts]
import { mainnet } from '{{packageName}}/chains'
import { config } from './config'

config.setState((x) => ({
  ...x,
  chainId: x.current ? x.chainId : mainnet.id,
}))
```

```ts-vue [config.ts]
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

:::

::: warning
Exercise caution when using this method. It is intended for internal and advanced use-cases only. Manually setting state can cause unexpected behavior.
:::

### subscribe

`(selector: (state: State<chains>) => state, listener: (selectedState: state, previousSelectedState: state) => void, options?: { emitImmediately?: boolean | undefined; equalityFn?: ((a: state, b: state) => boolean) | undefined } | undefined) => (() => void)`

Listens for state changes matching the `selector` function. Returns a function that can be called to unsubscribe the listener.

::: code-group

```ts-vue [index.ts]
import { config } from './config'

const unsubscribe = config.subscribe(
  (state) => state.chainId,
  (chainId) => console.log(`Chain ID changed to ${chainId}`),
)
unsubscribe()
```

```ts-vue [config.ts]
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

:::

## State

```ts-vue
import { type State } from '{{packageName}}'
```

### chainId

`chains[number]['id']`

Current chain ID. When `syncConnectedChain` is `true`, `chainId` is kept in sync with the current connection. Defaults to first chain in [`chains`](#chains).

### connections

`Map<string, Connection>`

Mapping of unique connector identifier to [`Connection`](#connection) object.

### current

`string | undefined`

Unique identifier of the current connection.

### status

`'connected' | 'connecting' | 'disconnected' | 'reconnecting'`

Current connection status.

* `'connecting'` attempting to establish connection.
* `'reconnecting'` attempting to re-establish connection to one or more connectors.
* `'connected'` at least one connector is connected.
* `'disconnected'` no connection to any connector.

## Connection

```ts-vue
import { type Connection } from '{{packageName}}'
```

### accounts

`readonly [Address, ...Address[]]`

Array of addresses associated with the connection.

### chainId

`number`

Chain ID associated with the connection.

### connector

`Connector`

Connector associated with the connection.

---

---
url: /react/api/createConfig.md
---

# createConfig

Creates new [`Config`](#config) object.

## Import

```ts-vue
import { createConfig } from '{{packageName}}'
```

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

::: tip Integrating a Viem Client

Instead of using [`transports`](#transports), it's possible to provide a function that returns a Viem [`Client`](https://viem.sh/docs/clients/custom) via the [`client`](#client) property for more fine-grained control over Wagmi's internal `Client` creation.

```ts-vue {3,7-9}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { createClient } from 'viem'

const config = createConfig({
  chains: [mainnet, sepolia],
  client({ chain }) {
    return createClient({ chain, transport: http() })
  },
})
```

:::

## Parameters

```ts-vue
import { type CreateConfigParameters } from '{{packageName}}'
```

### chains

`readonly [Chain, ...Chain[]]`

* Chains used by the `Config`.
* See Chains for more details about built-in chains and the `Chain` type.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia], // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### connectors

`CreateConnectorFn[] | undefined`

Connectors used by the `Config`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { injected } from '{{connectorsPackageName}}' // [!code focus]

const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()], // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### multiInjectedProviderDiscovery

`boolean | undefined`

* Enables discovery of injected providers via [EIP-6963](https://eips.ethereum.org/EIPS/eip-6963) using the [`mipd`](https://github.com/wevm/mipd) library and converting to injected connectors.
* Defaults to `true`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  multiInjectedProviderDiscovery: false, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### ssr

`boolean | undefined`

Flag to indicate if the config is being used in a server-side rendering environment. Defaults to `false`.

```ts-vue
import { createConfig, http } from '{{packageName}}' // [!code focus]
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  ssr: true, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### storage

`Storage | null | undefined`

* `Storage` used by the config. Persists `Config`'s [`State`](#state-1) between sessions.
* Defaults to `createStorage({ storage: typeof window !== 'undefined' && window.localStorage ? window.localStorage : noopStorage })`.

```ts-vue
import { createConfig, createStorage, http } from '{{packageName}}' // [!code focus]
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  storage: createStorage({ storage: window.localStorage }), // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### syncConnectedChain

`boolean | undefined`

* Keep the [`State['chainId']`](#chainid) in sync with the current connection.
* Defaults to `true`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  syncConnectedChain: false, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

***

### batch

`{ multicall?: boolean | { batchSize?: number | undefined; wait?: number | undefined } | undefined } | { [_ in chains[number]["id"]]?: { multicall?: boolean | { batchSize?: number | undefined; wait?: number | undefined } | undefined } | undefined } | undefined`

* Batch settings. See [Viem docs](https://viem.sh/docs/clients/custom#batch-optional) for more info.
* Defaults to `{ multicall: true }`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  batch: { multicall: true }, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### cacheTime

`number | { [_ in chains[number]['id']]?: number | undefined } | undefined`

* Frequency in milliseconds for polling enabled features. See [Viem docs](https://viem.sh/docs/clients/public#cachetime-optional) for more info.
* Defaults to [`pollingInterval`](#pollinginterval) or `4_000`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  cacheTime: 4_000, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### pollingInterval

`number | { [_ in chains[number]['id']]?: number | undefined } | undefined`

* Frequency in milliseconds for polling enabled features. See [Viem docs](https://viem.sh/docs/clients/custom#pollinginterval-optional) for more info.
* Defaults to `4_000`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  pollingInterval: 4_000, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### transports

`Record<chains[number]['id'], Transport>`

Mapping of [chain IDs](#chains) to `Transport`s. This mapping is used internally when creating chain-aware Viem [`Client`](https://viem.sh/docs/clients/custom) objects. See the Transport docs for more info.

```ts-vue
import { createConfig, fallback, http } from '{{packageName}}' // [!code focus]
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: { // [!code focus]
    [mainnet.id]: fallback([ // [!code focus]
      http('https://...'), // [!code focus]
      http('https://...'), // [!code focus]
    ]), // [!code focus]
    [sepolia.id]: http('https://...'), // [!code focus]
  }, // [!code focus]
})
```

***

### client

`(parameters: { chain: chains[number] }) => Client<Transport, chains[number]>`

Function for creating new Viem [`Client`](https://viem.sh/docs/clients/custom) to be used internally. Exposes more control over the internal `Client` creation logic versus using the [`transports`](#transports) property.

```ts-vue
import { createClient, http } from 'viem' // [!code focus]
import { createConfig } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  client({ chain }) { // [!code focus]
    return createClient({ chain, transport: http('https://...') }) // [!code focus]
  }, // [!code focus]
})
```

::: warning
When using this option, you likely want to pass `parameters.chain` straight through to [`createClient`](https://viem.sh/docs/clients/custom#createclient) to ensure the Viem `Client` is in sync with any active connections.
:::

## Return Type

```ts-vue
import { type Config } from '{{packageName}}'
```

## Config

Object responsible for managing Wagmi state and internals.

```ts-vue
import { type Config } from '{{packageName}}'
```

### chains

`readonly [Chain, ...Chain[]]`

[`chains`](#chains) passed to `createConfig`.

### connectors

`readonly Connector[]`

Connectors set up from passing [`connectors`](#connectors) and [`multiInjectedProviderDiscovery`](#multiinjectedproviderdiscovery) to `createConfig`.

### state

`State<chains>`

The `Config` object's internal state. See [`State`](#state-1) for more info.

### storage

`Storage | null`

[`storage`](#storage) passed to `createConfig`.

### getClient

`(parameters?: { chainId?: chainId | chains[number]['id'] | undefined }): Client<transports[chainId], Extract<chains[number], { id: chainId }>>`

Creates new Viem [`Client`](https://viem.sh/docs/clients/custom) object.

::: code-group

```ts-vue [index.ts]
import { config } from './config'

const client = config.getClient({ chainId: 1 })
```

```ts-vue [config.ts]
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

:::

### setState

`(value: State<chains> | ((state: State<chains>) => State<chains>)) => void`

Updates the `Config` object's internal state. See [`State`](#state-1) for more info.

::: code-group

```ts-vue [index.ts]
import { mainnet } from '{{packageName}}/chains'
import { config } from './config'

config.setState((x) => ({
  ...x,
  chainId: x.current ? x.chainId : mainnet.id,
}))
```

```ts-vue [config.ts]
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

:::

::: warning
Exercise caution when using this method. It is intended for internal and advanced use-cases only. Manually setting state can cause unexpected behavior.
:::

### subscribe

`(selector: (state: State<chains>) => state, listener: (selectedState: state, previousSelectedState: state) => void, options?: { emitImmediately?: boolean | undefined; equalityFn?: ((a: state, b: state) => boolean) | undefined } | undefined) => (() => void)`

Listens for state changes matching the `selector` function. Returns a function that can be called to unsubscribe the listener.

::: code-group

```ts-vue [index.ts]
import { config } from './config'

const unsubscribe = config.subscribe(
  (state) => state.chainId,
  (chainId) => console.log(`Chain ID changed to ${chainId}`),
)
unsubscribe()
```

```ts-vue [config.ts]
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

:::

## State

```ts-vue
import { type State } from '{{packageName}}'
```

### chainId

`chains[number]['id']`

Current chain ID. When `syncConnectedChain` is `true`, `chainId` is kept in sync with the current connection. Defaults to first chain in [`chains`](#chains).

### connections

`Map<string, Connection>`

Mapping of unique connector identifier to [`Connection`](#connection) object.

### current

`string | undefined`

Unique identifier of the current connection.

### status

`'connected' | 'connecting' | 'disconnected' | 'reconnecting'`

Current connection status.

* `'connecting'` attempting to establish connection.
* `'reconnecting'` attempting to re-establish connection to one or more connectors.
* `'connected'` at least one connector is connected.
* `'disconnected'` no connection to any connector.

## Connection

```ts-vue
import { type Connection } from '{{packageName}}'
```

### accounts

`readonly [Address, ...Address[]]`

Array of addresses associated with the connection.

### chainId

`number`

Chain ID associated with the connection.

### connector

`Connector`

Connector associated with the connection.

---

---
url: /shared/createConfig.md
---
# createConfig

Creates new [`Config`](#config) object.

## Import

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":215,"to":262}<fsm-vh3gqscxm4e>
import { createConfig } from '{{packageName}}'
```

## Usage

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":287,"to":593}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

::: tip Integrating a Viem Client

Instead of using [`transports`](#transports), it's possible to provide a function that returns a Viem [`Client`](https://viem.sh/docs/clients/custom) via the [`client`](#client) property for more fine-grained control over Wagmi's internal `Client` creation.

```ts-vue {3,7-9}
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":910,"to":1202}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { createClient } from 'viem'

const config = createConfig({
  chains: [mainnet, sepolia],
  client({ chain }) {
    return createClient({ chain, transport: http() })
  },
})
```

:::

## Parameters

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":1236,"to":1298}<fsm-vh3gqscxm4e>
import { type CreateConfigParameters } from '{{packageName}}'
```

### chains

`readonly [Chain, ...Chain[]]`

* Chains used by the `Config`.
* See Chains for more details about built-in chains and the `Chain` type.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":1504,"to":1827}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia], // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### connectors

`CreateConnectorFn[] | undefined`

Connectors used by the `Config`.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":1972,"to":2393}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { injected } from '{{connectorsPackageName}}' // [!code focus]

const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()], // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### multiInjectedProviderDiscovery

`boolean | undefined`

* Enables discovery of injected providers via [EIP-6963](https://eips.ethereum.org/EIPS/eip-6963) using the [`mipd`](https://github.com/wevm/mipd) library and converting to injected connectors.
* Defaults to `true`.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":2738,"to":3102}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  multiInjectedProviderDiscovery: false, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### ssr

`boolean | undefined`

Flag to indicate if the config is being used in a server-side rendering environment. Defaults to `false`.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":3256,"to":3609}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}' // [!code focus]
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  ssr: true, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### storage

`Storage | null | undefined`

* `Storage` used by the config. Persists `Config`'s [`State`](#state-1) between sessions.
* Defaults to `createStorage({ storage: typeof window !== 'undefined' && window.localStorage ? window.localStorage : noopStorage })`.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":3948,"to":4363}<fsm-vh3gqscxm4e>
import { createConfig, createStorage, http } from '{{packageName}}' // [!code focus]
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  storage: createStorage({ storage: window.localStorage }), // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### syncConnectedChain

`boolean | undefined`

* Keep the [`State['chainId']`](#chainid) in sync with the current connection.
* Defaults to `true`.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":4527,"to":4879}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  syncConnectedChain: false, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

***

### batch

`{ multicall?: boolean | { batchSize?: number | undefined; wait?: number | undefined } | undefined } | { [_ in chains[number]["id"]]?: { multicall?: boolean | { batchSize?: number | undefined; wait?: number | undefined } | undefined } | undefined } | undefined`

* Batch settings. See [Viem docs](https://viem.sh/docs/clients/custom#batch-optional) for more info.
* Defaults to `{ multicall: true }`.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":5312,"to":5665}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  batch: { multicall: true }, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### cacheTime

`number | { [_ in chains[number]['id']]?: number | undefined } | undefined`

* Frequency in milliseconds for polling enabled features. See [Viem docs](https://viem.sh/docs/clients/public#cachetime-optional) for more info.
* Defaults to [`pollingInterval`](#pollinginterval) or `4_000`.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":5982,"to":6325}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  cacheTime: 4_000, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### pollingInterval

`number | { [_ in chains[number]['id']]?: number | undefined } | undefined`

* Frequency in milliseconds for polling enabled features. See [Viem docs](https://viem.sh/docs/clients/custom#pollinginterval-optional) for more info.
* Defaults to `4_000`.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":6613,"to":6962}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  pollingInterval: 4_000, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### transports

`Record<chains[number]['id'], Transport>`

Mapping of [chain IDs](#chains) to `Transport`s. This mapping is used internally when creating chain-aware Viem [`Client`](https://viem.sh/docs/clients/custom) objects. See the Transport docs for more info.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":7334,"to":7806}<fsm-vh3gqscxm4e>
import { createConfig, fallback, http } from '{{packageName}}' // [!code focus]
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: { // [!code focus]
    [mainnet.id]: fallback([ // [!code focus]
      http('https://...'), // [!code focus]
      http('https://...'), // [!code focus]
    ]), // [!code focus]
    [sepolia.id]: http('https://...'), // [!code focus]
  }, // [!code focus]
})
```

***

### client

`(parameters: { chain: chains[number] }) => Client<Transport, chains[number]>`

Function for creating new Viem [`Client`](https://viem.sh/docs/clients/custom) to be used internally. Exposes more control over the internal `Client` creation logic versus using the [`transports`](#transports) property.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":8139,"to":8512}<fsm-vh3gqscxm4e>
import { createClient, http } from 'viem' // [!code focus]
import { createConfig } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  client({ chain }) { // [!code focus]
    return createClient({ chain, transport: http('https://...') }) // [!code focus]
  }, // [!code focus]
})
```

::: warning
When using this option, you likely want to pass `parameters.chain` straight through to [`createClient`](https://viem.sh/docs/clients/custom#createclient) to ensure the Viem `Client` is in sync with any active connections.
:::

## Return Type

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":8782,"to":8828}<fsm-vh3gqscxm4e>
import { type Config } from '{{packageName}}'
```

## Config

Object responsible for managing Wagmi state and internals.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":8914,"to":8960}<fsm-vh3gqscxm4e>
import { type Config } from '{{packageName}}'
```

### chains

`readonly [Chain, ...Chain[]]`

[`chains`](#chains) passed to `createConfig`.

### connectors

`readonly Connector[]`

Connectors set up from passing [`connectors`](#connectors) and [`multiInjectedProviderDiscovery`](#multiinjectedproviderdiscovery) to `createConfig`.

### state

`State<chains>`

The `Config` object's internal state. See [`State`](#state-1) for more info.

### storage

`Storage | null`

[`storage`](#storage) passed to `createConfig`.

### getClient

`(parameters?: { chainId?: chainId | chains[number]['id'] | undefined }): Client<transports[chainId], Extract<chains[number], { id: chainId }>>`

Creates new Viem [`Client`](https://viem.sh/docs/clients/custom) object.

::: code-group

```ts-vue [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":9704,"to":9787}<fsm-vh3gqscxm4e>
import { config } from './config'

const client = config.getClient({ chainId: 1 })
```

```ts-vue [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":9814,"to":10127}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

:::

### setState

`(value: State<chains> | ((state: State<chains>) => State<chains>)) => void`

Updates the `Config` object's internal state. See [`State`](#state-1) for more info.

::: code-group

```ts-vue [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":10351,"to":10520}<fsm-vh3gqscxm4e>
import { mainnet } from '{{packageName}}/chains'
import { config } from './config'

config.setState((x) => ({
  ...x,
  chainId: x.current ? x.chainId : mainnet.id,
}))
```

```ts-vue [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":10547,"to":10860}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

:::

::: warning
Exercise caution when using this method. It is intended for internal and advanced use-cases only. Manually setting state can cause unexpected behavior.
:::

### subscribe

`(selector: (state: State<chains>) => state, listener: (selectedState: state, previousSelectedState: state) => void, options?: { emitImmediately?: boolean | undefined; equalityFn?: ((a: state, b: state) => boolean) | undefined } | undefined) => (() => void)`

Listens for state changes matching the `selector` function. Returns a function that can be called to unsubscribe the listener.

::: code-group

```ts-vue [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":11478,"to":11657}<fsm-vh3gqscxm4e>
import { config } from './config'

const unsubscribe = config.subscribe(
  (state) => state.chainId,
  (chainId) => console.log(`Chain ID changed to ${chainId}`),
)
unsubscribe()
```

```ts-vue [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":11684,"to":11997}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

:::

## State

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":12027,"to":12072}<fsm-vh3gqscxm4e>
import { type State } from '{{packageName}}'
```

### chainId

`chains[number]['id']`

Current chain ID. When `syncConnectedChain` is `true`, `chainId` is kept in sync with the current connection. Defaults to first chain in [`chains`](#chains).

### connections

`Map<string, Connection>`

Mapping of unique connector identifier to [`Connection`](#connection) object.

### current

`string | undefined`

Unique identifier of the current connection.

### status

`'connected' | 'connecting' | 'disconnected' | 'reconnecting'`

Current connection status.

* `'connecting'` attempting to establish connection.
* `'reconnecting'` attempting to re-establish connection to one or more connectors.
* `'connected'` at least one connector is connected.
* `'disconnected'` no connection to any connector.

## Connection

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createConfig.md","from":12848,"to":12898}<fsm-vh3gqscxm4e>
import { type Connection } from '{{packageName}}'
```

### accounts

`readonly [Address, ...Address[]]`

Array of addresses associated with the connection.

### chainId

`number`

Chain ID associated with the connection.

### connector

`Connector`

Connector associated with the connection.

---

---
url: /solid/api/createConfig.md
---

# createConfig

Creates new [`Config`](#config) object.

## Import

```ts-vue
import { createConfig } from '{{packageName}}'
```

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

::: tip Integrating a Viem Client

Instead of using [`transports`](#transports), it's possible to provide a function that returns a Viem [`Client`](https://viem.sh/docs/clients/custom) via the [`client`](#client) property for more fine-grained control over Wagmi's internal `Client` creation.

```ts-vue {3,7-9}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { createClient } from 'viem'

const config = createConfig({
  chains: [mainnet, sepolia],
  client({ chain }) {
    return createClient({ chain, transport: http() })
  },
})
```

:::

## Parameters

```ts-vue
import { type CreateConfigParameters } from '{{packageName}}'
```

### chains

`readonly [Chain, ...Chain[]]`

* Chains used by the `Config`.
* See Chains for more details about built-in chains and the `Chain` type.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia], // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### connectors

`CreateConnectorFn[] | undefined`

Connectors used by the `Config`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { injected } from '{{connectorsPackageName}}' // [!code focus]

const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()], // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### multiInjectedProviderDiscovery

`boolean | undefined`

* Enables discovery of injected providers via [EIP-6963](https://eips.ethereum.org/EIPS/eip-6963) using the [`mipd`](https://github.com/wevm/mipd) library and converting to injected connectors.
* Defaults to `true`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  multiInjectedProviderDiscovery: false, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### ssr

`boolean | undefined`

Flag to indicate if the config is being used in a server-side rendering environment. Defaults to `false`.

```ts-vue
import { createConfig, http } from '{{packageName}}' // [!code focus]
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  ssr: true, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### storage

`Storage | null | undefined`

* `Storage` used by the config. Persists `Config`'s [`State`](#state-1) between sessions.
* Defaults to `createStorage({ storage: typeof window !== 'undefined' && window.localStorage ? window.localStorage : noopStorage })`.

```ts-vue
import { createConfig, createStorage, http } from '{{packageName}}' // [!code focus]
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  storage: createStorage({ storage: window.localStorage }), // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### syncConnectedChain

`boolean | undefined`

* Keep the [`State['chainId']`](#chainid) in sync with the current connection.
* Defaults to `true`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  syncConnectedChain: false, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

***

### batch

`{ multicall?: boolean | { batchSize?: number | undefined; wait?: number | undefined } | undefined } | { [_ in chains[number]["id"]]?: { multicall?: boolean | { batchSize?: number | undefined; wait?: number | undefined } | undefined } | undefined } | undefined`

* Batch settings. See [Viem docs](https://viem.sh/docs/clients/custom#batch-optional) for more info.
* Defaults to `{ multicall: true }`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  batch: { multicall: true }, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### cacheTime

`number | { [_ in chains[number]['id']]?: number | undefined } | undefined`

* Frequency in milliseconds for polling enabled features. See [Viem docs](https://viem.sh/docs/clients/public#cachetime-optional) for more info.
* Defaults to [`pollingInterval`](#pollinginterval) or `4_000`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  cacheTime: 4_000, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### pollingInterval

`number | { [_ in chains[number]['id']]?: number | undefined } | undefined`

* Frequency in milliseconds for polling enabled features. See [Viem docs](https://viem.sh/docs/clients/custom#pollinginterval-optional) for more info.
* Defaults to `4_000`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  pollingInterval: 4_000, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### transports

`Record<chains[number]['id'], Transport>`

Mapping of [chain IDs](#chains) to `Transport`s. This mapping is used internally when creating chain-aware Viem [`Client`](https://viem.sh/docs/clients/custom) objects. See the Transport docs for more info.

```ts-vue
import { createConfig, fallback, http } from '{{packageName}}' // [!code focus]
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: { // [!code focus]
    [mainnet.id]: fallback([ // [!code focus]
      http('https://...'), // [!code focus]
      http('https://...'), // [!code focus]
    ]), // [!code focus]
    [sepolia.id]: http('https://...'), // [!code focus]
  }, // [!code focus]
})
```

***

### client

`(parameters: { chain: chains[number] }) => Client<Transport, chains[number]>`

Function for creating new Viem [`Client`](https://viem.sh/docs/clients/custom) to be used internally. Exposes more control over the internal `Client` creation logic versus using the [`transports`](#transports) property.

```ts-vue
import { createClient, http } from 'viem' // [!code focus]
import { createConfig } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  client({ chain }) { // [!code focus]
    return createClient({ chain, transport: http('https://...') }) // [!code focus]
  }, // [!code focus]
})
```

::: warning
When using this option, you likely want to pass `parameters.chain` straight through to [`createClient`](https://viem.sh/docs/clients/custom#createclient) to ensure the Viem `Client` is in sync with any active connections.
:::

## Return Type

```ts-vue
import { type Config } from '{{packageName}}'
```

## Config

Object responsible for managing Wagmi state and internals.

```ts-vue
import { type Config } from '{{packageName}}'
```

### chains

`readonly [Chain, ...Chain[]]`

[`chains`](#chains) passed to `createConfig`.

### connectors

`readonly Connector[]`

Connectors set up from passing [`connectors`](#connectors) and [`multiInjectedProviderDiscovery`](#multiinjectedproviderdiscovery) to `createConfig`.

### state

`State<chains>`

The `Config` object's internal state. See [`State`](#state-1) for more info.

### storage

`Storage | null`

[`storage`](#storage) passed to `createConfig`.

### getClient

`(parameters?: { chainId?: chainId | chains[number]['id'] | undefined }): Client<transports[chainId], Extract<chains[number], { id: chainId }>>`

Creates new Viem [`Client`](https://viem.sh/docs/clients/custom) object.

::: code-group

```ts-vue [index.ts]
import { config } from './config'

const client = config.getClient({ chainId: 1 })
```

```ts-vue [config.ts]
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

:::

### setState

`(value: State<chains> | ((state: State<chains>) => State<chains>)) => void`

Updates the `Config` object's internal state. See [`State`](#state-1) for more info.

::: code-group

```ts-vue [index.ts]
import { mainnet } from '{{packageName}}/chains'
import { config } from './config'

config.setState((x) => ({
  ...x,
  chainId: x.current ? x.chainId : mainnet.id,
}))
```

```ts-vue [config.ts]
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

:::

::: warning
Exercise caution when using this method. It is intended for internal and advanced use-cases only. Manually setting state can cause unexpected behavior.
:::

### subscribe

`(selector: (state: State<chains>) => state, listener: (selectedState: state, previousSelectedState: state) => void, options?: { emitImmediately?: boolean | undefined; equalityFn?: ((a: state, b: state) => boolean) | undefined } | undefined) => (() => void)`

Listens for state changes matching the `selector` function. Returns a function that can be called to unsubscribe the listener.

::: code-group

```ts-vue [index.ts]
import { config } from './config'

const unsubscribe = config.subscribe(
  (state) => state.chainId,
  (chainId) => console.log(`Chain ID changed to ${chainId}`),
)
unsubscribe()
```

```ts-vue [config.ts]
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

:::

## State

```ts-vue
import { type State } from '{{packageName}}'
```

### chainId

`chains[number]['id']`

Current chain ID. When `syncConnectedChain` is `true`, `chainId` is kept in sync with the current connection. Defaults to first chain in [`chains`](#chains).

### connections

`Map<string, Connection>`

Mapping of unique connector identifier to [`Connection`](#connection) object.

### current

`string | undefined`

Unique identifier of the current connection.

### status

`'connected' | 'connecting' | 'disconnected' | 'reconnecting'`

Current connection status.

* `'connecting'` attempting to establish connection.
* `'reconnecting'` attempting to re-establish connection to one or more connectors.
* `'connected'` at least one connector is connected.
* `'disconnected'` no connection to any connector.

## Connection

```ts-vue
import { type Connection } from '{{packageName}}'
```

### accounts

`readonly [Address, ...Address[]]`

Array of addresses associated with the connection.

### chainId

`number`

Chain ID associated with the connection.

### connector

`Connector`

Connector associated with the connection.

---

---
url: /vue/api/createConfig.md
---

# createConfig

Creates new [`Config`](#config) object.

## Import

```ts-vue
import { createConfig } from '{{packageName}}'
```

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

::: tip Integrating a Viem Client

Instead of using [`transports`](#transports), it's possible to provide a function that returns a Viem [`Client`](https://viem.sh/docs/clients/custom) via the [`client`](#client) property for more fine-grained control over Wagmi's internal `Client` creation.

```ts-vue {3,7-9}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { createClient } from 'viem'

const config = createConfig({
  chains: [mainnet, sepolia],
  client({ chain }) {
    return createClient({ chain, transport: http() })
  },
})
```

:::

## Parameters

```ts-vue
import { type CreateConfigParameters } from '{{packageName}}'
```

### chains

`readonly [Chain, ...Chain[]]`

* Chains used by the `Config`.
* See Chains for more details about built-in chains and the `Chain` type.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia], // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### connectors

`CreateConnectorFn[] | undefined`

Connectors used by the `Config`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { injected } from '{{connectorsPackageName}}' // [!code focus]

const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()], // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### multiInjectedProviderDiscovery

`boolean | undefined`

* Enables discovery of injected providers via [EIP-6963](https://eips.ethereum.org/EIPS/eip-6963) using the [`mipd`](https://github.com/wevm/mipd) library and converting to injected connectors.
* Defaults to `true`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  multiInjectedProviderDiscovery: false, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### ssr

`boolean | undefined`

Flag to indicate if the config is being used in a server-side rendering environment. Defaults to `false`.

```ts-vue
import { createConfig, http } from '{{packageName}}' // [!code focus]
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  ssr: true, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### storage

`Storage | null | undefined`

* `Storage` used by the config. Persists `Config`'s [`State`](#state-1) between sessions.
* Defaults to `createStorage({ storage: typeof window !== 'undefined' && window.localStorage ? window.localStorage : noopStorage })`.

```ts-vue
import { createConfig, createStorage, http } from '{{packageName}}' // [!code focus]
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  storage: createStorage({ storage: window.localStorage }), // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### syncConnectedChain

`boolean | undefined`

* Keep the [`State['chainId']`](#chainid) in sync with the current connection.
* Defaults to `true`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  syncConnectedChain: false, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

***

### batch

`{ multicall?: boolean | { batchSize?: number | undefined; wait?: number | undefined } | undefined } | { [_ in chains[number]["id"]]?: { multicall?: boolean | { batchSize?: number | undefined; wait?: number | undefined } | undefined } | undefined } | undefined`

* Batch settings. See [Viem docs](https://viem.sh/docs/clients/custom#batch-optional) for more info.
* Defaults to `{ multicall: true }`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  batch: { multicall: true }, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### cacheTime

`number | { [_ in chains[number]['id']]?: number | undefined } | undefined`

* Frequency in milliseconds for polling enabled features. See [Viem docs](https://viem.sh/docs/clients/public#cachetime-optional) for more info.
* Defaults to [`pollingInterval`](#pollinginterval) or `4_000`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  cacheTime: 4_000, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### pollingInterval

`number | { [_ in chains[number]['id']]?: number | undefined } | undefined`

* Frequency in milliseconds for polling enabled features. See [Viem docs](https://viem.sh/docs/clients/custom#pollinginterval-optional) for more info.
* Defaults to `4_000`.

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  pollingInterval: 4_000, // [!code focus]
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

### transports

`Record<chains[number]['id'], Transport>`

Mapping of [chain IDs](#chains) to `Transport`s. This mapping is used internally when creating chain-aware Viem [`Client`](https://viem.sh/docs/clients/custom) objects. See the Transport docs for more info.

```ts-vue
import { createConfig, fallback, http } from '{{packageName}}' // [!code focus]
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: { // [!code focus]
    [mainnet.id]: fallback([ // [!code focus]
      http('https://...'), // [!code focus]
      http('https://...'), // [!code focus]
    ]), // [!code focus]
    [sepolia.id]: http('https://...'), // [!code focus]
  }, // [!code focus]
})
```

***

### client

`(parameters: { chain: chains[number] }) => Client<Transport, chains[number]>`

Function for creating new Viem [`Client`](https://viem.sh/docs/clients/custom) to be used internally. Exposes more control over the internal `Client` creation logic versus using the [`transports`](#transports) property.

```ts-vue
import { createClient, http } from 'viem' // [!code focus]
import { createConfig } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  client({ chain }) { // [!code focus]
    return createClient({ chain, transport: http('https://...') }) // [!code focus]
  }, // [!code focus]
})
```

::: warning
When using this option, you likely want to pass `parameters.chain` straight through to [`createClient`](https://viem.sh/docs/clients/custom#createclient) to ensure the Viem `Client` is in sync with any active connections.
:::

## Return Type

```ts-vue
import { type Config } from '{{packageName}}'
```

## Config

Object responsible for managing Wagmi state and internals.

```ts-vue
import { type Config } from '{{packageName}}'
```

### chains

`readonly [Chain, ...Chain[]]`

[`chains`](#chains) passed to `createConfig`.

### connectors

`readonly Connector[]`

Connectors set up from passing [`connectors`](#connectors) and [`multiInjectedProviderDiscovery`](#multiinjectedproviderdiscovery) to `createConfig`.

### state

`State<chains>`

The `Config` object's internal state. See [`State`](#state-1) for more info.

### storage

`Storage | null`

[`storage`](#storage) passed to `createConfig`.

### getClient

`(parameters?: { chainId?: chainId | chains[number]['id'] | undefined }): Client<transports[chainId], Extract<chains[number], { id: chainId }>>`

Creates new Viem [`Client`](https://viem.sh/docs/clients/custom) object.

::: code-group

```ts-vue [index.ts]
import { config } from './config'

const client = config.getClient({ chainId: 1 })
```

```ts-vue [config.ts]
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

:::

### setState

`(value: State<chains> | ((state: State<chains>) => State<chains>)) => void`

Updates the `Config` object's internal state. See [`State`](#state-1) for more info.

::: code-group

```ts-vue [index.ts]
import { mainnet } from '{{packageName}}/chains'
import { config } from './config'

config.setState((x) => ({
  ...x,
  chainId: x.current ? x.chainId : mainnet.id,
}))
```

```ts-vue [config.ts]
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

:::

::: warning
Exercise caution when using this method. It is intended for internal and advanced use-cases only. Manually setting state can cause unexpected behavior.
:::

### subscribe

`(selector: (state: State<chains>) => state, listener: (selectedState: state, previousSelectedState: state) => void, options?: { emitImmediately?: boolean | undefined; equalityFn?: ((a: state, b: state) => boolean) | undefined } | undefined) => (() => void)`

Listens for state changes matching the `selector` function. Returns a function that can be called to unsubscribe the listener.

::: code-group

```ts-vue [index.ts]
import { config } from './config'

const unsubscribe = config.subscribe(
  (state) => state.chainId,
  (chainId) => console.log(`Chain ID changed to ${chainId}`),
)
unsubscribe()
```

```ts-vue [config.ts]
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http('https://mainnet.example.com'),
    [sepolia.id]: http('https://sepolia.example.com'),
  },
})
```

:::

## State

```ts-vue
import { type State } from '{{packageName}}'
```

### chainId

`chains[number]['id']`

Current chain ID. When `syncConnectedChain` is `true`, `chainId` is kept in sync with the current connection. Defaults to first chain in [`chains`](#chains).

### connections

`Map<string, Connection>`

Mapping of unique connector identifier to [`Connection`](#connection) object.

### current

`string | undefined`

Unique identifier of the current connection.

### status

`'connected' | 'connecting' | 'disconnected' | 'reconnecting'`

Current connection status.

* `'connecting'` attempting to establish connection.
* `'reconnecting'` attempting to re-establish connection to one or more connectors.
* `'connected'` at least one connector is connected.
* `'disconnected'` no connection to any connector.

## Connection

```ts-vue
import { type Connection } from '{{packageName}}'
```

### accounts

`readonly [Address, ...Address[]]`

Array of addresses associated with the connection.

### chainId

`number`

Chain ID associated with the connection.

### connector

`Connector`

Connector associated with the connection.

---

---
url: /core/api/createConnector.md
---
# createConnector

Creates new [`CreateConnectorFn`](#parameters).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/createConnector.md","from":85,"to":131}<fsm-vh3gqscxm4e>
import { createConnector } from '@wagmi/core'
```

## Usage

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/createConnector.md","from":152,"to":359}<fsm-vh3gqscxm4e>
import { createConnector } from '@wagmi/core'

export type InjectedParameters = {}

export function injected(parameters: InjectedParameters = {}) {
  return createConnector((config) => ({
    // ...
  }))
}
```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/createConnector.md","from":385,"to":438}<fsm-vh3gqscxm4e>
import { type CreateConnectorFn } from '@wagmi/core'
```

Read [Creating Connectors](/dev/creating-connectors) for more info on the `CreateConnectorFn` type.

---

---
url: /core/api/createStorage.md
---

# createStorage

Creates new [`Storage`](#storage) object.

## Import

```ts-vue
import { createStorage } from '{{packageName}}'
```

## Usage

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
```

## Parameters

```ts-vue
import { type CreateStorageParameters } from '{{packageName}}'
```

### deserialize

`(<T>(value: string) => T) | undefined`

* Function to deserialize data from storage.
* Defaults to `deserialize`.

```ts-vue
import { createStorage, deserialize } from '{{packageName}}' // [!code focus]

const storage = createStorage({
  deserialize, // [!code focus]
  storage: localStorage,
})
```

::: warning
If you use a custom `deserialize` function, make sure it can handle `bigint` and `Map` values.
:::

### key

`string | undefined`

* Key prefix to use when persisting data.
* Defaults to `'wagmi'`.

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({
  key: 'my-app', // [!code focus]
  storage: localStorage,
})
```

### serialize

`(<T>(value: T) => string) | undefined`

* Function to serialize data for storage.
* Defaults to `serialize`.

```ts-vue
import { createStorage, serialize } from '{{packageName}}' // [!code focus]

const storage = createStorage({
  serialize, // [!code focus]
  storage: localStorage,
})
```

::: warning
If you use a custom `serialize` function, make sure it can handle `bigint` and `Map` values.
:::

### storage

`{ getItem(key: string): string | null | undefined | Promise<string | null | undefined>; setItem(key: string, value: string): void | Promise<void>; removeItem(key: string): void | Promise<void>; }`

* Storage interface to use for persisting data.
* Defaults to `localStorage`.
* Supports synchronous and asynchronous storage methods.

```ts-vue
import { createStorage } from '{{packageName}}'
// Using IndexedDB via https://github.com/jakearchibald/idb-keyval // [!code focus]
import { del, get, set } from 'idb-keyval' // [!code focus]

const storage = createStorage({
  storage: { // [!code focus]
    async getItem(name) { // [!code focus]
      return get(name)// [!code focus]
    }, // [!code focus]
    async setItem(name, value) { // [!code focus]
      await set(name, value) // [!code focus]
    }, // [!code focus]
    async removeItem(name) { // [!code focus]
      await del(name) // [!code focus]
    }, // [!code focus]
  }, // [!code focus]
})
```

## Return Type

```ts-vue
import { type Storage } from '{{packageName}}'
```

## Storage

Object responsible for persisting Wagmi `State` and other data.

```ts-vue
import { type Storage } from '{{packageName}}'
```

### getItem

`getItem(key: string, defaultValue?: value | null | undefined): value | null | Promise<value | null>`

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
const recentConnectorId = storage.getItem('recentConnectorId') // [!code focus]
```

### setItem

`setItem(key: string, value: any): void | Promise<void>`

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
storage.setItem('recentConnectorId', 'foo') // [!code focus]
```

### removeItem

`removeItem(key: string): void | Promise<void>`

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
storage.removeItem('recentConnectorId') // [!code focus]
```

---

---
url: /react/api/createStorage.md
---

# createStorage

Creates new [`Storage`](#storage) object.

## Import

```ts-vue
import { createStorage } from '{{packageName}}'
```

## Usage

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
```

## Parameters

```ts-vue
import { type CreateStorageParameters } from '{{packageName}}'
```

### deserialize

`(<T>(value: string) => T) | undefined`

* Function to deserialize data from storage.
* Defaults to `deserialize`.

```ts-vue
import { createStorage, deserialize } from '{{packageName}}' // [!code focus]

const storage = createStorage({
  deserialize, // [!code focus]
  storage: localStorage,
})
```

::: warning
If you use a custom `deserialize` function, make sure it can handle `bigint` and `Map` values.
:::

### key

`string | undefined`

* Key prefix to use when persisting data.
* Defaults to `'wagmi'`.

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({
  key: 'my-app', // [!code focus]
  storage: localStorage,
})
```

### serialize

`(<T>(value: T) => string) | undefined`

* Function to serialize data for storage.
* Defaults to `serialize`.

```ts-vue
import { createStorage, serialize } from '{{packageName}}' // [!code focus]

const storage = createStorage({
  serialize, // [!code focus]
  storage: localStorage,
})
```

::: warning
If you use a custom `serialize` function, make sure it can handle `bigint` and `Map` values.
:::

### storage

`{ getItem(key: string): string | null | undefined | Promise<string | null | undefined>; setItem(key: string, value: string): void | Promise<void>; removeItem(key: string): void | Promise<void>; }`

* Storage interface to use for persisting data.
* Defaults to `localStorage`.
* Supports synchronous and asynchronous storage methods.

```ts-vue
import { createStorage } from '{{packageName}}'
// Using IndexedDB via https://github.com/jakearchibald/idb-keyval // [!code focus]
import { del, get, set } from 'idb-keyval' // [!code focus]

const storage = createStorage({
  storage: { // [!code focus]
    async getItem(name) { // [!code focus]
      return get(name)// [!code focus]
    }, // [!code focus]
    async setItem(name, value) { // [!code focus]
      await set(name, value) // [!code focus]
    }, // [!code focus]
    async removeItem(name) { // [!code focus]
      await del(name) // [!code focus]
    }, // [!code focus]
  }, // [!code focus]
})
```

## Return Type

```ts-vue
import { type Storage } from '{{packageName}}'
```

## Storage

Object responsible for persisting Wagmi `State` and other data.

```ts-vue
import { type Storage } from '{{packageName}}'
```

### getItem

`getItem(key: string, defaultValue?: value | null | undefined): value | null | Promise<value | null>`

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
const recentConnectorId = storage.getItem('recentConnectorId') // [!code focus]
```

### setItem

`setItem(key: string, value: any): void | Promise<void>`

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
storage.setItem('recentConnectorId', 'foo') // [!code focus]
```

### removeItem

`removeItem(key: string): void | Promise<void>`

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
storage.removeItem('recentConnectorId') // [!code focus]
```

---

---
url: /shared/createStorage.md
---
# createStorage

Creates new [`Storage`](#storage) object.

## Import

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createStorage.md","from":169,"to":217}<fsm-vh3gqscxm4e>
import { createStorage } from '{{packageName}}'
```

## Usage

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createStorage.md","from":242,"to":348}<fsm-vh3gqscxm4e>
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
```

## Parameters

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createStorage.md","from":378,"to":441}<fsm-vh3gqscxm4e>
import { type CreateStorageParameters } from '{{packageName}}'
```

### deserialize

`(<T>(value: string) => T) | undefined`

* Function to deserialize data from storage.
* Defaults to `deserialize`.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createStorage.md","from":645,"to":816}<fsm-vh3gqscxm4e>
import { createStorage, deserialize } from '{{packageName}}' // [!code focus]

const storage = createStorage({
  deserialize, // [!code focus]
  storage: localStorage,
})
```

::: warning
If you use a custom `deserialize` function, make sure it can handle `bigint` and `Map` values.
:::

### key

`string | undefined`

* Key prefix to use when persisting data.
* Defaults to `'wagmi'`.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createStorage.md","from":1042,"to":1185}<fsm-vh3gqscxm4e>
import { createStorage } from '{{packageName}}'

const storage = createStorage({
  key: 'my-app', // [!code focus]
  storage: localStorage,
})
```

### serialize

`(<T>(value: T) => string) | undefined`

* Function to serialize data for storage.
* Defaults to `serialize`.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createStorage.md","from":1380,"to":1547}<fsm-vh3gqscxm4e>
import { createStorage, serialize } from '{{packageName}}' // [!code focus]

const storage = createStorage({
  serialize, // [!code focus]
  storage: localStorage,
})
```

::: warning
If you use a custom `serialize` function, make sure it can handle `bigint` and `Map` values.
:::

### storage

`{ getItem(key: string): string | null | undefined | Promise<string | null | undefined>; setItem(key: string, value: string): void | Promise<void>; removeItem(key: string): void | Promise<void>; }`

* Storage interface to use for persisting data.
* Defaults to `localStorage`.
* Supports synchronous and asynchronous storage methods.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createStorage.md","from":2020,"to":2635}<fsm-vh3gqscxm4e>
import { createStorage } from '{{packageName}}'
// Using IndexedDB via https://github.com/jakearchibald/idb-keyval // [!code focus]
import { del, get, set } from 'idb-keyval' // [!code focus]

const storage = createStorage({
  storage: { // [!code focus]
    async getItem(name) { // [!code focus]
      return get(name)// [!code focus]
    }, // [!code focus]
    async setItem(name, value) { // [!code focus]
      await set(name, value) // [!code focus]
    }, // [!code focus]
    async removeItem(name) { // [!code focus]
      await del(name) // [!code focus]
    }, // [!code focus]
  }, // [!code focus]
})
```

## Return Type

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createStorage.md","from":2666,"to":2713}<fsm-vh3gqscxm4e>
import { type Storage } from '{{packageName}}'
```

## Storage

Object responsible for persisting Wagmi `State` and other data.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createStorage.md","from":2860,"to":2907}<fsm-vh3gqscxm4e>
import { type Storage } from '{{packageName}}'
```

### getItem

`getItem(key: string, defaultValue?: value | null | undefined): value | null | Promise<value | null>`

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createStorage.md","from":3038,"to":3224}<fsm-vh3gqscxm4e>
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
const recentConnectorId = storage.getItem('recentConnectorId') // [!code focus]
```

### setItem

`setItem(key: string, value: any): void | Promise<void>`

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createStorage.md","from":3310,"to":3477}<fsm-vh3gqscxm4e>
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
storage.setItem('recentConnectorId', 'foo') // [!code focus]
```

### removeItem

`removeItem(key: string): void | Promise<void>`

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/createStorage.md","from":3557,"to":3720}<fsm-vh3gqscxm4e>
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
storage.removeItem('recentConnectorId') // [!code focus]
```

---

---
url: /solid/api/createStorage.md
---

# createStorage

Creates new [`Storage`](#storage) object.

## Import

```ts-vue
import { createStorage } from '{{packageName}}'
```

## Usage

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
```

## Parameters

```ts-vue
import { type CreateStorageParameters } from '{{packageName}}'
```

### deserialize

`(<T>(value: string) => T) | undefined`

* Function to deserialize data from storage.
* Defaults to `deserialize`.

```ts-vue
import { createStorage, deserialize } from '{{packageName}}' // [!code focus]

const storage = createStorage({
  deserialize, // [!code focus]
  storage: localStorage,
})
```

::: warning
If you use a custom `deserialize` function, make sure it can handle `bigint` and `Map` values.
:::

### key

`string | undefined`

* Key prefix to use when persisting data.
* Defaults to `'wagmi'`.

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({
  key: 'my-app', // [!code focus]
  storage: localStorage,
})
```

### serialize

`(<T>(value: T) => string) | undefined`

* Function to serialize data for storage.
* Defaults to `serialize`.

```ts-vue
import { createStorage, serialize } from '{{packageName}}' // [!code focus]

const storage = createStorage({
  serialize, // [!code focus]
  storage: localStorage,
})
```

::: warning
If you use a custom `serialize` function, make sure it can handle `bigint` and `Map` values.
:::

### storage

`{ getItem(key: string): string | null | undefined | Promise<string | null | undefined>; setItem(key: string, value: string): void | Promise<void>; removeItem(key: string): void | Promise<void>; }`

* Storage interface to use for persisting data.
* Defaults to `localStorage`.
* Supports synchronous and asynchronous storage methods.

```ts-vue
import { createStorage } from '{{packageName}}'
// Using IndexedDB via https://github.com/jakearchibald/idb-keyval // [!code focus]
import { del, get, set } from 'idb-keyval' // [!code focus]

const storage = createStorage({
  storage: { // [!code focus]
    async getItem(name) { // [!code focus]
      return get(name)// [!code focus]
    }, // [!code focus]
    async setItem(name, value) { // [!code focus]
      await set(name, value) // [!code focus]
    }, // [!code focus]
    async removeItem(name) { // [!code focus]
      await del(name) // [!code focus]
    }, // [!code focus]
  }, // [!code focus]
})
```

## Return Type

```ts-vue
import { type Storage } from '{{packageName}}'
```

## Storage

Object responsible for persisting Wagmi `State` and other data.

```ts-vue
import { type Storage } from '{{packageName}}'
```

### getItem

`getItem(key: string, defaultValue?: value | null | undefined): value | null | Promise<value | null>`

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
const recentConnectorId = storage.getItem('recentConnectorId') // [!code focus]
```

### setItem

`setItem(key: string, value: any): void | Promise<void>`

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
storage.setItem('recentConnectorId', 'foo') // [!code focus]
```

### removeItem

`removeItem(key: string): void | Promise<void>`

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
storage.removeItem('recentConnectorId') // [!code focus]
```

---

---
url: /vue/api/createStorage.md
---

# createStorage

Creates new [`Storage`](#storage) object.

## Import

```ts-vue
import { createStorage } from '{{packageName}}'
```

## Usage

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
```

## Parameters

```ts-vue
import { type CreateStorageParameters } from '{{packageName}}'
```

### deserialize

`(<T>(value: string) => T) | undefined`

* Function to deserialize data from storage.
* Defaults to `deserialize`.

```ts-vue
import { createStorage, deserialize } from '{{packageName}}' // [!code focus]

const storage = createStorage({
  deserialize, // [!code focus]
  storage: localStorage,
})
```

::: warning
If you use a custom `deserialize` function, make sure it can handle `bigint` and `Map` values.
:::

### key

`string | undefined`

* Key prefix to use when persisting data.
* Defaults to `'wagmi'`.

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({
  key: 'my-app', // [!code focus]
  storage: localStorage,
})
```

### serialize

`(<T>(value: T) => string) | undefined`

* Function to serialize data for storage.
* Defaults to `serialize`.

```ts-vue
import { createStorage, serialize } from '{{packageName}}' // [!code focus]

const storage = createStorage({
  serialize, // [!code focus]
  storage: localStorage,
})
```

::: warning
If you use a custom `serialize` function, make sure it can handle `bigint` and `Map` values.
:::

### storage

`{ getItem(key: string): string | null | undefined | Promise<string | null | undefined>; setItem(key: string, value: string): void | Promise<void>; removeItem(key: string): void | Promise<void>; }`

* Storage interface to use for persisting data.
* Defaults to `localStorage`.
* Supports synchronous and asynchronous storage methods.

```ts-vue
import { createStorage } from '{{packageName}}'
// Using IndexedDB via https://github.com/jakearchibald/idb-keyval // [!code focus]
import { del, get, set } from 'idb-keyval' // [!code focus]

const storage = createStorage({
  storage: { // [!code focus]
    async getItem(name) { // [!code focus]
      return get(name)// [!code focus]
    }, // [!code focus]
    async setItem(name, value) { // [!code focus]
      await set(name, value) // [!code focus]
    }, // [!code focus]
    async removeItem(name) { // [!code focus]
      await del(name) // [!code focus]
    }, // [!code focus]
  }, // [!code focus]
})
```

## Return Type

```ts-vue
import { type Storage } from '{{packageName}}'
```

## Storage

Object responsible for persisting Wagmi `State` and other data.

```ts-vue
import { type Storage } from '{{packageName}}'
```

### getItem

`getItem(key: string, defaultValue?: value | null | undefined): value | null | Promise<value | null>`

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
const recentConnectorId = storage.getItem('recentConnectorId') // [!code focus]
```

### setItem

`setItem(key: string, value: any): void | Promise<void>`

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
storage.setItem('recentConnectorId', 'foo') // [!code focus]
```

### removeItem

`removeItem(key: string): void | Promise<void>`

```ts-vue
import { createStorage } from '{{packageName}}'

const storage = createStorage({ storage: localStorage })
storage.removeItem('recentConnectorId') // [!code focus]
```

---

---
url: /dev/creating-connectors.md
---
# Creating Connectors

Thanks for your interest in adding a new connector to Wagmi! Please take a moment to review this document **before starting work on a new connector.**

## Overview

This guide details how to create new connectors and upstream them back into Wagmi. By following these steps, you will understand the development process, workflow, and requirements for new connectors. **Not all connectors will be accepted into Wagmi** for a variety of reasons outlined in this document.

In addition, for connector requests to be accepted, the team creating the connector must [sponsor Wagmi](https://github.com/sponsors/wevm). It takes time and effort to maintain third-party connectors. Wagmi is an OSS project that depends on sponsors and grants to continue our work. Please get in touch via <dev@wevm.dev> if you have questions about sponsoring.

::: warning **Please ask first before starting work on a new connector.**
To avoid having your pull request declined after investing time and effort into a new connector, we ask that contributors create a [Connector Request](https://github.com/wevm/wagmi/discussions/new?category=connector-request) before starting work. This ensures the connector solves for an important or general use-case of interest to Wagmi users and is well supported by the Wagmi and connector teams.
:::

## 1. Follow the contributing guide

Check out the [Contributing Guide](/dev/contributing) to get your local development environment set up and learn more about the contributing workflow.

## 2. Create a new file for the connector

Create a new file in `packages/connectors/src` named after the connector you want to add.

For example, if you want to add Foo, you would create a file named `foo.ts`. File names should be camel-cased and as short as possible.

## 3. Create the connector object.

Import `createConnector` from `@wagmi/core` and export a new function that accepts a parameters object and returns the `createConnector` result. This is the base of all connectors. The name of the connector name should be the same as the file name.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/dev/creating-connectors.md","from":2109,"to":2305}<fsm-vh3gqscxm4e>
import { createConnector } from '@wagmi/core'

export type FooBarBazParameters = {}

export function fooBarBaz(parameters: FooBarBazParameters = {}) {
  return createConnector((config) => ({}))
}
```

## 4. Add the missing properties to the object

Now that the base of the connector is set up, you should see a type error that looks something like this:

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/dev/creating-connectors.md","from":2480,"to":4138}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"51529c3efa008aca29b1a99d6189d29f0675b46bfd307c0fa712fc44cfd1d5b5","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIBjUjGY0AwhDBgY/NBFIAeAK5gA1pADuYCrwBK0uVHlw0pdmADm25WoiaAfNr38DRk2cu9rGsA96ihIjDiktKypABiYEqq3o76pIbGphZWMbY+cc4JrskeXul2hYyCwmISUjJykYh+AWUhlRFR+ZqZLknuqTb2bdkdKZ5p9nbcNf6lQeWhVc1DWrrxiW4DLRkLWUu5Xd6FADpg7AC2WHJoAnWTDWGUIMbMpAyIAAxUrDAWaPhIAIwArFRoe7mGCPEAlQLBCrXV5mXDPKj8fD3ZgyMhIJ4AXwo6GwcIIxDRALooMYWGRhxBZD4zjAADN2OYasB9rxWQIkWY4DUAlAJKwMLxkKIOfMAHTi4XMMzIAC6MoA3Cy2TBDuw0DRSDUAKKq9VkeSQ6akLUkMBoACyzCwdkVYDZvGMcmYwIA/EylfbWSoYBgav1zLbPWzgWgAJI0Q41eTegXE95QOAO5YeIhsRQwXhxsAJ3iMADKYWdMHDKstWF4ADJ1u1k9sCtxkDGZdpYLTmIpWGgAGppjNZnOp1jp3gAH14YA7rFHg1bsKgdkYMZqMZbMDbHe7vbdvFb7c7PaHGbHylnUigfAAvHZc7uNwfh/3ExPWFOXbxB8Ox8+pzUPzA+GOAAKpAQKqcAwPIt77r2mb0PGT6Trwb5/tO368L+vY2h6nrgWGEZRjGsE0Nmib+toKGPrmBZOsCJaHGWlbVtk4qiiMjY+jKqGTguS68Cu769hhh6XteRAQOwUDTsBoHsOB8hiRJWF2kGvBCIcBJ0TUi4+n6yYie+4mSUBIFgRBCnzoGbIYlxL7Tiea5zpZrImMwYBwCcDxwNuTguBOhwAEZkNoAAqpCue5pzXse2YOWetoYjcdwPD8ADsrzvOYnxIAAbACQIgngNL0uYNwcFI6IIkiYWouQiDfClWI4jgeBkCB5BUEljwAEwABzpR8XyIAALAi0Bwl1KVDS8ID0m8YDMBSeBmLAtCimgCBUBJLWkKQAC0E1Tbt3xPENu1DTcND0HgwW4rwADkwAYndvCybwYFwO4vCfBmtIQC+tifVgIE4A87DwLwtImV9t0PYKtC6bkMo1Ks8qqcIvJgPyL00tu/p2TF9JxWjzAY1jEkI+4qM8nyArzRSFMWFT6M06pUBubjybTtTmMCv6sr46eMBQEzJMs5gOAMwGDogooWDbowjD6dJpnyYZIwC7FQuoyxvDfF1b1yBmLGoxI5rwHARby4wFJwBbwI1NJRASWQZu20W+nmQBM6a8LvBPTUEnaHTMDaOLIcCFMMjaK5kk9QbQiiqVMAkKw21taVsIVWCVUohqSC9RizZgmNhUXIajQK0VDL6Ywj3cNwNwUoCSCgFmH0SHg60gBiGJAA=="}
// @errors: 2740
import { createConnector } from '@wagmi/core'
// ---cut---
createConnector((config) => ({}))
```

The type error tells you what properties are missing from `createConnector`'s return type. Add them all in!

#### Properties

* `icon`: Optional icon URL for the connector.
* `id`: The ID for the connector. This should be camel-cased and as short as possible. Example: `fooBarBaz`.
* `name`: Human-readable name for the connector. Example: `'Foo Bar Baz'`.
* `rdns`: Optional reverse DNS for the connector. This is used to filter out duplicate [EIP-6963](https://eips.ethereum.org/EIPS/eip-6963) injected providers when `createConfig#multiInjectedProviderDiscovery` is enabled.

#### Methods

* `connect`: Function for connecting the connector.
* `disconnect`: Function for disconnecting the connector.
* `getAccounts`: Function that returns the connected accounts for the connector.
* `getChainId`: Function that returns the connected chain ID for the connector.
* `getProvider`: Function that returns the underlying provider interface for internal use throughout the connector.
* `isAuthorized`: Function that returns whether the connector has connected previously and is still authorized.
* `setup`: Optional function for running when the connector is first created.
* `switchChain`: Optional function for switching the connector's active chain.

#### Events

* `onAccountsChanged`: Function for subscribing to account changes internally in the connector.
* `onChainChanged`: Function for subscribing to chain changes internally in the connector.
* `onConnect`: Function for subscribing to connection events internally in the connector.
* `onDisconnect`: Function for subscribing to disconnection events internally in the connector.
* `onMessage`: Optional function for subscribing to messages internally in the connector.

#### Parameters

`createConnector` also has the following config properties you can use within the connector:

* `chains`: List of chains configured by the user.
* `emitter`: Emitter for emitting events. Used to sync connector state with Wagmi `Config`. The following events are available:
  * `change`: Emitted when the connected accounts or chain changes.
  * `connect`: Emitted when the connector connects.
  * `disconnect`: Emitted when the connector disconnects.
  * `error`: Emitted when the connector receives an error.
  * `message`: Emitted when the connector receives a message.
* `storage`: Optional storage configured by the user. Defaults to wrapper around localStorage.

::: tip
If you plan to use a third-party SDK, it should have minimal dependencies (limit bundle size, supply chain attacks, etc.) and use the most permissive license possible (ideally MIT). Any third-party packages, should also have [`"sideEffects": false`](https://webpack.js.org/guides/tree-shaking/#mark-the-file-as-side-effect-free) in their `package.json` file for maximum tree-shakability support.
:::

::: tip
All address values returned and emitted by the connector should be checksummed using Viem's [`getAddress`](https://viem.sh/docs/utilities/getAddress).
:::

## 5. Export the connector

Export the connector from `packages/connectors/src/exports/index.ts` in alphabetic order.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/dev/creating-connectors.md","from":7253,"to":7296}<fsm-vh3gqscxm4e>
export { fooBarBaz } from './fooBarBaz.js'
```

## 6. Try out the connector and add tests

While building a connector, it can be useful to try it out with Wagmi. You can use the [development playgrounds](/dev/contributing#_5-running-the-dev-playgrounds) for testing your changes.

Ideally, you should also be able to add tests for the connector in a `connectorName.test.ts` file. This isn't always easy so at a minimum please create a test file with instructions for how to test the connector manually. The test file should include actual tests or "instruction tests" for the following:

* How to connect the connector.
* How to disconnect the connector.
* How to switch the connector's active chain (if applicable).

Remember to include all info required to test the connector, like software to install (browser extension, mobile app, etc.), smart contracts to interact with/deploy, etc.

Finally, you should also update the test file in `packages/connectors/src/exports/index.test.ts` to include the new connector. You can do this manually or by running:

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/dev/creating-connectors.md","from":8319,"to":8382}<fsm-vh3gqscxm4e>
pnpm test:update packages/connectors/src/exports/index.test.ts
```

## 7. Add your team to CODEOWNERS

It is critical that connectors are updated in a timely manner and actively maintained so that users of Wagmi can rely on them in production settings.

The Wagmi core team will provide as much assistance as possible to keep connectors up-to-date with breaking changes from Wagmi, but it is your responsibility to ensure that any dependencies and issues/discussions related to the connector are handled in a timely manner. If issues are not resolved in a timely manner, the connector may be removed from Wagmi.

In support of this goal, add at least one member of your team to the [CODEOWNERS](https://github.com/wevm/wagmi/blob/main/.github/CODEOWNERS) file so that you get notified of pull requests, issues, etc. related to the connector. You can add your team like this:

```
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/dev/creating-connectors.md","from":9199,"to":9245}<fsm-vh3gqscxm4e>
/packages/connectors/src/fooBarBaz @tmm @jxom
```

For more info about GitHub code owners, check out the [GitHub Documentation](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).

## 8. Document the connector

The connector should be documented. Follow the step on [writing documentation](/dev/contributing#_7-writing-documentation) to get set up with running the docs site locally and add the required pages.

## 9. Create a changeset

Now that the connector works and has tests, it's time to create a changeset to prepare for release. Run the following to create a changeset:

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/dev/creating-connectors.md","from":9871,"to":9886}<fsm-vh3gqscxm4e>
pnpm changeset
```

The changeset should be a `patch` applied to the `@wagmi/connectors` repository with the description `Added [ConnectorName]`, For example, `Added Foo Bar Baz`.

## 10. Create a pull request

The connector is ready to go! Create a [pull request](/dev/contributing#_8-submitting-a-pull-request) and the connector should make it into a future release of Wagmi after some review.

---

---
url: /core/api/transports/custom.md
---

# custom

The `custom` Transport connects to a JSON-RPC API via custom. Wraps Viem's [`custom` Transport](https://viem.sh/docs/clients/transports/custom).

## Import

```ts-vue
import { custom } from '{{packageName}}'
```

## Usage

```ts-vue
import { 
  createConfig, 
  custom // [!code hl]
} from '{{packageName}}'
import { mainnet } from '{{packageName}}/chains'
import { customRpc } from './rpc'

export const config = createConfig({
  chains: [mainnet],
  connectors: [injected()],
  transports: {
    [mainnet.id]: custom({ // [!code hl]
      async request({ method, params }) { // [!code hl]
        const response = await customRpc.request(method, params) // [!code hl]
        return response // [!code hl]
      } // [!code hl]
    }) // [!code hl]
  },
})
```

## Parameters

### provider

`{ request({ method: string, params: unknown[] }): Promise<unknown> }`

An [EIP-1193 `request` function](https://eips.ethereum.org/EIPS/eip-1193#request) function.

```ts
import { customRpc } from './rpc'

const transport = custom({
  async request({ method, params }) { // [!code focus:3]
    const response = await customRpc.request(method, params)
    return response
  }
})
```

### key (optional)

`string`

A key for the Transport. Defaults to `"custom"`.

```ts
const transport = custom(
  provider,
  { 
    key: 'windowProvider', // [!code focus]
  }
)
```

### name (optional)

`string`

A name for the Transport. Defaults to `"Ethereum Provider"`.

```ts
const transport = custom(
  provider,
  { 
    name: 'Window Ethereum Provider', // [!code focus]
  }
)
```

### retryCount (optional)

`number`

The max number of times to retry when a request fails. Defaults to `3`.

```ts
const transport = custom(provider, {
  retryCount: 5, // [!code focus]
})
```

### retryDelay (optional)

`number`

The base delay (in ms) between retries. By default, the Transport will use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) (`~~(1 << count) * retryDelay`), which means the time between retries is not constant.

```ts
const transport = custom(provider, {
  retryDelay: 100, // [!code focus]
})
```

---

---
url: /react/api/transports/custom.md
---

# custom

The `custom` Transport connects to a JSON-RPC API via custom. Wraps Viem's [`custom` Transport](https://viem.sh/docs/clients/transports/custom).

## Import

```ts-vue
import { custom } from '{{packageName}}'
```

## Usage

```ts-vue
import { 
  createConfig, 
  custom // [!code hl]
} from '{{packageName}}'
import { mainnet } from '{{packageName}}/chains'
import { customRpc } from './rpc'

export const config = createConfig({
  chains: [mainnet],
  connectors: [injected()],
  transports: {
    [mainnet.id]: custom({ // [!code hl]
      async request({ method, params }) { // [!code hl]
        const response = await customRpc.request(method, params) // [!code hl]
        return response // [!code hl]
      } // [!code hl]
    }) // [!code hl]
  },
})
```

## Parameters

### provider

`{ request({ method: string, params: unknown[] }): Promise<unknown> }`

An [EIP-1193 `request` function](https://eips.ethereum.org/EIPS/eip-1193#request) function.

```ts
import { customRpc } from './rpc'

const transport = custom({
  async request({ method, params }) { // [!code focus:3]
    const response = await customRpc.request(method, params)
    return response
  }
})
```

### key (optional)

`string`

A key for the Transport. Defaults to `"custom"`.

```ts
const transport = custom(
  provider,
  { 
    key: 'windowProvider', // [!code focus]
  }
)
```

### name (optional)

`string`

A name for the Transport. Defaults to `"Ethereum Provider"`.

```ts
const transport = custom(
  provider,
  { 
    name: 'Window Ethereum Provider', // [!code focus]
  }
)
```

### retryCount (optional)

`number`

The max number of times to retry when a request fails. Defaults to `3`.

```ts
const transport = custom(provider, {
  retryCount: 5, // [!code focus]
})
```

### retryDelay (optional)

`number`

The base delay (in ms) between retries. By default, the Transport will use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) (`~~(1 << count) * retryDelay`), which means the time between retries is not constant.

```ts
const transport = custom(provider, {
  retryDelay: 100, // [!code focus]
})
```

---

---
url: /shared/transports/custom.md
---
# custom

The `custom` Transport connects to a JSON-RPC API via custom. Wraps Viem's [`custom` Transport](https://viem.sh/docs/clients/transports/custom).

## Import

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/custom.md","from":240,"to":281}<fsm-vh3gqscxm4e>
import { custom } from '{{packageName}}'
```

## Usage

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/custom.md","from":306,"to":832}<fsm-vh3gqscxm4e>
import { 
  createConfig, 
  custom // [!code hl]
} from '{{packageName}}'
import { mainnet } from '{{packageName}}/chains'
import { customRpc } from './rpc'

export const config = createConfig({
  chains: [mainnet],
  connectors: [injected()],
  transports: {
    [mainnet.id]: custom({ // [!code hl]
      async request({ method, params }) { // [!code hl]
        const response = await customRpc.request(method, params) // [!code hl]
        return response // [!code hl]
      } // [!code hl]
    }) // [!code hl]
  },
})
```

## Parameters

### provider

`{ request({ method: string, params: unknown[] }): Promise<unknown> }`

An [EIP-1193 `request` function](https://eips.ethereum.org/EIPS/eip-1193#request) function.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/custom.md","from":1037,"to":1244}<fsm-vh3gqscxm4e>
import { customRpc } from './rpc'

const transport = custom({
  async request({ method, params }) { // [!code focus:3]
    const response = await customRpc.request(method, params)
    return response
  }
})
```

### key (optional)

`string`

A key for the Transport. Defaults to `"custom"`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/custom.md","from":1335,"to":1428}<fsm-vh3gqscxm4e>
const transport = custom(
  provider,
  { 
    key: 'windowProvider', // [!code focus]
  }
)
```

### name (optional)

`string`

A name for the Transport. Defaults to `"Ethereum Provider"`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/custom.md","from":1532,"to":1636}<fsm-vh3gqscxm4e>
const transport = custom(
  provider,
  { 
    name: 'Window Ethereum Provider', // [!code focus]
  }
)
```

### retryCount (optional)

`number`

The max number of times to retry when a request fails. Defaults to `3`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/custom.md","from":1757,"to":1831}<fsm-vh3gqscxm4e>
const transport = custom(provider, {
  retryCount: 5, // [!code focus]
})
```

### retryDelay (optional)

`number`

The base delay (in ms) between retries. By default, the Transport will use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) (`~~(1 << count) * retryDelay`), which means the time between retries is not constant.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/custom.md","from":2115,"to":2191}<fsm-vh3gqscxm4e>
const transport = custom(provider, {
  retryDelay: 100, // [!code focus]
})
```

---

---
url: /solid/api/transports/custom.md
---

# custom

The `custom` Transport connects to a JSON-RPC API via custom. Wraps Viem's [`custom` Transport](https://viem.sh/docs/clients/transports/custom).

## Import

```ts-vue
import { custom } from '{{packageName}}'
```

## Usage

```ts-vue
import { 
  createConfig, 
  custom // [!code hl]
} from '{{packageName}}'
import { mainnet } from '{{packageName}}/chains'
import { customRpc } from './rpc'

export const config = createConfig({
  chains: [mainnet],
  connectors: [injected()],
  transports: {
    [mainnet.id]: custom({ // [!code hl]
      async request({ method, params }) { // [!code hl]
        const response = await customRpc.request(method, params) // [!code hl]
        return response // [!code hl]
      } // [!code hl]
    }) // [!code hl]
  },
})
```

## Parameters

### provider

`{ request({ method: string, params: unknown[] }): Promise<unknown> }`

An [EIP-1193 `request` function](https://eips.ethereum.org/EIPS/eip-1193#request) function.

```ts
import { customRpc } from './rpc'

const transport = custom({
  async request({ method, params }) { // [!code focus:3]
    const response = await customRpc.request(method, params)
    return response
  }
})
```

### key (optional)

`string`

A key for the Transport. Defaults to `"custom"`.

```ts
const transport = custom(
  provider,
  { 
    key: 'windowProvider', // [!code focus]
  }
)
```

### name (optional)

`string`

A name for the Transport. Defaults to `"Ethereum Provider"`.

```ts
const transport = custom(
  provider,
  { 
    name: 'Window Ethereum Provider', // [!code focus]
  }
)
```

### retryCount (optional)

`number`

The max number of times to retry when a request fails. Defaults to `3`.

```ts
const transport = custom(provider, {
  retryCount: 5, // [!code focus]
})
```

### retryDelay (optional)

`number`

The base delay (in ms) between retries. By default, the Transport will use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) (`~~(1 << count) * retryDelay`), which means the time between retries is not constant.

```ts
const transport = custom(provider, {
  retryDelay: 100, // [!code focus]
})
```

---

---
url: /vue/api/transports/custom.md
---

# custom

The `custom` Transport connects to a JSON-RPC API via custom. Wraps Viem's [`custom` Transport](https://viem.sh/docs/clients/transports/custom).

## Import

```ts-vue
import { custom } from '{{packageName}}'
```

## Usage

```ts-vue
import { 
  createConfig, 
  custom // [!code hl]
} from '{{packageName}}'
import { mainnet } from '{{packageName}}/chains'
import { customRpc } from './rpc'

export const config = createConfig({
  chains: [mainnet],
  connectors: [injected()],
  transports: {
    [mainnet.id]: custom({ // [!code hl]
      async request({ method, params }) { // [!code hl]
        const response = await customRpc.request(method, params) // [!code hl]
        return response // [!code hl]
      } // [!code hl]
    }) // [!code hl]
  },
})
```

## Parameters

### provider

`{ request({ method: string, params: unknown[] }): Promise<unknown> }`

An [EIP-1193 `request` function](https://eips.ethereum.org/EIPS/eip-1193#request) function.

```ts
import { customRpc } from './rpc'

const transport = custom({
  async request({ method, params }) { // [!code focus:3]
    const response = await customRpc.request(method, params)
    return response
  }
})
```

### key (optional)

`string`

A key for the Transport. Defaults to `"custom"`.

```ts
const transport = custom(
  provider,
  { 
    key: 'windowProvider', // [!code focus]
  }
)
```

### name (optional)

`string`

A name for the Transport. Defaults to `"Ethereum Provider"`.

```ts
const transport = custom(
  provider,
  { 
    name: 'Window Ethereum Provider', // [!code focus]
  }
)
```

### retryCount (optional)

`number`

The max number of times to retry when a request fails. Defaults to `3`.

```ts
const transport = custom(provider, {
  retryCount: 5, // [!code focus]
})
```

### retryDelay (optional)

`number`

The base delay (in ms) between retries. By default, the Transport will use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) (`~~(1 << count) * retryDelay`), which means the time between retries is not constant.

```ts
const transport = custom(provider, {
  retryDelay: 100, // [!code focus]
})
```

---

---
url: /core/api/actions/deployContract.md
---
# deployContract&#x20;

Action for deploying a contract to the network, given bytecode, and constructor arguments.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/deployContract.md","from":288,"to":333}<fsm-vh3gqscxm4e>
import { deployContract } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/deployContract.md","from":380,"to":635}<fsm-vh3gqscxm4e>
import { deployContract } from '@wagmi/core'
import { wagmiAbi } from './abi'
import { config } from './config'

const result = await deployContract(config, {
  abi: wagmiAbi,
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
})
```

```ts [abi.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/deployContract.md","from":654,"to":788}<fsm-vh3gqscxm4e>
export const wagmiAbi = [
  ...
  {
    inputs: [],
    stateMutability: "nonpayable",
    type: "constructor",
  },
  ...
] as const
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Deploying with Constructor Args

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/deployContract.md","from":906,"to":1178}<fsm-vh3gqscxm4e>
import { deployContract } from '@wagmi/core'
import { wagmiAbi } from './abi'
import { config } from './config'

const result = await deployContract(config, {
  abi: wagmiAbi,
  args: [69420],
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
})
```

```ts [abi.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/deployContract.md","from":1197,"to":1361}<fsm-vh3gqscxm4e>
export const wagmiAbi = [
  ...
  {
    inputs: [{ name: "x", type: "uint32" }],
    stateMutability: "nonpayable",
    type: "constructor",
  },
  ...
] as const;
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/deployContract.md","from":1433,"to":1493}<fsm-vh3gqscxm4e>
import { type DeployContractParameters } from '@wagmi/core'
```

### abi

`Abi`

The contract's ABI.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/deployContract.md","from":1567,"to":1856}<fsm-vh3gqscxm4e>
import { deployContract } from '@wagmi/core'
import { wagmiAbi } from './abi'
import { config } from './config'

const result = await deployContract(config, {
  abi: wagmiAbi, // [!code focus]
  args: [69420],
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
})
```

```ts [abi.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/deployContract.md","from":1875,"to":2039}<fsm-vh3gqscxm4e>
export const wagmiAbi = [
  ...
  {
    inputs: [{ name: "x", type: "uint32" }],
    stateMutability: "nonpayable",
    type: "constructor",
  },
  ...
] as const;
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### account

`Address | Account | undefined`

Account to use when deploying a contract. Throws if account is not found on [`connector`](#connector).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/deployContract.md","from":2271,"to":2617}<fsm-vh3gqscxm4e>
import { deployContract } from '@wagmi/core'
import { wagmiAbi } from './abi'
import { config } from './config'

const result = await deployContract(config, {
  abi: wagmiAbi,
  account: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
  args: [69420],
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
})
```

```ts [abi.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/deployContract.md","from":2636,"to":2800}<fsm-vh3gqscxm4e>
export const wagmiAbi = [
  ...
  {
    inputs: [{ name: "x", type: "uint32" }],
    stateMutability: "nonpayable",
    type: "constructor",
  },
  ...
] as const;
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### args

`readonly unknown[] | undefined`

* Arguments to pass when deploying the contract.
* Inferred from [`abi`](#abi).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/deployContract.md","from":3007,"to":3296}<fsm-vh3gqscxm4e>
import { deployContract } from '@wagmi/core'
import { wagmiAbi } from './abi'
import { config } from './config'

const result = await deployContract(config, {
  abi: wagmiAbi,
  args: [69420], // [!code focus]
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
})
```

```ts [abi.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/deployContract.md","from":3315,"to":3479}<fsm-vh3gqscxm4e>
export const wagmiAbi = [
  ...
  {
    inputs: [{ name: "x", type: "uint32" }],
    stateMutability: "nonpayable",
    type: "constructor",
  },
  ...
] as const;
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### bytecode

`Hex`

The contract's bytecode.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/deployContract.md","from":3608,"to":3897}<fsm-vh3gqscxm4e>
import { deployContract } from '@wagmi/core'
import { wagmiAbi } from './abi'
import { config } from './config'

const result = await deployContract(config, {
  abi: wagmiAbi,
  args: [69420],
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...', // [!code focus]
})
```

```ts [abi.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/deployContract.md","from":3916,"to":4080}<fsm-vh3gqscxm4e>
export const wagmiAbi = [
  ...
  {
    inputs: [{ name: "x", type: "uint32" }],
    stateMutability: "nonpayable",
    type: "constructor",
  },
  ...
] as const;
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

* Connector to use when deploying a contract.
* Defaults to current connector.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/deployContract.md","from":4282,"to":4643}<fsm-vh3gqscxm4e>
import { getConnection, deployContract } from '@wagmi/core'
import { wagmiAbi } from './abi'
import { config } from './config'

const { connector } = getConnection(config)
const result = await deployContract(config, {
  abi: wagmiAbi,
  args: [69420],
  bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
  connector, // [!code focus]
})
```

```ts [abi.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/deployContract.md","from":4662,"to":4826}<fsm-vh3gqscxm4e>
export const wagmiAbi = [
  ...
  {
    inputs: [{ name: "x", type: "uint32" }],
    stateMutability: "nonpayable",
    type: "constructor",
  },
  ...
] as const;
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/deployContract.md","from":4898,"to":4958}<fsm-vh3gqscxm4e>
import { type DeployContractReturnType } from '@wagmi/core'
```

[`Hash`](https://viem.sh/docs/glossary/types#hash)

Transaction hash.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/deployContract.md","from":5050,"to":5109}<fsm-vh3gqscxm4e>
import { type DeployContractErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Viem

* [`deployContract`](https://viem.sh/docs/contract/deployContract)

---

---
url: /core/api/utilities/deserialize.md
---

# deserialize

Deserialize function that supports `bigint` and `Map`.

## Import

```ts-vue
import { deserialize } from '{{packageName}}'
```

## Usage

```ts-vue
import { deserialize } from '{{packageName}}'

const result = deserialize('{"foo":"wagmi","bar":{"__type":"bigint","value":"123"}}')
```

## Parameters

### value

`string`

The string to deserialize.

### reviver

`(key: string, value: any) => any`

A custom reviver function for handling standard values.

## Return Type

`unknown`

Parsed value.

---

---
url: /react/api/utilities/deserialize.md
---

# deserialize

Deserialize function that supports `bigint` and `Map`.

## Import

```ts-vue
import { deserialize } from '{{packageName}}'
```

## Usage

```ts-vue
import { deserialize } from '{{packageName}}'

const result = deserialize('{"foo":"wagmi","bar":{"__type":"bigint","value":"123"}}')
```

## Parameters

### value

`string`

The string to deserialize.

### reviver

`(key: string, value: any) => any`

A custom reviver function for handling standard values.

## Return Type

`unknown`

Parsed value.

---

---
url: /shared/utilities/deserialize.md
---
# deserialize

Deserialize function that supports `bigint` and `Map`.

## Import

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/utilities/deserialize.md","from":155,"to":201}<fsm-vh3gqscxm4e>
import { deserialize } from '{{packageName}}'
```

## Usage

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/utilities/deserialize.md","from":226,"to":359}<fsm-vh3gqscxm4e>
import { deserialize } from '{{packageName}}'

const result = deserialize('{"foo":"wagmi","bar":{"__type":"bigint","value":"123"}}')
```

## Parameters

### value

`string`

The string to deserialize.

### reviver

`(key: string, value: any) => any`

A custom reviver function for handling standard values.

## Return Type

`unknown`

Parsed value.

---

---
url: /vue/api/utilities/deserialize.md
---

# deserialize

Deserialize function that supports `bigint` and `Map`.

## Import

```ts-vue
import { deserialize } from '{{packageName}}'
```

## Usage

```ts-vue
import { deserialize } from '{{packageName}}'

const result = deserialize('{"foo":"wagmi","bar":{"__type":"bigint","value":"123"}}')
```

## Parameters

### value

`string`

The string to deserialize.

### reviver

`(key: string, value: any) => any`

A custom reviver function for handling standard values.

## Return Type

`unknown`

Parsed value.

---

---
url: /core/api/actions/disconnect.md
---
# disconnect

Action for disconnecting connections.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/disconnect.md","from":192,"to":233}<fsm-vh3gqscxm4e>
import { disconnect } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/disconnect.md","from":280,"to":381}<fsm-vh3gqscxm4e>
import { disconnect } from '@wagmi/core'
import { config } from './config'

await disconnect(config)
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/disconnect.md","from":452,"to":508}<fsm-vh3gqscxm4e>
import { type DisconnectParameters } from '@wagmi/core'
```

### connector

`Connector | undefined`

[Connector](/core/api/connectors) to disconnect with.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/disconnect.md","from":640,"to":850}<fsm-vh3gqscxm4e>
import { disconnect, getConnection } from '@wagmi/core'
import { config } from './config'

const { connector } = getConnection(config)
const result = await disconnect(config, {
  connector, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/disconnect.md","from":916,"to":971}<fsm-vh3gqscxm4e>
import { type DisconnectErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

---

---
url: /core/guides/error-handling.md
---
# Error Handling

Every module in Wagmi Core exports an accompanying error type which you can use to strongly type your `catch` statements.

These types come in the form of `<Module>ErrorType`. For example, the `getBlockNumber` action exports a `GetBlockNumberErrorType` type.

Unfortunately, [TypeScript doesn't have an abstraction for typed exceptions](https://github.com/microsoft/TypeScript/issues/13219), so the most pragmatic & vanilla approach would be to explicitly cast error types in the `catch` statement.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/error-handling.md","from":552,"to":1306}<fsm-vh3gqscxm4e>
import { type GetBlockNumberErrorType, getBlockNumber } from '@wagmi/core'
import { config } from './config'

try {
  const blockNumber = await getBlockNumber(config)
} catch (e) {
  const error = e as GetBlockNumberErrorType
  error.name
  //    ^? (property) name: "Error" | "ChainDisconnectedError" | "HttpRequestError" | "InternalRpcError" | "InvalidInputRpcError" | "InvalidParamsRpcError" | "InvalidRequestRpcError" | "JsonRpcVersionUnsupportedError" | ... 16 more ... | "WebSocketRequestError"

  if (error.name === 'InternalRpcError')
    error.code
    //    ^? (property) code: -32603

  if (error.name === 'HttpRequestError')
    error.headers
    //    ^? (property) headers: Headers
    error.status
    //    ^? (property) status: number
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: tip
If you are using [Wagmi Hooks](/react/api/hooks), errors are [already strongly typed](/react/guides/error-handling) via the `error` property.
:::

---

---
url: /react/guides/error-handling.md
---
# Error Handling

The `error` property in Wagmi Hooks is strongly typed with it's corresponding error type. This enables you to have granular precision with handling errors in your application.

You can discriminate the error type by using the `name` property on the error object.

::: code-group

```tsx twoslash [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/error-handling.md","from":325,"to":5892}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"f5cf0003ac91d32dabedd71106481b4f3cd10de7f641dff78f479b328c2716e9","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAhVhBEBrAHKCAtgCMyAHhGT+7AOa86NMFDi8AwoZO8AvLfvGKvEfmbswASShm9DCW1gZgRsbIADognt5gcDEAushgmjqkKTHsUMlOHq7RsV4+iSApadpkWSA5ye6yrDBiACLMaMz5WiY+aAB8jFjMpMwaMDSkcAD8iLwAqrIKSmrpZAAKw6PjZHD6ru5xPv4NME2t7cx93LML8ooq6lWkAErjgqRgACrYMLqNzWg2h0+lEwOwNFgIKQ0NJFvcVk9KCAoEoEIgCGg0Fg4IgAPS4gDuzGMGnYADo4PhcaQYMwxLjmFh2LjCBBlHBcTI7stHhkkXAOtCkABOKhNMDGND4JAARgALFRBcZxnguUsHqtyGKfLhEAAGKhxEZiMgigC+FHQPzwhBIWuo5jwQlE4kkvAAglgsIxrrxXnS0GSAFIAZQAGmSAKJNMZgGEAH2klhgRjAMCg/MFDEQctFIHFkuliAAzIrhsrsyBPVgkRw00gAEyGrzGibmy3Ua3o22mxWO9FhAW8KAXWbdYy9XiJ4SwVPppEokRokCffAwXisLgwuCCEQieBwISsVgYXg0uAQVgkAIjjoCKG8KXrgCOgjIGDJmeG2YAbAB2MVgkLJAFWocsVXRW9mFrHUkFLYpNhNchEBlPULStHAbWIXsHXoPBBxhMhSChWYAHFxnVBEMkjUhiNIb4cCnXg0mPBdUTwVd1yIh8IC0AArAF71IR8114V933cdh+F4ZgpG44SiWsKViIJMAyVBABaXgWhTZhBFYNAlIgXgAAMWNYEzPyoAVvyQP94ILKUkAAVjLUgKzweSYPrEtm0QtsUJ/dDO0w9FxNIDAkRoPCB0kId5LIij4V5MgaLohj10Tcy2KXDjRPk3heIEsQhJEl83wiyTpNksxaIfRSRJUtTNO03T9MMx9jLM/SLKskAbKFRB7MAiUnMQVywPciCQC87UfPgo0A1NQLgswUKCGw+1osrFgOC4Pg1WSzVdDscITHcSoMnccdegGIYRjGCZplmYBQV4d6PDpNdPnBGAZmYzUmJnFMdQCadkznKAAG43o+w4/Cgf7LrIIGIdBmGpA+uADBwABpGAMH+gVSB8UxwdnUHUYptNodh96wgif7ToiKmQZpjGPrEirCdmEM0BJsQAHlSTQXRXsxzn3vCjB8Z5s9aRRMAT14IotCOp4YnccXJZ1z7PBgH6xiRwHybZ9NWchjndc5+H/GNp4LfRunrd4bGIDxgmif50nHZp330ytnWzSSf3aYlyXgmYNX03+yMwCjpooF0G643cci0EolLSDSqEMuunpU/l5hFeV1X1YyTXeG1l36a+g3fvtjJQ9DwOXdtxHZmR4TTct53rbdj25eJn2e8p0f2b7j7g76FvJ/emymkNv7eY6Rfft0MlN5n8eA7n3hN7JXgG2c3gNChdcD9bzmfHYcQ2CBZh/pThN9833gZVP8/X8Pnew85i1eAxGlrLGITED68GLJ/Gk38mJAO5rLAAElwfAAAxMAMRt5JmprvcORI0CeCfhAS8tIpCJnAQ2KBF836/wxmaX0txM6aleGgd4Xwfgby3qCcEkJoSwm5BqREVBFzLnwJibEeJCTElJBSKkNIAwMiZCyIh7JORwh5JqL8g0AAcDkgJjXlG5Dy6JDrqMEfmWCvkEKtmWg2IKHY1q6g2naKK/ZYhxUInVUgiUM7l1Sp4jKTFspCPYuiTitU6KFX4oJfgD4nxcwkrwKSMk5KeN4A1ZSEBVLqTAFpHS/A9IGSMqZcyllNHZlQro0aRYJpKmmrNcxPkJqLSQo2VaXYnE4W2kwLAxEcDQgwHweOYxZgxBzqQUBiYYjujQBAUkIhb4YFUBANAIZBBeihDQKAYyJmAKrDMuZ/ooAYAAOpsCaGgV4xVNlzCwMYEYsBtkgFgSAOQM5F5EIADLgUec8mwJQwAtHYG7MAaYTRbM8TsmILQ1kcBEO0GA/gfmTJAAgsRrxxICiRbs3wcYyDx1YM8LAIgsUxBxUQNgOQcVYEEBcolJKQBkopVADYD04CEuJRCp5yLGUcCgOit8Ap2X0qDBeMA7KABqOwJBgDmAkNZPDNn0o+eCW+kZaD7nTOmIVnLnkAFlxiECgEstAKCIAzm1XRSFIB9VSmgMa1Z6zoRarpTq5FLLZAWqhFatYxEiA5DIIC4FoLFWut2a8C87x9zGtNeal1lquVhvgGa0g+5ZXMHJewTc0dPXjITTEHNVr2X8vgGgLF4CZQfzPtA8Bv8ymylQiNYCOZDHTSGbgOauomktiWshYUbT1rSxcTFEAgxelkEwIMrYIyQD0umbM9g8zMD2vlRs9Ms79kLsOScs54xLkAnTDcu5xcYD0teZYd5EAvlTXpX8+IgawjBrXaGqFMKF3wsRc+lFaKYAYtLZ+nFEx8UFrzQysA5LeVUppcB55PKcgstGGyuNXqQOwb5T+gVtKOXxueSKyQEqpWSFlTuR1IbsPIuVSLNVGrYB8qQ7mvVBq7XLJjZYaDyKbWGuXSR51WHkPPPdTANjuyfXEH9aQe9khH3grI4miNKaYDRrNaxujhak2RpgGmjNWamhCfzSpkDRb0MlrLW/CtlCYG1uslmetBp8x6KLKBWplY23eU7X5axvb+2OJ7FtVxBFwkkV4OnRhTwxkBKyj1HKy4wkFSKtE2JolpZVWSQFhSXBGqZOajk1q+T2pFO6seUpVnbIoQbABOzVSXItsrPUusuoZRNisT2pAdiMLec2kOnaPT3bjoGcxKduz13zsXYs5ZDqFVPpk1MjdIgt2nOPLumAVyD23PuSez9Z6oAXqvcqG9/yJMgv3dJvjyLoVYFhe+479HkWoqxMWzF/7cUfDYLp0D4HKVgGpZh+lqH4MaEQ7x672KwNMvu99z9uGxVEslZMaVRGV1Oqu1aijqr1UwE1bRwHVqONMZNUpzH9KcdGrGwjzZr2BPk99WJg7Un6XhuTVG5j+PXv0/U5p7w2nBP6eeSzolYOTOHzM1WqhP8sFmwzMVwaMpiygUcg56reAXMdtlI15pAVpdeaws4vsw7/M2RYTiAGDtLP9WsyhP85W5ctYV+ifXMhXOygWt2lppXNdhW5p1/C7jXYdAN53E2YvIZ1vN5b+z1vJpGNN+0e3yuUJO/8stBrbuOm+d197hKvBbtYH5/460wTcqhPyqkuLJUYnCTiUlxJ1UUkRPSfgJq2TcltUKZ1YpPUitR6l1orRjaxo1PAjVzxDu4/uea4gBsxZk8+c9+iUdPX+l8H9GIYM4YyQAZJgkBd0YYCxkMmSKA7AiCzCX4GHSHRM3pgQZ8XVHyRPYl0CfskV+b/TO9loGl8BdDP4+YCog2/d99DuDf6/7/7BD9DB4Nh6g94VZNrwROZ4AH5EDD4yg/ij4u5J72LtLT466Vh66+4yD+7G6B6gwQFyiy5h6ICoER7TR24ICx4oFoEBRyhaJT4dY4HdJjoL5+i0jL6hgRjr6lBb4xhgFwD76H7H48Gn7jAc6X7X6369K7CP7f6v4kzv40C7DAGH6gFxiAGZ5yEgHCE6EQHOSVKwE27IiH7IFUFq7LTOR/isHa64S4Hp6eKzBzpzILJcYTZXbhYegzZzY7oXJLZHaHprZhY/BMSbbbbfK56MSJi3o+A05HbhFxG2ByI0ByDtCeAhj6xQD6R+LpQRGJhnYXY0AfqFGpEAZ4ovZ0a+GoaQbg4VGZS8C/abD/Y5q+HkJyjmY1oAysT57RZF4RIl4whl5lTxKVRV4pYFR14N4tR5IFIdQzJt6FZ9QDTZi2LQFW7jTmG1YWIyjQE2HIStYhTtaOFdKz7dZ9ITr9bDKDafruELqeEk7cZI4gaPGzYKzboLZBHLZQChHHqnpvIGyfIxFTYgAJEApAoPrJGfolFvplFvEwZPZAbc7cog4QafZQZonA7vbMptEA4/YYk5Bg6vaQ74aw6EZyqvFKoqqlpo4Y6vZE6KaxpY4gbMkvHeHk7DAeo4kxAiZ+qwDibQmSawngms7yYsnKZsk85qbybs6ZoJxc4ynIq86fG/r0ohgEi3yeCQkC7vx6g9HULEE0wQF/gTTbGOYD6K5bDIGHHO7q6T6YHrTYFOFe4JAwgGCwCzAaTFiQF6jOTB5+mmFjRWlTTOGwDIF5hHEq7J6DrsGxQekFDem8C+n+mBmS7ZjBm97y7UERntoNL1bRkOmJ4NgOGdJ+YuF0SzAo70nUY8YpEFnCJ5RcTF5RKl4JblQJJJI1QzHpYZJZLzHN5LFdQlJrFm7Fh+k5lVZ5meRD70HFkJ7IQNgyjlmp5dacE3GP58Fr5xgb5wBCE74iFiFH7cEBhkhn4yFQDf536KGSFP5yEqHsBqGf6aF/6GH9BAH6FaEfl9BBnORUHbFwHWmQSWGx4Niq4lnIQYFtZa4Vlp5JlekwA+l+l6gBlBnd7TnNqzmxSRngWQVLkgRyhrkz4jpXG9aL73k7kCGb7EofmiGIESHnmXkX7XlyG3kP73nKGYiqEf4aHfnvlHk6Ffk34GFCXgGZlwTCgWkUHAXhkIFgWFmNgEUeYuSrlJCGjQCOLcIbJVx8IhZNxmgCDEQaC8AADkRIJI7AZloIoIzoYg0qHoXoPoVcsM/mwAw4Fw7gBURlzgJiAiGQPotlmM8kUwZIbawVkV6C0V70SSjAoV4VWwTgjgzgZlWeOedEZlfA1c9M3uHltBvAvlqWUVnMNILCHwvAugiBfQ7oehnwawqWhUe47wNIUAh8fM0ehuwAtBZouguI1VsMZosMcVCVbayVqVtZVG6ONGOaWVrl4c7lyZ64RV8kwVnMzsZVrClV1Vzw8KG4dJgQ9ZbVLgKZwASFvV/Vh+IImMQ1mM+I38oIZoSIj00EiAoA5gwQB5kgeAhktAIAZoZoQAA=="}
// @noErrors
import { useBlockNumber } from 'wagmi'

function App() {
  const { data, error } = useBlockNumber()
  //            ^?

  error?.name
  //     ^?






  if (error?.name === 'HttpRequestError') {
    const { status } = error
    //      ^?      


    return <div>A HTTP error occurred. Status: {status}</div>
  }
  if (error?.name === 'LimitExceededRpcError') {
    const { code } = error
    //      ^?

    
    return <div>Rate limit exceeded. Code: {code}</div>
  }
  // ...
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

---

---
url: /solid/guides/error-handling.md
---
# Error Handling

`@wagmi/solid` provides comprehensive error handling through typed errors and TanStack Query's error states.

## Query Errors

When using query primitives, errors are available through the `error` property:

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/guides/error-handling.md","from":233,"to":575}<fsm-vh3gqscxm4e>
import { useBalance } from '@wagmi/solid'

function Balance() {
  const balance = useBalance(() => ({
    address: '0x...',
  }))

  return (
    <div>
      {balance.isError && (
        <p>Error: {balance.error?.message}</p>
      )}
      {balance.isSuccess && (
        <p>Balance: {balance.data?.formatted}</p>
      )}
    </div>
  )
}
```

## Mutation Errors

For mutation primitives like `useConnect` or `useDisconnect`, you can handle errors similarly:

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/guides/error-handling.md","from":703,"to":1218}<fsm-vh3gqscxm4e>
import { useConnect } from '@wagmi/solid'
import { injected } from '@wagmi/solid/connectors'

function Connect() {
  const connect = useConnect()

  const handleConnect = () => {
    connect.mutate(
      { connector: injected() },
      {
        onError(error) {
          console.error('Failed to connect:', error.message)
        },
      }
    )
  }

  return (
    <div>
      <button onClick={handleConnect}>Connect</button>
      {connect.isError && <p>Error: {connect.error?.message}</p>}
    </div>
  )
}
```

## Error Types

Wagmi exports specific error types that you can use for more granular error handling:

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/guides/error-handling.md","from":1333,"to":1809}<fsm-vh3gqscxm4e>
import { useConnect, ConnectorNotFoundError } from '@wagmi/solid'

function Connect() {
  const connect = useConnect()

  const handleConnect = () => {
    connect.mutate(
      { connector: injected() },
      {
        onError(error) {
          if (error instanceof ConnectorNotFoundError) {
            console.error('Wallet not installed')
          } else {
            console.error('Unknown error:', error.message)
          }
        },
      }
    )
  }

  // ...
}
```

## Common Errors

### ConnectorNotFoundError

Thrown when trying to use a connector that isn't available (e.g., MetaMask not installed).

### ChainNotConfiguredError

Thrown when trying to use a chain that isn't configured in your Wagmi config.

### ConnectorAlreadyConnectedError

Thrown when trying to connect with a connector that's already connected.

## Further Reading

* [Wagmi Errors](/solid/api/errors)
* [TanStack Query Error Handling](https://tanstack.com/query/latest/docs/framework/solid/guides/queries#error-handling)

---

---
url: /vue/guides/error-handling.md
---
# Error Handling

The `error` property in Wagmi Composables is strongly typed with it's corresponding error type. This enables you to have granular precision with handling errors in your application.

You can discriminate the error type by using the `name` property on the error object.

::: code-group

```vue twoslash [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/error-handling.md","from":331,"to":5471}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"26fedaeea151ddba71fa403843f00ead34374f64e5dd13dafc27e1465b3af479","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAhVhBEBrAHKCAtgCMyAHhGT+7AOa86NMFDi8AwoZO8AvLfvGKvEfmbswASShm9DCW1gZgRsbIADognt5gcDEAushgmjqkKTHsUMlOHq7RsV4+iSApadpkWSA5ye6yrDBiACLMaMz5WiY+aAB8jFjMpMwaMDSkcAD8iLwAqrIKSmrpZAAKw6PjZHD6ru5xPv4NME2t7cx93LML8ooq6lWkAErjgqRgACrYMLqNzWg2h0+lEwOwNFgIKQ0NJFvcVk9KCAoEoEIgCGg0Fg4IgAPS4gDuzGMGnYADo4PhcaQYMwxLjmFh2LjCBBlHBcTI7stHhkkXAOtCkABmAAsVCaYGMaHwSAAjOLqMNjOM8Fylg9VuQJT5cIg5VQ4iMxGQkABOAC+FHQPzwhBI2uo5jwYQFvCgF1m3WMvV4AB9pJYYEYwDAoEiUSI0SBPvgYLxWFwYXBBCIRPA4EJWKwMLwaXAIKwSAEPR0BFDeDL4wBHQRkDBk/mChiIADswolwWlssQisFKpbyIuSI4oZFhq8xomSAAHFabTg7cRTVQaPQXZI3WRSFDZgBxcYahEZACipB3pG+OH9vDS2YjqLwsfj24rEC0ACsAeXSJW47xa3rdx2H4XhmCkV9fyJawZR3AkwDJUEAFpeBaYNmEEVg0BgiBeAAAzvVg8MbKgBWGFtWzNTspRlJAAFZV2VVV0UgkddXHYpNhNch9VFedqFtdFANIDAkTXQdXRhSD90PeFeTIM8LyveMA0Ih8oyff9IN4d8vzEH8/xrOsROA0DwLMc8K2gv84IQ5DUPQzDsMrXCCMwoiSJAMihTbKiQElbt6MY0gBzwVidTHRAO04qdTV4/jMEXdF7RXJ113RFgOC4Ph1TkrVdDscITHcSoMncb1egGIYRjGCZplmYBQV4ZqPDpONPnBGAZlvLUb2EWAQzDPqg0GqAAG4mpaw4/CgbrSrIYaBt1cbJuauADBwABpGAMG6gVSB8UwA364NlsW07QxWqQptcbrCoic7Rom67muE3bZgAZTQA6xAAeVJNBdEal6Wte4yMG29681pFEwBzXgii0PKnhidxgdBjGpramAOrGObeuOkazsJpbLuezHMem/x8aeR7lvJinQfWiAtp2vbvsOunLq5sMGcxi0kh5q7GeCZgkbDbqTzAMWmigXQKrANB3APNAj3k0hFKhZTyp6RX3BpZhYfhxHkYyVHeHRxmsc8HHOppjIhaFvmrap2bZnm38SYu3nVqt5nWah/bOa90and90GBb6MOQaZjomlxrrPrj22xl0Ml06jkP6fDlr07JXgACY6N4DQoXjPPndBnx2HENggWYbqFZhAM894OUS7L3hW6zsnfatXgYjeyGYhvVvhQ7mku/Tm9B/ByGAAkuHwAAxMAYkzwNSZ9kGiTQTxG4gQtaSkFvp4Lify+nnvt4ta55jhHktVeNB3i+H404z0FwUhaFYW5TVERUEjNGfAmJsR4kJMSUkFIqQG3pIyZkrJ2ScgfgAvkpFmyzj8gFWivFgqhXRLlR+gD/LsSihOLi05EAFz4taASSUCDLkdOJDcCQpKWVIDJVWpsFIcOUjeNSQDHzomfBZC8OlPzfn4BWKsAFwamTAhBDhvBrKwQgPBRCYAUJoX4BhLCOF8KEWIk2ci8oAAMM5qKBUQAxJUIVmIgHCqQyKAA2ChsUeJmISoJRhDoxLOgylgHcOBoQYD4NLMYswYia1ICPAMMQACCaAICkhEDXDAqgIBoA+oILAP8aBQBiXEgeIAkkpPYCIV4hsMAAHU2BNDQK8PSBS5hYGMCMWARSQAzxAHIfq8dD4ABkmJdJ6TYEoYAWjsGZmAUMJpCkcOKTEFouSOAiHaDAfwoz4kgHnmA14gEBTbJKb4RWZBpasGeFgEQxyYinKIGwHIpysCCEadc25IB7mPKgBsGqcArk3MWd0nZXyOBQAOXWAUAKPkACkCxgABQANR2BIMAcwEi5PyWGD5gzwQ1xPLQdMYYwzQqBT0gAsuMQgUBMloGXhAfqpKLxLJAJSmU0BaU5LyVCApTKoQst+bIPlsTgUlLWDuIgOQyBTJmXMgpHzXgFneOmWl9LGXvLJTsxVDLSDpnRcwB57BEzi2FSy01oqYgAohfANAxzW5ynbqXSe3dN7e3DBg0x+o5S2JwT2PsTFBwRNwBFPUbiYp0ioa2bxDC3r+PSiAQYwSyCYHCVsKJIAPllNSekzlmKeXYs1SUrNFSqlQFqfU8YTSARhlae0w2MAPl9MsAMiAwz7EfPGfEGVYQ5UFuZRakAKysBrI2VswtMQ9lYmtUc8dnyzkfDYOanpoKnlgBeW8wF/bl1gAeWC35ox/kaq3SCnd3zp0bthfCpFKLJDopTNy6Efb+UDtxQDAlRLYDgqPc+ilVKOVZLVZYJdOy2XUtzQ+3l36RU9MFTAYDYqJVStIN2yQvaFnHpKdq5VMBVUMqA1Bs18AdV6uloa41TR4OWoIwOq1MBDm2sLfax1ncXUnVGiYnyDqfVdlwf6+xgathsVce4iNcUo10MSnqXxqUWGBKTaEvgUB2BEFmPPT45LBlJI5loV58BeAADJeCKrIMWcVLMEAes43RMxVjcHRX7A4pTRAhN6m9SJ7iIpo1SZSswgJsRNzsIvFwtWWoYn8NUu5dS0ZRHaV0lImR/43oKPMtpVR+BbKaO0Y5fRLlDHuWMZZlscoXE2f8jxnstiHODicaOVztijSiZ4nKYUXmlx+NXH5xNLNk1hNvGmkpmbknZswOBrF6Gf07OLZUmG5bsyVpgM0mtbSOkNtnU2qALa20qg7RMlDszq3jegzsodI6aBjowxO/ZdHIUMYu3OiYFzKNzt3au9dT2V0/M2BoQ9m6JsnNPWC89T24WSGvZMVFd682PsOyy19+LCUwGJV+37R2Smgf/XSvDyOPno5pVkrlY2nuwaJ4h2AyHpk9oOwqoj2HcPqpR4RpVuqYD6rIzLOD1GelPdo/Ru108HUXynvna+7qvKYP1C41stm/X4IcUGlz8p6uTka0gAuXiJM+J83GiSAWxG7l4CrELTwws/AEZFoRGkRFaWUXF/S0jfyyKS7wECii9dQS4DZdRdktEOV0U5AxblswFbF56guwpuM0Qq7L6rHCFcS/c1Q4Uc4NcMK1x1+NXWQkpt4JOrA56YkUg6C/eqPVaYi44y2GhBoyuR6QGGqreAyLF7j8VhPcVRS0IXFJ2N6fByZ563wXP+eOGF/aDIe2C1y+FdV6Kavvq6/R8b0XmQLew0NY872Tv9DvNMO10wIJ3WFPumU6p9TmnMQHR0zQawhnjOkFM8EizIefJFwj9Y+zAa8BOZb1L8NG+t+SZtYyadYH5Z69ZOan4aZaaX66Y35GbwAmZhhmbYgV6q4uKKjz7kJ2IELIjKYt5+Tr6J6tbJS7696sJbgcLBY8Iax8Km4Rb3gW7RbW7iK24wj26GRyJATO5mRKLiJpYZb2Q6J6LOTJJ5ZB6eTeSV6UTS5BTYEOI1ZkJygEHK4b5yjJ5d5AG+YZ6gED59aRIDazpTY5r45Q7yqGFDYlozZ1JzaNILYHa1oraNr9I4xDIjKzqdo+B7ZoYfInYVKjow4DqnIPaLqc4novZQDPKvLvYA45D7rfbRHhFA6hElIg4IrXLIrg63oYoQZPqo4xBw62oI5I5Pa45074YM4DqlEmE5HY6zrE7JExBmaSpk5eFU6zpYbM5lG1F3YdEkYGreDkYc4VFc4NEgA843YfIfQEg1yeAeFgB875xyhmKC6sZEyXSoHUIzhhqYF8Y4Hy4hryjKGUJxRFzEHSZaE65sJu5UHEKni0HXj0GsBRaaQvg26SJ24JZGRcEu4pbKL8Fe6Za+7CEB5GISHi7h5v64KVaf4sSx4HHUKlaEFxRihnFp5pR946FH4GCwCzBITChq5mJ0QbHCguJz7lZIC7EOLYnBrOJ6hq5t48Sijq4aFCTgx75yaH7Z7Um4n4lmKEnEmkkyG9iL7ojUlx70l/5UJMmomkHon77ybZ4QE55n7QHsBX56a34IH35IGP7EnthCkf78Zf54HwkFzV5ImMkCyGjQBSZ/AiAHRYDJhvBYAJjgTGCOAxDYTrxfwQg8oWx/xG4OwWgCA7gaC8AADkRIJI7A4ZoIoIkk/ppYzA7g2kwZzgRCaCZAjA3AcZa8oYHCUwZIQauZJZeZuguI60Dp/QuZugNAEIiYNAII10ugTmvARASEIEHpjiBZRZWwTgjgzg4ZQ+12NqMSsZIATZoMCSypnwawbuOkaY7wNIUA+cX0Y+OIFswAbuo+xevAFoFok05ZTmTZh5rZ7ZpwsgHZ/AXZkEhZQa/Zg5BR76iOn6wq45k5LUzwGyCYeKUkRRn6+cdgOJm5251Je5B5zZuIx5oI5ZdZw6GyfQSItUzASAoA5gwQcAqKeARAdYIA+5QAA==="}
<script setup lang="ts">
// @noErrors
import { useBlockNumber } from 'wagmi'

const { data, error } = useBlockNumber()
//            ^?


error?.name
//     ^?





</script>

<template>
  <div v-if="error?.name === 'HttpRequestError'">
    A HTTP error occurred. Status: {{ error.status }}
//                                          ^?
  </div>

  <div v-else-if="error?.name === 'LimitExceededRpcError'">
    Rate limit exceeded. Code: {{ error.code }}
//                                      ^?
  </div>
</template>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

---

---
url: /core/api/errors.md
---
# Errors

Error classes used by Wagmi.

## BaseError

Error class extended by all errors.

```ts-vue
import { BaseError } from '{{packageName}}'
```

## Config

### ConnectorAccountNotFoundError

When an account does not exist on the connector or is unable to be used.

```ts-vue
import { ConnectorAccountNotFoundError } from '{{packageName}}'
```

### ConnectorAlreadyConnectedError

When a connector is already connected.

```ts-vue
import { ConnectorAlreadyConnectedError } from '{{packageName}}'
```

### ConnectorChainMismatchError

When the Wagmi Config is out-of-sync with the connector's active chain ID. This is rare and likely an upstream wallet issue.

```ts-vue
import { ConnectorChainMismatchError } from '{{packageName}}'
```

### ChainNotConfiguredError

When a chain is not configured. You likely need to add the chain to `Config['chains']`.

```ts-vue
import { ChainNotConfiguredError } from '{{packageName}}'
```

### ConnectorNotConnectedError

When a connector is not connected.

```ts-vue
import { ConnectorNotConnectedError } from '{{packageName}}'
```

### ConnectorNotFoundError

When a connector is not found or able to be used.

```ts-vue
import { ConnectorNotFoundError } from '{{packageName}}'
```

### ConnectorUnavailableReconnectingError

During the reconnection step, the only connector methods guaranteed to be available are: `id`, `name`, `type`, `uuid`. All other methods are not guaranteed to be available until reconnection completes and connectors are fully restored. This error commonly occurs for connectors that asynchronously inject after reconnection has already started.

```ts-vue
import { ConnectorUnavailableReconnectingError } from '{{packageName}}'
```

## Connector

### ProviderNotFoundError

When a connector's provider is not found or able to be used.

```ts-vue
import { ProviderNotFoundError } from '{{packageName}}'
```

### SwitchChainNotSupportedError

When switching chains is not supported by connectors.

```ts-vue
import { SwitchChainNotSupportedError } from '{{packageName}}'
```

---

---
url: /react/api/errors.md
---
# Errors

Error classes used by Wagmi.

## BaseError

Error class extended by all errors.

```ts-vue
import { BaseError } from '{{packageName}}'
```

## Config

### ConnectorAccountNotFoundError

When an account does not exist on the connector or is unable to be used.

```ts-vue
import { ConnectorAccountNotFoundError } from '{{packageName}}'
```

### ConnectorAlreadyConnectedError

When a connector is already connected.

```ts-vue
import { ConnectorAlreadyConnectedError } from '{{packageName}}'
```

### ConnectorChainMismatchError

When the Wagmi Config is out-of-sync with the connector's active chain ID. This is rare and likely an upstream wallet issue.

```ts-vue
import { ConnectorChainMismatchError } from '{{packageName}}'
```

### ChainNotConfiguredError

When a chain is not configured. You likely need to add the chain to `Config['chains']`.

```ts-vue
import { ChainNotConfiguredError } from '{{packageName}}'
```

### ConnectorNotConnectedError

When a connector is not connected.

```ts-vue
import { ConnectorNotConnectedError } from '{{packageName}}'
```

### ConnectorNotFoundError

When a connector is not found or able to be used.

```ts-vue
import { ConnectorNotFoundError } from '{{packageName}}'
```

### ConnectorUnavailableReconnectingError

During the reconnection step, the only connector methods guaranteed to be available are: `id`, `name`, `type`, `uuid`. All other methods are not guaranteed to be available until reconnection completes and connectors are fully restored. This error commonly occurs for connectors that asynchronously inject after reconnection has already started.

```ts-vue
import { ConnectorUnavailableReconnectingError } from '{{packageName}}'
```

## Connector

### ProviderNotFoundError

When a connector's provider is not found or able to be used.

```ts-vue
import { ProviderNotFoundError } from '{{packageName}}'
```

### SwitchChainNotSupportedError

When switching chains is not supported by connectors.

```ts-vue
import { SwitchChainNotSupportedError } from '{{packageName}}'
```

## React

### WagmiProviderNotFoundError

When a Wagmi hook is used outside of a [`WagmiProvider`](/react/api/WagmiProvider).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/errors.md","from":288,"to":339}<fsm-vh3gqscxm4e>
import { WagmiProviderNotFoundError } from 'wagmi'
```

---

---
url: /solid/api/errors.md
---
# Errors

`@wagmi/solid` exports error types that can be used for type-safe error handling.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/errors.md","from":110,"to":217}<fsm-vh3gqscxm4e>
import { 
  BaseError,
  ChainNotConfiguredError,
  ConnectorNotFoundError,
  // ...
} from '@wagmi/solid'
```

## Base Error

All Wagmi errors extend from `BaseError`:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/errors.md","from":286,"to":509}<fsm-vh3gqscxm4e>
import { BaseError } from '@wagmi/solid'

try {
  // Wagmi operation
} catch (error) {
  if (error instanceof BaseError) {
    console.error('Wagmi error:', error.message)
    console.error('Details:', error.details)
  }
}
```

## Available Errors

### ChainNotConfiguredError

Thrown when trying to use a chain that isn't configured in your Wagmi config.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/errors.md","from":649,"to":882}<fsm-vh3gqscxm4e>
import { ChainNotConfiguredError } from '@wagmi/solid'

try {
  // Operation with unconfigured chain
} catch (error) {
  if (error instanceof ChainNotConfiguredError) {
    console.error('Chain not configured:', error.message)
  }
}
```

### ConnectorNotFoundError

Thrown when trying to use a connector that doesn't exist or isn't available.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/errors.md","from":999,"to":1198}<fsm-vh3gqscxm4e>
import { ConnectorNotFoundError } from '@wagmi/solid'

try {
  // Connect operation
} catch (error) {
  if (error instanceof ConnectorNotFoundError) {
    console.error('Wallet not installed')
  }
}
```

### ConnectorAlreadyConnectedError

Thrown when trying to connect with a connector that's already connected.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/errors.md","from":1319,"to":1531}<fsm-vh3gqscxm4e>
import { ConnectorAlreadyConnectedError } from '@wagmi/solid'

try {
  // Connect operation
} catch (error) {
  if (error instanceof ConnectorAlreadyConnectedError) {
    console.error('Already connected')
  }
}
```

### ProviderNotFoundError

Thrown when the connector's provider is not found.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/errors.md","from":1621,"to":1817}<fsm-vh3gqscxm4e>
import { ProviderNotFoundError } from '@wagmi/solid'

try {
  // Provider operation
} catch (error) {
  if (error instanceof ProviderNotFoundError) {
    console.error('Provider not found')
  }
}
```

### SwitchChainNotSupportedError

Thrown when the connector doesn't support programmatic chain switching.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/errors.md","from":1935,"to":2160}<fsm-vh3gqscxm4e>
import { SwitchChainNotSupportedError } from '@wagmi/solid'

try {
  // Switch chain operation
} catch (error) {
  if (error instanceof SwitchChainNotSupportedError) {
    console.error('Chain switching not supported')
  }
}
```

## More Errors

See the [`@wagmi/core` Errors docs](/core/api/errors) for the full list of available error types.

---

---
url: /vue/api/errors.md
---
# Errors

Error classes used by Wagmi.

## BaseError

Error class extended by all errors.

```ts-vue
import { BaseError } from '{{packageName}}'
```

## Config

### ConnectorAccountNotFoundError

When an account does not exist on the connector or is unable to be used.

```ts-vue
import { ConnectorAccountNotFoundError } from '{{packageName}}'
```

### ConnectorAlreadyConnectedError

When a connector is already connected.

```ts-vue
import { ConnectorAlreadyConnectedError } from '{{packageName}}'
```

### ConnectorChainMismatchError

When the Wagmi Config is out-of-sync with the connector's active chain ID. This is rare and likely an upstream wallet issue.

```ts-vue
import { ConnectorChainMismatchError } from '{{packageName}}'
```

### ChainNotConfiguredError

When a chain is not configured. You likely need to add the chain to `Config['chains']`.

```ts-vue
import { ChainNotConfiguredError } from '{{packageName}}'
```

### ConnectorNotConnectedError

When a connector is not connected.

```ts-vue
import { ConnectorNotConnectedError } from '{{packageName}}'
```

### ConnectorNotFoundError

When a connector is not found or able to be used.

```ts-vue
import { ConnectorNotFoundError } from '{{packageName}}'
```

### ConnectorUnavailableReconnectingError

During the reconnection step, the only connector methods guaranteed to be available are: `id`, `name`, `type`, `uuid`. All other methods are not guaranteed to be available until reconnection completes and connectors are fully restored. This error commonly occurs for connectors that asynchronously inject after reconnection has already started.

```ts-vue
import { ConnectorUnavailableReconnectingError } from '{{packageName}}'
```

## Connector

### ProviderNotFoundError

When a connector's provider is not found or able to be used.

```ts-vue
import { ProviderNotFoundError } from '{{packageName}}'
```

### SwitchChainNotSupportedError

When switching chains is not supported by connectors.

```ts-vue
import { SwitchChainNotSupportedError } from '{{packageName}}'
```

---

---
url: /core/api/actions/estimateFeesPerGas.md
---
# estimateFeesPerGas

Returns an estimate for the fees per gas (in wei) for a transaction to be likely included in the next block.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateFeesPerGas.md","from":287,"to":336}<fsm-vh3gqscxm4e>
import { estimateFeesPerGas } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateFeesPerGas.md","from":383,"to":515}<fsm-vh3gqscxm4e>
import { estimateFeesPerGas } from '@wagmi/core'
import { config } from './config'

const result = await estimateFeesPerGas(config)
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateFeesPerGas.md","from":586,"to":650}<fsm-vh3gqscxm4e>
import { type EstimateFeesPerGasParameters } from '@wagmi/core'
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateFeesPerGas.md","from":786,"to":1008}<fsm-vh3gqscxm4e>
import { estimateFeesPerGas } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const result = await estimateFeesPerGas(config, {
  chainId: mainnet.id, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### type

`'legacy' | 'eip1559'`

* Fee value type.
* Defaults to `'eip1559'`

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateFeesPerGas.md","from":1169,"to":1335}<fsm-vh3gqscxm4e>
import { estimateFeesPerGas } from '@wagmi/core'
import { config } from './config'

const result = estimateFeesPerGas(config, {
  type: 'legacy', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateFeesPerGas.md","from":1407,"to":1471}<fsm-vh3gqscxm4e>
import { type EstimateFeesPerGasReturnType } from '@wagmi/core'
```

[`FeeValues`](https://viem.sh/docs/glossary/types#feevalues)

An estimate (in wei) for the fees per gas.

### gasPrice

`bigint | undefined`

* Gas price.
* When [`type`](#type) is `'eip1559'`, value is `undefined`.

### maxFeePerGas

`bigint | undefined`

* Max fee per gas.
* When [`type`](#type) is `'legacy'`, value is `undefined`.

### maxPriorityFeePerGas

`bigint | undefined`

* Max priority fee per gas.
* When [`type`](#type) is `'legacy'`, value is `undefined`.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateFeesPerGas.md","from":1966,"to":2029}<fsm-vh3gqscxm4e>
import { type EstimateFeesPerGasErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`estimateFeesPerGas`](https://viem.sh/docs/actions/public/estimateFeesPerGas)

---

---
url: /core/api/actions/estimateGas.md
---
# estimateGas

Action for estimating the gas necessary to complete a transaction without submitting it to the network.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateGas.md","from":261,"to":303}<fsm-vh3gqscxm4e>
import { estimateGas } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateGas.md","from":350,"to":588}<fsm-vh3gqscxm4e>
import { estimateGas } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await estimateGas(config, {
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateGas.md","from":659,"to":716}<fsm-vh3gqscxm4e>
import { type EstimateGasParameters } from '@wagmi/core'
```

### accessList

`AccessList | undefined`

The access list.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateGas.md","from":813,"to":1188}<fsm-vh3gqscxm4e>
import { estimateGas } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await estimateGas(config, {
  accessList: [{ // [!code focus]
    address: '0x1', // [!code focus]
    storageKeys: ['0x1'], // [!code focus]
  }], // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### account

`Address | Account | undefined`

Account to use when estimating gas.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateGas.md","from":1353,"to":1665}<fsm-vh3gqscxm4e>
import { estimateGas } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await estimateGas(config, {
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

Chain ID to target when estimating gas.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateGas.md","from":1847,"to":2170}<fsm-vh3gqscxm4e>
import { estimateGas } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { parseEther } from 'viem'
import { config } from './config'

const result = await estimateGas(config, {
  chainId: mainnet.id, // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

Connector to estimate with. If no [`account`](#account) is provided, will use default account from connector.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateGas.md","from":2403,"to":2757}<fsm-vh3gqscxm4e>
import { getConnections, estimateGas } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const connections = getConnections(config)
const result = await estimateGas(config, {
  connector: connections[0]?.connector, // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### data

`` `0x${string}` | undefined ``

A contract hashed method call with encoded args.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateGas.md","from":2932,"to":3241}<fsm-vh3gqscxm4e>
import { estimateGas } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await estimateGas(config, {
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### gas

`bigint | undefined`

Gas provided for transaction execution.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateGas.md","from":3395,"to":3685}<fsm-vh3gqscxm4e>
import { estimateGas } from '@wagmi/core'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

const result = await estimateGas(config, {
  gas: parseGwei('20'), // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### gasPrice

`bigint | undefined`

The price in wei to pay per gas. Only applies to [Legacy Transactions](https://viem.sh/docs/glossary/terms#legacy-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateGas.md","from":3937,"to":4232}<fsm-vh3gqscxm4e>
import { estimateGas } from '@wagmi/core'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

const result = await estimateGas(config, {
  gasPrice: parseGwei('20'), // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxFeePerGas

`bigint | undefined`

Total fee per gas in wei, inclusive of [`maxPriorityFeePerGas`](#maxPriorityFeePerGas). Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateGas.md","from":4542,"to":4841}<fsm-vh3gqscxm4e>
import { estimateGas } from '@wagmi/core'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

const result = await estimateGas(config, {
  maxFeePerGas: parseGwei('20'), // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxPriorityFeePerGas

`bigint | undefined`

Max priority fee per gas in wei. Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateGas.md","from":5104,"to":5443}<fsm-vh3gqscxm4e>
import { estimateGas } from '@wagmi/core'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

const result = await estimateGas(config, {
  maxFeePerGas: parseGwei('20'),
  maxPriorityFeePerGas: parseGwei('2'), // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### nonce

`number`

Unique number identifying this transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateGas.md","from":5596,"to":5865}<fsm-vh3gqscxm4e>
import { estimateGas } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await estimateGas(config, {
  nonce: 123, // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### to

`Address | undefined`

The transaction recipient or contract address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateGas.md","from":6026,"to":6281}<fsm-vh3gqscxm4e>
import { estimateGas } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await estimateGas(config, {
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### type

`'legacy' | 'eip1559' | 'eip2930' | undefined`

Optional transaction request type to narrow parameters.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateGas.md","from":6478,"to":6752}<fsm-vh3gqscxm4e>
import { estimateGas } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await estimateGas(config, {
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  type: 'eip1559', // [!code focus]
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### value

`bigint | undefined`

Value in wei sent with this transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateGas.md","from":6909,"to":7165}<fsm-vh3gqscxm4e>
import { estimateGas } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await estimateGas(config, {
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B', 
  value: parseEther('0.01'), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateGas.md","from":7237,"to":7294}<fsm-vh3gqscxm4e>
import { type EstimateGasReturnType } from '@wagmi/core'
```

`bigint`

The gas estimate in wei.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateGas.md","from":7351,"to":7407}<fsm-vh3gqscxm4e>
import { type EstimateGasErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`estimateGas`](https://viem.sh/docs/actions/public/estimateGas)

---

---
url: /core/api/actions/estimateMaxPriorityFeePerGas.md
---
# estimateMaxPriorityFeePerGas

Returns an estimate for the max priority fee per gas (in wei) for a transaction to be likely included in the next block.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateMaxPriorityFeePerGas.md","from":319,"to":378}<fsm-vh3gqscxm4e>
import { estimateMaxPriorityFeePerGas } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateMaxPriorityFeePerGas.md","from":425,"to":577}<fsm-vh3gqscxm4e>
import { estimateMaxPriorityFeePerGas } from '@wagmi/core'
import { config } from './config'

const result = await estimateMaxPriorityFeePerGas(config)
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateMaxPriorityFeePerGas.md","from":648,"to":712}<fsm-vh3gqscxm4e>
import { type EstimateFeesPerGasParameters } from '@wagmi/core'
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateMaxPriorityFeePerGas.md","from":848,"to":1090}<fsm-vh3gqscxm4e>
import { estimateMaxPriorityFeePerGas } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const result = await estimateMaxPriorityFeePerGas(config, {
  chainId: mainnet.id, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateMaxPriorityFeePerGas.md","from":1162,"to":1226}<fsm-vh3gqscxm4e>
import { type EstimateFeesPerGasReturnType } from '@wagmi/core'
```

`bigint`

An estimate (in wei) for the max priority fee per gas.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/estimateMaxPriorityFeePerGas.md","from":1313,"to":1376}<fsm-vh3gqscxm4e>
import { type EstimateFeesPerGasErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`estimateMaxPriorityFeePerGas`](https://viem.sh/docs/actions/public/estimateMaxPriorityFeePerGas)

---

---
url: /core/guides/ethers.md
---
# Ethers.js Adapters

It is recommended for projects to migrate to [Viem](https://viem.sh) when using Wagmi, but there are some cases where you might still need to use [Ethers.js](https://ethers.org) in your project:

* You may want to **incrementally migrate** Ethers.js usage to Viem
* Some **third-party libraries & SDKs** may only support Ethers.js
* Personal preference

We have provided reference implementations for Viem → Ethers.js adapters that you can copy + paste in your project.

## Client → Provider

### Reference Implementation

Copy the following reference implementation into a file of your choice:

::: code-group

```ts [Ethers v5]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/ethers.md","from":652,"to":1599}<fsm-vh3gqscxm4e>
import { type Config, getClient } from '@wagmi/core'
import { providers } from 'ethers'
import type { Client, Chain, Transport } from 'viem'

export function clientToProvider(client: Client<Transport, Chain>) {
  const { chain, transport } = client
  const network = {
    chainId: chain.id,
    name: chain.name,
    ensAddress: chain.contracts?.ensRegistry?.address,
  }
  if (transport.type === 'fallback')
    return new providers.FallbackProvider(
      (transport.transports as ReturnType<Transport>[]).map(
        ({ value }) => new providers.JsonRpcProvider(value?.url, network),
      ),
    )
  return new providers.JsonRpcProvider(transport.url, network)
}

/** Action to convert a viem Public Client to an ethers.js Provider. */
export function getEthersProvider(
  config: Config,
  { chainId }: { chainId?: number } = {},
) {
  const client = getClient(config, { chainId })
  if (!client) return
  return clientToProvider(client)
}
```

```ts [Ethers v6]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/ethers.md","from":1622,"to":2629}<fsm-vh3gqscxm4e>
import { type Config, getClient } from '@wagmi/core'
import { FallbackProvider, JsonRpcProvider } from 'ethers'
import type { Client, Chain, Transport } from 'viem'

export function clientToProvider(client: Client<Transport, Chain>) {
  const { chain, transport } = client
  const network = {
    chainId: chain.id,
    name: chain.name,
    ensAddress: chain.contracts?.ensRegistry?.address,
  }
  if (transport.type === 'fallback') {
    const providers = (transport.transports as ReturnType<Transport>[]).map(
      ({ value }) => new JsonRpcProvider(value?.url, network),
    )
    if (providers.length === 1) return providers[0]
    return new FallbackProvider(providers)
  }
  return new JsonRpcProvider(transport.url, network)
}

/** Action to convert a viem Client to an ethers.js Provider. */
export function getEthersProvider(
  config: Config,
  { chainId }: { chainId?: number } = {},
) {
  const client = getClient(config, { chainId })
  if (!client) return
  return clientToProvider(client)
}
```

:::

### Usage

Now you can use the `getEthersProvider` function in your components:

::: code-group

```ts [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/ethers.md","from":2755,"to":2909}<fsm-vh3gqscxm4e>
import { getEthersProvider } from './ethers'
import { config } from './config'

function example() {
  const provider = getEthersProvider(config)
  ...
}
```

```ts [ethers.ts (Ethers v5)]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/ethers.md","from":2944,"to":3892}<fsm-vh3gqscxm4e>
import { type Config, getClient } from '@wagmi/core'
import { providers } from 'ethers'
import type { Client, Chain, Transport } from 'viem'

export function clientToProvider(client: Client<Transport, Chain>) {
  const { chain, transport } = client
  const network = {
    chainId: chain.id,
    name: chain.name,
    ensAddress: chain.contracts?.ensRegistry?.address,
  }
  if (transport.type === 'fallback')
    return new providers.FallbackProvider(
      (transport.transports as ReturnType<Transport>[]).map(
        ({ value }) => new providers.JsonRpcProvider(value?.url, network),
      ),
    )
  return new providers.JsonRpcProvider(transport.url, network)
}

/** Action to convert a viem Public Client to an ethers.js Provider. */
export function getEthersProvider(
  config: Config,
  { chainId }: { chainId?: number } = {},
) {
  const client = getClient(config, { chainId })
  if (!client) return
  return clientToProvider(client)
}

```

```ts [ethers.ts (Ethers v6)]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/ethers.md","from":3927,"to":4934}<fsm-vh3gqscxm4e>
import { type Config, getClient } from '@wagmi/core'
import { FallbackProvider, JsonRpcProvider } from 'ethers'
import type { Client, Chain, Transport } from 'viem'

export function clientToProvider(client: Client<Transport, Chain>) {
  const { chain, transport } = client
  const network = {
    chainId: chain.id,
    name: chain.name,
    ensAddress: chain.contracts?.ensRegistry?.address,
  }
  if (transport.type === 'fallback') {
    const providers = (transport.transports as ReturnType<Transport>[]).map(
      ({ value }) => new JsonRpcProvider(value?.url, network),
    )
    if (providers.length === 1) return providers[0]
    return new FallbackProvider(providers)
  }
  return new JsonRpcProvider(transport.url, network)
}

/** Action to convert a viem Client to an ethers.js Provider. */
export function getEthersProvider(
  config: Config,
  { chainId }: { chainId?: number } = {},
) {
  const client = getClient(config, { chainId })
  if (!client) return
  return clientToProvider(client)
}
```

:::

## Connector Client → Signer

### Reference Implementation

Copy the following reference implementation into a file of your choice:

::: code-group

```ts [Ethers v5]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/ethers.md","from":5111,"to":5914}<fsm-vh3gqscxm4e>
import { Config, getConnectorClient } from '@wagmi/core'
import { providers } from 'ethers'
import type { Account, Chain, Client, Transport } from 'viem'

export function clientToSigner(client: Client<Transport, Chain, Account>) {
  const { account, chain, transport } = client
  const network = {
    chainId: chain.id,
    name: chain.name,
    ensAddress: chain.contracts?.ensRegistry?.address,
  }
  const provider = new providers.Web3Provider(transport, network)
  const signer = provider.getSigner(account.address)
  return signer
}

/** Action to convert a Viem Client to an ethers.js Signer. */
export async function getEthersSigner(
  config: Config,
  { chainId }: { chainId?: number } = {},
) {
  const client = await getConnectorClient(config, { chainId })
  return clientToSigner(client)
}
```

```ts [Ethers v6]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/ethers.md","from":5937,"to":6771}<fsm-vh3gqscxm4e>
import { Config, getConnectorClient } from '@wagmi/core'
import { BrowserProvider, JsonRpcSigner } from 'ethers'
import type { Account, Chain, Client, Transport } from 'viem'

export function clientToSigner(client: Client<Transport, Chain, Account>) {
  const { account, chain, transport } = client
  const network = {
    chainId: chain.id,
    name: chain.name,
    ensAddress: chain.contracts?.ensRegistry?.address,
  }
  const provider = new BrowserProvider(transport, network)
  const signer = new JsonRpcSigner(provider, account.address)
  return signer
}

/** Action to convert a viem Wallet Client to an ethers.js Signer. */
export async function getEthersSigner(
  config: Config,
  { chainId }: { chainId?: number } = {},
) {
  const client = await getConnectorClient(config, { chainId })
  return clientToSigner(client)
}

```

:::

### Usage

Now you can use the `getEthersSigner` function in your components:

::: code-group

```ts [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/ethers.md","from":6895,"to":7045}<fsm-vh3gqscxm4e>
import { getEthersSigner } from './ethers'
import { config } from './config'

function example() {
  const provider = getEthersSigner(config)
  ...
}
```

```ts [ethers.ts (Ethers v5)]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/ethers.md","from":7080,"to":7883}<fsm-vh3gqscxm4e>
import { Config, getConnectorClient } from '@wagmi/core'
import { providers } from 'ethers'
import type { Account, Chain, Client, Transport } from 'viem'

export function clientToSigner(client: Client<Transport, Chain, Account>) {
  const { account, chain, transport } = client
  const network = {
    chainId: chain.id,
    name: chain.name,
    ensAddress: chain.contracts?.ensRegistry?.address,
  }
  const provider = new providers.Web3Provider(transport, network)
  const signer = provider.getSigner(account.address)
  return signer
}

/** Action to convert a Viem Client to an ethers.js Signer. */
export async function getEthersSigner(
  config: Config,
  { chainId }: { chainId?: number } = {},
) {
  const client = await getConnectorClient(config, { chainId })
  return clientToSigner(client)
}
```

```ts [ethers.ts (Ethers v6)]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/ethers.md","from":7918,"to":8752}<fsm-vh3gqscxm4e>
import { Config, getConnectorClient } from '@wagmi/core'
import { BrowserProvider, JsonRpcSigner } from 'ethers'
import type { Account, Chain, Client, Transport } from 'viem'

export function clientToSigner(client: Client<Transport, Chain, Account>) {
  const { account, chain, transport } = client
  const network = {
    chainId: chain.id,
    name: chain.name,
    ensAddress: chain.contracts?.ensRegistry?.address,
  }
  const provider = new BrowserProvider(transport, network)
  const signer = new JsonRpcSigner(provider, account.address)
  return signer
}

/** Action to convert a viem Wallet Client to an ethers.js Signer. */
export async function getEthersSigner(
  config: Config,
  { chainId }: { chainId?: number } = {},
) {
  const client = await getConnectorClient(config, { chainId })
  return clientToSigner(client)
}

```

:::

---

---
url: /react/guides/ethers.md
---
# Ethers.js Adapters

It is recommended for projects to migrate to [Viem](https://viem.sh) when using Wagmi, but there are some cases where you might still need to use [Ethers.js](https://ethers.org) in your project:

* You may want to **incrementally migrate** Ethers.js usage to Viem
* Some **third-party libraries & SDKs** may only support Ethers.js
* Personal preference

We have provided reference implementations for Viem → Ethers.js adapters that you can copy + paste in your project.

## Client → Provider

### Reference Implementation

Copy the following reference implementation into a file of your choice:

::: code-group

```ts [Ethers v5]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/ethers.md","from":652,"to":1629}<fsm-vh3gqscxm4e>
import { providers } from 'ethers'
import { useMemo } from 'react'
import type { Chain, Client, Transport } from 'viem'
import { Config, useClient } from 'wagmi'

export function clientToProvider(client: Client<Transport, Chain>) {
  const { chain, transport } = client
  const network = {
    chainId: chain.id,
    name: chain.name,
    ensAddress: chain.contracts?.ensRegistry?.address,
  }
  if (transport.type === 'fallback')
    return new providers.FallbackProvider(
      (transport.transports as ReturnType<Transport>[]).map(
        ({ value }) => new providers.JsonRpcProvider(value?.url, network),
      ),
    )
  return new providers.JsonRpcProvider(transport.url, network)
}

/** Hook to convert a viem Client to an ethers.js Provider. */
export function useEthersProvider({
  chainId,
}: { chainId?: number | undefined } = {}) {
  const client = useClient<Config>({ chainId })
  return useMemo(() => (client ? clientToProvider(client) : undefined), [client])
}
```

```ts [Ethers v6]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/ethers.md","from":1652,"to":2688}<fsm-vh3gqscxm4e>
import { FallbackProvider, JsonRpcProvider } from 'ethers'
import { useMemo } from 'react'
import type { Chain, Client, Transport } from 'viem'
import { type Config, useClient } from 'wagmi'

export function clientToProvider(client: Client<Transport, Chain>) {
  const { chain, transport } = client
  const network = {
    chainId: chain.id,
    name: chain.name,
    ensAddress: chain.contracts?.ensRegistry?.address,
  }
  if (transport.type === 'fallback') {
    const providers = (transport.transports as ReturnType<Transport>[]).map(
      ({ value }) => new JsonRpcProvider(value?.url, network),
    )
    if (providers.length === 1) return providers[0]
    return new FallbackProvider(providers)
  }
  return new JsonRpcProvider(transport.url, network)
}

/** Action to convert a viem Client to an ethers.js Provider. */
export function useEthersProvider({ chainId }: { chainId?: number } = {}) {
  const client = useClient<Config>({ chainId })
  return useMemo(() => (client ? clientToProvider(client) : undefined), [client])
}
```

:::

### Usage

Now you can use the `useEthersProvider` function in your components:

::: code-group

```ts [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/ethers.md","from":2814,"to":2928}<fsm-vh3gqscxm4e>
import { useEthersProvider } from './ethers'

function Example() {
  const provider = useEthersProvider()
  ...
}
```

```ts [ethers.ts (Ethers v5)]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/ethers.md","from":2963,"to":3940}<fsm-vh3gqscxm4e>
import { providers } from 'ethers'
import { useMemo } from 'react'
import type { Chain, Client, Transport } from 'viem'
import { Config, useClient } from 'wagmi'

export function clientToProvider(client: Client<Transport, Chain>) {
  const { chain, transport } = client
  const network = {
    chainId: chain.id,
    name: chain.name,
    ensAddress: chain.contracts?.ensRegistry?.address,
  }
  if (transport.type === 'fallback')
    return new providers.FallbackProvider(
      (transport.transports as ReturnType<Transport>[]).map(
        ({ value }) => new providers.JsonRpcProvider(value?.url, network),
      ),
    )
  return new providers.JsonRpcProvider(transport.url, network)
}

/** Hook to convert a viem Client to an ethers.js Provider. */
export function useEthersProvider({
  chainId,
}: { chainId?: number | undefined } = {}) {
  const client = useClient<Config>({ chainId })
  return useMemo(() => (client ? clientToProvider(client) : undefined), [client])
}
```

```ts [ethers.ts (Ethers v6)]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/ethers.md","from":3975,"to":5011}<fsm-vh3gqscxm4e>
import { FallbackProvider, JsonRpcProvider } from 'ethers'
import { useMemo } from 'react'
import type { Chain, Client, Transport } from 'viem'
import { type Config, useClient } from 'wagmi'

export function clientToProvider(client: Client<Transport, Chain>) {
  const { chain, transport } = client
  const network = {
    chainId: chain.id,
    name: chain.name,
    ensAddress: chain.contracts?.ensRegistry?.address,
  }
  if (transport.type === 'fallback') {
    const providers = (transport.transports as ReturnType<Transport>[]).map(
      ({ value }) => new JsonRpcProvider(value?.url, network),
    )
    if (providers.length === 1) return providers[0]
    return new FallbackProvider(providers)
  }
  return new JsonRpcProvider(transport.url, network)
}

/** Action to convert a viem Client to an ethers.js Provider. */
export function useEthersProvider({ chainId }: { chainId?: number } = {}) {
  const client = useClient<Config>({ chainId })
  return useMemo(() => (client ? clientToProvider(client) : undefined), [client])
}
```

:::

## Connector Client → Signer

### Reference Implementation

Copy the following reference implementation into a file of your choice:

::: code-group

```ts [Ethers v5]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/ethers.md","from":5188,"to":6038}<fsm-vh3gqscxm4e>
import { providers } from 'ethers'
import { useMemo } from 'react'
import type { Account, Chain, Client, Transport } from 'viem'
import { Config, useConnectorClient } from 'wagmi'

export function clientToSigner(client: Client<Transport, Chain, Account>) {
  const { account, chain, transport } = client
  const network = {
    chainId: chain.id,
    name: chain.name,
    ensAddress: chain.contracts?.ensRegistry?.address,
  }
  const provider = new providers.Web3Provider(transport, network)
  const signer = provider.getSigner(account.address)
  return signer
}

/** Hook to convert a Viem Client to an ethers.js Signer. */
export function useEthersSigner({ chainId }: { chainId?: number } = {}) {
  const { data: client } = useConnectorClient<Config>({ chainId })
  return useMemo(() => (client ? clientToSigner(client) : undefined), [client])
}
```

```ts [Ethers v6]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/ethers.md","from":6061,"to":6946}<fsm-vh3gqscxm4e>
import { BrowserProvider, JsonRpcSigner } from 'ethers'
import { useMemo } from 'react'
import type { Account, Chain, Client, Transport } from 'viem'
import { type Config, useConnectorClient } from 'wagmi'

export function clientToSigner(client: Client<Transport, Chain, Account>) {
  const { account, chain, transport } = client
  const network = {
    chainId: chain.id,
    name: chain.name,
    ensAddress: chain.contracts?.ensRegistry?.address,
  }
  const provider = new BrowserProvider(transport, network)
  const signer = new JsonRpcSigner(provider, account.address)
  return signer
}

/** Hook to convert a viem Wallet Client to an ethers.js Signer. */
export function useEthersSigner({ chainId }: { chainId?: number } = {}) {
  const { data: client } = useConnectorClient<Config>({ chainId })
  return useMemo(() => (client ? clientToSigner(client) : undefined), [client])
}
```

:::

### Usage

Now you can use the `useEthersSigner` function in your components:

::: code-group

```ts [example.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/ethers.md","from":7070,"to":7178}<fsm-vh3gqscxm4e>
import { useEthersSigner } from './ethers'

function example() {
  const signer = useEthersSigner()
  ...
}
```

```ts [ethers.ts (Ethers v5)]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/ethers.md","from":7213,"to":8065}<fsm-vh3gqscxm4e>
import { providers } from 'ethers'
import { useMemo } from 'react'
import type { Account, Chain, Client, Transport } from 'viem'
import { Config, useConnectorClient } from 'wagmi'

export function clientToSigner(client: Client<Transport, Chain, Account>) {
  const { account, chain, transport } = client
  const network = {
    chainId: chain.id,
    name: chain.name,
    ensAddress: chain.contracts?.ensRegistry?.address,
  }
  const provider = new providers.Web3Provider(transport, network)
  const signer = provider.getSigner(account.address)
  return signer
}

/** Action to convert a Viem Client to an ethers.js Signer. */
export function useEthersSigner({ chainId }: { chainId?: number } = {}) {
  const { data: client } = useConnectorClient<Config>({ chainId })
  return useMemo(() => (client ? clientToSigner(client) : undefined), [client])
}
```

```ts [ethers.ts (Ethers v6)]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/ethers.md","from":8100,"to":8985}<fsm-vh3gqscxm4e>
import { BrowserProvider, JsonRpcSigner } from 'ethers'
import { useMemo } from 'react'
import type { Account, Chain, Client, Transport } from 'viem'
import { type Config, useConnectorClient } from 'wagmi'

export function clientToSigner(client: Client<Transport, Chain, Account>) {
  const { account, chain, transport } = client
  const network = {
    chainId: chain.id,
    name: chain.name,
    ensAddress: chain.contracts?.ensRegistry?.address,
  }
  const provider = new BrowserProvider(transport, network)
  const signer = new JsonRpcSigner(provider, account.address)
  return signer
}

/** Hook to convert a viem Wallet Client to an ethers.js Signer. */
export function useEthersSigner({ chainId }: { chainId?: number } = {}) {
  const { data: client } = useConnectorClient<Config>({ chainId })
  return useMemo(() => (client ? clientToSigner(client) : undefined), [client])
}
```

:::

---

---
url: /cli/api/plugins/etherscan.md
---
# etherscan

Plugin for fetching ABIs from [Etherscan](https://etherscan.io) and adding into `contracts` config.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/etherscan.md","from":131,"to":178}<fsm-vh3gqscxm4e>
import { etherscan } from '@wagmi/cli/plugins'
```

## Usage

```ts{2,6-14}
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/etherscan.md","from":207,"to":580}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { etherscan } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    etherscan({
      apiKey: process.env.ETHERSCAN_API_KEY,
      chainId: 1,
      contracts: [
        {
          name: 'Wagmigotchi',
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        },
      ],
    }),
  ],
})
```

## Configuration

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/etherscan.md","from":609,"to":667}<fsm-vh3gqscxm4e>
import { type EtherscanConfig } from '@wagmi/cli/plugins'
```

### apiKey

`string`

Etherscan API key. Etherscan API keys are specific per network and include testnets (e.g. Ethereum Mainnet and Sepolia share same API key).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/etherscan.md","from":841,"to":1231}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { etherscan } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    etherscan({
      apiKey: process.env.ETHERSCAN_API_KEY, // [!code focus]
      chainId: 1,
      contracts: [
        {
          name: 'Wagmigotchi',
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        },
      ],
    }),
  ],
})
```

### cacheDuration

`number | undefined`

* Duration in milliseconds to cache ABIs.
* Defaults to `1_800_000` (30 minutes).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/etherscan.md","from":1366,"to":1786}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { etherscan } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    etherscan({
      apiKey: process.env.ETHERSCAN_API_KEY,
      cacheDuration: 300_000, // [!code focus]
      chainId: 1,
      contracts: [
        {
          name: 'Wagmigotchi',
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        },
      ],
    }),
  ],
})
```

### chainId

`number`

Chain ID to use for fetching ABI. If [`address`](/cli/config/options#address) is an object, `chainId` is used to select the address.

View supported chains on the [Etherscan docs](https://docs.etherscan.io/etherscan-v2/getting-started/supported-chains).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/etherscan.md","from":2075,"to":2673}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { etherscan } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    etherscan({
      apiKey: process.env.ETHERSCAN_API_KEY,
      chainId: 1, // [!code focus]
      contracts: [
        {
          name: 'Wagmigotchi',
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        },
        {
          name: 'EnsRegistry',
          address: {
            1: '0x314159265dd8dbb310642f98f50c066173c1259b',
            5: '0x112234455c3a32fd11230c42e7bccd4a84e02010',
          },
        },
      ],
    }),
  ],
})
```

### contracts

`{ name: string; address?: Address | Record<number, Address> | undefined }[]`

Contracts to fetch ABIs for.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/etherscan.md","from":2808,"to":3283}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { etherscan } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    etherscan({
      apiKey: process.env.ETHERSCAN_API_KEY,
      chainId: 1,
      contracts: [ // [!code focus]
        { // [!code focus]
          name: 'Wagmigotchi', // [!code focus]
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1', // [!code focus]
        }, // [!code focus]
      ], // [!code focus]
    }),
  ],
})
```

### tryFetchProxyImplementation

`boolean | undefined`

* Whether to try fetching proxy implementation address of the contract.
* Defaults to `false`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/etherscan.md","from":3446,"to":3875}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { etherscan } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    etherscan({
      apiKey: process.env.ETHERSCAN_API_KEY,
      chainId: 1,
      contracts: [
        {
          name: 'FiatToken',
          address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
        },
      ],
      tryFetchProxyImplementation: true, // [!code focus]
    }),
  ],
})
```

---

---
url: /core/api/transports/fallback.md
---

# fallback

The `fallback` Transport consumes **multiple** Transports. If a Transport request fails, it will fall back to the next one in the list. Wraps Viem's [`fallback` Transport](https://viem.sh/docs/clients/transports/fallback).

## Import

```ts-vue
import { fallback } from '{{packageName}}'
```

## Usage

```ts-vue
import { 
  createConfig, 
  fallback, // [!code hl]
  http,
} from '{{packageName}}'
import { mainnet } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet],
  connectors: [injected()],
  transports: {
    [mainnet.id]: fallback([ // [!code hl]
      http('https://foo-bar-baz.quiknode.pro/...'), // [!code hl]
      http('https://mainnet.infura.io/v3/...'), // [!code hl]
    ]) // [!code hl]
  },
})
```

---

---
url: /react/api/transports/fallback.md
---

# fallback

The `fallback` Transport consumes **multiple** Transports. If a Transport request fails, it will fall back to the next one in the list. Wraps Viem's [`fallback` Transport](https://viem.sh/docs/clients/transports/fallback).

## Import

```ts-vue
import { fallback } from '{{packageName}}'
```

## Usage

```ts-vue
import { 
  createConfig, 
  fallback, // [!code hl]
  http,
} from '{{packageName}}'
import { mainnet } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet],
  connectors: [injected()],
  transports: {
    [mainnet.id]: fallback([ // [!code hl]
      http('https://foo-bar-baz.quiknode.pro/...'), // [!code hl]
      http('https://mainnet.infura.io/v3/...'), // [!code hl]
    ]) // [!code hl]
  },
})
```

---

---
url: /shared/transports/fallback.md
---
# fallback

The `fallback` Transport consumes **multiple** Transports. If a Transport request fails, it will fall back to the next one in the list. Wraps Viem's [`fallback` Transport](https://viem.sh/docs/clients/transports/fallback).

## Import

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/fallback.md","from":320,"to":363}<fsm-vh3gqscxm4e>
import { fallback } from '{{packageName}}'
```

## Usage

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/fallback.md","from":388,"to":826}<fsm-vh3gqscxm4e>
import { 
  createConfig, 
  fallback, // [!code hl]
  http,
} from '{{packageName}}'
import { mainnet } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet],
  connectors: [injected()],
  transports: {
    [mainnet.id]: fallback([ // [!code hl]
      http('https://foo-bar-baz.quiknode.pro/...'), // [!code hl]
      http('https://mainnet.infura.io/v3/...'), // [!code hl]
    ]) // [!code hl]
  },
})
```

---

---
url: /solid/api/transports/fallback.md
---

# fallback

The `fallback` Transport consumes **multiple** Transports. If a Transport request fails, it will fall back to the next one in the list. Wraps Viem's [`fallback` Transport](https://viem.sh/docs/clients/transports/fallback).

## Import

```ts-vue
import { fallback } from '{{packageName}}'
```

## Usage

```ts-vue
import { 
  createConfig, 
  fallback, // [!code hl]
  http,
} from '{{packageName}}'
import { mainnet } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet],
  connectors: [injected()],
  transports: {
    [mainnet.id]: fallback([ // [!code hl]
      http('https://foo-bar-baz.quiknode.pro/...'), // [!code hl]
      http('https://mainnet.infura.io/v3/...'), // [!code hl]
    ]) // [!code hl]
  },
})
```

---

---
url: /vue/api/transports/fallback.md
---

# fallback

The `fallback` Transport consumes **multiple** Transports. If a Transport request fails, it will fall back to the next one in the list. Wraps Viem's [`fallback` Transport](https://viem.sh/docs/clients/transports/fallback).

## Import

```ts-vue
import { fallback } from '{{packageName}}'
```

## Usage

```ts-vue
import { 
  createConfig, 
  fallback, // [!code hl]
  http,
} from '{{packageName}}'
import { mainnet } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet],
  connectors: [injected()],
  transports: {
    [mainnet.id]: fallback([ // [!code hl]
      http('https://foo-bar-baz.quiknode.pro/...'), // [!code hl]
      http('https://mainnet.infura.io/v3/...'), // [!code hl]
    ]) // [!code hl]
  },
})
```

---

---
url: /core/guides/faq.md
---
# FAQ / Troubleshooting

Collection of frequently asked questions with ideas on how to troubleshoot and resolve them.

## How do I support the project?

Wagmi is an open source software project and free to use. If you enjoy using Wagmi or would like to support Wagmi development, you can:

* [Become a sponsor on GitHub](https://github.com/sponsors/wevm)
* Send us crypto
  * Mainnet: 0x4557B18E779944BFE9d78A672452331C186a9f48
  * Multichain: 0xd2135CfB216b74109775236E36d4b433F1DF507B
* [Become a supporter on Drips](https://www.drips.network/app/projects/github/wevm/wagmi)

If you use Wagmi at work, **consider asking your company to sponsor Wagmi**. This may not be easy, but **business sponsorships typically make a much larger impact on the sustainability of OSS projects** than individual donations, so you will help us much more if you succeed.

## Type inference doesn't work

* Check that you set up TypeScript correctly with `"strict": true` in your `tsconfig.json` (TypeScript docs)
* Check that you const-asserted any ABIs or Typed Data you are using.
* Restart your language server or IDE, and check for type errors in your code.

## My wallet doesn't work

If you run into issues with a specific wallet, try another before opening up an issue. There are many different wallets and it's likely that the issue is with the wallet itself, not Wagmi. For example, if you are using Wallet X and sending a transaction doesn't work, try Wallet Y and see if it works.

## `BigInt` Serialization

Using native `BigInt` with `JSON.stringify` will raise a `TypeError` as
[`BigInt` values are not serializable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#use_within_json). There are two techniques to mitigate this:

#### Lossless serialization

Lossless serialization means that `BigInt` will be converted to a format that can be deserialized later (e.g. `69420n` → `"#bigint.69420"`). The trade-off is that these values are not human-readable and are not intended to be displayed to the user.

Lossless serialization can be achieved with wagmi's `serialize` and `deserialize` utilities.

```tsx
import { serialize, deserialize } from 'wagmi'

const serialized = serialize({ value: 69420n })
// '{"value":"#bigint.69420"}'

const deserialized = deserialize(serialized)
// { value: 69420n }
```

#### Lossy serialization

Lossy serialization means that the `BigInt` will be converted to a normal display string (e.g. `69420n` → `'69420'`).
The trade-off is that you will not be able to deserialize the `BigInt` with `JSON.parse` as it can not distinguish between a normal string and a `BigInt`.

This method can be achieved by modifying `JSON.stringify` to include a BigInt `replacer`:

```tsx
const replacer = (key, value) =>
  typeof value === 'bigint' ? value.toString() : value

JSON.stringify({ value: 69420n }, replacer)
// '{"value":"69420"}'
```

## Is Wagmi production ready?

Yes. Wagmi is very stable and is used in production by thousands of organizations, like [Stripe](https://stripe.com), [Shopify](https://shopify.com), [Coinbase](https://coinbase.com), [Uniswap](https://uniswap.org), [ENS](https://ens.domains), [Optimism](https://optimism.com).

## Is Wagmi strict with semver?

Yes, Wagmi is very strict with [semantic versioning](https://semver.org) and we will never introduce breaking changes to the runtime API in a minor version bump.

For exported types, we try our best to not introduce breaking changes in non-major versions, however, [TypeScript doesn't follow semver](https://www.learningtypescript.com/articles/why-typescript-doesnt-follow-strict-semantic-versioning) and often introduces breaking changes in minor releases that can cause Wagmi type issues. See the TypeScript docs for more information.

## How can I contribute to Wagmi?

The Wagmi team accepts all sorts of contributions. Check out the [Contributing](/dev/contributing) guide to get started. If you are interested in adding a new connector to Wagmi, check out the [Creating Connectors](/dev/creating-connectors) guide.

## Anything else you want to know?

Please create a new [GitHub Discussion thread](https://github.com/wevm/wagmi). You're also free to suggest changes to this or any other page on the site using the "Suggest changes to this page" button at the bottom of the page.

---

---
url: /react/guides/faq.md
---
# FAQ / Troubleshooting

Collection of frequently asked questions with ideas on how to troubleshoot and resolve them.

## How do I support the project?

Wagmi is an open source software project and free to use. If you enjoy using Wagmi or would like to support Wagmi development, you can:

* [Become a sponsor on GitHub](https://github.com/sponsors/wevm)
* Send us crypto
  * Mainnet: 0x4557B18E779944BFE9d78A672452331C186a9f48
  * Multichain: 0xd2135CfB216b74109775236E36d4b433F1DF507B
* [Become a supporter on Drips](https://www.drips.network/app/projects/github/wevm/wagmi)

If you use Wagmi at work, **consider asking your company to sponsor Wagmi**. This may not be easy, but **business sponsorships typically make a much larger impact on the sustainability of OSS projects** than individual donations, so you will help us much more if you succeed.

## Type inference doesn't work

* Check that you set up TypeScript correctly with `"strict": true` in your `tsconfig.json` (TypeScript docs)
* Check that you const-asserted any ABIs or Typed Data you are using.
* Restart your language server or IDE, and check for type errors in your code.

## My wallet doesn't work

If you run into issues with a specific wallet, try another before opening up an issue. There are many different wallets and it's likely that the issue is with the wallet itself, not Wagmi. For example, if you are using Wallet X and sending a transaction doesn't work, try Wallet Y and see if it works.

## `BigInt` Serialization

Using native `BigInt` with `JSON.stringify` will raise a `TypeError` as
[`BigInt` values are not serializable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#use_within_json). There are two techniques to mitigate this:

#### Lossless serialization

Lossless serialization means that `BigInt` will be converted to a format that can be deserialized later (e.g. `69420n` → `"#bigint.69420"`). The trade-off is that these values are not human-readable and are not intended to be displayed to the user.

Lossless serialization can be achieved with wagmi's `serialize` and `deserialize` utilities.

```tsx
import { serialize, deserialize } from 'wagmi'

const serialized = serialize({ value: 69420n })
// '{"value":"#bigint.69420"}'

const deserialized = deserialize(serialized)
// { value: 69420n }
```

#### Lossy serialization

Lossy serialization means that the `BigInt` will be converted to a normal display string (e.g. `69420n` → `'69420'`).
The trade-off is that you will not be able to deserialize the `BigInt` with `JSON.parse` as it can not distinguish between a normal string and a `BigInt`.

This method can be achieved by modifying `JSON.stringify` to include a BigInt `replacer`:

```tsx
const replacer = (key, value) =>
  typeof value === 'bigint' ? value.toString() : value

JSON.stringify({ value: 69420n }, replacer)
// '{"value":"69420"}'
```

## Is Wagmi production ready?

Yes. Wagmi is very stable and is used in production by thousands of organizations, like [Stripe](https://stripe.com), [Shopify](https://shopify.com), [Coinbase](https://coinbase.com), [Uniswap](https://uniswap.org), [ENS](https://ens.domains), [Optimism](https://optimism.com).

## Is Wagmi strict with semver?

Yes, Wagmi is very strict with [semantic versioning](https://semver.org) and we will never introduce breaking changes to the runtime API in a minor version bump.

For exported types, we try our best to not introduce breaking changes in non-major versions, however, [TypeScript doesn't follow semver](https://www.learningtypescript.com/articles/why-typescript-doesnt-follow-strict-semantic-versioning) and often introduces breaking changes in minor releases that can cause Wagmi type issues. See the TypeScript docs for more information.

## How can I contribute to Wagmi?

The Wagmi team accepts all sorts of contributions. Check out the [Contributing](/dev/contributing) guide to get started. If you are interested in adding a new connector to Wagmi, check out the [Creating Connectors](/dev/creating-connectors) guide.

## Anything else you want to know?

Please create a new [GitHub Discussion thread](https://github.com/wevm/wagmi). You're also free to suggest changes to this or any other page on the site using the "Suggest changes to this page" button at the bottom of the page.

## How does Wagmi work?

Until there's a more in-depth write-up about Wagmi internals, here is the gist:

* Wagmi is essentially a wrapper around [Viem](https://viem.sh) and TanStack Query that adds connector and multichain support.
* [Connectors](/react/api/connectors) allow Wagmi and Ethereum accounts to communicate with each other.
* The Wagmi [`Config`](/react/api/createConfig#config) manages connections established between Wagmi and Connectors, as well as some global state. [Connections](/react/api/createConfig#connection) come with one or more addresses and a chain ID.
  * If there are connections, the Wagmi `Config` listens for connection changes and updates the [`chainId`](/react/api/createConfig#chainid) based on the ["current" connection](/react/api/createConfig#current). (The Wagmi `Config` can have [many connections established](/react/api/createConfig#connections) at once, but only one connection can be the "current" connection. Usually this is the connection from the last connector that is connected, but can change based on event emitted from other connectors or through the [`useSwitchConnection`](/react/api/hooks/useSwitchConnection) hook and [`switchConnection`](/core/api/actions/switchConnection) action.)
  * If there are no connections, the Wagmi `Config` defaults the global state `chainId` to the first chain it was created with or last established connection.
  * The global `chainId` can be changed directly using the [`useSwitchChain`](/react/api/hooks/useSwitchChain) hook and [`switchChain`](/core/api/actions/switchChain) action. This works when there are no connections as well as for most connectors (not all connectors support chain switching).
* Wagmi uses the global `chainId` (from the "current" connection or global state) to internally create Viem Client's, which are used by hooks and actions.
* Hooks are constructed by TanStack Query options helpers, exported by the `'@wagmi/core/query'` entrypoint, and some additional code to wire up type parameters, hook into React Context, etc.
* There are three types of hooks: query hooks, mutation hooks, and config hooks. Query hooks, like [`useCall`](/react/api/hooks/useCall), generally read blockchain state and mutation hooks, like [`useSendTransaction`](/react/api/hooks/useSendTransaction), usually change state through sending transactions via the "current" connection. Config hooks are for getting data from and managing the Wagmi `Config` instance, e.g. [`useChainId`](/react/api/hooks/useChainId) and `useSwitchConnection`. Query and mutation hooks usually have corresponding [Viem actions.](https://viem.sh)

---

---
url: /vue/guides/faq.md
---
# FAQ / Troubleshooting

Collection of frequently asked questions with ideas on how to troubleshoot and resolve them.

## How do I support the project?

Wagmi is an open source software project and free to use. If you enjoy using Wagmi or would like to support Wagmi development, you can:

* [Become a sponsor on GitHub](https://github.com/sponsors/wevm)
* Send us crypto
  * Mainnet: 0x4557B18E779944BFE9d78A672452331C186a9f48
  * Multichain: 0xd2135CfB216b74109775236E36d4b433F1DF507B
* [Become a supporter on Drips](https://www.drips.network/app/projects/github/wevm/wagmi)

If you use Wagmi at work, **consider asking your company to sponsor Wagmi**. This may not be easy, but **business sponsorships typically make a much larger impact on the sustainability of OSS projects** than individual donations, so you will help us much more if you succeed.

## Type inference doesn't work

* Check that you set up TypeScript correctly with `"strict": true` in your `tsconfig.json` (TypeScript docs)
* Check that you const-asserted any ABIs or Typed Data you are using.
* Restart your language server or IDE, and check for type errors in your code.

## My wallet doesn't work

If you run into issues with a specific wallet, try another before opening up an issue. There are many different wallets and it's likely that the issue is with the wallet itself, not Wagmi. For example, if you are using Wallet X and sending a transaction doesn't work, try Wallet Y and see if it works.

## `BigInt` Serialization

Using native `BigInt` with `JSON.stringify` will raise a `TypeError` as
[`BigInt` values are not serializable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#use_within_json). There are two techniques to mitigate this:

#### Lossless serialization

Lossless serialization means that `BigInt` will be converted to a format that can be deserialized later (e.g. `69420n` → `"#bigint.69420"`). The trade-off is that these values are not human-readable and are not intended to be displayed to the user.

Lossless serialization can be achieved with wagmi's `serialize` and `deserialize` utilities.

```tsx
import { serialize, deserialize } from 'wagmi'

const serialized = serialize({ value: 69420n })
// '{"value":"#bigint.69420"}'

const deserialized = deserialize(serialized)
// { value: 69420n }
```

#### Lossy serialization

Lossy serialization means that the `BigInt` will be converted to a normal display string (e.g. `69420n` → `'69420'`).
The trade-off is that you will not be able to deserialize the `BigInt` with `JSON.parse` as it can not distinguish between a normal string and a `BigInt`.

This method can be achieved by modifying `JSON.stringify` to include a BigInt `replacer`:

```tsx
const replacer = (key, value) =>
  typeof value === 'bigint' ? value.toString() : value

JSON.stringify({ value: 69420n }, replacer)
// '{"value":"69420"}'
```

## Is Wagmi production ready?

Yes. Wagmi is very stable and is used in production by thousands of organizations, like [Stripe](https://stripe.com), [Shopify](https://shopify.com), [Coinbase](https://coinbase.com), [Uniswap](https://uniswap.org), [ENS](https://ens.domains), [Optimism](https://optimism.com).

## Is Wagmi strict with semver?

Yes, Wagmi is very strict with [semantic versioning](https://semver.org) and we will never introduce breaking changes to the runtime API in a minor version bump.

For exported types, we try our best to not introduce breaking changes in non-major versions, however, [TypeScript doesn't follow semver](https://www.learningtypescript.com/articles/why-typescript-doesnt-follow-strict-semantic-versioning) and often introduces breaking changes in minor releases that can cause Wagmi type issues. See the TypeScript docs for more information.

## How can I contribute to Wagmi?

The Wagmi team accepts all sorts of contributions. Check out the [Contributing](/dev/contributing) guide to get started. If you are interested in adding a new connector to Wagmi, check out the [Creating Connectors](/dev/creating-connectors) guide.

## Anything else you want to know?

Please create a new [GitHub Discussion thread](https://github.com/wevm/wagmi). You're also free to suggest changes to this or any other page on the site using the "Suggest changes to this page" button at the bottom of the page.

---

---
url: /cli/api/plugins/fetch.md
---
# fetch

Plugin for fetching and parsing ABIs from network resource with `fetch`.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/fetch.md","from":100,"to":143}<fsm-vh3gqscxm4e>
import { fetch } from '@wagmi/cli/plugins'
```

## Usage

```ts{2,6-23}
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/fetch.md","from":172,"to":853}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { fetch } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    fetch({
      contracts: [
        {
          name: 'Wagmigotchi',
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        },
      ],
      request(contract) {
        if (!contract.address) throw new Error('address is required')
        const address =
          typeof contract.address === 'string'
            ? contract.address
            : Object.values(contract.address)[0]
        return {
          url: `https://api.etherscan.io/api?module=contract&action=getabi&address=${address}`,
        }
      },
    }),
  ],
})
```

## Configuration

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/fetch.md","from":883,"to":937}<fsm-vh3gqscxm4e>
import { type FetchConfig } from '@wagmi/cli/plugins'
```

### cacheDuration

`number | undefined`

* Duration in milliseconds to cache ABIs.
* Defaults to `1_800_000` (30 minutes).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/fetch.md","from":1072,"to":1800}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { fetch } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    fetch({
      cacheDuration: 300_000, // [!code focus]
      contracts: [
        {
          name: 'Wagmigotchi',
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        },
      ],
      request(contract) {
        if (!contract.address) throw new Error('address is required')
        const address =
          typeof contract.address === 'string'
            ? contract.address
            : Object.values(contract.address)[0]
        return {
          url: `https://api.etherscan.io/api?module=contract&action=getabi&address=${address}`,
        }
      },
    }),
  ],
})
```

### contracts

`{ name: string; address?: Address | Record<number, Address> | undefined }[]`

Contracts to fetch ABIs for.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/fetch.md","from":1935,"to":2719}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { fetch } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    fetch({
      contracts: [ // [!code focus]
        { // [!code focus]
          name: 'Wagmigotchi', // [!code focus]
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1', // [!code focus]
        }, // [!code focus]
      ], // [!code focus]
      request(contract) {
        if (!contract.address) throw new Error('address is required')
        const address =
          typeof contract.address === 'string'
            ? contract.address
            : Object.values(contract.address)[0]
        return {
          url: `https://api.etherscan.io/api?module=contract&action=getabi&address=${address}`,
        }
      },
    }),
  ],
})

```

### getCacheKey

`((config: { contract: { address: Address | Record<chainId, Address> | undefined; name: string } }) => string) | undefined`

* Function for creating a cache key for contract. Contract data is cached at `~/.wagmi-cli/plugins/fetch/cache/`.
* Defaults to `({ contract }) => JSON.stringify(contract)`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/fetch.md","from":3047,"to":4015}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { fetch } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    fetch({
      contracts: [
        {
          name: 'wagmigotchi',
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        },
      ],
      getCacheKey({ contract }) { // [!code focus]
        if (typeof contract.address === 'string') // [!code focus]
          return `${name}:${contract.address}` // [!code focus]
        return `${name}:${JSON.stringify(contract.address)}` // [!code focus]
      }, // [!code focus]
      request(contract) {
        if (!contract.address) throw new Error('address is required')
        const address =
          typeof contract.address === 'string'
            ? contract.address
            : Object.values(contract.address)[0]
        return {
          url: `https://api.etherscan.io/api?module=contract&action=getabi&address=${address}`,
        }
      },
    }),
  ],
})

```

### name

`string`

* Name of source.
* Defaults to `'Fetch'`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/fetch.md","from":4090,"to":4813}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { fetch } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    fetch({
      contracts: [
        {
          name: 'Wagmigotchi',
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        },
      ],
      name: 'Etherscan', // [!code focus]
      request(contract) {
        if (!contract.address) throw new Error('address is required')
        const address =
          typeof contract.address === 'string'
            ? contract.address
            : Object.values(contract.address)[0]
        return {
          url: `https://api.etherscan.io/api?module=contract&action=getabi&address=${address}`,
        }
      },
    }),
  ],
})
```

### parse

`((config: { response: Response }) => Abi | Promise<Abi>) | undefined`

* Function for parsing ABI from fetch response.
* Defaults to `({ response }) => response.json()`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/fetch.md","from":5006,"to":5949}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { fetch } from '@wagmi/cli/plugins'
 
export default defineConfig({
  plugins: [
    fetch({
      contracts: [
        {
          name: 'Wagmigotchi',
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        },
      ],
      async parse({ response }) { // [!code focus]
        const json = await response.json() // [!code focus]
        if (json.status === '0') throw new Error(json.message) // [!code focus]
        return json.result // [!code focus]
      }, // [!code focus]
      request(contract) {
        if (!contract.address) throw new Error('address is required')
        const address =
          typeof contract.address === 'string'
            ? contract.address
            : Object.values(contract.address)[0]
        return {
          url: `https://api.etherscan.io/api?module=contract&action=getabi&address=${address}`,
        }
      },
    }),
  ],
})
```

### request

`(config: { address?: Address | Record<chainId, Address> | undefined }) => { url: RequestInfo; init?: RequestInit | undefined } | Promise<{ url: RequestInfo; init?: RequestInit | undefined }>`

Function for returning a request to fetch ABI from.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/fetch.md","from":6220,"to":7072}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { fetch } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    fetch({
      contracts: [
        {
          name: 'Wagmigotchi',
          address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        },
      ],
      request(contract) { // [!code focus]
        if (!contract.address) throw new Error('address is required') // [!code focus]
        const address = // [!code focus]
          typeof contract.address === 'string' // [!code focus]
            ? contract.address // [!code focus]
            : Object.values(contract.address)[0] // [!code focus]
        return { // [!code focus]
          url: `https://api.etherscan.io/api?module=contract&action=getabi&address=${address}`, // [!code focus]
        } // [!code focus]
      }, // [!code focus]
    }),
  ],
})

```

---

---
url: /cli/api/plugins/foundry.md
---
# foundry

Plugin for resolving ABIs from [Foundry](https://github.com/foundry-rs/foundry) projects. Supports [`watch`](/cli/api/commands/generate#w-watch) mode.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/foundry.md","from":180,"to":225}<fsm-vh3gqscxm4e>
import { foundry } from '@wagmi/cli/plugins'
```

## Usage

```ts{2,6-8}
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/foundry.md","from":253,"to":449}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { foundry } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    foundry({
      project: '../hello_foundry',
    }),
  ],
})
```

## Configuration

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/foundry.md","from":478,"to":534}<fsm-vh3gqscxm4e>
import { type FoundryConfig } from '@wagmi/cli/plugins'
```

### artifacts

`string | undefined`

* Project's artifacts directory. Same as your `foundry.toml`/`forge`s `--out` (`-o`) option.
* Defaults to `'out/'`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/foundry.md","from":700,"to":903}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { foundry } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    foundry({
      artifacts: 'out/', // [!code focus]
    }),
  ],
})
```

### includeBroadcasts

`boolean | undefined`

Automatically detect contract deployments from Foundry's `run-latest.json` files in the `broadcast/` directory.

* The `deployments` mapping can be used to override broadcast deployments for the same contract.
* Broadcasts are read once when `wagmi generate` runs. To pick up new broadcast deployments after running deploy scripts, rerun the generate command.
* Defaults to `false`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/foundry.md","from":1344,"to":1553}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { foundry } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    foundry({
      includeBroadcasts: true, // [!code focus]
    }),
  ],
})
```

### deployments

`{ [key: string]: address?: Address | Record<chainId, Address> | undefined } | undefined`

Mapping of addresses to attach to artifacts.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/foundry.md","from":1718,"to":2159}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { foundry } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    foundry({
      deployments: { // [!code focus]
        Counter: { // [!code focus]
          1: '0x314159265dd8dbb310642f98f50c066173c1259b', // [!code focus]
          5: '0x112234455c3a32fd11230c42e7bccd4a84e02010', // [!code focus]
        }, // [!code focus]
      }, // [!code focus]
    }),
  ],
})
```

### exclude

`string[] | undefined`

Artifact files to exclude relative to `artifacts`. Supports glob patterns.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/foundry.md","from":2283,"to":3324}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { foundry } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    foundry({
      exclude: [ // [!code focus]
        // the following patterns are excluded by default // [!code focus]
        'Common.sol/**', // [!code focus]
        'Components.sol/**', // [!code focus]
        'Script.sol/**', // [!code focus]
        'StdAssertions.sol/**', // [!code focus]
        'StdInvariant.sol/**', // [!code focus]
        'StdError.sol/**', // [!code focus]
        'StdCheats.sol/**', // [!code focus]
        'StdMath.sol/**', // [!code focus]
        'StdJson.sol/**', // [!code focus]
        'StdStorage.sol/**', // [!code focus]
        'StdUtils.sol/**', // [!code focus]
        'Vm.sol/**', // [!code focus]
        'console.sol/**', // [!code focus]
        'console2.sol/**', // [!code focus]
        'test.sol/**', // [!code focus]
        '**.s.sol/*.json', // [!code focus]
        '**.t.sol/*.json', // [!code focus]
      ], // [!code focus]
    }),
  ],
})
```

### forge

`{ clean?: boolean | undefined; build?: boolean | undefined; path?: string | undefined; rebuild?: boolean | undefined } | undefined`

Options for `forge`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/foundry.md","from":3502,"to":3891}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { foundry } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    foundry({
      forge: {  // [!code focus]
        clean: true,  // [!code focus]
        build: true,  // [!code focus]
        path: 'path/to/forge',  // [!code focus]
        rebuild: true,  // [!code focus]
      },  // [!code focus]
    }),
  ],
})
```

#### clean

* Remove build artifacts and cache directories on start up.
* Defaults to `false`.

#### build

* Build Foundry project before fetching artifacts.
* Defaults to `true`.

#### path

* Path to `forge` executable command.
* Defaults to `forge`.

#### rebuild

* Rebuild every time a watched file or directory is changed. Used for setting up [`watch`](/cli/api/commands/generate#w-watch) mode.
* Defaults to `true`.

### include

`string[] | undefined`

Artifact files to include relative to `artifacts`. Supports glob patterns.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/foundry.md","from":4440,"to":4775}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { foundry } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    foundry({
      include: [  // [!code focus]
        // the following patterns are included by default  // [!code focus]
        '*.json',  // [!code focus]
      ],  // [!code focus]
    }),
  ],
})
```

### namePrefix

`string | undefined`

Prefix to prepend to artifact names. Useful for preventing name collisions between contracts from other sources.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/foundry.md","from":4938,"to":5187}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { foundry } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    foundry({  // [!code focus]
      namePrefix: 'HelloFoundry',  // [!code focus]
    }),  // [!code focus]
  ],
})
```

### project

`string | undefined`

* Path to Foundry project.
* Defaults to Foundry configuration using `forge config --json` command.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/foundry.md","from":5334,"to":5581}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { foundry } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    foundry({ // [!code focus]
      project: '../hello_foundry', // [!code focus]
    }), // [!code focus]
  ],
})
```

---

---
url: /core/guides/framework-adapters.md
---
# Framework Adapters

Folks often ask if they can use Wagmi with other frameworks, like Svelte, Solid.js, and more.

The short answer is — you already can! Wagmi Core is pure VanillaJS that you can use with any framework. For some, this answer is (understandably) unsatisfying as they want a tight integration between Wagmi Core and their favorite framework's reactivity system, e.g. what Wagmi is for React and Vue.

Someday, we would love to support additional frameworks, but unfortunately the core team doesn't have time to build and support them in a high-quality way at the moment. This could change in the future with additional [sponsors](https://github.com/sponsors/wevm), reshuffling of the roadmap, or if someone from the community wants to lead the effort.

In the meantime, here are some tips on how to create tighter bonds between Wagmi Core and other frameworks.

## Dependency Injection

Once you create a Wagmi Config, you'll need to make sure your framework has access to it inside your higher-level functions (e.g. hooks for React, composables for Vue). For example, Wagmi uses [React Context](https://react.dev/learn/passing-data-deeply-with-context) to inject the Config into React Hooks and update it if it changes. This makes it so your users don't need to pass a Config object every time they use a hook.

## Reactivity Layer

All frameworks approach reactivity in a different way. To hook into your favorite frameworks, reactivity system, it's often helpful to see what other popular libraries for your framework are doing.

The most important thing to hook up Wagmi Core with your framework is to make sure changes to the Wagmi Config are tracked. This enables behavior, like switching chains or connecting accounts, to propagate throughout your app and update state. Check out [`useConnection`](https://github.com/wevm/wagmi/blob/main/packages/react/src/hooks/useConnection.ts), [`useChainId`](https://github.com/wevm/wagmi/blob/main/packages/react/src/hooks/useChainId.ts), [`useClient`](https://github.com/wevm/wagmi/blob/main/packages/react/src/hooks/useClient.ts), and [`useConnectorClient`](https://github.com/wevm/wagmi/blob/main/packages/react/src/hooks/useConnectorClient.ts) — versions of these for your framework are important to get right as they power a lot of internals.

## TanStack Query

Wagmi uses [TanStack Query](https://tanstack.com/query) to enable caching, deduplication, persistence, and more in React and Vue applications. Normally, you would need to find a similar library for your framework, but the good news is TanStack Query supports other frameworks! (Svelte, Solid, and Angular at the time of writing.)

To get started with your framework, install and set up the related TanStack Query adapter. Next, import query keys/functions and mutation functions from the `'@wagmi/core/query'` entrypoint. You can plug these directly into your framework's TanStack Query adapter functions.

If you are building a library, you'll also want to make sure that you wire up generics correctly so type-inference and safety work correctly. The best way to make sure you are doing this correctly, is to see how we do this for React with Wagmi by checking out the [source code](https://github.com/wevm/wagmi/tree/main/packages/react/src/hooks).

## Testing

If you are building a library, you'll want to write tests. Wagmi uses [React Testing Library](https://testing-library.com/docs/react-testing-library/intro) to test hooks. [Testing Library](https://testing-library.com) also supports other frameworks, like Svelte, Solid, and more. You can take a look at how the React tests work and do something similar for your code.

## Proxy Exports

Wagmi proxies exports directly from Wagmi Core and [Viem](https://viem.sh) to make importing easier. You'll likely want to imitate this behavior for your framework.

---

---
url: /cli/api/commands/generate.md
---
# generate

Generates code based on configuration, using `contracts` and `plugins`.

## Usage

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/commands/generate.md","from":103,"to":119}<fsm-vh3gqscxm4e>
wagmi generate 
```

## Options

### -c, --config \<path>

`string`

Path to config file.

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/commands/generate.md","from":203,"to":243}<fsm-vh3gqscxm4e>
wagmi generate --config wagmi.config.ts
```

### -r, --root \<path>

`string`

Root path to resolve config from.

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/commands/generate.md","from":326,"to":361}<fsm-vh3gqscxm4e>
wagmi generate --root path/to/root
```

### -w, --watch

`boolean`

Watch for changes (for plugins that support watch mode).

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/commands/generate.md","from":460,"to":483}<fsm-vh3gqscxm4e>
wagmi generate --watch
```

### -h, --help

Displays help message.

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/commands/generate.md","from":536,"to":558}<fsm-vh3gqscxm4e>
wagmi generate --help
```

---

---
url: /core/api/actions/getBalance.md
---
# getBalance

Action for fetching native currency balance.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBalance.md","from":199,"to":240}<fsm-vh3gqscxm4e>
import { getBalance } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBalance.md","from":287,"to":460}<fsm-vh3gqscxm4e>
import { getBalance } from '@wagmi/core'
import { config } from './config'

const balance = getBalance(config, {
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBalance.md","from":531,"to":587}<fsm-vh3gqscxm4e>
import { type GetBalanceParameters } from '@wagmi/core'
```

### address

`Address`

Address to get balance for.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBalance.md","from":677,"to":867}<fsm-vh3gqscxm4e>
import { getBalance } from '@wagmi/core'
import { config } from './config'

const balance = getBalance(config, {
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### blockNumber

`bigint | undefined`

Block number to get balance at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBalance.md","from":1026,"to":1242}<fsm-vh3gqscxm4e>
import { getBalance } from '@wagmi/core'
import { config } from './config'

const balance = getBalance(config, {
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
  blockNumber: 17829139n, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get balance at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBalance.md","from":1440,"to":1652}<fsm-vh3gqscxm4e>
import { getBalance } from '@wagmi/core'
import { config } from './config'

const balance = getBalance(config, {
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
  blockTag: 'latest', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBalance.md","from":1838,"to":2102}<fsm-vh3gqscxm4e>
import { getBalance } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const balance = await getBalance(config, {
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
  chainId: mainnet.id, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBalance.md","from":2174,"to":2230}<fsm-vh3gqscxm4e>
import { type GetBalanceReturnType } from '@wagmi/core'
```

### decimals

`number`

Number of decimals for balance [`value`](#value).

### symbol

`string`

Symbol of native currency.

### value

`bigint`

Raw value of balance.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBalance.md","from":2420,"to":2475}<fsm-vh3gqscxm4e>
import { type GetBalanceErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getBalance`](https://viem.sh/docs/actions/public/getBalance) for native currency balances
* [`multicall`](https://viem.sh/docs/contract/multicall) for token balances

---

---
url: /core/api/actions/getBlobBaseFee.md
---
# getBlobBaseFee

Action for fetching the current blob base fee (in wei).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlobBaseFee.md","from":222,"to":267}<fsm-vh3gqscxm4e>
import { getBlobBaseFee } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlobBaseFee.md","from":314,"to":443}<fsm-vh3gqscxm4e>
import { getBlobBaseFee } from '@wagmi/core'
import { config } from './config'

const blobBaseFee = await getBlobBaseFee(config)
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlobBaseFee.md","from":514,"to":574}<fsm-vh3gqscxm4e>
import { type GetBlobBaseFeeParameters } from '@wagmi/core'
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlobBaseFee.md","from":710,"to":929}<fsm-vh3gqscxm4e>
import { getBlobBaseFee } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const blobBaseFee = await getBlobBaseFee(config, {
  chainId: mainnet.id, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlobBaseFee.md","from":1001,"to":1061}<fsm-vh3gqscxm4e>
import { type GetBlobBaseFeeReturnType } from '@wagmi/core'
```

`bigint`

Current blob base fee (in wei).

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlobBaseFee.md","from":1125,"to":1184}<fsm-vh3gqscxm4e>
import { type GetBlobBaseFeeErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getBlobBaseFee`](https://viem.sh/docs/actions/public/getBlobBaseFee)

---

---
url: /core/api/actions/getBlock.md
---
# getBlock

Action for fetching information about a block at a block number, hash or tag.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlock.md","from":226,"to":265}<fsm-vh3gqscxm4e>
import { getBlock } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlock.md","from":312,"to":429}<fsm-vh3gqscxm4e>
import { getBlock } from '@wagmi/core'
import { config } from './config'

const blockNumber = await getBlock(config)
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlock.md","from":500,"to":554}<fsm-vh3gqscxm4e>
import { type GetBlockParameters } from '@wagmi/core'
```

### blockHash

`` `0x${string}` ``

Information at a given block hash.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlock.md","from":663,"to":884}<fsm-vh3gqscxm4e>
import { getBlock } from '@wagmi/core'
import { config } from './config'

const blockNumber = await getBlock(config, {
  blockHash: '0x89644bbd5c8d682a2e9611170e6c1f02573d866d286f006cbf517eec7254ec2d' // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`bigint`

Information at a given block number.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlock.md","from":1035,"to":1196}<fsm-vh3gqscxm4e>
import { getBlock } from '@wagmi/core'
import { config } from './config'

const blockNumber = await getBlock(config, {
  blockNumber: 42069n // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized'`

Information at a given block tag. Defaults to `'latest'`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlock.md","from":1415,"to":1576}<fsm-vh3gqscxm4e>
import { getBlock } from '@wagmi/core'
import { config } from './config'

const blockNumber = await getBlock(config, {
  blockTag: 'pending' // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlock.md","from":1757,"to":1964}<fsm-vh3gqscxm4e>
import { getBlock } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const blockNumber = await getBlock(config, {
  chainId: mainnet.id, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### includeTransactions

`boolean`

Whether or not to include transactions as objects.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlock.md","from":2134,"to":2301}<fsm-vh3gqscxm4e>
import { getBlock } from '@wagmi/core'
import { config } from './config'

const blockNumber = await getBlock(config, {
  includeTransactions: true // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlock.md","from":2373,"to":2427}<fsm-vh3gqscxm4e>
import { type GetBlockReturnType } from '@wagmi/core'
```

[`Block`](https://viem.sh/docs/glossary/types#block)

Information about the block.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlock.md","from":2532,"to":2585}<fsm-vh3gqscxm4e>
import { type GetBlockErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getBlock`](https://viem.sh/docs/actions/public/getBlock)

---

---
url: /core/api/actions/getBlockNumber.md
---
# getBlockNumber

Action for fetching the number of the most recent block seen.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlockNumber.md","from":228,"to":273}<fsm-vh3gqscxm4e>
import { getBlockNumber } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlockNumber.md","from":320,"to":449}<fsm-vh3gqscxm4e>
import { getBlockNumber } from '@wagmi/core'
import { config } from './config'

const blockNumber = await getBlockNumber(config)
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlockNumber.md","from":520,"to":580}<fsm-vh3gqscxm4e>
import { type GetBlockNumberParameters } from '@wagmi/core'
```

### cacheTime

`number | undefined`

Time in milliseconds that cached block number will remain in memory.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlockNumber.md","from":724,"to":895}<fsm-vh3gqscxm4e>
import { getBlockNumber } from '@wagmi/core'
import { config } from './config'

const blockNumber = await getBlockNumber(config, {
  cacheTime: 4_000, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlockNumber.md","from":1076,"to":1295}<fsm-vh3gqscxm4e>
import { getBlockNumber } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const blockNumber = await getBlockNumber(config, {
  chainId: mainnet.id, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlockNumber.md","from":1367,"to":1427}<fsm-vh3gqscxm4e>
import { type GetBlockNumberReturnType } from '@wagmi/core'
```

`bigint`

Most recent block number seen.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlockNumber.md","from":1490,"to":1549}<fsm-vh3gqscxm4e>
import { type GetBlockNumberErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getBlockNumber`](https://viem.sh/docs/actions/public/getBlockNumber)
* [`watchBlockNumber`](https://viem.sh/docs/actions/public/watchBlockNumber)

---

---
url: /core/api/actions/getBlockTransactionCount.md
---
# getBlockTransactionCount

Action for fetching the number of Transactions at a block number, hash or tag.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlockTransactionCount.md","from":275,"to":330}<fsm-vh3gqscxm4e>
import { getBlockTransactionCount } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlockTransactionCount.md","from":377,"to":536}<fsm-vh3gqscxm4e>
import { getBlockTransactionCount } from '@wagmi/core'
import { config } from './config'

const blockTransactionCount = await getBlockTransactionCount(config)
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlockTransactionCount.md","from":607,"to":677}<fsm-vh3gqscxm4e>
import { type GetBlockTransactionCountParameters } from '@wagmi/core'
```

### cacheTime

`number | undefined`

Time in milliseconds that cached block transaction count will remain in memory.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlockTransactionCount.md","from":832,"to":1033}<fsm-vh3gqscxm4e>
import { getBlockTransactionCount } from '@wagmi/core'
import { config } from './config'

const blockTransactionCount = await getBlockTransactionCount(config, {
  cacheTime: 4_000, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlockTransactionCount.md","from":1214,"to":1463}<fsm-vh3gqscxm4e>
import { getBlockTransactionCount } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const blockTransactionCount = await getBlockTransactionCount(config, {
  chainId: mainnet.id, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlockTransactionCount.md","from":1535,"to":1605}<fsm-vh3gqscxm4e>
import { type GetBlockTransactionCountReturnType } from '@wagmi/core'
```

`number`

The number of Transactions at a block number

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBlockTransactionCount.md","from":1682,"to":1751}<fsm-vh3gqscxm4e>
import { type GetBlockTransactionCountErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getBlockTransactionCount`](https://viem.sh/docs/actions/public/getBlockTransactionCount)

---

---
url: /core/api/actions/getBytecode.md
---
# getBytecode

Action for retrieving the bytecode at an address.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBytecode.md","from":207,"to":249}<fsm-vh3gqscxm4e>
import { getBytecode } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBytecode.md","from":296,"to":461}<fsm-vh3gqscxm4e>
import { getBytecode } from '@wagmi/core'
import { config } from './config'

await getBytecode(config, {
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBytecode.md","from":532,"to":589}<fsm-vh3gqscxm4e>
import { type GetBytecodeParameters } from '@wagmi/core'
```

### address

`Address`

The contract address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBytecode.md","from":673,"to":855}<fsm-vh3gqscxm4e>
import { getBytecode } from '@wagmi/core'
import { config } from './config'

await getBytecode(config, {
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`bigint | undefined`

The block number to check the bytecode at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBytecode.md","from":1020,"to":1228}<fsm-vh3gqscxm4e>
import { getBytecode } from '@wagmi/core'
import { config } from './config'

await getBytecode(config, {
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  blockNumber: 16280770n, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

The block tag to check the bytecode at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBytecode.md","from":1437,"to":1639}<fsm-vh3gqscxm4e>
import { getBytecode } from '@wagmi/core'
import { config } from './config'

await getBytecode(config, {
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  blockTag: 'safe', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

The chain ID to check the bytecode at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBytecode.md","from":1820,"to":2070}<fsm-vh3gqscxm4e>
import { getBytecode } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

await getBytecode(config, {
  chainId: mainnet.id, // [!code focus]
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBytecode.md","from":2142,"to":2199}<fsm-vh3gqscxm4e>
import { type GetBytecodeReturnType } from '@wagmi/core'
```

`Hex`

The contract's bytecode.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getBytecode.md","from":2253,"to":2309}<fsm-vh3gqscxm4e>
import { type GetBytecodeErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getCode`](https://viem.sh/docs/contract/getCode)

---

---
url: /core/api/actions/getCallsStatus.md
---
# getCallsStatus

Action to fetch the status and receipts of a call batch that was sent via [`sendCalls`](/core/api/actions/sendCalls).

[Read more.](https://github.com/ethereum/EIPs/blob/1663ea2e7a683285f977eda51c32cec86553f585/EIPS/eip-5792.md#wallet_getcallsstatus)

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getCallsStatus.md","from":417,"to":462}<fsm-vh3gqscxm4e>
import { getCallsStatus } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getCallsStatus.md","from":509,"to":666}<fsm-vh3gqscxm4e>
import { getCallsStatus } from '@wagmi/core'
import { config } from './config'

const status = await getCallsStatus(config, {
  id: '0x1234567890abcdef',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getCallsStatus.md","from":737,"to":797}<fsm-vh3gqscxm4e>
import { type GetCallsStatusParameters } from '@wagmi/core'
```

### connector

`Connector | undefined`

Connector to get call statuses with.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getCallsStatus.md","from":912,"to":1185}<fsm-vh3gqscxm4e>
import { getConnections, getCallsStatus } from '@wagmi/core'
import { config } from './config'

const connections = getConnections(config)
const status = await getCallsStatus(config, {
  connector: connections[0]?.connector, // [!code focus]
  id: '0x1234567890abcdef',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### id

`string`

Identifier of the call batch.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getCallsStatus.md","from":1316,"to":1490}<fsm-vh3gqscxm4e>
import { getCallsStatus } from '@wagmi/core'
import { config } from './config'

const status = await getCallsStatus(config, {
  id: '0x1234567890abcdef', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getCallsStatus.md","from":1562,"to":1622}<fsm-vh3gqscxm4e>
import { type GetCallsStatusReturnType } from '@wagmi/core'
```

`{ status: 'PENDING' | 'CONFIRMED', receipts: TransactionReceipt[] }`

The status and receipts of the call batch.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getCallsStatus.md","from":1758,"to":1817}<fsm-vh3gqscxm4e>
import { type GetCallsStatusErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getCallsStatus`](https://viem.sh/docs/actions/wallet/getCallsStatus)

---

---
url: /core/api/actions/getCapabilities.md
---
# getCapabilities

Action to extract capabilities (grouped by chain ID) that a connected wallet supports (e.g. paymasters, session keys, etc).

[Read more.](https://github.com/ethereum/EIPs/blob/815028dc634463e1716fc5ce44c019a6040f0bef/EIPS/eip-5792.md#wallet_getcapabilities)

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getCapabilities.md","from":430,"to":476}<fsm-vh3gqscxm4e>
import { getCapabilities } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getCapabilities.md","from":523,"to":655}<fsm-vh3gqscxm4e>
import { getCapabilities } from '@wagmi/core'
import { config } from './config'

const capabilities = await getCapabilities(config)
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getCapabilities.md","from":726,"to":787}<fsm-vh3gqscxm4e>
import { type GetCapabilitiesParameters } from '@wagmi/core'
```

### account

`Account | Address | undefined`

Fetch capabilities for the provided account.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getCapabilities.md","from":916,"to":1127}<fsm-vh3gqscxm4e>
import { getCapabilities } from '@wagmi/core'
import { config } from './config'

const capabilities = await getCapabilities(config, {
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

Connector to get capabilities from.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getCapabilities.md","from":1286,"to":1539}<fsm-vh3gqscxm4e>
import { getConnections, getCapabilities } from '@wagmi/core'
import { config } from './config'

const connections = getConnections(config)
const capabilities = await getCapabilities(config, {
  connector: connections[0]?.connector, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getCapabilities.md","from":1611,"to":1672}<fsm-vh3gqscxm4e>
import { type GetCapabilitiesReturnType } from '@wagmi/core'
```

`bigint`

Most recent block number seen.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getCapabilities.md","from":1735,"to":1795}<fsm-vh3gqscxm4e>
import { type GetCapabilitiesErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getCapabilities`](https://viem.sh/docs/actions/wallet/getCapabilities)

---

---
url: /core/api/actions/getChainId.md
---
# getChainId

Action for getting current chain ID.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getChainId.md","from":70,"to":111}<fsm-vh3gqscxm4e>
import { getChainId } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getChainId.md","from":158,"to":269}<fsm-vh3gqscxm4e>
import { getChainId } from '@wagmi/core'
import { config } from './config'

const chainId = getChainId(config)
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getChainId.md","from":341,"to":397}<fsm-vh3gqscxm4e>
import { type GetChainIdReturnType } from '@wagmi/core'
```

`number`

Current chain ID from [`config.state.chainId`](/core/api/createConfig#chainid).

::: info
Only returns chain IDs for chains configured via `createConfig`'s [`chains`](/core/api/createConfig#chains) parameter.

If the active [connection](/core/api/createConfig#connection) [`chainId`](/core/api/createConfig#chainid-1) is not from a chain included in your Wagmi `Config`, `getChainId` will return the last configured chain ID.
:::

---

---
url: /core/api/actions/getChains.md
---
# getChains

Action for getting configured chains.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getChains.md","from":69,"to":109}<fsm-vh3gqscxm4e>
import { getChains } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getChains.md","from":156,"to":264}<fsm-vh3gqscxm4e>
import { getChains } from '@wagmi/core'
import { config } from './config'

const chains = getChains(config)
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getChains.md","from":336,"to":391}<fsm-vh3gqscxm4e>
import { type GetChainsReturnType } from '@wagmi/core'
```

`readonly [Chain, ...Chain[]]`

Chains from [`config.chains`](/core/api/createConfig#chains).

---

---
url: /core/api/actions/getClient.md
---
# getClient

Action for getting Viem [`Client`](https://viem.sh/docs/clients/custom) instance.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getClient.md","from":113,"to":153}<fsm-vh3gqscxm4e>
import { getClient } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getClient.md","from":200,"to":308}<fsm-vh3gqscxm4e>
import { getClient } from '@wagmi/core'
import { config } from './config'

const client = getClient(config)
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getClient.md","from":379,"to":434}<fsm-vh3gqscxm4e>
import { type GetClientParameters } from '@wagmi/core'
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when getting Viem Client.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getClient.md","from":576,"to":780}<fsm-vh3gqscxm4e>
import { getClient } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const client = await getClient(config, {
  chainId: mainnet.id, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getClient.md","from":852,"to":907}<fsm-vh3gqscxm4e>
import { type GetClientReturnType } from '@wagmi/core'
```

`Client`

Viem [`Client`](https://viem.sh/docs/clients/custom) instance.

---

---
url: /core/api/actions/getConnection.md
---
# getConnection

Action for getting current connection.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getConnection.md","from":74,"to":118}<fsm-vh3gqscxm4e>
import { getConnection } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getConnection.md","from":165,"to":285}<fsm-vh3gqscxm4e>
import { getConnection } from '@wagmi/core'
import { config } from './config'

const connection = getConnection(config)
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getConnection.md","from":357,"to":416}<fsm-vh3gqscxm4e>
import { type GetConnectionReturnType } from '@wagmi/core'
```

### address

`Address | undefined`

* Connected address from connector.
* Defaults to first address in [`addresses`](#addresses).

### addresses

`readonly Address[] | undefined`

Connected addresses from connector.

### chain

`Chain | undefined`

Connected chain from connector. If chain is not configured by config, it will be `undefined`.

### chainId

`number | undefined`

Connected chain id from connector.

### connector

`Connector | undefined`

Connected connector.

### isConnecting / isReconnecting / isConnected / isDisconnected

`boolean`

Boolean variables derived from [`status`](#status).

### status

`'connecting' | 'reconnecting' | 'connected' | 'disconnected'`

* `'connecting'` attempting to establish connection.
* `'reconnecting'` attempting to re-establish connection to one or more connectors.
* `'connected'` at least one connector is connected.
* `'disconnected'` no connection to any connector.

::: info You can use `status` to narrow the return type.
For example, when `status` is `'connected'` properties like `address` are guaranteed to be defined.

```ts twoslash
// @twoslash-cache: {"v":1,"hash":"70621ff7ba048810d10cff60e35c82126a2beb12177fb38b972d09b620d6367c","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BjCMONAAmbDBkbQEsWidgHEYaAMIsefQWABK4gK6kwAFWy4qbAIakGiACxUANjDABzNPiQBGAAxU0ei+KbTeAlpRAn+PJEcQRnw9HT4yJEMAXwp0TTxCEnInOgMQAAosUggcfQwASnZdNCU4YQAdECh+OC4ZGigq9gAfdir6zxgmkFb2kFJeD1lLZraO4YFRkB9dfTsAVlNzKxtEADYnFzdEEBKynz8AxCCQsIjyRFsF2PicROJI1Pp3Vg5O2SF2YAqwdn/2DooFBBnByuwAILA0FwADcvwBgOh8Dg8GEgyBLBMGHYyChIJRFHYADpSfiYcgALqU+F/AFnfzCCShfx9JRgWAAM383VpiIZYAAklBhGAlABbABGZD59MmEFITPlpFl/1qUm4XRF7DQpCUMFV7HVk38FmEnJ0JlRhtqABFah9GubLdaEQDaopHabnVaDW7/vtwRNNREerTorNnPMjABmZaWax2IJR1zpL3eUw8uxUM6kcI0S4AJlu1ASuwAjvrSBgfDQXrsuGxOCavj86f8gQSwcJySjDZ2YWj2BioFicXjkWCiaTib2wVSaf7OCywEyV2yOTBuTwoIaBcLRRLpSql46FUqQ2gFTa4BqGt1hLr9Te755vewLb6b/a6pMHx+XT9dsjTgT0TUsH1XWAwNKmCP8w1+CNtCjAxDDjXwVkTK5k22NMWzAQ4syuHNQjzC4kGLSkc2gXBdn4Tl2AydMwGJQN2AAXk49gAHJHW6biijbf5mN+USwDEiTxKkyTJKQkBxXEHQkFANJzDgOQ8DQBBomiIA==="}
import { type GetConnectionReturnType } from '@wagmi/core'
const connection = {} as GetConnectionReturnType
// ---cut---
if (connection.status === 'connected') {
  connection
  // ^?















}
```

Or when status is `'disconnected'` properties like `address` are guaranteed to be `undefined`:

```ts twoslash
// @twoslash-cache: {"v":1,"hash":"03f1cafa2983888b08080373baa176953254622dd97feb972d42875fedc5dd86","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BjCMONAAmbDBkbQEsWidgHEYaAMIsefQWABK4gK6kwAFWy4qbAIakGiACxUANjDABzNPiQBGAAxU0ei+KbTeAlpRAn+PJEcQRnw9HT4yJEMAXwp0TTxCEnInOgMQAAosUggcfQwASnZdNCU4YQAdECh+OC4ZGigq9gAfdir6zxgmkFb2kFJeD1lLZraO4YFRkB9dfTsAVlNzKxtEADYnFzdEEBKynz8AxCCQsIjyRFsF2PicROJI1Pp3Vg5O2SF2YAqwdn/2DooFBBnByuwlGBYAAzfzdADcvwBgOBoLg8GEkJhcKgiL+ALO/kxUJgsJ4uKRBNC/gAklBidjyXjkR80BBSAzSTjmQDalJuF16exoToTOief9aopWf4LMIRWKYBL2HzJrL5aLxZTJXAACK1VndYRoUhKJXa4rOUrgqo1OqTbpVPHRWbOeZGTa+FbWOxBN2udIy7ymOF2KhnUjhGiXABMt2oCV2AEczaQMD4aC9dlw2Jw1V8fvj/kCQfBwViuUyLSW0RiISSyQiLYSwJzGxSi5xqWA6W3uc3Juy+1XO6qBREhQqtaO4NK1ZYNYrlWOGurhZrzTP9fbx41jabN8j9jbqgaHT1na69AZDJ6zJYfVc/dtA/mwIdQ1dw6FIxckHGAF1w2gXBdn4aF2AyIMwAAOmPdgAF4kPYAByO1DSgFCikLf5oN+fCwAIojCJI4jiJdKgAFtxB0JBQDScw4DkPA0AQaJoiAA"}
import { type GetConnectionReturnType } from '@wagmi/core'
const connection = {} as GetConnectionReturnType
// ---cut---
if (connection.status === 'disconnected') {
  connection
  // ^?















}
```

:::

---

---
url: /core/api/actions/getConnections.md
---
# getConnections

Action for getting active connections.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getConnections.md","from":75,"to":120}<fsm-vh3gqscxm4e>
import { getConnections } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getConnections.md","from":167,"to":290}<fsm-vh3gqscxm4e>
import { getConnections } from '@wagmi/core'
import { config } from './config'

const connections = getConnections(config)
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getConnections.md","from":362,"to":422}<fsm-vh3gqscxm4e>
import { type GetConnectionsReturnType } from '@wagmi/core'
```

[`Connection[]`](/core/api/createConfig#connection)

Active connections.

---

---
url: /core/api/actions/getConnectorClient.md
---
# getConnectorClient

Action for getting a Viem [`Client`](https://viem.sh/docs/clients/custom) object for the current or provided connector.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getConnectorClient.md","from":298,"to":347}<fsm-vh3gqscxm4e>
import { getConnectorClient } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getConnectorClient.md","from":394,"to":526}<fsm-vh3gqscxm4e>
import { getConnectorClient } from '@wagmi/core'
import { config } from './config'

const client = await getConnectorClient(config)
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getConnectorClient.md","from":597,"to":661}<fsm-vh3gqscxm4e>
import { type GetConnectorClientParameters } from '@wagmi/core'
```

### account

`Address | Account | undefined`

Account to use with client. Throws if account is not found on [`connector`](#connector).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getConnectorClient.md","from":834,"to":1045}<fsm-vh3gqscxm4e>
import { getConnectorClient } from '@wagmi/core'
import { config } from './config'

const client = await getConnectorClient(config, {
  account: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use with client.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getConnectorClient.md","from":1219,"to":1441}<fsm-vh3gqscxm4e>
import { getConnectorClient } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const client = await getConnectorClient(config, {
  chainId: mainnet.id, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

* Connector to get client for.
* Defaults to current connector.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getConnectorClient.md","from":1628,"to":1881}<fsm-vh3gqscxm4e>
import { getConnections, getConnectorClient } from '@wagmi/core'
import { config } from './config'

const connections = getConnections(config)
const client = await getConnectorClient(config, {
  connector: connections[0]?.connector, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getConnectorClient.md","from":1953,"to":2009}<fsm-vh3gqscxm4e>
import { type GetChainIdReturnType } from '@wagmi/core'
```

`Client`

Viem [`Client`](https://viem.sh/docs/clients/custom) object for the current or provided connector.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getConnectorClient.md","from":2140,"to":2203}<fsm-vh3gqscxm4e>
import { type GetConnectorClientErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

---

---
url: /core/api/actions/getConnectors.md
---
# getConnectors

Action for getting configured connectors.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getConnectors.md","from":77,"to":121}<fsm-vh3gqscxm4e>
import { getConnectors } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getConnectors.md","from":168,"to":288}<fsm-vh3gqscxm4e>
import { getConnectors } from '@wagmi/core'
import { config } from './config'

const connectors = getConnectors(config)
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getConnectors.md","from":360,"to":419}<fsm-vh3gqscxm4e>
import { type GetConnectorsReturnType } from '@wagmi/core'
```

`readonly Connector[]`

Connectors from [`config.connectors`](/core/api/createConfig#connectors-1).

---

---
url: /core/api/actions/getContractEvents.md
---
# getContractEvents

Action for fetching a list of contract event logs matching the provided parameters.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getContractEvents.md","from":259,"to":307}<fsm-vh3gqscxm4e>
import { getContractEvents } from '@wagmi/core'
```

## Usage

By default, `getContractEvents` returns all matched events on the ABI. In practice, you must use scoping to filter for specific events.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getContractEvents.md","from":491,"to":713}<fsm-vh3gqscxm4e>
import { getContractEvents } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

// Fetch event logs for every event on every ERC-20 contract. 
const logs = getContractEvents(config, { abi })
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getContractEvents.md","from":820,"to":883}<fsm-vh3gqscxm4e>
import { type GetContractEventsParameters } from '@wagmi/core'
```

### abi

`Abi`

The contract's ABI. Check out the [TypeScript docs](/react/typescript#const-assert-abis-typed-data) for how to set up ABIs for maximum type inference and safety.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getContractEvents.md","from":1099,"to":1296}<fsm-vh3gqscxm4e>
import { getContractEvents } from '@wagmi/core'
import { abi } from './abi' // [!code focus]
import { config } from './config'

const logs = getContractEvents(config, {
  abi, // [!code focus]
})

```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### address

`Address | undefined`

The contract's address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getContractEvents.md","from":1475,"to":1711}<fsm-vh3gqscxm4e>
import { getContractEvents } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const logs = getContractEvents(config, {
  address: '0x6b175474e89094c44da98b954eedeac495271d0f', // [!code focus]
  abi,
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### args

`object | readonly unknown[] | undefined`

* Logs can be scoped to given indexed arguments.
* Inferred from [`abi`](#abi) and [`eventName`](#eventname).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getContractEvents.md","from":1993,"to":2374}<fsm-vh3gqscxm4e>
import { getContractEvents } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const logs = getContractEvents(config, {
  abi,
  eventName: 'Transfer',
  args: { // [!code focus]
    from: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045', // [!code focus]
    to: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
  }, // [!code focus]
})

```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

Only indexed arguments in `event` are candidates for `args`.

An argument can also be an array to indicate that other values can exist in the position:

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getContractEvents.md","from":2645,"to":3163}<fsm-vh3gqscxm4e>
import { getContractEvents } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const logs = getContractEvents(config, {
  abi,
  eventName: 'Transfer',
  args: {
    from: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045', 
    to: [ // [!code focus]
      '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
      '0xa5cc3c03994db5b0d9a5eedd10cabab0813678ac', // [!code focus]
      '0xa152f8bb749c55e9943a3a0a3111d18ee2b3f94e', // [!code focus]
    ], // [!code focus]
  },
})

```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockHash

`` `0x${string}` | undefined ``

* Block hash to include logs from. Mutually exclusive with `fromBlock`/`toBlock`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getContractEvents.md","from":3412,"to":3674}<fsm-vh3gqscxm4e>
import { getContractEvents } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const logs = getContractEvents(config, {
  abi,
  blockHash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getContractEvents.md","from":3891,"to":4138}<fsm-vh3gqscxm4e>
import { getContractEvents } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { abi } from './abi'
import { config } from './config'

const logs = getContractEvents(config, {
  abi,
  chainId: mainnet.id, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### eventName

`string | undefined`

* Event to filter for the contract.
* Inferred from [`abi`](#abi).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getContractEvents.md","from":4361,"to":4565}<fsm-vh3gqscxm4e>
import { getContractEvents } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const logs = getContractEvents(config, {
  abi,
  eventName: 'Approval', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### fromBlock

`bigint | 'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

* Block to start including logs from. Mutually exclusive with `blockHash`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getContractEvents.md","from":4856,"to":5056}<fsm-vh3gqscxm4e>
import { getContractEvents } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const logs = getContractEvents(config, {
  abi,
  fromBlock: 69420n, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### strict

`boolean | undefined`

* Flag to only return logs that conform to the indexed & non-indexed arguments on the `event`, meaning that `args` will always be defined. Defaults to `false`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getContractEvents.md","from":5370,"to":5565}<fsm-vh3gqscxm4e>
import { getContractEvents } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const logs = getContractEvents(config, {
  abi,
  strict: true, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### toBlock

`bigint | 'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

* Block to stop including logs from. Mutually exclusive with `blockHash`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getContractEvents.md","from":5853,"to":6051}<fsm-vh3gqscxm4e>
import { getContractEvents } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const logs = getContractEvents(config, {
  abi,
  toBlock: 70120n, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getContractEvents.md","from":6159,"to":6222}<fsm-vh3gqscxm4e>
import { type GetContractEventsReturnType } from '@wagmi/core'
```

A list of event logs.

## Type Inference

With [`abi`](#abi) setup correctly, TypeScript will infer the correct types for [`eventName`](#eventname), [`args`](#args), and [`onLogs`](#onlogs) parameters. See the Wagmi [TypeScript docs](/core/typescript) for more information.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getContractEvents.md","from":6518,"to":6576}<fsm-vh3gqscxm4e>
import { type GetContractEventsError } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getContractEvents`](https://viem.sh/docs/contract/getContractEvents)

---

---
url: /core/api/actions/getEnsAddress.md
---
# getEnsAddress

Action for fetching ENS address for name.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAddress.md","from":205,"to":249}<fsm-vh3gqscxm4e>
import { getEnsAddress } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAddress.md","from":296,"to":489}<fsm-vh3gqscxm4e>
import { getEnsAddress } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensAddress = getEnsAddress(config, {
  name: normalize('wevm.eth'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: warning
Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use Viem's built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this.
:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAddress.md","from":1015,"to":1074}<fsm-vh3gqscxm4e>
import { type GetEnsAddressParameters } from '@wagmi/core'
```

***

### blockNumber

`bigint | undefined`

Block number to get ENS address at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAddress.md","from":1192,"to":1428}<fsm-vh3gqscxm4e>
import { getEnsAddress } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensAddress = getEnsAddress(config, {
  blockNumber: 17829139n, // [!code focus]
  name: normalize('wevm.eth'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get ENS address at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAddress.md","from":1630,"to":1862}<fsm-vh3gqscxm4e>
import { getEnsAddress } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensAddress = getEnsAddress(config, {
  blockTag: 'latest', // [!code focus]
  name: normalize('wevm.eth'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAddress.md","from":2048,"to":2332}<fsm-vh3gqscxm4e>
import { getEnsAddress } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensAddress = await getEnsAddress(config, {
  chainId: mainnet.id, // [!code focus]
  name: normalize('wevm.eth'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### coinType

`number | undefined`

The [ENSIP-9](https://docs.ens.domains/ens-improvement-proposals/ensip-9-multichain-address-resolution) coin type to fetch the address for.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAddress.md","from":2591,"to":2823}<fsm-vh3gqscxm4e>
import { getEnsAddress } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensAddress = await getEnsAddress(config, {
  coinType: 60, // [!code focus]
  name: normalize('wevm.eth'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### name

`string`

Name to get the address for.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAddress.md","from":2955,"to":3171}<fsm-vh3gqscxm4e>
import { getEnsAddress } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensAddress = await getEnsAddress(config, {
  name: normalize('wevm.eth'), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### universalResolverAddress

`Address | undefined`

* Address of ENS Universal Resolver Contract.
* Defaults to current chain's Universal Resolver Contract address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAddress.md","from":3420,"to":3710}<fsm-vh3gqscxm4e>
import { getEnsAddress } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensAddress = await getEnsAddress(config, {
  name: normalize('wevm.eth'),
  universalResolverAddress: '0x74E20Bd2A1fE0cdbe45b9A1d89cb7e0a45b36376', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAddress.md","from":3782,"to":3841}<fsm-vh3gqscxm4e>
import { type GetEnsAddressReturnType } from '@wagmi/core'
```

`string`

ENS address.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAddress.md","from":3886,"to":3944}<fsm-vh3gqscxm4e>
import { type GetEnsAddressErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getEnsAddress`](https://viem.sh/docs/ens/actions/getEnsAddress)

---

---
url: /core/api/actions/getEnsAvatar.md
---
# getEnsAvatar

Action for fetching ENS address for avatar.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAvatar.md","from":204,"to":247}<fsm-vh3gqscxm4e>
import { getEnsAvatar } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAvatar.md","from":294,"to":490}<fsm-vh3gqscxm4e>
import { getEnsAvatar } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensAvatar = await getEnsAvatar(config, {
  name: normalize('wevm.eth'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: warning
Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAvatar`. You can use Viem's built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this.
:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAvatar.md","from":1015,"to":1073}<fsm-vh3gqscxm4e>
import { type GetEnsAvatarParameters } from '@wagmi/core'
```

***

### assetGatewayUrls&#x20;

`{ ipfs?: string | undefined; arweave?: string | undefined } | undefined`

Gateway urls to resolve IPFS and/or Arweave assets.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAvatar.md","from":1295,"to":1610}<fsm-vh3gqscxm4e>
import { getEnsAvatar } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensAvatar = await getEnsAvatar(config, {
  assetGatewayUrls: { // [!code focus]
    ipfs: 'https://cloudflare-ipfs.com', // [!code focus]
  }, // [!code focus]
  name: normalize('wevm.eth'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`bigint | undefined`

Block number to get avatar at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAvatar.md","from":1764,"to":2003}<fsm-vh3gqscxm4e>
import { getEnsAvatar } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensAvatar = await getEnsAvatar(config, {
  blockNumber: 17829139n, // [!code focus]
  name: normalize('wevm.eth'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get avatar at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAvatar.md","from":2200,"to":2435}<fsm-vh3gqscxm4e>
import { getEnsAvatar } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensAvatar = await getEnsAvatar(config, {
  blockTag: 'latest', // [!code focus]
  name: normalize('wevm.eth'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAvatar.md","from":2621,"to":2902}<fsm-vh3gqscxm4e>
import { getEnsAvatar } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensAvatar = await getEnsAvatar(config, {
  chainId: mainnet.id, // [!code focus]
  name: normalize('wevm.eth'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### gatewayUrls

`string[] | undefined`

A set of Universal Resolver gateways, used for resolving CCIP-Read requests made through the ENS Universal Resolver Contract.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAvatar.md","from":3152,"to":3414}<fsm-vh3gqscxm4e>
import { getEnsAvatar } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensAvatar = await getEnsAvatar(config, {
  gatewayUrls: ['https://cloudflare-ipfs.com'] { // [!code focus]
  name: normalize('wevm.eth'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### name

`string`

Name to get the avatar for.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAvatar.md","from":3545,"to":3758}<fsm-vh3gqscxm4e>
import { getEnsAvatar } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensAvatar = await getEnsAvatar(config, {
  name: normalize('wevm.eth'), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### universalResolverAddress

`Address | undefined`

* Address of ENS Universal Resolver Contract.
* Defaults to current chain's Universal Resolver Contract address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAvatar.md","from":4007,"to":4294}<fsm-vh3gqscxm4e>
import { getEnsAvatar } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensAvatar = await getEnsAvatar(config, {
  name: normalize('wevm.eth'),
  universalResolverAddress: '0x74E20Bd2A1fE0cdbe45b9A1d89cb7e0a45b36376', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAvatar.md","from":4366,"to":4424}<fsm-vh3gqscxm4e>
import { type GetEnsAvatarReturnType } from '@wagmi/core'
```

`string | null`

The avatar URI for ENS name.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsAvatar.md","from":4492,"to":4545}<fsm-vh3gqscxm4e>
import { type getEnsAvatarError } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getEnsAvatar`](https://viem.sh/docs/ens/actions/getEnsAvatar)

---

---
url: /core/api/actions/getEnsName.md
---
# getEnsName

Action for fetching primary ENS name for address.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsName.md","from":204,"to":245}<fsm-vh3gqscxm4e>
import { getEnsName } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsName.md","from":292,"to":465}<fsm-vh3gqscxm4e>
import { getEnsName } from '@wagmi/core'
import { config } from './config'

const ensName = getEnsName(config, {
  address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsName.md","from":536,"to":592}<fsm-vh3gqscxm4e>
import { type GetEnsNameParameters } from '@wagmi/core'
```

### address

`Address`

Address to get the name for.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsName.md","from":683,"to":879}<fsm-vh3gqscxm4e>
import { getEnsName } from '@wagmi/core'
import { config } from './config'

const ensName = await getEnsName(config, {
  address: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### blockNumber

`bigint | undefined`

Block number to get name at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsName.md","from":1035,"to":1251}<fsm-vh3gqscxm4e>
import { getEnsName } from '@wagmi/core'
import { config } from './config'

const ensName = getEnsName(config, {
  address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  blockNumber: 17829139n, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get name at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsName.md","from":1446,"to":1658}<fsm-vh3gqscxm4e>
import { getEnsName } from '@wagmi/core'
import { config } from './config'

const ensName = getEnsName(config, {
  address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  blockTag: 'latest', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsName.md","from":1844,"to":2108}<fsm-vh3gqscxm4e>
import { getEnsName } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const ensName = await getEnsName(config, {
  address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  chainId: mainnet.id, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### universalResolverAddress

`Address | undefined`

* Address of ENS Universal Resolver Contract.
* Defaults to current chain's Universal Resolver Contract address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsName.md","from":2357,"to":2624}<fsm-vh3gqscxm4e>
import { getEnsName } from '@wagmi/core'
import { config } from './config'

const ensName = await getEnsName(config, {
  address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  universalResolverName: '0x74E20Bd2A1fE0cdbe45b9A1d89cb7e0a45b36376', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsName.md","from":2696,"to":2752}<fsm-vh3gqscxm4e>
import { type GetEnsNameReturnType } from '@wagmi/core'
```

`string | null`

The primary ENS name for the address. Returns `null` if address does not have primary name assigned.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsName.md","from":2892,"to":2947}<fsm-vh3gqscxm4e>
import { type GetEnsNameErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getEnsName`](https://viem.sh/docs/ens/actions/getEnsName)

---

---
url: /core/api/actions/getEnsResolver.md
---
# getEnsResolver

Action for fetching ENS resolver for name.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsResolver.md","from":209,"to":254}<fsm-vh3gqscxm4e>
import { getEnsResolver } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsResolver.md","from":301,"to":497}<fsm-vh3gqscxm4e>
import { getEnsResolver } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensResolver = getEnsResolver(config, {
  name: normalize('wevm.eth'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: warning
Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsResolver`. You can use Viem's built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this.
:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsResolver.md","from":1024,"to":1084}<fsm-vh3gqscxm4e>
import { type GetEnsResolverParameters } from '@wagmi/core'
```

***

### blockNumber

`bigint | undefined`

Block number to get resolver at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsResolver.md","from":1199,"to":1438}<fsm-vh3gqscxm4e>
import { getEnsResolver } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensResolver = getEnsResolver(config, {
  blockNumber: 17829139n, // [!code focus]
  name: normalize('wevm.eth'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get resolver at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsResolver.md","from":1637,"to":1872}<fsm-vh3gqscxm4e>
import { getEnsResolver } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensResolver = getEnsResolver(config, {
  blockTag: 'latest', // [!code focus]
  name: normalize('wevm.eth'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsResolver.md","from":2058,"to":2345}<fsm-vh3gqscxm4e>
import { getEnsResolver } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensResolver = await getEnsResolver(config, {
  chainId: mainnet.id, // [!code focus]
  name: normalize('wevm.eth'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### name

`string`

Name to get the resolver for.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsResolver.md","from":2478,"to":2697}<fsm-vh3gqscxm4e>
import { getEnsResolver } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensResolver = await getEnsResolver(config, {
  name: normalize('wevm.eth'), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### universalResolverAddress

`Address | undefined`

* Address of ENS Universal Resolver Contract.
* Defaults to current chain's Universal Resolver Contract address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsResolver.md","from":2946,"to":3239}<fsm-vh3gqscxm4e>
import { getEnsResolver } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensResolver = await getEnsResolver(config, {
  name: normalize('wevm.eth'),
  universalResolverAddress: '0x74E20Bd2A1fE0cdbe45b9A1d89cb7e0a45b36376', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsResolver.md","from":3311,"to":3371}<fsm-vh3gqscxm4e>
import { type GetEnsResolverReturnType } from '@wagmi/core'
```

`Address`

The address of the resolver.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsResolver.md","from":3433,"to":3488}<fsm-vh3gqscxm4e>
import { type getEnsResolverError } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getEnsResolver`](https://viem.sh/docs/ens/actions/getEnsResolver)

---

---
url: /core/api/actions/getEnsText.md
---
# getEnsText

Action for fetching a text record for a specified ENS name and key.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsText.md","from":222,"to":263}<fsm-vh3gqscxm4e>
import { getEnsText } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsText.md","from":310,"to":516}<fsm-vh3gqscxm4e>
import { getEnsText } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensText = getEnsText(config, {
  name: normalize('wevm.eth'),
  key: 'com.twitter',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: warning
Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsText`. You can use Viem's built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this.
:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsText.md","from":1039,"to":1095}<fsm-vh3gqscxm4e>
import { type GetEnsTextParameters } from '@wagmi/core'
```

***

### blockNumber

`bigint | undefined`

Block number to get the text at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsText.md","from":1210,"to":1459}<fsm-vh3gqscxm4e>
import { getEnsText } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensText = getEnsText(config, {
  blockNumber: 17829139n, // [!code focus]
  name: normalize('wevm.eth'),
  key: 'com.twitter',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get the text at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsText.md","from":1658,"to":1903}<fsm-vh3gqscxm4e>
import { getEnsText } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensText = getEnsText(config, {
  blockTag: 'latest', // [!code focus]
  name: normalize('wevm.eth'),
  key: 'com.twitter',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsText.md","from":2089,"to":2386}<fsm-vh3gqscxm4e>
import { getEnsText } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensText = await getEnsText(config, {
  chainId: mainnet.id, // [!code focus]
  name: normalize('wevm.eth'),
  key: 'com.twitter',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### key

`string`

ENS key to get Text for.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsText.md","from":2513,"to":2742}<fsm-vh3gqscxm4e>
import { getEnsText } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensText = await getEnsText(config, {
  name: normalize('wevm.eth'),
  key: 'com.twitter', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### name

`string`

Name to get the text for.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsText.md","from":2871,"to":3100}<fsm-vh3gqscxm4e>
import { getEnsText } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensText = await getEnsText(config, {
  name: normalize('wevm.eth'), // [!code focus]
  key: 'com.twitter',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### universalResolverAddress

`Address | undefined`

* Address of ENS Universal Resolver Contract.
* Defaults to current chain's Universal Resolver Contract address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsText.md","from":3349,"to":3652}<fsm-vh3gqscxm4e>
import { getEnsText } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const ensText = await getEnsText(config, {
  name: normalize('wevm.eth'),
  key: 'com.twitter',
  universalResolverAddress: '0x74E20Bd2A1fE0cdbe45b9A1d89cb7e0a45b36376', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsText.md","from":3724,"to":3780}<fsm-vh3gqscxm4e>
import { type GetEnsTextReturnType } from '@wagmi/core'
```

`string | null`

The text record for ENS name.

Returns `null` if name does not have text assigned.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getEnsText.md","from":3902,"to":3953}<fsm-vh3gqscxm4e>
import { type getEnsTextError } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getEnsText`](https://viem.sh/docs/ens/actions/getEnsText)

---

---
url: /core/api/actions/getFeeHistory.md
---
# getFeeHistory

Action for fetching a collection of historical gas information.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getFeeHistory.md","from":227,"to":271}<fsm-vh3gqscxm4e>
import { getFeeHistory } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getFeeHistory.md","from":318,"to":496}<fsm-vh3gqscxm4e>
import { getFeeHistory } from '@wagmi/core'
import { config } from './config'

const feeHistory = await getFeeHistory(config, {
  blockCount: 4,
  rewardPercentiles: [25, 75]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getFeeHistory.md","from":567,"to":626}<fsm-vh3gqscxm4e>
import { type GetFeeHistoryParameters } from '@wagmi/core'
```

### blockCount

`number`

Number of blocks in the requested range. Between 1 and 1024 blocks can be requested in a single query. Less than requested may be returned if not all blocks are available.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getFeeHistory.md","from":862,"to":1057}<fsm-vh3gqscxm4e>
import { getFeeHistory } from '@wagmi/core'
import { config } from './config'

const feeHistory = await getFeeHistory(config, {
  blockCount: 4, // [!code focus]
  rewardPercentiles: [25, 75]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### rewardPercentiles

`number[]`

A monotonically increasing list of percentile values to sample from each block's effective priority fees per gas in ascending order, weighted by gas used.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getFeeHistory.md","from":1330,"to":1525}<fsm-vh3gqscxm4e>
import { getFeeHistory } from '@wagmi/core'
import { config } from './config'

const feeHistory = await getFeeHistory(config, {
  blockCount: 4,
  rewardPercentiles: [25, 75] // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`bigint | undefined`

Highest number block of the requested range.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getFeeHistory.md","from":1692,"to":1913}<fsm-vh3gqscxm4e>
import { getFeeHistory } from '@wagmi/core'
import { config } from './config'

const feeHistory = await getFeeHistory(config, {
  blockCount: 4,
  blockNumber: 1551231n, // [!code focus]
  rewardPercentiles: [25, 75],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag of the highest number block of the requested range.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getFeeHistory.md","from":2144,"to":2360}<fsm-vh3gqscxm4e>
import { getFeeHistory } from '@wagmi/core'
import { config } from './config'

const feeHistory = await getFeeHistory(config, {
  blockCount: 4,
  blockTag: 'safe', // [!code focus]
  rewardPercentiles: [25, 75],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getFeeHistory.md","from":2541,"to":2805}<fsm-vh3gqscxm4e>
import { getFeeHistory } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const feeHistory = await getFeeHistory(config, {
  blockCount: 4,
  chainId: mainnet.id, // [!code focus]
  rewardPercentiles: [25, 75],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getFeeHistory.md","from":2877,"to":2936}<fsm-vh3gqscxm4e>
import { type GetFeeHistoryReturnType } from '@wagmi/core'
```

[`FeeHistory`](https://viem.sh/docs/glossary/types#feehistory)

The fee history.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getFeeHistory.md","from":3039,"to":3097}<fsm-vh3gqscxm4e>
import { type GetFeeHistoryErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getFeeHistory`](https://viem.sh/docs/actions/public/getFeeHistory)

---

---
url: /core/api/actions/getGasPrice.md
---
# getGasPrice

Action for fetching the current price of gas (in wei).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getGasPrice.md","from":212,"to":254}<fsm-vh3gqscxm4e>
import { getGasPrice } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getGasPrice.md","from":301,"to":421}<fsm-vh3gqscxm4e>
import { getGasPrice } from '@wagmi/core'
import { config } from './config'

const gasPrice = await getGasPrice(config)
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getGasPrice.md","from":492,"to":549}<fsm-vh3gqscxm4e>
import { type GetGasPriceParameters } from '@wagmi/core'
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getGasPrice.md","from":685,"to":895}<fsm-vh3gqscxm4e>
import { getGasPrice } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const gasPrice = await getGasPrice(config, {
  chainId: mainnet.id, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getGasPrice.md","from":967,"to":1024}<fsm-vh3gqscxm4e>
import { type GetGasPriceReturnType } from '@wagmi/core'
```

`bigint`

Current price of gas (in wei).

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getGasPrice.md","from":1087,"to":1143}<fsm-vh3gqscxm4e>
import { type GetGasPriceErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getGasPrice`](https://viem.sh/docs/actions/public/getGasPrice)

---

---
url: /core/api/actions/getProof.md
---
# getProof

Action for return the account and storage values of the specified account including the Merkle-proof.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getProof.md","from":250,"to":289}<fsm-vh3gqscxm4e>
import { getProof } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getProof.md","from":336,"to":591}<fsm-vh3gqscxm4e>
import { getProof } from '@wagmi/core'
import { config } from './config'

await getProof(config, {
  address: '0x4200000000000000000000000000000000000016',
  storageKeys: [
    '0x4a932049252365b3eedbc5190e18949f2ec11f39d3bef2d259764799a1b27d99',
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getProof.md","from":662,"to":716}<fsm-vh3gqscxm4e>
import { type GetProofParameters } from '@wagmi/core'
```

### address

`Address`

The account address to get the proof for.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getProof.md","from":820,"to":1092}<fsm-vh3gqscxm4e>
import { getProof } from '@wagmi/core'
import { config } from './config'

await getProof(config, {
  address: '0x4200000000000000000000000000000000000016', // [!code focus]
  storageKeys: [
    '0x4a932049252365b3eedbc5190e18949f2ec11f39d3bef2d259764799a1b27d99',
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### storageKeys

`` `0x${string}`[] ``

Array of storage-keys that should be proofed and included.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getProof.md","from":1274,"to":1548}<fsm-vh3gqscxm4e>
import { getProof } from '@wagmi/core'
import { config } from './config'

await getProof(config, {
  address: '0x4200000000000000000000000000000000000016',
  storageKeys: [ // [!code focus:3]
    '0x4a932049252365b3eedbc5190e18949f2ec11f39d3bef2d259764799a1b27d99',
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`bigint | undefined`

Proof at a given block number.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getProof.md","from":1701,"to":1996}<fsm-vh3gqscxm4e>
import { getProof } from '@wagmi/core'
import { config } from './config'

await getProof(config, {
  address: '0x4200000000000000000000000000000000000016',
  blockNumber: 42069n, // [!code focus]
  storageKeys: [
    '0x4a932049252365b3eedbc5190e18949f2ec11f39d3bef2d259764799a1b27d99',
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Proof at a given block tag.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getProof.md","from":2193,"to":2487}<fsm-vh3gqscxm4e>
import { getProof } from '@wagmi/core'
import { config } from './config'

await getProof(config, {
  address: '0x4200000000000000000000000000000000000016',
  blockTag: 'latest', // [!code focus]
  storageKeys: [
    '0x4a932049252365b3eedbc5190e18949f2ec11f39d3bef2d259764799a1b27d99',
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

The ID of chain to get the proof for.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getProof.md","from":2667,"to":3009}<fsm-vh3gqscxm4e>
import { getProof } from '@wagmi/core'
import { config } from './config'
import { optimism } from '@wagmi/core/chains'

await getProof(config, {
  chainId: optimism.id, // [!code focus]
  address: '0x4200000000000000000000000000000000000016',
  storageKeys: [
    '0x4a932049252365b3eedbc5190e18949f2ec11f39d3bef2d259764799a1b27d99',
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getProof.md","from":3081,"to":3135}<fsm-vh3gqscxm4e>
import { type GetProofReturnType } from '@wagmi/core'
```

`Proof`

Proof data.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getProof.md","from":3178,"to":3231}<fsm-vh3gqscxm4e>
import { type GetProofErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getProof`](https://viem.sh/docs/actions/public/getProof)

---

---
url: /core/api/actions/getPublicClient.md
---
# getPublicClient

Action for getting Viem [`PublicClient`](https://viem.sh/docs/clients/public) instance.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getPublicClient.md","from":125,"to":171}<fsm-vh3gqscxm4e>
import { getPublicClient } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getPublicClient.md","from":218,"to":338}<fsm-vh3gqscxm4e>
import { getPublicClient } from '@wagmi/core'
import { config } from './config'

const client = getPublicClient(config)
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: warning
If you want to optimize bundle size, you should use [`getClient`](/core/api/actions/getClient) along with Viem's [tree-shakable actions](https://viem.sh/docs/clients/custom#tree-shaking) instead. Since Public Client has all public actions attached directly to it.
:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getPublicClient.md","from":690,"to":745}<fsm-vh3gqscxm4e>
import { type GetClientParameters } from '@wagmi/core'
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when getting Viem Public Client.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getPublicClient.md","from":894,"to":1104}<fsm-vh3gqscxm4e>
import { getPublicClient } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const client = getPublicClient(config, {
  chainId: mainnet.id, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getPublicClient.md","from":1176,"to":1237}<fsm-vh3gqscxm4e>
import { type GetPublicClientReturnType } from '@wagmi/core'
```

`PublicClient | undefined`

Viem [`PublicClient`](https://viem.sh/docs/clients/public) instance.

---

---
url: /core/api/actions/getStorageAt.md
---
# getStorageAt

Action for returning the value from a storage slot at a given address.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getStorageAt.md","from":231,"to":274}<fsm-vh3gqscxm4e>
import { getStorageAt } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getStorageAt.md","from":321,"to":503}<fsm-vh3gqscxm4e>
import { getStorageAt } from '@wagmi/core'
import { config } from './config'

await getStorageAt(config, {
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  slot: '0x0',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getStorageAt.md","from":574,"to":632}<fsm-vh3gqscxm4e>
import { type GetStorageAtParameters } from '@wagmi/core'
```

### address

`Address`

The contract address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getStorageAt.md","from":716,"to":915}<fsm-vh3gqscxm4e>
import { getStorageAt } from '@wagmi/core'
import { config } from './config'

await getStorageAt(config, {
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', // [!code focus]
  slot: '0x0',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### slot

`Hex`

The storage position (as a hex encoded value).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getStorageAt.md","from":1062,"to":1261}<fsm-vh3gqscxm4e>
import { getStorageAt } from '@wagmi/core'
import { config } from './config'

await getStorageAt(config, {
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  slot: '0x0', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`bigint | undefined`

The block number to check the storage at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getStorageAt.md","from":1425,"to":1650}<fsm-vh3gqscxm4e>
import { getStorageAt } from '@wagmi/core'
import { config } from './config'

await getStorageAt(config, {
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  blockNumber: 16280770n, // [!code focus]
  slot: '0x0',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

The block tag to check the storage at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getStorageAt.md","from":1858,"to":2077}<fsm-vh3gqscxm4e>
import { getStorageAt } from '@wagmi/core'
import { config } from './config'

await getStorageAt(config, {
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  blockTag: 'safe', // [!code focus]
  slot: '0x0',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

The chain ID to check the storage at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getStorageAt.md","from":2257,"to":2524}<fsm-vh3gqscxm4e>
import { getStorageAt } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

await getStorageAt(config, {
  chainId: mainnet.id, // [!code focus]
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  slot: '0x0',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getStorageAt.md","from":2596,"to":2654}<fsm-vh3gqscxm4e>
import { type GetStorageAtReturnType } from '@wagmi/core'
```

`Hex`

The value of the storage slot.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getStorageAt.md","from":2714,"to":2771}<fsm-vh3gqscxm4e>
import { type GetStorageAtErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getStorageAt`](https://viem.sh/docs/contract/getStorageAt)

---

---
url: /cli/getting-started.md
---
# Getting Started

## Overview

Wagmi CLI is a command line interface for managing ABIs (from Etherscan/block explorers, Foundry/Hardhat projects, etc.), generating code (e.g. React Hooks), and much more. It makes working with Ethereum easier by automating manual work so you can build faster. You can learn more about the rationale behind the project in the [Why Wagmi CLI](/cli/why) section.

## Manual Installation

To manually add Wagmi CLI to your project, install the required packages.

::: code-group

```bash [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/getting-started.md","from":524,"to":547}<fsm-vh3gqscxm4e>
pnpm add -D @wagmi/cli
```

```bash [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/getting-started.md","from":566,"to":600}<fsm-vh3gqscxm4e>
npm install --save-dev @wagmi/cli
```

```bash [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/getting-started.md","from":620,"to":643}<fsm-vh3gqscxm4e>
yarn add -D @wagmi/cli
```

```bash [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/getting-started.md","from":662,"to":684}<fsm-vh3gqscxm4e>
bun add -D @wagmi/cli
```

:::

## Create Config File

Run the `init` command to generate a configuration file: either `wagmi.config.ts` if TypeScript is detected, otherwise `wagmi.config.js`. You can also create the configuration file manually. See [Configuring CLI](/cli/config/configuring-cli) for more info.

::: code-group

```bash [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/getting-started.md","from":1004,"to":1020}<fsm-vh3gqscxm4e>
pnpm wagmi init
```

```bash [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/getting-started.md","from":1039,"to":1054}<fsm-vh3gqscxm4e>
npx wagmi init
```

```bash [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/getting-started.md","from":1074,"to":1090}<fsm-vh3gqscxm4e>
yarn wagmi init
```

```bash [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/getting-started.md","from":1109,"to":1124}<fsm-vh3gqscxm4e>
bun wagmi init
```

:::

The generated configuration file will look something like this:

::: code-group

```ts [wagmi.config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/getting-started.md","from":1237,"to":1372}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'

export default defineConfig({
  out: 'src/generated.ts',
  contracts: [],
  plugins: [],
})
```

:::

## Add Contracts And Plugins

Once the configuration file is set up, you can add contracts and plugins to it. These contracts and plugins are used to manage ABIs (fetch from block explorers, resolve from the file system, etc.), generate code (React hooks, etc.), and much more!

For example, we can add the ERC-20 contract from Viem, and the [`etherscan`](/cli/api/plugins/etherscan) and [`react`](/cli/api/plugins/react) plugins.

::: code-group

```ts{2,3,9-12,15-27,28} [wagmi.config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/getting-started.md","from":1871,"to":2570}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { etherscan, react } from '@wagmi/cli/plugins'
import { erc20Abi } from 'viem'
import { mainnet, sepolia } from 'wagmi/chains'
 
export default defineConfig({
  out: 'src/generated.ts',
  contracts: [
    {
      name: 'erc20',
      abi: erc20Abi,
    },
  ],
  plugins: [
    etherscan({
      apiKey: process.env.ETHERSCAN_API_KEY!,
      chainId: mainnet.id,
      contracts: [
        {
          name: 'EnsRegistry',
          address: {
            [mainnet.id]: '0x314159265dd8dbb310642f98f50c066173c1259b',
            [sepolia.id]: '0x112234455c3a32fd11230c42e7bccd4a84e02010',
          },
        },
      ],
    }),
    react(),
  ],
})
```

:::

## Run Code Generation

Now that we added a few contracts and plugins to the configuration file, we can run the [`generate`](/cli/api/commands/generate) command to resolve ABIs and generate code to the `out` file.

::: code-group

```bash [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/getting-started.md","from":2824,"to":2844}<fsm-vh3gqscxm4e>
pnpm wagmi generate
```

```bash [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/getting-started.md","from":2863,"to":2882}<fsm-vh3gqscxm4e>
npx wagmi generate
```

```bash [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/getting-started.md","from":2902,"to":2922}<fsm-vh3gqscxm4e>
yarn wagmi generate
```

```bash [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/getting-started.md","from":2941,"to":2960}<fsm-vh3gqscxm4e>
bun wagmi generate
```

:::

In this example, the `generate` command will do the following:

* Validate the `etherscan` and `react` plugins
* Fetch and cache the ENS Registry ABI from the Mainnet Etherscan API
* Pull in the `erc20Abi` using the name `'ERC20'`
* Generate React Hooks for both ABIs
* Save ABIs, ENS Registry deployment addresses, and React Hooks to the `out` file

## Use Generated Code

Once `out` is created, you can start using the generated code in your project.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/getting-started.md","from":3429,"to":3914}<fsm-vh3gqscxm4e>
import { useReadErc20, useReadErc20BalanceOf } from './generated'

// Use the generated ERC-20 read hook
const { data } = useReadErc20({
  address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
  functionName: 'balanceOf',
  args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'],
})

// Use the generated ERC-20 "balanceOf" hook
const { data } = useReadErc20BalanceOf({
  address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
  args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'],
})
```

::: tip
Instead of committing the `out` file, you likely want to add `out` to your `.gitignore` and run `generate` during the build process or before you start your dev server in a `"predev"` script.
:::

## Next Steps

For more information on what to do next, check out the following topics.

* [**Configuring CLI**](/cli/config/configuring-cli) Learn how to configure the CLI to work best for your project.
* [**Commands**](/cli/api/commands) Learn more about the CLI commands and how to use them.
* [**Plugins**](/cli/api/plugins) Browse the collection of plugins and set them up with your config.

---

---
url: /core/getting-started.md
---
# Getting Started

## Overview

Wagmi Core is a VanillaJS library for Ethereum. You can learn more about the rationale behind the project in the [Why Wagmi](/core/why) section.

## Manual Installation

To manually add Wagmi to your project, install the required packages.

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/getting-started.md","from":447,"to":507}<fsm-vh3gqscxm4e>
pnpm add @wagmi/core @wagmi/connectors viem@{{viemVersion}}
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/getting-started.md","from":530,"to":593}<fsm-vh3gqscxm4e>
npm install @wagmi/core @wagmi/connectors viem@{{viemVersion}}
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/getting-started.md","from":617,"to":677}<fsm-vh3gqscxm4e>
yarn add @wagmi/core @wagmi/connectors viem@{{viemVersion}}
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/getting-started.md","from":700,"to":759}<fsm-vh3gqscxm4e>
bun add @wagmi/core @wagmi/connectors viem@{{viemVersion}}
```

:::

* [Wagmi Connectors](/core/api/connectors) is a collection of interfaces for linking accounts/wallets to Wagmi.
* [Viem](https://viem.sh) is a TypeScript interface for Ethereum that performs blockchain operations.
* [TypeScript](/react/typescript) is optional, but highly recommended. Learn more about [TypeScript support](/core/typescript).

### Create Config

Create and export a new Wagmi config using `createConfig`.

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

In this example, Wagmi is configured to use the Mainnet and Sepolia chains. Check out the [`createConfig` docs](/core/api/createConfig) for more configuration options.

### Use Wagmi

Now that everything is set up, you can pass the `config` to use actions.

::: code-group

```tsx [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/getting-started.md","from":1542,"to":1729}<fsm-vh3gqscxm4e>
import { getConnection, getEnsName } from '@wagmi/core'
import { config } from './config'

const { address } = getConnection(config)
const ensName = await getEnsName(config, { address })
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Next Steps

For more information on what to do next, check out the following topics.

* [**TypeScript**](/core/typescript) Learn how to get the most out of Wagmi's type-safety and inference for an enlightened developer experience.
* [**Actions**](/core/api/actions) Browse the collection of actions and learn how to use them.
* [**Framework Adapters**](/core/guides/framework-adapters) Learn how to create a Wagmi-like adapter for your favorite framework.
* [**Viem docs**](https://viem.sh) Wagmi Core is a wrapper around Viem that manages account and client reactivity. Learn more about Viem and how to use it.

---

---
url: /react/getting-started.md
---
# Getting Started

## Overview

Wagmi is a React Hooks library for Ethereum. You can learn more about the rationale behind the project in the [Why Wagmi](/react/why) section.

## Automatic Installation

For new projects, it is recommended to set up your Wagmi app using the [`create-wagmi`](/cli/create-wagmi) command line interface (CLI). This will create a new Wagmi project using TypeScript and install the required dependencies.

::: code-group

```bash [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/getting-started.md","from":605,"to":623}<fsm-vh3gqscxm4e>
pnpm create wagmi
```

```bash [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/getting-started.md","from":642,"to":666}<fsm-vh3gqscxm4e>
npm create wagmi@latest
```

```bash [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/getting-started.md","from":686,"to":704}<fsm-vh3gqscxm4e>
yarn create wagmi
```

```bash [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/getting-started.md","from":723,"to":740}<fsm-vh3gqscxm4e>
bun create wagmi
```

:::

Once the command runs, you'll see some prompts to complete.

```ansi
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/getting-started.md","from":818,"to":886}<fsm-vh3gqscxm4e>
Project name: wagmi-project
Select a framework: React / Vanilla
...
```

After the prompts, `create-wagmi` will create a directory with your project name and install the required dependencies. Check out the `README.md` for further instructions (if required).

## Manual Installation

To manually add Wagmi to your project, install the required packages.

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/getting-started.md","from":1207,"to":1265}<fsm-vh3gqscxm4e>
pnpm add wagmi viem@{{viemVersion}} @tanstack/react-query
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/getting-started.md","from":1288,"to":1349}<fsm-vh3gqscxm4e>
npm install wagmi viem@{{viemVersion}} @tanstack/react-query
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/getting-started.md","from":1373,"to":1431}<fsm-vh3gqscxm4e>
yarn add wagmi viem@{{viemVersion}} @tanstack/react-query
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/getting-started.md","from":1454,"to":1511}<fsm-vh3gqscxm4e>
bun add wagmi viem@{{viemVersion}} @tanstack/react-query
```

:::

* [Viem](https://viem.sh) is a TypeScript interface for Ethereum that performs blockchain operations.
* [TanStack Query](https://tanstack.com/query/v5) is an async state manager that handles requests, caching, and more.
* [TypeScript](/react/typescript) is optional, but highly recommended. Learn more about [TypeScript support](/react/typescript).

### Create Config

Create and export a new Wagmi config using `createConfig`.

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

In this example, Wagmi is configured to use the Mainnet and Sepolia chains, and `injected` connector. Check out the [`createConfig` docs](/react/api/createConfig) for more configuration options.

::: details TypeScript Tip
If you are using TypeScript, you can "register" the Wagmi config or use the hook `config` property to get strong type-safety across React Context in places that wouldn't normally have type info.

::: code-group

```ts twoslash [register config]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/getting-started.md","from":2479,"to":5900}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"1e950b442ed7db157508f31fce13aca96913b67241b30d5521468ad652cad085","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAhVhBEBrAHKCAtgCMyAHhGT+7AOa86NMFDi8AwoZO8AvLfvHdpGMyiTWGXqgAdKV4QrUUVAFFaLEUPUjhEXmAgkNTUjy8fP1h+ZkFWNETk4LTS3gzvMF9eMGYNGESAkAi0fDI4EWYwJoBuFLLSiqzpUlZGgjQ0LASAehmYVvbOsAA6CV7+gfTPSurmLHYAVVHx/EnpxDn99hWFtvjltYgZ642S0oBfPvevzd4wpTKAAq7HqiQAjAAmAAMsO+aQMYDQpGYYgSST+aSGVT8MDAcEOYHYJHibAASvAIKwSUVMQNsXsoFAPHB0U1obQYFzuVzwQAWKAAdnBAA4RJCtHzBVAAJwyyEAZlgzC04IVCoArDB+XyeW8tlidsMASobBkaFBEoroSKNXaRfCBr93obMjjeBp8uJOqxWAraS76Ub3V5mfA2SAOZ1weCtLBoRqZYLBVoFQA2BUxtOC6GQkUitMSmCQ5jgwUKpNp6Pg/UGkIMvwm5RmzwWiF8zXp6Hgx1lZ1pfupFbD3j8j0QDy8YcrXu8EnsfgYAASXHwAH5EoxGCIOHjCrZd0jdNOAHwUXhYZgo+o0eKJABqZAXy9XAAUr3UFu0+I4T7xX6QEAaOwsi6FoEBUp4YAnnwAA+0iWDARhgDAUDfB857FGk07oQAumevAiPgzDsGAACSUBmPQeJWIRrjIE0REkfiTS4cgYCaDopBsU07BQKxTh0WARjGAxIBMaRcCsexnFkDxIB8ax56yKwMBiAAIswaDMIJWgmKRaAnowl7Xl+8QbrwhyyAogLqNoZDvqZt5wPorjnhJ5FQMpMCqRpWnMDBiRWfI4RqLJpAUmggikGAQLYDAugqWpaCadpJ5BKCWATmg0jWaFdlcZQIDeCICCIBMUyzDMADuzDGMBKxwPgMwZGILwHDMhAQMocAzDIIW2eFRVwNppAMIgMpUKpYDGK0SD8lQo3GAseD9TZKgFWQRUcChSDQlQTEomIW0TRh6DxXghAkkVND0EwbCcDwuUDRt4W6HYwkmO4wbVIE7xNlEMQTu0AZbA2vA5HkBSg3W5Q/X4tRgrwTQtPcHRdLWdbg9FYzIxVFxzHcSxdE8mMGuD1zHLjTRnJVlztTcRMPCTEgM2TA6zoOoShSCSNQrC0KzoiyKomg6JYUGbrVHiBJEiScDkpS1JkDDWPw7woYshGHI8jy/JCqK4qStKcqKsqqrqlqOp6iAs5g+rTYtlpqFWgqNp2hqDp0iEXODOrnoFOwPp+qr5Pq5r4bjFGpaxvGibJqmGZZjmeYFkWJZlhWgpVjH7OS7sjahU7bajh2Gpdj23u8L7vvTqX46TjhfzzouK5NRZW47uwe6JDYh5oMew4ESZn7OQ+T6t2+H43t+Th/gBQEgQl4GQV0MG8PBwg5KRqHoZhfxN2AHz4ee4Ib6OMZ2jG4LnnpxgGUZI8z+ZoeHx83BBXlg32RFCzRbF8VB4rHSkSDQWUxrPXWmFH+RUSplXxlVWq9UbhNRap4Nq1xOoQR6n1L+r0YFUBGlecafJ9ogGmrNfA80+SLSvMtcaIA1r5SGlNHeSBIQHWIkdW8e0zrUAuuVMggFyCENGuNDUgopp4koUgSR4loC4EQIqSEHCQBGGmp+PApFYC0BWGLIqfE8BCIALTKMhKYvkfJjGChuuYPAcUcC8AAORQgVE43gIEagQBylwOAJhahhBgLwNAEBgnxWcWfeC18r4xnPlvJCO8oBOJWNtGAJBWBGNIMI7abClGcI/MdcgiAyx8MwDgS6xAtqLTseVYygEcBjQwHwDyFEISKmGmIpAEipEzTmogORS0VrlRaVAHJu08niS4aLE6JSKDnXKeVK6VTqA1IUkiMguQRBBIpPfEayyiFjXmjGHpMjEAiloaQeheAdkgR4aw8ZGp8ncJmZCUpAiCCVJESsu6tSsD1LIJgPgNy9mkBWIiESvdXDfSln4P6aQAbRFiCDDEgZ6zq0hl6UO9sYU1E/OMVGxNui2yrq6AuIxqYIPpkzdGqx1jEtRX7HFlMTh41pgTBmtxFjM1pc8V49Ktg11nE2XmDRRwwjhH8YW3DxZV3BjLQkxJ2iKzgFSGkKLYZwyZUyLWUdOS615AKYUYoJRSllPKJUngLaam1JYm2dt87GiLuaF2vBrS2ntPan2nrNVkoDt6NgId1WwwptqyOeNo4xjjDABMSYUzpkzOCbMuZ8yFh0BncslZqx5zKODR2zrLSl07Gmbs3rBUHxHGODQwMpzDlnC3F87dNzbn7r3fuQDh7TzMuiR8pBnxt3wI5Ues9fz/kAsBUCK9VJrzgghbeKE0JBAwkGkIb98IdOIfNSEaYTl9O3dQOhQz5GfWMGMxRe7DrTKKXyN5CyPnXWqT8o9I0hIQpcMe6FZK4WpARUDOIMqGXgwxdDZdYccWI1FSjLlNLs2MrJTjU45wqrUseHS71pLhjMopWyqq1xOVoxQ7yg4MGy3/R5qCUV/MJXvClaLf92KyXyrlkq1gFIVXK1IFih1IZQ2sl1fqg1BtjXGzNWbS1aprXW25DB9D7o82thdW6j2XsGW+xk9UP1QcA3+hA/RjDPHta0GrFGmNCd43J2TWnNNpYM3Zyzfy4NDsnXyYLfyItJaq4kewhWvkDcgmHzSPW/tHdm3dyRK20LA9Tznifl28evbJ5NUHc/J6I6F7juXhBKd0EZ3xOQrvRd+93irpPOuw5xS+Q33IdI3dFyrnDNcKepA56pmFPmjKY+B0FFaLAdlJIkDmE/2rgIMdzikHAScUEIITDv5cUYMAQixFSKtLFQqau3BJuIR3FeIJVaoD5CCU4sb7B3ESwMhs1E2yYC7NvCB8FJhEhlJgBAfgL6TD9A+IuoqN5mBIFAOYGWEgwB4H0R8D4QA==="}
// @errors: 2322
import { type Config } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

declare const config: Config<readonly [typeof mainnet, typeof sepolia]>
// ---cut---
import { useBlockNumber } from 'wagmi'

useBlockNumber({ chainId: 123 })

declare module 'wagmi' {
  interface Register {
    config: typeof config
  }
}
```

```ts twoslash [hook config property]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/getting-started.md","from":5943,"to":8411}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"849a5652cb34072baf13797118507e525565a80b04851946389914c2dc341926","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAhVhBEBrAHKCAtgCMyAHhGT+7AOa86NMFDi8AwoZO8AvLfvGKvEfmbswASShm9DCW1gZgRsbIADognt5gcDEAushgmjqkKTHsUMlOHq7RsV4+iSApadpkWSA5ye6yrDBiACLMaMz5WiY+aAB8jFjMpMwaMDSkcAD8iLwAqrIKSmrpZAAKw6PjZHD6ru5xPv4NME2t7cx93LML8ooq6lWkAErjgqRgACrYMLqNzWg2h0+lEwOwNFgIKQ0NJFvcVk9KCAoEoEIgCGg0Fg4IgAPS4gDuzGMGnYADo4PhcaQYMwxLjmFh2LjCBBlHBcTI7stHhkkXAOtCkABOKhNMDGND4JAARgALFRBcZxnguUsHqtyGKfLhEAAGKhxEZiMgigC+FHQPzwhBIWuo5iYbE4PFh3I1T10dnCJl0NOYKLArAwvFQoN4Ed4WnhAFFaFhFDTJrNgOHI+n/YHg7xYPxmIJWGgU2n06XeJnJNmwFtZjEY1KdiJmGAYgBuEtlyMVoMh96sWsYrE4/HjfCN5tkiRtjud8u0rMhxnsOakfu8GL4THYvEMplk0fjsCTiC79jTqSds3ti8Rq8d6PLT7gmCzGUAJj1n+v6bCaGNaBxXhUxvUtu2zYI4DmME7TgNhXjgCBWDtYsQNnMDFygKAaTgQCYj1WgYEIojCPlKAAHYZQADhEN8tDlMioGFYU3wAZlgZgtBlFiWIAVhgeU5WI89ZwzedKxDB8VBsf0aCgWZWL1SieOUyjv0vNSy3Q3gNALcQm1YVgWJQkSuzEnteADLD4FwkB8KbGUZS0WA9R44UyLIrQWIANhYhyvLIvU30oyivNomA32YGUyJYtyvPsmVhJMucA3EqN4Wk2lZNfOVeO8vUZQ00s7xA4r0zJcreHlbSoRgXhyrJQq7XYfgMAACS4fAZl4RhGBEDhgiLWx+rANBdHqvp3CGEYxgmQCADUyGatqOo2abtkmPhHD6Xg1lICBSVkXQtAgRDaTAK5eAAH2kSwYCMMAYCga8LSAjt6uepIJsqq7Koc5SHJldxumMXoBimrZZq64CyvK57rnmOEeU1V40HeL4fjG8qQTBCEoRhNV4V5U0qBREQ0UHbd8SJElyUpalaXpJcWRO9lOURj0+SoAVhgYRA5QNEBxUlaVEHlRVhmVXmQAJpHEW1B6kDfQ0vH/U19QtK0cDwMg9vtbmhUQHiyLFYJhaQY3YmgXVWLfJWQCMcUtjwHxYFoMkAKRHJtdIUgAFobbff25TlX2yKRGh6Dwb4cF4AByd8WNj3h2GsSAYS4OATGraNarQCBeEwGP45+gH/ocn7hFzHUoFjskkSaEhWG93X651RXlc2E1yFFsiNeoa10VtYmHUj9FBj2nBoQwPhDj8OTKtY/lBV5o2TYlKVzfF0hJbwWf/FbhXEDto06QmWVe8tfutcH4hh4jqXx4gSfMBn1xZm9CI/TM7MwxAyTlDjAmGqyZXqoVMilcyuZ8yFmMklLS1YxgDnrGOSYTYWwgEKmhb+vZVwDk3EOHcB5UETinBgmcnYtJLhXGuDcW5hynn3A2YhR4JCnkSmWUqkZOERn/k+RBC9Px6kKr+f8gFoYUOwWYBIUF2AwTgvARCyFQFJWSguCymFsI2XwsRYipEKLUVovRRizE2K0k4txPiAkhJkLAZpSR/8MrtEevJFiillI8VUuQ28mDwFqJ0oWdg+lDKwJMpQjR1kBx2Uio5Zyrl3KeR8n5AKQUQphQilFGKZE4rRPYSJLSDiZLOMqjlHieUCpeN4NwyphV6rFOqjSOqsMOxNRau1SkXUep9XYANd+w1RrjUmpsGaOxZgLVIEtNp+BVoQx2Jtbau19op1+MdU6zYLrXUrndauz13DiIjO9UEZpPpLx5ubQGgtTYb0QF5LeO90RhAiAfa2HdVbd18kcw0Vtna42hEBN06oEQZEqQIPaGg47U1JLHUEoIZYczIIwYAHgShz1fKxA4rhKncCRDNZgSBQDmAghIMAeAPZmjNEAA"}
// @errors: 2322
import { type Config } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

declare const config: Config<readonly [typeof mainnet, typeof sepolia]>
// ---cut---
import { useBlockNumber } from 'wagmi'

useBlockNumber({ chainId: 123, config })
```

By registering or using the hook `config` property, `useBlockNumber`'s `chainId` is strongly typed to only allow Mainnet and Sepolia IDs. Learn more by reading the [TypeScript docs](/react/typescript#config-types).
:::

### Wrap App in Context Provider

Wrap your app in the `WagmiProvider` React Context Provider and pass the `config` you created earlier to the `config` property.

::: code-group

```tsx [app.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/getting-started.md","from":8831,"to":9099}<fsm-vh3gqscxm4e>
import { WagmiProvider } from 'wagmi' // [!code focus]
import { config } from './config' // [!code focus]

function App() {
  return (
    <WagmiProvider config={config}> // [!code focus]
      {/** ... */} // [!code focus]
    </WagmiProvider> // [!code focus]
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

Check out the [`WagmiProvider` docs](/react/api/WagmiProvider) to learn more about React Context in Wagmi.

### Setup TanStack Query

Inside the `WagmiProvider`, wrap your app in a TanStack Query React Context Provider, e.g. `QueryClientProvider`, and pass a new `QueryClient` instance to the `client` property.

::: code-group

```tsx [app.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/getting-started.md","from":9495,"to":9955}<fsm-vh3gqscxm4e>
import { QueryClient, QueryClientProvider } from '@tanstack/react-query' // [!code focus]
import { WagmiProvider } from 'wagmi'
import { config } from './config'

const queryClient = new QueryClient() // [!code focus]

function App() {
  return (
    <WagmiProvider config={config}>
      <QueryClientProvider client={queryClient}> // [!code focus]
        {/** ... */} // [!code focus]
      </QueryClientProvider> // [!code focus]
    </WagmiProvider>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

Check out the [TanStack Query docs](https://tanstack.com/query/latest/docs/framework/react/overview) to learn about the library, APIs, and more.

### Use Wagmi

Now that everything is set up, every component inside the Wagmi and TanStack Query Providers can use Wagmi React Hooks.

::: code-group

```tsx [profile.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/getting-started.md","from":10324,"to":10690}<fsm-vh3gqscxm4e>
import { useConnection, useEnsName } from 'wagmi'

export function Profile() {
  const { address } = useConnection()
  const { data, error, status } = useEnsName({ address })
  if (status === 'pending') return <div>Loading ENS name</div>
  if (status === 'error')
    return <div>Error fetching ENS name: {error.message}</div>
  return <div>ENS name: {data}</div>
}
```

```tsx [app.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/getting-started.md","from":10712,"to":11122}<fsm-vh3gqscxm4e>
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { WagmiProvider } from 'wagmi'
import { config } from './config'
import { Profile } from './profile'

const queryClient = new QueryClient()

function App() {
  return (
    <WagmiProvider config={config}>
      <QueryClientProvider client={queryClient}>
        <Profile />
      </QueryClientProvider>
    </WagmiProvider>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Next Steps

For more information on what to do next, check out the following topics.

* [**TypeScript**](/react/typescript) Learn how to get the most out of Wagmi's type-safety and inference for an enlightened developer experience.
* [**Connect Wallet**](/react/guides/connect-wallet) Learn how to enable wallets to connect to and disconnect from your apps and display information about connected accounts.
* [**React Hooks**](/react/api/hooks) Browse the collection of React Hooks and learn how to use them.
* [**Viem**](/react/guides/viem) Learn about Viem and how it works with Wagmi.

---

---
url: /solid/getting-started.md
---
# Getting Started

## Overview

`@wagmi/solid` is a collection of Solid primitives for Ethereum. You can learn more about the rationale behind the project in the [Why Wagmi](/solid/why) section.

## Manual Installation

To manually add `@wagmi/solid` to your project, install the required packages.

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/getting-started.md","from":475,"to":540}<fsm-vh3gqscxm4e>
pnpm add @wagmi/solid viem@{{viemVersion}} @tanstack/solid-query
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/getting-started.md","from":563,"to":631}<fsm-vh3gqscxm4e>
npm install @wagmi/solid viem@{{viemVersion}} @tanstack/solid-query
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/getting-started.md","from":655,"to":720}<fsm-vh3gqscxm4e>
yarn add @wagmi/solid viem@{{viemVersion}} @tanstack/solid-query
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/getting-started.md","from":743,"to":807}<fsm-vh3gqscxm4e>
bun add @wagmi/solid viem@{{viemVersion}} @tanstack/solid-query
```

:::

* [Viem](https://viem.sh) is a TypeScript interface for Ethereum that performs blockchain operations.
* [TanStack Query](https://tanstack.com/query/v5) is an async state manager that handles requests, caching, and more.
* [TypeScript](/solid/typescript) is optional, but highly recommended. Learn more about [TypeScript support](/solid/typescript).

### Create Config

Create and export a new Wagmi config using `createConfig`.

::: code-group

```ts [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/getting-started.md","from":1278,"to":1527}<fsm-vh3gqscxm4e>
import { http, createConfig } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

:::

In this example, Wagmi is configured to use the Mainnet and Sepolia chains, and `injected` connector. Check out the [`createConfig` docs](/solid/api/createConfig) for more configuration options.

::: details TypeScript Tip
If you are using TypeScript, you can "register" the Wagmi config or use the hook `config` property to get strong type-safety across Solid Context in places that wouldn't normally have type info.

::: code-group

```ts twoslash [register config]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/getting-started.md","from":2003,"to":6092}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"5a265a7585bba6cc64f83e9dd43093d209786bd39bd0106c74836c3c3bff74f8","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAhVhBEBrAHKCAtgCMyAHhGT+7AOa86NMFDi8AwoZO8AvLfvHdpGMyiTWGXqgAdKV4QrUUVAFFaLEUPUjhEXmAgkNTUjy8fP1h+ZkFWNETk4LTS3gzvMF9eMGYNGESAkAi0fDI4EWYwJoBuFLLSiqzpUlZGgjQ0LASAehmYVvbOsAA6CV7+gfTPSurmLHYAVVHx/EnpxDn99hWFtvjltYgZ642S0oBfPvevzd4wpTKAAq7HqiQAjAAmAAMsO+aQMYDQpGYYgSST+aSGVT8MDAcEOYHYJHibAASvAIKwSUVMQNsXsoFAPHB0U1obQYFzuVzwQAWKAAdnBAA4RJCtHzBVAAJwyyEAZlgzC04IVCoArDB+XyeW8tlidsMASobBkaFBEoroSKNXaRfCBr93obMjjeBp8uJOqxWAraS76Ub3V5mfA2SAOZ1weCtLBoRqZYLBVoFQA2BUxtOC6GQkUitMSmCQ5jgwUKpNp6Pg/UGkIMvwm5RmzwWiF8zXp6Hgx1lZ1pfupFbD3j8j0QDy8YcrXu8EnsfgYAASXHwAH5EoxGCIOHjCrZd0jdNOAHwUXhYZgo+o0eKJABqZAXy9XAAUr3UFu0+I4T7xX6QEAaOwsi6FoEBUp4YAnnwAA+0iWDARhgDAUDfB857FGk07oQAumevAiPgzDsGAACSUBmPQeJWIRrjIE0REkfiTS4cgYCaDopBsU07BQKxTh0WARjGAxIBMaRcCsexnFkDxIB8ax56yKwMBiAAIswaDMIJWgmKRaAnowl7Xl+8QbtIsgKIC6jaGQKzvqZt5wPorjnhJ5FQMpMCqRpWnMDBiQyPI4RqLJpArBSaCCKQYBAtgMC6CpaloJp2knkELAcFwfC1PUcCXiIMCWSFNnhUEoJYBOaAldZKi2VxlAgN4IgIIgExTLMMwAO7MMYwErHA+AzHAVJ8S8BwzIQEDKHAMzBXVYV2eQVBwNppAMIgMpUKpYDGK0SD8lQ63GAseALaFDVkE1HAoUg0JUExKJiNdW0YegCV4IQJJNTQ9BMGwnA8LVl3hbodjCSY7jBtUgTvE2UQxBO7QBlsDa8DkeQFKjdblDDfh5Q0vBNC09wdF0tZ1ujMVjMTHUXHMdxLF0TyUwa6PXMctNNGcnWXBNNxMw8LMSALbMDrOg6hKFIJgqOMJwn8iLIqiaDolhQZutUeIEkSJJwOSlLUmQONU/jvChiyEYcjyPL8kKoripK0pyoqyqquqWo6nqICzmj5tNi2WmoVaCo2naGoOnSIRS4M5uegU7A+n6pvs+blvhuMUalrG8aJsmqYZlmOZ5gWRYlmWFaClWOfi5ruyNqFQdtqOHYal2PbR7wsex9OrfjpOOF/POi4rkNFlbju7B7okNiHmgx7DgRJmfs5D5PqPb4fje35OH+AFASBiXgZBXQwbw8HCDkpGoehmF/EPYAfPh57ghfo4xnaMbgueenGAZRkV473MkFKyoNloOW3mZFyp5uCgNKvVcKkUFgxTiglReKwMpEg0FVDaIMyrLSai1Nq9Muq9X6jcIaI0xpQAFlNCCs15pgIIY1Va61NpSh2nifa+BDp8mOleU6m0QAXRYddHaN8kCQkesRZ6t57rvWoJ9dqZBAIrRAGtK8m1CxcL2gdRAkJ+HiWgLgAxCo+QaioEYXan48CkVgLQFYasmp8TwKogAtIqCxniMyeL5L9cweAACCpBjCaD3LwCA/BeCYBwLwAA5IwH8f5gCEWIqRCiEJFQ9G7vE3gIEagQBqlwOAJhahhGKmgCAF4oG3kidE2JxV4mOVXu0cGrhoZaz8Kgf4oVEaxBRkkPGXSMZISxvuVJ6NCbjFJszbovthkNxGNzUh/Mhbk1WOsBZHMDhc1OOcLq1xbiLGFps54rwFlfG7jkpsssiZQlhNCHJfdwQagHsVHCc4N4vnHpubc89Z7zwwcvWpgzHykGfGPfALTgHA1/P+QCwFQKwPflfGA054krH6DYNgrBeClOMLUaKk4PDEqkI06w8TUkeUyfLBUOSPh5K6JRKlhFURtDuRZDiy1UWIWQrfNJzEKIWTfvBb+X8Yy8uvihNC+KDA4AANIwAwBZNaEK9pSqQjfWVABHQQZAVWJAADIQVkAAeWAgvAAivq0gGAzVYHEJIFyf8DLngAOILEWldUgERSBqPijgX++kkTnnRsgacL86Z6oNUqjATR35NBjXagAYvMv8l8+XapyYiESFkIYiWBe/F57ypwjkzdKgVvU0BEQsifVSXRi0jkhKWvuFb0XDiZZOUiBgcFaXYBUrF7wgRtBiQlawUSEk0qgF24qPagKXnEBU/4CxupcnJW0WQY6cBwCHWUQNTSoQKjyQUyAxTWRlJVKpGJ1TGkJNFR/V5Gpv6av5TOlYN0YAkFYG4/1E4bqSIMTIj8L1yCIFeYoxpX1iDiOoIE9qxlAI4A2hgPg06RXv3Fc+yV7a31NU0RtJAwpdE8KIwI0JZ12rToA3dID4lZGq1eoYyDyiCAwfUX9YRBkyC5CKrwCk/81qwYI5tNUCoSP6JFORoReABMgXkRI2jlj6MgfkeByELGcDQZ+sdeDIBEMQGQ5gPgcmhMRVzSYWeHTw0a2loCfpyM7wYkDPWc2mMvSp39iM6ZdNZmnLrmUamJw6a8wZvME5GzWa+y7q6JZnNgs8wOfzI56zHiiwuX7VIPdZy3NBPchWTylaSBVmiTz2wRk60JMSdohtRrG1IGVwL6cmRWyzpyW2vIBTCjFBKKUsp5RKk8B7TU2o+S6m5AFuOIzA7mhDrwa0tp7SZZjstxZwwE7elxf6ZzuM1shha5nOm2cYxxhgAmJMKZ0yZnBNmXM+ZCw6AruWSs1ZJuxeNE3WblpW6djTN2Vb2WH4jjHBoZGZaZzD2+VCie/zp5IkBXDhep5zxAOgevCFm8howugckhFh9QL1qgufXD2aggYR20OYceETz4fYXwqTIBdqkcQGmaTlHjGQ2MDR0xrOVNyNenyTTpi2M6bg/9KjzqaoWeMFZznnSllwzSAjaIAynO2am0s9z2MKdm285+GZEXlhvfK0smm+y+aM0NyLCAxvXMjPiys0LhyDjHLJml85BxJuA/hjLPLWTHmzmVnI9WXd0aVb1jV1gFI6s0h12ne3B3WRtY651h2PXnb9bdkNsTXsxs+1W+990M3WxzYWxHKOLnrmh/jl6JOW3Gsa+GBnJPR3aDVlO+dguV3i53bLo90sz3q6vei5Xwv1Ri/B2+/yX7/2u7e+wsDvkraqeQ4xz89cfyp4zwPIj4FKPQVOfBZCreTld7woPki4+EEG3QTgghStaEyf33eI/Z+NO2FaMOhmCTvCWds+EdLtzkgLzk9IxmBuCDKM/I9CYnYjgtVEMqIogjyh8AIIigkgAALkLATUIcAzpBBBCIFLRcRbi46MDUrpKeRZIKjdzcDcD4GIQ7hXjFSg5QD5BNKYF9TYF1Z8R5IazcakC8bFSmZ1Lq7S6JCNKTrS79AfBk5NQ3jMBICgDmA6wSBgB4DOIfAfBAA="}
// @errors: 2345
import { type Config } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

declare const config: Config<readonly [typeof mainnet, typeof sepolia]>
// ---cut---
import { useBlockNumber } from '@wagmi/solid'

useBlockNumber(() => ({ chainId: 123 }))

declare module '@wagmi/solid' {
  interface Register {
    config: typeof config
  }
}
```

```ts twoslash [hook config property]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/getting-started.md","from":6135,"to":9580}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"f81e0bbbae23a2914d38755afa1fcae7b27d59df3ac778f5d55a5f0a3952daf7","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAhVhBEBrAHKCAtgCMyAHhGT+7AOa86NMFDi8AwoZO8AvLfvGKvEfmbswASShm9DCW1gZgRsbIADognt5gcDEAushgmjqkKTHsUMlOHq7RsV4+iSApadpkWSA5ye6yrDBiACLMaMz5WiY+aAB8jFjMpMwaMDSkcAD8iNKyCkpq6WQAdAAKw6PjZHD6ru5xPv4NME2t7cx93LMy8ooq6lWkKwBK44KkYAAq2DC6jc00G0On0omAWBwuHwwFs4EMRDA5ndFo8MmD2BosBBSGgkQsHstyFQoEoEIgCGg0Fg4IgAPS0gDuzGMGnYKzg+FpcAgHCgtOYWHYtMIEGUcFpt3xSyelBAcA6OKQAE4qE0wMY0PgkABGAAsVAVxnGeEl92lGVlHDAuEQAAYqHERmIyMqAL4UdC/PCEEhE6jmJhsTg8PFm1F6OzhEy6UgwZgksCsDC8VBg3jp3haM0AUVoWEUscms2AaYzZdj8ckSd4sH4zEErDQxdLZdbvArCerMLGsxi2c1OxEzDAMQA3C22xmO1Xkx9WL2KVSafTxvhB8OVhIxxPJ+2453kwL2ABVUjz3gxfCU6l0/mClar9dgTcQO/sbdSSeu8ef9PfidZosXwYjAszagATLaUE/mWYRoE6aA0rwJa/q206JsmwRwMeYDsL6cBsG83KsL6zaobu6HVvGUCxnASExLatAwMxLHMXqUAAOzagAHCI4FaLqHFQEqSrgQAzLAzBaNqYliQArDAeq6qxH67uW+4zpmZo2BWNBQLM4m2txckmdxMFfuZbaUcmGgNuIQ6sKwYlkWpU4aRhvDUbR9EgIxQ7atqWiwLaclKhxHFaGJABsYkBVFHG2uB3HcVF/EwOBzDahxYlhVF/naqprl7pWHmASoOlxnpYG6vJ0W2tqlmtv+qHNWWKztbweq8Bo2KIu1KyNb67D8BgAASXD4DMvCMIwIgcMETa2PNYBoLo/V9O4QwjGMExIQAamQw1jRNGzbdskx8I4fS8GspAQKysi6FoEA8nGYBXLwAA+0iWDARjWlAP7ushE79UDSQbZ1X2dQFJkBdq7jdMYvQDFtWy7VNpoooS6ybDtOxre1Vw3PMYY428aAfN8vyEysoK4Zi2K4ljBIysSpLetey6MsyrLspyxE5G+wovWKEqk9jbNygqDCIIJqrBBqWqIHqBrDEassgCz5ouqqPg2uBDpeAhLp2u6no4HgZB3X68rDLLqUK+qmpIGJhuxNABtibqclUEYapbHgPiwLQKyIbKORW6QpAALTiT7ccxTHbuyjQ9B4AAgqQxiaAtvAQPwvCYDgvAAOSMJd13AB4JR+PpnXiaOBRRsYsyRhEMbudWqBaYsub5r1RbIcVB41n99aNsWI+ad2oEXiA/ZrpMQ4jiATfWdIZ4LleS63o+y8blua/Tx5R6nuel5c7eR4PgOB/PhIb5jrw34v03/WdVF3W9bwYO8ENI1xocimjNOa7AFpt2Wqtdam08bnX2odQBJ04G7UrjdO6D0/jPVesOD6n1+ql14OwawkBcRcDgCYGEWZERoAgLwNG+NSD50LsXREpdTrowJu3aMG8e5lWUP3AsOwp4b1rBPRa1cN6zwXIvJ8z8N5zm3lfFcd84ArxfPIruh5BTnyUbvekN995qMPq+I8z9X6v34cBHsDcoK2nfh1bUclv6xl/u1JuADjrANmKAqBkDwErVppDBh8DZgHVIEdIB+AOGMJDFddB91iF/HWnwb6whYAEJWKWGwbBWC8AocYGElNXGxmKVIVh1hS7V0OHXMCjdm4RDbq4TuJVu7V34YIweSFJFaLHnWOyIjenSPnrI++mjWmzi3vPHeN4VFL2MQ/CA4zR5nymZffRb5b7zPUY/Mxx8LEOJWJ/FxfV3H/0QV4yaPjZp+KWgE6BRNYFnV2mEi5USYnwLQbdRJj0UnQ3SX9fWUACGeUsGXapzBPAwGsTAKalQMj/N+v9GAgMa7xH8FNbU0N4ZwwCoi2sQKm5qIgDgAA0jADAU15QRPVPiwFAMm4AEdBBkEpbMAAMi9WQAB5Vkq0ACKLLSAYG5VgcQkhdhI16O4AA4uMKU4ZSDZmjtiH4OBEY9BWu4Xh/UIbuBiMy1l5KMAxGhgaoVGAABiq9rppKRYShpJgprcOMEE6GH8sU9VcR/O1BKGW8CZGgTwU1sFNGHO6jq4ETluKOb6mAILhiIh8AYTE7R2DUKyahL4a4i6/GsAXMuNT/CEMTUQ0Q90hjiGoZmcYDJmLlLXLIXNOA4CZrbGqthEExKEOIbwUhnk6KUKkk0IudDWFlyxd9HFcl4Z0uRVAUuKxLQwBIKwKONtLT6yQO7R0kKJg6jkubagXpyQ+l1v6dO5JBh3RwDiDAfAi1QExdi2GM68VxvnbKO2ipEBcSdkrJAHE1bZ2NOSR9m7rTbqNpsZ05BEDgV1Ee1h3piDnrTpra9JKyCYAfa4Z1rhoYupaaPVMqEOl5iEUPFCFFeliIGSDcik4pFbBkaolehVXIKLWYuWZtIjE7KWWvHcTHemrIvjx7mhi2MmKfkJxjf5GqtQzFYkCdS7GNTgghbpwn0wbywjhPCOxCLwB5KRBjRUT5USgDReAPlGKsVYuxLivF+KCWEqJCScZpKyQUkpFScmLMb34RVdoKKDJiSMiZOSZkdNv1ixvWyjZ2AOSci5IqG8vK2YXH5TKgVgqhXCpFGKcUEpJRSmlDKWUcocTyrljjakgvaV0mFzqNU5J1QarFpTCnQaON1NGsGE5PFRJATc+5/iFpBKeZwoe4TInIOeTsL5GCklPRemG96qSfp+pRUDdw1GMyDbAK6CGc6gVfplkgYy/6XaICisBjWeAwgRAgwbaDJs4NiW4idh0nsg6MxxMPbWiqX4CAwWXAAAkyFkQpBYLrBGCYHhIZpoMYNU2u/g6liQOAR103BuCyh2swJAoBzBYQkGAPA4dXSuiAA==="}
// @errors: 2345
import { type Config } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

declare const config: Config<readonly [typeof mainnet, typeof sepolia]>
// ---cut---
import { useBlockNumber } from '@wagmi/solid'

useBlockNumber(() => ({ chainId: 123, config }))
```

By registering or using the hook `config` property, `useBlockNumber`'s `chainId` is strongly typed to only allow Mainnet and Sepolia IDs. Learn more by reading the [TypeScript docs](/solid/typescript#config-types).
:::

### Wrap App in Context Provider

Wrap your app in the `WagmiProvider` Solid Context Provider and pass the `config` you created earlier to the `config` property.

::: code-group

```tsx [App.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/getting-started.md","from":10001,"to":10191}<fsm-vh3gqscxm4e>
import { WagmiProvider } from '@wagmi/solid'
import { config } from './config'

function App() {
  return (
    <WagmiProvider config={config}>
      {/** ... */}
    </WagmiProvider>
  )
}
```

```ts [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/getting-started.md","from":10213,"to":10462}<fsm-vh3gqscxm4e>
import { http, createConfig } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

:::

Check out the [`WagmiProvider` docs](/solid/api/WagmiProvider) to learn more about Solid Context in Wagmi.

### Setup TanStack Query

Inside the `WagmiProvider`, wrap your app in a TanStack Query Solid Context Provider, e.g. `QueryClientProvider`, and pass a new `QueryClient` instance to the `client` property.

::: code-group

```tsx [App.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/getting-started.md","from":10816,"to":11198}<fsm-vh3gqscxm4e>
import { QueryClient, QueryClientProvider } from '@tanstack/solid-query'
import { WagmiProvider } from '@wagmi/solid'
import { config } from './config'

const queryClient = new QueryClient()

function App() {
  return (
    <WagmiProvider config={config}>
      <QueryClientProvider client={queryClient}>
        {/** ... */}
      </QueryClientProvider>
    </WagmiProvider>
  )
}
```

```ts [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/getting-started.md","from":11220,"to":11469}<fsm-vh3gqscxm4e>
import { http, createConfig } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

:::

Check out the [TanStack Query docs](https://tanstack.com/query/latest/docs/framework/solid/overview) to learn about the library, APIs, and more.

### Use Wagmi

Now that everything is set up, every component inside the Wagmi and TanStack Query Providers can use Wagmi Solid Primitives.

::: code-group

```tsx [Profile.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/getting-started.md","from":11801,"to":12035}<fsm-vh3gqscxm4e>
import { useConnection } from '@wagmi/solid'

export function Profile() {
  const connection = useConnection()

  return (
    <div>
      <p>Address: {connection.address}</p>
      <p>Status: {connection.status}</p>
    </div>
  )
}
```

```tsx [App.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/getting-started.md","from":12057,"to":12474}<fsm-vh3gqscxm4e>
import { QueryClient, QueryClientProvider } from '@tanstack/solid-query'
import { WagmiProvider } from '@wagmi/solid'
import { config } from './config'
import { Profile } from './Profile'

const queryClient = new QueryClient()

function App() {
  return (
    <WagmiProvider config={config}>
      <QueryClientProvider client={queryClient}>
        <Profile />
      </QueryClientProvider>
    </WagmiProvider>
  )
}
```

```ts [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/getting-started.md","from":12496,"to":12745}<fsm-vh3gqscxm4e>
import { http, createConfig } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

:::

## Next Steps

For more information on what to do next, check out the following topics.

* [**TypeScript**](/solid/typescript) Learn how to get the most out of Wagmi's type-safety and inference for an enlightened developer experience.
* [**Connect Wallet**](/solid/guides/connect-wallet) Learn how to enable wallets to connect to and disconnect from your apps and display information about connected accounts.
* [**Solid Primitives**](/solid/api/primitives) Browse the collection of Solid Primitives and learn how to use them.
* [**Viem**](/solid/guides/viem) Learn about Viem and how it works with Wagmi.

---

---
url: /tempo/getting-started.md
---
# Getting Started

## Overview

[Tempo](https://tempo.xyz) is a purpose-built Layer 1 blockchain optimized for payments.

It enshrines features like [token management](https://docs.tempo.xyz/protocol/tip20/overview), [Fee AMM](https://docs.tempo.xyz/protocol/fees), and a [stablecoin DEX](https://docs.tempo.xyz/protocol/exchange) directly into the protocol, as well as a [Tempo transaction type](https://docs.tempo.xyz/protocol/transactions) with support for batch calls, fee sponsorship, configurable fee tokens, concurrent transactions, access keys, and scheduled execution.

## Setup

Wagmi React and Core both have first-class support for Tempo with [Hooks](/tempo/hooks/) and [Actions](/tempo/actions/). To get started, first follow the [Getting Started guide for React](/react/getting-started) or [Core](/core/getting-started) and make sure your [Viem](https://viem.sh) version is `{{viemVersion}}`.

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/getting-started.md","from":1147,"to":1206}<fsm-vh3gqscxm4e>
pnpm add viem@{{viemVersion}} accounts@{{accountsVersion}}
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/getting-started.md","from":1228,"to":1290}<fsm-vh3gqscxm4e>
npm install viem@{{viemVersion}} accounts@{{accountsVersion}}
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/getting-started.md","from":1313,"to":1372}<fsm-vh3gqscxm4e>
yarn add viem@{{viemVersion}} accounts@{{accountsVersion}}
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/getting-started.md","from":1395,"to":1453}<fsm-vh3gqscxm4e>
bun add viem@{{viemVersion}} accounts@{{accountsVersion}}
```

:::

To dive a layer deeper, check out the [Viem Tempo docs](https://viem.sh/tempo).

## Use Wagmi Hooks

Now that everything is set up, we can use regular Wagmi Hooks (e.g. `useSendTransactionSync`)
that are decorated with [Tempo properties](https://docs.tempo.xyz/protocol/transactions/spec-tempo-transaction)
like `calls` (batch transactions), `feePayer` (fee sponsorship), `nonceKey` (concurrent transactions) and more!

::: code-group

```tsx [tokenMetadata.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/getting-started.md","from":1927,"to":2813}<fsm-vh3gqscxm4e>
import { useSendTransactionSync } from 'wagmi'

export function TokenMetadata() {
  const sendTransactionSync = useSendTransactionSync()

  return (
    <button
      onClick={() =>
        sendTransactionSync.mutate({
          calls: [
            {
              data: '0xcafebabe00000000000000000000000000000001',
              to: '0xdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef'
            },
            {
              data: '0xdeadbeef00000000000000000000000000000002',
              to: '0xfeedfacefeedfacefeedfacefeedfacefeedface'
            },
            {
              data: '0xfeedface00000000000000000000000000000003',
              to: '0xfeedfacefeedfacefeedfacefeedfacefeedface'
            },
          ],
          feePayer: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045',
          nonceKey: 1337n,
        })
      }
    >
      Send transaction
    </button>
  )
}
```

```tsx [app.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/getting-started.md","from":2834,"to":3262}<fsm-vh3gqscxm4e>
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { WagmiProvider } from 'wagmi'
import { config } from './config'
import { TokenMetadata } from './tokenMetadata'

const queryClient = new QueryClient()

function App() {
  return (
    <WagmiProvider config={config}>
      <QueryClientProvider client={queryClient}>
        <TokenMetadata />
      </QueryClientProvider>
    </WagmiProvider>
  )
}
```

```tsx [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/getting-started.md","from":3285,"to":3584}<fsm-vh3gqscxm4e>
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})
```

:::

## Use Tempo Hooks

You can also use [Tempo-specific Hooks](/tempo/hooks/):

::: code-group

```tsx [tokenMetadata.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/getting-started.md","from":3713,"to":4184}<fsm-vh3gqscxm4e>
import { Hooks } from 'wagmi/tempo'

const alphaUsd = '0x20c0000000000000000000000000000000000001'

export function TokenMetadata() {
  const { data: metadata, ...metadataQuery } = Hooks.token.useGetMetadata({ 
    token: alphaUsd 
  })

  if (metadataQuery.isError)
    return <div>Error fetching metadata: {metadataQuery.error.message}</div>
  if (metadataQuery.isLoading) return <div>Loading metadata...</div>
  return <div>{metadata.name} ({metadata.symbol})</div>
}
```

```tsx [app.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/getting-started.md","from":4206,"to":4634}<fsm-vh3gqscxm4e>
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { WagmiProvider } from 'wagmi'
import { config } from './config'
import { TokenMetadata } from './tokenMetadata'

const queryClient = new QueryClient()

function App() {
  return (
    <WagmiProvider config={config}>
      <QueryClientProvider client={queryClient}>
        <TokenMetadata />
      </QueryClientProvider>
    </WagmiProvider>
  )
}
```

```tsx [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/getting-started.md","from":4658,"to":4957}<fsm-vh3gqscxm4e>
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})
```

:::

## Use Tempo Actions

You can also use [Tempo-specific Actions](/tempo/actions/) directly via the `wagmi/tempo` and `@wagmi/core/tempo` entrypoints:

::: code-group

```ts [React]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/getting-started.md","from":5147,"to":5426}<fsm-vh3gqscxm4e>
import { Actions } from 'wagmi/tempo'
import { config } from './config'

const alphaUsd = '0x20c0000000000000000000000000000000000001'

const metadata = await Actions.token.getMetadata(config, {
  token: alphaUsd,
})

console.log('Token:', metadata.name, `(${metadata.symbol})`)
```

```ts [React config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/getting-started.md","from":5455,"to":5754}<fsm-vh3gqscxm4e>
import { createConfig, http } from 'wagmi'
import { tempo } from 'wagmi/chains'
import { tempoWallet } from 'wagmi/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})
```

```ts [Core]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/getting-started.md","from":5772,"to":6057}<fsm-vh3gqscxm4e>
import { Actions } from '@wagmi/core/tempo'
import { config } from './config'

const alphaUsd = '0x20c0000000000000000000000000000000000001'

const metadata = await Actions.token.getMetadata(config, {
  token: alphaUsd,
})

console.log('Token:', metadata.name, `(${metadata.symbol})`)
```

```ts [Core config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/tempo/getting-started.md","from":6085,"to":6402}<fsm-vh3gqscxm4e>
import { createConfig, http } from '@wagmi/core'
import { tempo } from '@wagmi/core/chains'
import { tempoWallet } from '@wagmi/core/tempo'

export const config = createConfig({
  connectors: [tempoWallet()],
  chains: [tempo],
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})
```

:::

## Next Steps

After you have set up your Tempo with Wagmi, you can now:

* [**Guides & Examples**](https://docs.tempo.xyz/guide/tempo-transaction) Follow guides on how to [use accounts](https://docs.tempo.xyz/guide/use-accounts), [make payments](https://docs.tempo.xyz/guide/payments), [issue stablecoins](https://docs.tempo.xyz/guide/issuance), [exchange stablecoins](https://docs.tempo.xyz/guide/stablecoin-exchange), and more!
* [**Tempo React Hooks**](/tempo/hooks/) Browse the collection of React Hooks and learn how to use them.
* [**Tempo Core Actions**](/tempo/actions/) Browse the collection of Core Actions and learn how to use them.

---

---
url: /vue/getting-started.md
---
# Getting Started

## Overview

Wagmi is a collection of Vue composition utilities for Ethereum. You can learn more about the rationale behind the project in the [Why Wagmi](/vue/why) section.

## Automatic Installation

For new projects, it is recommended to set up your Wagmi app using the [`create-wagmi`](/cli/create-wagmi) command line interface (CLI). This will create a new Wagmi project using TypeScript and install the required dependencies.

::: code-group

```bash [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/getting-started.md","from":621,"to":639}<fsm-vh3gqscxm4e>
pnpm create wagmi
```

```bash [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/getting-started.md","from":658,"to":682}<fsm-vh3gqscxm4e>
npm create wagmi@latest
```

```bash [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/getting-started.md","from":702,"to":720}<fsm-vh3gqscxm4e>
yarn create wagmi
```

```bash [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/getting-started.md","from":739,"to":756}<fsm-vh3gqscxm4e>
bun create wagmi
```

:::

Once the command runs, you'll see some prompts to complete.

```ansi
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/getting-started.md","from":834,"to":900}<fsm-vh3gqscxm4e>
Project name: wagmi-project
Select a framework: Vue / Vanilla
...
```

After the prompts, `create-wagmi` will create a directory with your project name and install the required dependencies. Check out the `README.md` for further instructions (if required).

## Manual Installation

To manually add Wagmi to your project, install the required packages.

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/getting-started.md","from":1221,"to":1282}<fsm-vh3gqscxm4e>
pnpm add @wagmi/vue viem@{{viemVersion}} @tanstack/vue-query
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/getting-started.md","from":1305,"to":1369}<fsm-vh3gqscxm4e>
npm install @wagmi/vue viem@{{viemVersion}} @tanstack/vue-query
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/getting-started.md","from":1393,"to":1454}<fsm-vh3gqscxm4e>
yarn add @wagmi/vue viem@{{viemVersion}} @tanstack/vue-query
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/getting-started.md","from":1477,"to":1537}<fsm-vh3gqscxm4e>
bun add @wagmi/vue viem@{{viemVersion}} @tanstack/vue-query
```

:::

* [Viem](https://viem.sh) is a TypeScript interface for Ethereum that performs blockchain operations.
* [TanStack Query](https://tanstack.com/query/v5) is an async state manager that handles requests, caching, and more.
* [TypeScript](/vue/typescript) is optional, but highly recommended. Learn more about [TypeScript support](/vue/typescript).

### Create Config

Create and export a new Wagmi config using `createConfig`.

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

In this example, Wagmi is configured to use the Mainnet and Sepolia chains, and `injected` connector. Check out the [`createConfig` docs](/vue/api/createConfig) for more configuration options.

::: details TypeScript Tip
If you are using TypeScript, you can "register" the Wagmi config or use the hook `config` property to get strong type-safety in places that wouldn't normally have type info.

::: code-group

```ts twoslash [register config]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/getting-started.md","from":2475,"to":6000}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"a23946e4e600232f2356272aa1638ad6dfa3cb14a3230c917234b4d331429652","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAhVhBEBrAHKCAtgCMyAHhGT+7AOa86NMFDi8AwoZO8AvLfvHdpGMyiTWGXqgAdKV4QrUUVAFFaLEUPUjhEXmAgkNTUjy8fP1h+ZkFWNETk4LTS3gzvMF9eMGYNGESAkAi0fDI4EWYwJoBuFLLSiqzpUlZGgjQ0LASAehmYVvbOsAA6CV7+gfTPSurmLHYAVVHx/EnpxDn99hWFtvjltYgZ642S0oBfPvevzd4wpTKAAq7HqiQAjAAmAAMsO+aQMYDQpGYYgSST+aSGVT8MDAcEOYHYJHibAASvAIKwSUVMQNsXsoFAPHB0U1obQYFzuVzwQAWKAAdnBAA4RJCtHzBVAAJwyyEAZlgzC04IVCoArDB+XyeW8tlidsMASobBkaFBEoroSKNXaRfCBr93obMjjeBp8uJOqxWAraS76Ub3V5mfA2SAOZ1weCtLBoRqZYLBVoFQA2BUxtOC6GQkUitMSmCQ5jgwUKpNp6Pg/UGkIMvwm5RmzwWiF8zXp6Hgx1lZ1pfupFbD3j8j0QDy8YcrXu8EnsfgYAASXHwAH5EoxGCIOHjCrZd0jdNOAHwUXhYZgo+o0eKJABqZAXy9XAAUr3UFu0+I4T7xX6QEAaOwsi6FoEBUp4YAnnwAA+0iWDARhgDAUDfB857FGk07oQAumevAiPgzDsGAACSUBmPQeJWIRrjIE0REkfiTS4cgYCaDopBsU07BQKxTh0WARjGAxIBMaRcCsexnFkDxIB8ax56yKwMBiAAIswaDMIJWgmKRaAnowl7Xl+8QAPobrwhyyAogLqNoZDvqZt5wPorjnhJ5FQMpMCqRpWnMDBiQ2fI4RqLJpAUmggikGAQLYDAugqWpaCadpJ5BKCWATmg0i2eFDlcZQIDeCICCIBMUyzDMADuzDGMBKxwPgMxEIIMAvAcMwGBoOVwCqqlwDMMhhfZkUlXA2mkAwiAylQqlgMYrRIPyVDTcYCx4KNdkqEVZAlRwKFINCVBMSiYgHXNGHoIleCECSJU0PQTBsJwPD5WNe2RbodjCSY7jBtUgTvE2UQxBO7QBlsDa8DkeQFNDdblEDfi1GCvBNC09wdF0tZ1rDsVjJjVUXHMdxLF0Tz4wasPXMcxNNGc1WXF1NwUw8VMSGzNMDrOg6hOFIIY1CsLQrOiLIqiaDolhQZutUeIEkSJIDawFJwFSNIYoGZR00yLIRhyPI8vyQqiuKkrSnKirKqq6pajqeogLOMOo/84UtlpqFWgqNp2hqDp0iEAuDO7noFOwPp+kjBPu6GhvjFGpaxvGibJqmGZZjmeYFkWJZlhWgpVinvPy7sjae+aPujh2Gpdj2we8KHofTrX46TjhfzzouK4tVZW47uwe6JDYh5oMew4ESZn6uQ+T692+H43t+Th/gBQEgUl4GQV0MG8PBwg5KRqHoZhfxd2AHz4ee4IH6OMZ2jG4LnnpxgGUZM8rxZVmhbtEWOVIM5We7RJ4rGCtZAq41AHRVivFRKYDMpEj6rlT6/99rkCoGVCqpMar1UajcFqbUOpsx6kBfqg14AjSgd9QBk1pqzT5BqBaeJlr4FWnydaV5NqzRADtQqE0FonyQJCM6xELq3hOjdagd1KpkEApgkAU0ryzULCwpaK1ECCjOtAXAiBFSQlESAIwi1Px4FIrAWgKwZYlT4ngeRABaAxkInGJgcYKJ65g8AJRwLwAA5FCBUfjeAgRqBAPKXA4AmFqGEGAvA0AQHiYlfx6kuRYAALLMAwDoCk/BdB33gs/J+MZ75HyQifKAJ4/ErEOjAEgrB7GkAUYdYR+ixEfkuuQRAZZpGYBwPdYgB11peMqsZQCOAZoYD4F5CiVlUkwAyVknJSF8n3yKRqZ+pTELIVQieehKikBqJAItNhSBtHUG4VtSqMyoAtOOm08S4jpZXR6RQW6/TKoPSGdQEZCkkRkFyCIOJFJ35TW+comaq1IQv2OawzRIouGkB4XgEFIFJFCPucwx5HTJHdMhL02RBBBmKOerwsZEAJmYD4KisFpAViIhEqPVwgMFZ+BBmkMG0RYhQx1m7VlcMkII33HLOO/L0YNBJtjSm3QXZN1dBXEYjNcGsw5rjVY6xZW6zDvy+mJwSbMzJmzW4ixObqueK8TVWwW6zibMLCVos4R/ElhI2WTdYZK0JMSdo5JKTUjILHWm8cDbhiTpyE2vIBTCjFBKKUsp5RKk8PbTU2o+S6m5GXPW7smxezbLwa0tp7Su1SKHeVwwI7ejYDHXlyN9ZhlZKG6scYYAJiTCmdMmZwTZlzPmQsOgC7lkrNWDN2qFXZurpaWunY0zdiLSHfms425jg0JDKcw5Zw9xfP3Tc25x6j3Hog88X8zLokfKQZ8fd8DAO/h9X8/5ALAVAjvVSe84IIWPihNCQQMLVpCJfa+eyqAQtmmqNM6jTmIFAxcpFVzxKuDuXoyD51nldL5ASj5RLHrDJetcyQU0hKMpcP9NwsN2WpE5RDOIrqtWw3hl6ANfKFXivGFK01w7S3uiJqcc4NVVWPA1bOkdwxdVKoNTVa4xqcZ8fNQcYd1q/i2tBPamEjr3jOullRhjwwPUq29erX12sRWBp1cG+tJNjbhpTebaNVs4220TWqZNTt02WprVmqurYa75oDkHLVJbtj8vLVHSt/of1GYVQnENZnaCNrTq2zOHau2517cWUsA7i5Dpc6K0d7nvYTv5FOmdTc5PvEXXyDucTL5pA3RegeO7h5Ij3fViep5D3L2PfPM9i8WpXuPT+de96t5gQgs+6Cr6yk7M/Vfc+JW11fvwvsyF3SNlgc0ZBjaMGGUmHg4c9pEiXkymvjo2A5iUEzSSGggRgDm4CHvf4gAAvg4CxCYB+KCEEfh0CuKMGAIRYipEKIQkVM3bgb3EI7ivHE5dUB8hxL8Q9hqT32overQZAFqJgUwFBbeULm3jCJD6TACA/B8MmH6B8L9JUbzMCQKAcwSsJBgDwDYj4HwgA=="}
// @errors: 2322
import { type Config } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

declare const config: Config<readonly [typeof mainnet, typeof sepolia]>
// ---cut---
import { useBlockNumber } from '@wagmi/vue'

useBlockNumber({ chainId: 123 })

declare module '@wagmi/vue' {
  interface Register {
    config: typeof config
  }
}
```

```ts twoslash [hook config property]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/getting-started.md","from":6043,"to":8630}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"b0daf106bbcd51604a04f61b444559e5b4612f840caeff27571cf1d2939b54a2","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAhVhBEBrAHKCAtgCMyAHhGT+7AOa86NMFDi8AwoZO8AvLfvGKvEfmbswASShm9DCW1gZgRsbIADognt5gcDEAushgmjqkKTHsUMlOHq7RsV4+iSApadpkWSA5ye6yrDBiACLMaMz5WiY+aAB8jFjMpMwaMDSkcAD6APyIvACqsgpKaulkAArDo+NkcPqu7nE+/g0wTa3tzH3c80vyiirqVaQASuOCpGAAKtgwuo1mmg2h0+lEwOwNFgIKQ0NJlo81i9KCAoEoEIgCGg0Fg4IgAPT4gDuzGMGnYADo4Ph8URBDB8cwsOx8QYoRA4MwtE04PiZA9Vs8Mii4B1YUgAJxUJpgYxofBIACMABYqGLjOM8PyVk91uRpT5cIgAAxUOIjMRkSUAXwo6D+eEIJH11HMTDYnB48IFupeujs4RMulIMGYaLArAwvFQ4N4cd43NWAFFaFhFCHJvNgLH47mQ2HJJHeLB+MxBKw0Fmc7ma7x8+Gi2AdvMYkn5XsRMwwDEANzV2vx+uFqOfVgtrE4vGE8b4DtdikSXv9gd10MNqNM9gLUhj3gxfDY3EExnMikzudgBcQE/sJdSAfWvv3uOP/uJlTfSEweaKgBMxoAp9czCNALTQPFeGzZ8ayHCMo2COAFghZ1OVYd44AgVhnSraCV1goswygEM4AgmJjVoGBKKoyiVSgAB2RUAA4RF/LRlToqAJQlX8AGZYC5RUeJ4gBWGAVWVai7xXPM12HBNERsfMaCgeZeONRjhM0xigIfHTa3wqMNHLcRO1YVgeJw6TB1kuDeEI4jSJAcjO0VRUtFgY1hIlOi6K0HiADYeNc/y6ONX9GMY/zWJgX9mEVOieO8/yXMVKSrNXAtbPfZRFNDZSf2VESAuNRU9JrV9oIq3MKRq3gVV4DQYRgXgaopMrnXYfgMAACS4fA5l4RhGBEDhgkrWxRrANBdFavp3CGEYxgmCCADUyE6nq+q2RbdkmPhHD6XgNlICByVkXQtAgTDQzAG5eAAH2kSwYCMMAYCgJ9bUg/tWs+pI5rqh66tczTXMVdxumMXoBgWnZltmO4EUFPVtrhvYZpqm5EZ9JEMneNBPh+P4MYpMEIXZWFvR1XGrSoNERAxCcj0JEkyUpalaXpG9WVO6FOW5eA+SR31hSoUVhgYRBlWE6VgjlBVEBVNVhg1SWQG1REhVpkAODepBfzNLwwKtE1bXtHA8DIE6XXF8VECi2XZXlJA6LNaAjV438DZAIwZR2PAfFgWgKXAlEckt0hSAAWk938Y68qO6JRGh6DwX4cF4AByP8eMz3h2GsSA4S4OATCbAXeDQCBK7+LOWkorAAFlmAwHR3n4XRFSBsHQdcoHhBLQ0oD6TOKRRJoSFYCPrfHw19cN7ZLXIRW6LN6gHUxJ1tZTtXBhOnBYQwPhjj8KABvrmAm5btuXs77uQeEsH++e173r6EUxUlh2dbl53EFd6gKtNSYhPv4WeetEDe3NMwJeSpV52nXhbTexBt5ukxHvCAB9MDH1cOfBuzdW4wHbv6VwQMAwRGDDZIsMZoLZRTGmJqmZvq4WsplIsJYywVksulAyvAmxjHHG2WckxOzdhAGVPCVCRw7nHAeScx5zwiPnIucRy4By8M3NuXc+5DxThvGedsSjLwSBvGlWsVV4wWLjNlT8Ai6r/kAv2ECYEIJQUkWw+CCQkLsBQmwdCmFsLMPShldcdkoBEXgI5ci1FqK0QYsxVi7FOLcT4qGLQgkRJiWVBJKiZjpK8Oyrldo71VI8XUppYS2k1Evgkaw0JRkKzsFMuZbhVkNHhIcuOZycU3IeS8j5PygVgqhXCpFaKsV4qJToslHpeT3GhMKUpEpdVCrCWKqVapvArFbLKq1FZDUmotRqu1daXVerUgGkNEa7AxrzBsJNaas15rbCWnseYa1SAbXOfgVGry9pOEOsdU6Bd/iXWul2O6j0B4vSHp9dwbj4y/XBNaf6z9B5vWHh/CWLt/KO3lkgXFgDSCqzwGECI4CPYL2NsvIKKK3awADhTOEwAqaaz1FsgQJ0NBZwAAKs3JJzGAmdwTgg1sjF4jAWWgJUvYniRxSHWm4CiJazAkCgHMAhCQYA8Ch2tNaIAA=="}
// @errors: 2322
import { type Config } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

declare const config: Config<readonly [typeof mainnet, typeof sepolia]>
// ---cut---
import { useBlockNumber } from '@wagmi/vue'

useBlockNumber({ chainId: 123, config })
```

By registering or using the hook `config` property, `useBlockNumber`'s `chainId` is strongly typed to only allow Mainnet and Sepolia IDs. Learn more by reading the [TypeScript docs](/vue/typescript#config-types).
:::

### Add Plugin to App

Add the `WagmiPlugin` to your app instance and pass the `config` you created earlier to the plugin options.

::: code-group

```tsx [main.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/getting-started.md","from":9017,"to":9268}<fsm-vh3gqscxm4e>
import { WagmiPlugin } from '@wagmi/vue' // [!code focus]
import { createApp } from 'vue'
import { config } from './config' // [!code focus]
import App from './App.vue'

createApp(App)
  .use(WagmiPlugin, { config }) // [!code focus]
  .mount('#app')
```

```vue [App.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/getting-started.md","from":9289,"to":9312}<fsm-vh3gqscxm4e>
<template>
</template>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

Check out the [`WagmiPlugin` docs](/vue/api/WagmiPlugin) to learn more about the plugin API.

### Setup TanStack Query

After the `WagmiPlugin`, attach the `VueQueryPlugin` to your app, and pass a new `QueryClient` instance to the `queryClient` property.

::: code-group

```tsx [main.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/getting-started.md","from":9649,"to":10045}<fsm-vh3gqscxm4e>
import { QueryClient, VueQueryPlugin } from '@tanstack/vue-query' // [!code focus]
import { WagmiPlugin } from '@wagmi/vue'
import { createApp } from 'vue'
import { config } from './config'
import App from './App.vue'

const queryClient = new QueryClient() // [!code focus]

createApp(App)
  .use(WagmiPlugin, { config })
  .use(VueQueryPlugin, { queryClient }) // [!code focus]
  .mount('#app')
```

```vue [App.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/getting-started.md","from":10066,"to":10089}<fsm-vh3gqscxm4e>
<template>
</template>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

Check out the [TanStack Query docs](https://tanstack.com/query/latest/docs/framework/vue/overview) to learn about the library, APIs, and more.

### Use Wagmi

Now that everything is set up, every component inside your app can use Wagmi Vue Composables.

::: code-group

```vue [App.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/getting-started.md","from":10424,"to":10823}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnection, useEnsName } from '@wagmi/vue'

const { address } = useConnection()
const { data, error, status } = useEnsName({ address })
</script>

<template>
  <div v-if="status === 'pending'">Loading ENS name</div>
  <div v-else-if="status === 'error'">
    Error fetching ENS name: {{error.message}}
  </div>
  <div v-else>ENS name: {{data}}</div>
</template>
```

```tsx [main.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/getting-started.md","from":10844,"to":11189}<fsm-vh3gqscxm4e>
import { QueryClient, VueQueryPlugin } from '@tanstack/vue-query'
import { WagmiPlugin } from '@wagmi/vue'
import { createApp } from 'vue'
import { config } from './config'
import App from './App.vue'

const queryClient = new QueryClient()

createApp(App)
  .use(WagmiPlugin, { config })
  .use(VueQueryPlugin, { queryClient })
  .mount('#app')
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Next Steps

For more information on what to do next, check out the following topics.

* [**TypeScript**](/vue/typescript) Learn how to get the most out of Wagmi's type-safety and inference for an enlightened developer experience.
* [**Connect Wallet**](/vue/guides/connect-wallet) Learn how to enable wallets to connect to and disconnect from your apps and display information about connected accounts.
* [**Vue Composables**](/vue/api/composables) Browse the collection of Vue Composables and learn how to use them.
* [**Viem**](/vue/guides/viem) Learn about Viem and how it works with Wagmi.

---

---
url: /core/api/actions/getTransaction.md
---
# getTransaction

Action for fetching transactions given hashes or block identifiers.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransaction.md","from":234,"to":279}<fsm-vh3gqscxm4e>
import { getTransaction } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransaction.md","from":326,"to":532}<fsm-vh3gqscxm4e>
import { getTransaction } from '@wagmi/core'
import { config } from './config'

const transaction = getTransaction(config, {
  hash: '0x0fa64daeae54e207aa98613e308c2ba8abfe274f75507e741508cc4db82c8cb5',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransaction.md","from":603,"to":663}<fsm-vh3gqscxm4e>
import { type GetTransactionParameters } from '@wagmi/core'
```

***

### blockHash

`bigint | undefined`

Block hash to get transaction at (with [`index`](#index)).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransaction.md","from":802,"to":1042}<fsm-vh3gqscxm4e>
import { getTransaction } from '@wagmi/core'
import { config } from './config'

const transaction = getTransaction(config, {
  blockHash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', // [!code focus]
  index: 0,
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`bigint | undefined`

Block number to get transaction at (with [`index`](#index)).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransaction.md","from":1225,"to":1408}<fsm-vh3gqscxm4e>
import { getTransaction } from '@wagmi/core'
import { config } from './config'

const transaction = getTransaction(config, {
  blockNumber: 17829139n, // [!code focus]
  index: 0,
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get transaction at (with [`index`](#index)).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransaction.md","from":1635,"to":1812}<fsm-vh3gqscxm4e>
import { getTransaction } from '@wagmi/core'
import { config } from './config'

const transaction = getTransaction(config, {
  blockTag: 'safe', // [!code focus]
  index: 0,
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransaction.md","from":1998,"to":2295}<fsm-vh3gqscxm4e>
import { getTransaction } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const transaction = await getTransaction(config, {
  chainId: mainnet.id, // [!code focus]
  hash: '0x0fa64daeae54e207aa98613e308c2ba8abfe274f75507e741508cc4db82c8cb5',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### hash

`` `0x${string}` | undefined ``

Hash to get transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransaction.md","from":2446,"to":2669}<fsm-vh3gqscxm4e>
import { getTransaction } from '@wagmi/core'
import { config } from './config'

const transaction = getTransaction(config, {
  hash: '0x0fa64daeae54e207aa98613e308c2ba8abfe274f75507e741508cc4db82c8cb5', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### index

`number | undefined`

An index to be used with a block identifier ([hash](#blockhash), [number](#blocknumber), or [tag](#blocktag)).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransaction.md","from":2896,"to":3073}<fsm-vh3gqscxm4e>
import { getTransaction } from '@wagmi/core'
import { config } from './config'

const transaction = getTransaction(config, {
  blockTag: 'safe',
  index: 0  // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransaction.md","from":3145,"to":3205}<fsm-vh3gqscxm4e>
import { type GetTransactionReturnType } from '@wagmi/core'
```

[`Transaction`](https://viem.sh/docs/glossary/types#transaction)

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransaction.md","from":3292,"to":3351}<fsm-vh3gqscxm4e>
import { type GetTransactionErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getTransaction`](https://viem.sh/docs/actions/public/getTransaction)

---

---
url: /core/api/actions/getTransactionConfirmations.md
---
# getTransactionConfirmations

Action for fetching the number of blocks passed (confirmations) since the transaction was processed on a block. If confirmations is 0, then the Transaction has not been confirmed & processed yet.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionConfirmations.md","from":401,"to":459}<fsm-vh3gqscxm4e>
import { getTransactionConfirmations } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionConfirmations.md","from":506,"to":738}<fsm-vh3gqscxm4e>
import { getTransactionConfirmations } from '@wagmi/core'
import { config } from './config'

const transaction = getTransactionConfirmations(config, {
  hash: '0x0fa64daeae54e207aa98613e308c2ba8abfe274f75507e741508cc4db82c8cb5',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionConfirmations.md","from":809,"to":882}<fsm-vh3gqscxm4e>
import { type GetTransactionConfirmationsParameters } from '@wagmi/core'
```

***

### hash

`` `0x${string}` | undefined ``

The hash of the transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionConfirmations.md","from":997,"to":1246}<fsm-vh3gqscxm4e>
import { getTransactionConfirmations } from '@wagmi/core'
import { config } from './config'

const transaction = getTransactionConfirmations(config, {
  hash: '0x0fa64daeae54e207aa98613e308c2ba8abfe274f75507e741508cc4db82c8cb5', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### transactionReceipt

`TransactionReceipt | undefined`

The transaction receipt.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionConfirmations.md","from":1412,"to":1614}<fsm-vh3gqscxm4e>
import { getTransactionConfirmations } from '@wagmi/core'
import { config } from './config'

const transaction = getTransactionConfirmations(config, {
  transactionReceipt: { ... }, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionConfirmations.md","from":1800,"to":2123}<fsm-vh3gqscxm4e>
import { getTransactionConfirmations } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const transaction = await getTransactionConfirmations(config, {
  chainId: mainnet.id, // [!code focus]
  hash: '0x0fa64daeae54e207aa98613e308c2ba8abfe274f75507e741508cc4db82c8cb5',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionConfirmations.md","from":2195,"to":2268}<fsm-vh3gqscxm4e>
import { type GetTransactionConfirmationsReturnType } from '@wagmi/core'
```

`bigint`

The number of blocks passed since the transaction was processed. If confirmations is 0, then the Transaction has not been confirmed & processed yet.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionConfirmations.md","from":2449,"to":2521}<fsm-vh3gqscxm4e>
import { type GetTransactionConfirmationsErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getTransactionConfirmations`](https://viem.sh/docs/actions/public/getTransactionConfirmations)

---

---
url: /core/api/actions/getTransactionCount.md
---
# getTransactionCount

Action for fetching the number of transactions an Account has sent.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionCount.md","from":249,"to":299}<fsm-vh3gqscxm4e>
import { getTransactionCount } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionCount.md","from":346,"to":546}<fsm-vh3gqscxm4e>
import { getTransactionCount } from '@wagmi/core'
import { config } from './config'

const transactionCount = getTransactionCount(config, {
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionCount.md","from":617,"to":682}<fsm-vh3gqscxm4e>
import { type GetTransactionCountParameters } from '@wagmi/core'
```

***

### address

`Address`

The address of the account.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionCount.md","from":777,"to":994}<fsm-vh3gqscxm4e>
import { getTransactionCount } from '@wagmi/core'
import { config } from './config'

const transactionCount = getTransactionCount(config, {
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### blockNumber

`bigint | undefined`

Get the count at a block number.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionCount.md","from":1154,"to":1397}<fsm-vh3gqscxm4e>
import { getTransactionCount } from '@wagmi/core'
import { config } from './config'

const transactionCount = getTransactionCount(config, {
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
  blockNumber: 17829139n, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Get the count at a block tag.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionCount.md","from":1596,"to":1835}<fsm-vh3gqscxm4e>
import { getTransactionCount } from '@wagmi/core'
import { config } from './config'

const transactionCount = getTransactionCount(config, {
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
  blockTag: 'latest', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionCount.md","from":2021,"to":2261}<fsm-vh3gqscxm4e>
import { getTransactionCount } from '@wagmi/core'
import { config } from './config'

const transactionCount = getTransactionCount(config, {
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
  chainId: mainnet.id, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionCount.md","from":2334,"to":2399}<fsm-vh3gqscxm4e>
import { type GetTransactionCountReturnType } from '@wagmi/core'
```

`number`

The number of transactions an account has sent.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionCount.md","from":2479,"to":2543}<fsm-vh3gqscxm4e>
import { type GetTransactionCountErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getTransactionCount`](https://viem.sh/docs/actions/public/getTransactionCount)

---

---
url: /core/api/actions/getTransactionReceipt.md
---
# getTransactionReceipt

Action for return the [Transaction Receipt](https://viem.sh/docs/glossary/terms#transaction-receipt) given a [Transaction](https://viem.sh/docs/glossary/terms#transaction) hash.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionReceipt.md","from":365,"to":417}<fsm-vh3gqscxm4e>
import { getTransactionReceipt } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionReceipt.md","from":464,"to":670}<fsm-vh3gqscxm4e>
import { getTransactionReceipt } from '@wagmi/core'
import { config } from './config'

await getTransactionReceipt(config, {
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionReceipt.md","from":741,"to":808}<fsm-vh3gqscxm4e>
import { type GetTransactionReceiptParameters } from '@wagmi/core'
```

### hash

`` `0x${string}` ``

A transaction hash.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionReceipt.md","from":897,"to":1120}<fsm-vh3gqscxm4e>
import { getTransactionReceipt } from '@wagmi/core'
import { config } from './config'

await getTransactionReceipt(config, {
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

The ID of chain to return the transaction receipt from.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionReceipt.md","from":1318,"to":1609}<fsm-vh3gqscxm4e>
import { getTransactionReceipt } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

await getTransactionReceipt(config, {
  chainId: mainnet.id, // [!code focus]
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionReceipt.md","from":1681,"to":1748}<fsm-vh3gqscxm4e>
import { type GetTransactionReceiptReturnType } from '@wagmi/core'
```

[`TransactionReceipt`](https://viem.sh/docs/glossary/types#transactionreceipt)

The transaction receipt.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getTransactionReceipt.md","from":1875,"to":1941}<fsm-vh3gqscxm4e>
import { type GetTransactionReceiptErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`getTransactionReceipt`](https://viem.sh/docs/actions/public/getTransactionReceipt)

---

---
url: /core/api/actions/getWalletClient.md
---
# getWalletClient

Action for getting a Viem [`WalletClient`](https://viem.sh/docs/clients/wallet) object for the current or provided connector.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getWalletClient.md","from":295,"to":341}<fsm-vh3gqscxm4e>
import { getWalletClient } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getWalletClient.md","from":388,"to":508}<fsm-vh3gqscxm4e>
import { getWalletClient } from '@wagmi/core'
import { config } from './config'

const client = getWalletClient(config)
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: warning
If you want to optimize bundle size, you should use [`getConnectorClient`](/core/api/actions/getConnectorClient) along with Viem's [tree-shakable actions](https://viem.sh/docs/clients/custom#tree-shaking) instead. Since Wallet Client has all wallet actions attached directly to it.
:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getWalletClient.md","from":878,"to":939}<fsm-vh3gqscxm4e>
import { type GetWalletClientParameters } from '@wagmi/core'
```

### account

`Address | Account | undefined`

Account to use with client. Throws if account is not found on [`connector`](#connector).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getWalletClient.md","from":1112,"to":1311}<fsm-vh3gqscxm4e>
import { getWalletClient } from '@wagmi/core'
import { config } from './config'

const client = getWalletClient(config, {
  account: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use with client.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getWalletClient.md","from":1485,"to":1695}<fsm-vh3gqscxm4e>
import { getWalletClient } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const client = getWalletClient(config, {
  chainId: mainnet.id, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

* Connector to get client for.
* Defaults to current connector.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getWalletClient.md","from":1882,"to":2123}<fsm-vh3gqscxm4e>
import { getConnections, getWalletClient } from '@wagmi/core'
import { config } from './config'

const connections = getConnections(config)
const client = getWalletClient(config, {
  connector: connections[0]?.connector, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getWalletClient.md","from":2195,"to":2251}<fsm-vh3gqscxm4e>
import { type GetChainIdReturnType } from '@wagmi/core'
```

`WalletClient`

Viem [`WalletClient`](https://viem.sh/docs/clients/wallet) object for the current or provided connector.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/getWalletClient.md","from":2394,"to":2454}<fsm-vh3gqscxm4e>
import { type GetWalletClientErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

---

---
url: /cli/api/plugins/hardhat.md
---
# hardhat

Plugin for resolving ABIs from [Hardhat](https://hardhat.org) projects. Supports [`watch`](/cli/api/commands/generate#w-watch) mode.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/hardhat.md","from":151,"to":196}<fsm-vh3gqscxm4e>
import { hardhat } from '@wagmi/cli/plugins'
```

## Usage

```ts{2,6-8}
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/hardhat.md","from":224,"to":420}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { hardhat } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    hardhat({
      project: '../hello_hardhat',
    }),
  ],
})
```

## Configuration

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/hardhat.md","from":449,"to":505}<fsm-vh3gqscxm4e>
import { type HardhatConfig } from '@wagmi/cli/plugins'
```

### artifacts

`string | undefined`

* Project's artifacts directory. Same as your project's `artifacts` [path configuration](https://hardhat.org/hardhat-runner/docs/config#path-configuration) option.
* Defaults to `'artifacts/'`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/hardhat.md","from":748,"to":986}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { hardhat } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    hardhat({
      artifacts: 'out/', // [!code focus]
      project: '../hello_hardhat',
    }),
  ],
})
```

### deployments

`{ [key: string]: address?: Address | Record<chainId, Address> | undefined } | undefined`

Mapping of addresses to attach to artifacts.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/hardhat.md","from":1151,"to":1627}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { hardhat } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    hardhat({
      project: '../hello_hardhat',
      deployments: { // [!code focus]
        Counter: { // [!code focus]
          1: '0x314159265dd8dbb310642f98f50c066173c1259b', // [!code focus]
          5: '0x112234455c3a32fd11230c42e7bccd4a84e02010', // [!code focus]
        }, // [!code focus]
      }, // [!code focus]
    }),
  ],
})
```

### exclude

`string[] | undefined`

Artifact files to exclude relative to `artifacts`. Supports glob patterns.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/hardhat.md","from":1751,"to":2163}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { hardhat } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    hardhat({
      exclude: [ // [!code focus]
        // the following patterns are excluded by default // [!code focus]
        'build-info/**', // [!code focus]
        '*.dbg.json', // [!code focus]
      ], // [!code focus]
      project: '../hello_hardhat',
    }),
  ],
})
```

### commands

`{ clean?: string | boolean | undefined; build?: string | boolean | undefined; rebuild?: string | boolean | undefined } | undefined`

Hardhat command options.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/hardhat.md","from":2348,"to":2773}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { hardhat } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    hardhat({
      commands: { // [!code focus]
        clean: 'pnpm hardhat clean', // [!code focus]
        build: 'pnpm hardhat compile', // [!code focus]
        rebuild: 'pnpm hardhat compile', // [!code focus]
      }, // [!code focus]
      project: '../hello_hardhat',
    }),
  ],
})
```

#### clean

* Remove build artifacts and cache directories on start up.
* Defaults to `'${packageManger} hardhat clean'`.

#### build

* Build Foundry project before fetching artifacts.
* Defaults to `'${packageManger} hardhat compile'`.

#### rebuild

* Command to run when watched file or directory is changed. Used for setting up [`watch`](/cli/api/commands/generate#w-watch) mode.
* Defaults to `'${packageManger} hardhat compile'`.

### include

`string[] | undefined`

Artifact files to include relative to `artifacts`. Supports glob patterns.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/hardhat.md","from":3335,"to":3701}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { hardhat } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    hardhat({
      include: [ // [!code focus]
        // the following patterns are included by default // [!code focus]
        '*.json', // [!code focus]
      ], // [!code focus]
      project: '../hello_hardhat',
    }),
  ],
})
```

### namePrefix

`string | undefined`

Prefix to prepend to artifact names. Useful for preventing name collisions between contracts from other sources.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/hardhat.md","from":3864,"to":4111}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { hardhat } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    hardhat({
      namePrefix: 'HelloHardhat', // [!code focus]
      project: '../hello_hardhat',
    }),
  ],
})
```

### project

`string`

Path to Hardhat project.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/hardhat.md","from":4171,"to":4384}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { hardhat } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    hardhat({
      project: '../hello_hardhat', // [!code focus]
    }),
  ],
})
```

---

---
url: /react/api/hooks.md
---
# Hooks

React Hooks for accounts, wallets, contracts, transactions, signing, ENS, and more.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks.md","from":316,"to":354}<fsm-vh3gqscxm4e>
import { useConnection } from 'wagmi'
```

## Available Hooks

---

---
url: /core/api/transports/http.md
---

# http

The `http` Transport connects to a JSON-RPC API via HTTP. Wraps Viem's [`http` Transport](https://viem.sh/docs/clients/transports/http).

## Import

```ts-vue
import { http } from '{{packageName}}'
```

## Usage

```ts-vue
import { 
  createConfig, 
  http // [!code hl]
} from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()],
  transports: {
    [mainnet.id]: http('https://foo-bar-baz.quiknode.pro/...'), // [!code hl]
    [sepolia.id]: http('https://foo-bar-sep.quiknode.pro/...'), // [!code hl]
  },
})
```

::: warning
If no URL is provided, then the transport will fall back to a public RPC URL on the chain. It is highly recommended to provide an authenticated RPC URL to prevent rate-limiting.
:::

### Batch JSON-RPC

The `http` Transport supports Batch JSON-RPC. This means that multiple JSON-RPC requests can be sent in a single HTTP request.

The Transport will batch up Actions over a given period and execute them in a single Batch JSON-RPC HTTP request. By default, this period is a [zero delay](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Event_loop#zero_delays) meaning that the batch request will be executed at the end of the current [JavaScript message queue](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Event_loop#queue). Consumers can specify a custom time period `wait` (in ms).

You can enable Batch JSON-RPC by setting the `batch` flag to `true`:

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: true // [!code hl]
})
```

## Parameters

### url

`string`

URL of the JSON-RPC API. Defaults to `chain.rpcUrls.default.http[0]`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...')
```

### batch

`boolean | BatchOptions`

Toggle to enable Batch JSON-RPC. Defaults to `false`

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: true // [!code focus]
})
```

### batch.batchSize

`number`

The maximum number of JSON-RPC requests to send in a batch. Defaults to `1_000`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: {
    batchSize: 2_000 // [!code focus]
  }
})
```

### batch.wait

`number`

The maximum number of milliseconds to wait before sending a batch. Defaults to `0` ([zero delay](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Event_loop#zero_delays)).

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: {
    wait: 16 // [!code focus]
  }
})
```

### fetchOptions

[`RequestInit`](https://developer.mozilla.org/en-US/docs/Web/API/fetch)

[Fetch options](https://developer.mozilla.org/en-US/docs/Web/API/fetch) to pass to the internal `fetch` function. Useful for passing auth headers or cache options.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  fetchOptions: { // [!code focus:5]
    headers: {
      'Authorization': 'Bearer ...'
    }
  }
})
```

### key

`string`

A key for the Transport. Defaults to `"http"`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  key: 'alchemy', // [!code focus]
})
```

### name

`string`

A name for the Transport. Defaults to `"HTTP JSON-RPC"`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  name: 'Alchemy HTTP Provider', // [!code focus]
})
```

### retryCount

`number`

The max number of times to retry when a request fails. Defaults to `3`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  retryCount: 5, // [!code focus]
})
```

### retryDelay

`number`

The base delay (in ms) between retries. By default, the Transport will use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) (`~~(1 << count) * retryDelay`), which means the time between retries is not constant.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  retryDelay: 100, // [!code focus]
})
```

### timeout

`number`

The timeout for requests. Defaults to `10_000`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  timeout: 60_000, // [!code focus]
})
```

---

---
url: /react/api/transports/http.md
---

# http

The `http` Transport connects to a JSON-RPC API via HTTP. Wraps Viem's [`http` Transport](https://viem.sh/docs/clients/transports/http).

## Import

```ts-vue
import { http } from '{{packageName}}'
```

## Usage

```ts-vue
import { 
  createConfig, 
  http // [!code hl]
} from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()],
  transports: {
    [mainnet.id]: http('https://foo-bar-baz.quiknode.pro/...'), // [!code hl]
    [sepolia.id]: http('https://foo-bar-sep.quiknode.pro/...'), // [!code hl]
  },
})
```

::: warning
If no URL is provided, then the transport will fall back to a public RPC URL on the chain. It is highly recommended to provide an authenticated RPC URL to prevent rate-limiting.
:::

### Batch JSON-RPC

The `http` Transport supports Batch JSON-RPC. This means that multiple JSON-RPC requests can be sent in a single HTTP request.

The Transport will batch up Actions over a given period and execute them in a single Batch JSON-RPC HTTP request. By default, this period is a [zero delay](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Event_loop#zero_delays) meaning that the batch request will be executed at the end of the current [JavaScript message queue](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Event_loop#queue). Consumers can specify a custom time period `wait` (in ms).

You can enable Batch JSON-RPC by setting the `batch` flag to `true`:

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: true // [!code hl]
})
```

## Parameters

### url

`string`

URL of the JSON-RPC API. Defaults to `chain.rpcUrls.default.http[0]`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...')
```

### batch

`boolean | BatchOptions`

Toggle to enable Batch JSON-RPC. Defaults to `false`

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: true // [!code focus]
})
```

### batch.batchSize

`number`

The maximum number of JSON-RPC requests to send in a batch. Defaults to `1_000`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: {
    batchSize: 2_000 // [!code focus]
  }
})
```

### batch.wait

`number`

The maximum number of milliseconds to wait before sending a batch. Defaults to `0` ([zero delay](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Event_loop#zero_delays)).

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: {
    wait: 16 // [!code focus]
  }
})
```

### fetchOptions

[`RequestInit`](https://developer.mozilla.org/en-US/docs/Web/API/fetch)

[Fetch options](https://developer.mozilla.org/en-US/docs/Web/API/fetch) to pass to the internal `fetch` function. Useful for passing auth headers or cache options.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  fetchOptions: { // [!code focus:5]
    headers: {
      'Authorization': 'Bearer ...'
    }
  }
})
```

### key

`string`

A key for the Transport. Defaults to `"http"`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  key: 'alchemy', // [!code focus]
})
```

### name

`string`

A name for the Transport. Defaults to `"HTTP JSON-RPC"`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  name: 'Alchemy HTTP Provider', // [!code focus]
})
```

### retryCount

`number`

The max number of times to retry when a request fails. Defaults to `3`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  retryCount: 5, // [!code focus]
})
```

### retryDelay

`number`

The base delay (in ms) between retries. By default, the Transport will use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) (`~~(1 << count) * retryDelay`), which means the time between retries is not constant.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  retryDelay: 100, // [!code focus]
})
```

### timeout

`number`

The timeout for requests. Defaults to `10_000`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  timeout: 60_000, // [!code focus]
})
```

---

---
url: /shared/transports/http.md
---
# http

The `http` Transport connects to a JSON-RPC API via HTTP. Wraps Viem's [`http` Transport](https://viem.sh/docs/clients/transports/http).

## Import

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/http.md","from":230,"to":269}<fsm-vh3gqscxm4e>
import { http } from '{{packageName}}'
```

## Usage

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/http.md","from":294,"to":701}<fsm-vh3gqscxm4e>
import { 
  createConfig, 
  http // [!code hl]
} from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()],
  transports: {
    [mainnet.id]: http('https://foo-bar-baz.quiknode.pro/...'), // [!code hl]
    [sepolia.id]: http('https://foo-bar-sep.quiknode.pro/...'), // [!code hl]
  },
})
```

::: warning
If no URL is provided, then the transport will fall back to a public RPC URL on the chain. It is highly recommended to provide an authenticated RPC URL to prevent rate-limiting.
:::

### Batch JSON-RPC

The `http` Transport supports Batch JSON-RPC. This means that multiple JSON-RPC requests can be sent in a single HTTP request.

The Transport will batch up Actions over a given period and execute them in a single Batch JSON-RPC HTTP request. By default, this period is a [zero delay](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Event_loop#zero_delays) meaning that the batch request will be executed at the end of the current [JavaScript message queue](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Event_loop#queue). Consumers can specify a custom time period `wait` (in ms).

You can enable Batch JSON-RPC by setting the `batch` flag to `true`:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/http.md","from":1598,"to":1694}<fsm-vh3gqscxm4e>
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: true // [!code hl]
})
```

## Parameters

### url

`string`

URL of the JSON-RPC API. Defaults to `chain.rpcUrls.default.http[0]`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/http.md","from":1810,"to":1873}<fsm-vh3gqscxm4e>
const transport = http('https://foo-bar-baz.quiknode.pro/...')
```

### batch

`boolean | BatchOptions`

Toggle to enable Batch JSON-RPC. Defaults to `false`

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/http.md","from":1976,"to":2075}<fsm-vh3gqscxm4e>
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: true // [!code focus]
})
```

### batch.batchSize

`number`

The maximum number of JSON-RPC requests to send in a batch. Defaults to `1_000`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/http.md","from":2200,"to":2321}<fsm-vh3gqscxm4e>
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: {
    batchSize: 2_000 // [!code focus]
  }
})
```

### batch.wait

`number`

The maximum number of milliseconds to wait before sending a batch. Defaults to `0` ([zero delay](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Event_loop#zero_delays)).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/http.md","from":2539,"to":2652}<fsm-vh3gqscxm4e>
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: {
    wait: 16 // [!code focus]
  }
})
```

### fetchOptions

[`RequestInit`](https://developer.mozilla.org/en-US/docs/Web/API/fetch)

[Fetch options](https://developer.mozilla.org/en-US/docs/Web/API/fetch) to pass to the internal `fetch` function. Useful for passing auth headers or cache options.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/http.md","from":2919,"to":3085}<fsm-vh3gqscxm4e>
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  fetchOptions: { // [!code focus:5]
    headers: {
      'Authorization': 'Bearer ...'
    }
  }
})
```

### key

`string`

A key for the Transport. Defaults to `"http"`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/http.md","from":3163,"to":3266}<fsm-vh3gqscxm4e>
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  key: 'alchemy', // [!code focus]
})
```

### name

`string`

A name for the Transport. Defaults to `"HTTP JSON-RPC"`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/http.md","from":3355,"to":3473}<fsm-vh3gqscxm4e>
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  name: 'Alchemy HTTP Provider', // [!code focus]
})
```

### retryCount

`number`

The max number of times to retry when a request fails. Defaults to `3`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/http.md","from":3583,"to":3685}<fsm-vh3gqscxm4e>
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  retryCount: 5, // [!code focus]
})
```

### retryDelay

`number`

The base delay (in ms) between retries. By default, the Transport will use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) (`~~(1 << count) * retryDelay`), which means the time between retries is not constant.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/http.md","from":3958,"to":4062}<fsm-vh3gqscxm4e>
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  retryDelay: 100, // [!code focus]
})
```

### timeout

`number`

The timeout for requests. Defaults to `10_000`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/http.md","from":4145,"to":4249}<fsm-vh3gqscxm4e>
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  timeout: 60_000, // [!code focus]
})
```

---

---
url: /solid/api/transports/http.md
---

# http

The `http` Transport connects to a JSON-RPC API via HTTP. Wraps Viem's [`http` Transport](https://viem.sh/docs/clients/transports/http).

## Import

```ts-vue
import { http } from '{{packageName}}'
```

## Usage

```ts-vue
import { 
  createConfig, 
  http // [!code hl]
} from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()],
  transports: {
    [mainnet.id]: http('https://foo-bar-baz.quiknode.pro/...'), // [!code hl]
    [sepolia.id]: http('https://foo-bar-sep.quiknode.pro/...'), // [!code hl]
  },
})
```

::: warning
If no URL is provided, then the transport will fall back to a public RPC URL on the chain. It is highly recommended to provide an authenticated RPC URL to prevent rate-limiting.
:::

### Batch JSON-RPC

The `http` Transport supports Batch JSON-RPC. This means that multiple JSON-RPC requests can be sent in a single HTTP request.

The Transport will batch up Actions over a given period and execute them in a single Batch JSON-RPC HTTP request. By default, this period is a [zero delay](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Event_loop#zero_delays) meaning that the batch request will be executed at the end of the current [JavaScript message queue](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Event_loop#queue). Consumers can specify a custom time period `wait` (in ms).

You can enable Batch JSON-RPC by setting the `batch` flag to `true`:

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: true // [!code hl]
})
```

## Parameters

### url

`string`

URL of the JSON-RPC API. Defaults to `chain.rpcUrls.default.http[0]`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...')
```

### batch

`boolean | BatchOptions`

Toggle to enable Batch JSON-RPC. Defaults to `false`

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: true // [!code focus]
})
```

### batch.batchSize

`number`

The maximum number of JSON-RPC requests to send in a batch. Defaults to `1_000`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: {
    batchSize: 2_000 // [!code focus]
  }
})
```

### batch.wait

`number`

The maximum number of milliseconds to wait before sending a batch. Defaults to `0` ([zero delay](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Event_loop#zero_delays)).

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: {
    wait: 16 // [!code focus]
  }
})
```

### fetchOptions

[`RequestInit`](https://developer.mozilla.org/en-US/docs/Web/API/fetch)

[Fetch options](https://developer.mozilla.org/en-US/docs/Web/API/fetch) to pass to the internal `fetch` function. Useful for passing auth headers or cache options.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  fetchOptions: { // [!code focus:5]
    headers: {
      'Authorization': 'Bearer ...'
    }
  }
})
```

### key

`string`

A key for the Transport. Defaults to `"http"`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  key: 'alchemy', // [!code focus]
})
```

### name

`string`

A name for the Transport. Defaults to `"HTTP JSON-RPC"`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  name: 'Alchemy HTTP Provider', // [!code focus]
})
```

### retryCount

`number`

The max number of times to retry when a request fails. Defaults to `3`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  retryCount: 5, // [!code focus]
})
```

### retryDelay

`number`

The base delay (in ms) between retries. By default, the Transport will use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) (`~~(1 << count) * retryDelay`), which means the time between retries is not constant.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  retryDelay: 100, // [!code focus]
})
```

### timeout

`number`

The timeout for requests. Defaults to `10_000`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  timeout: 60_000, // [!code focus]
})
```

---

---
url: /vue/api/transports/http.md
---

# http

The `http` Transport connects to a JSON-RPC API via HTTP. Wraps Viem's [`http` Transport](https://viem.sh/docs/clients/transports/http).

## Import

```ts-vue
import { http } from '{{packageName}}'
```

## Usage

```ts-vue
import { 
  createConfig, 
  http // [!code hl]
} from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()],
  transports: {
    [mainnet.id]: http('https://foo-bar-baz.quiknode.pro/...'), // [!code hl]
    [sepolia.id]: http('https://foo-bar-sep.quiknode.pro/...'), // [!code hl]
  },
})
```

::: warning
If no URL is provided, then the transport will fall back to a public RPC URL on the chain. It is highly recommended to provide an authenticated RPC URL to prevent rate-limiting.
:::

### Batch JSON-RPC

The `http` Transport supports Batch JSON-RPC. This means that multiple JSON-RPC requests can be sent in a single HTTP request.

The Transport will batch up Actions over a given period and execute them in a single Batch JSON-RPC HTTP request. By default, this period is a [zero delay](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Event_loop#zero_delays) meaning that the batch request will be executed at the end of the current [JavaScript message queue](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Event_loop#queue). Consumers can specify a custom time period `wait` (in ms).

You can enable Batch JSON-RPC by setting the `batch` flag to `true`:

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: true // [!code hl]
})
```

## Parameters

### url

`string`

URL of the JSON-RPC API. Defaults to `chain.rpcUrls.default.http[0]`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...')
```

### batch

`boolean | BatchOptions`

Toggle to enable Batch JSON-RPC. Defaults to `false`

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: true // [!code focus]
})
```

### batch.batchSize

`number`

The maximum number of JSON-RPC requests to send in a batch. Defaults to `1_000`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: {
    batchSize: 2_000 // [!code focus]
  }
})
```

### batch.wait

`number`

The maximum number of milliseconds to wait before sending a batch. Defaults to `0` ([zero delay](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Event_loop#zero_delays)).

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  batch: {
    wait: 16 // [!code focus]
  }
})
```

### fetchOptions

[`RequestInit`](https://developer.mozilla.org/en-US/docs/Web/API/fetch)

[Fetch options](https://developer.mozilla.org/en-US/docs/Web/API/fetch) to pass to the internal `fetch` function. Useful for passing auth headers or cache options.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  fetchOptions: { // [!code focus:5]
    headers: {
      'Authorization': 'Bearer ...'
    }
  }
})
```

### key

`string`

A key for the Transport. Defaults to `"http"`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  key: 'alchemy', // [!code focus]
})
```

### name

`string`

A name for the Transport. Defaults to `"HTTP JSON-RPC"`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  name: 'Alchemy HTTP Provider', // [!code focus]
})
```

### retryCount

`number`

The max number of times to retry when a request fails. Defaults to `3`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  retryCount: 5, // [!code focus]
})
```

### retryDelay

`number`

The base delay (in ms) between retries. By default, the Transport will use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) (`~~(1 << count) * retryDelay`), which means the time between retries is not constant.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  retryDelay: 100, // [!code focus]
})
```

### timeout

`number`

The timeout for requests. Defaults to `10_000`.

```ts
const transport = http('https://foo-bar-baz.quiknode.pro/...', {
  timeout: 60_000, // [!code focus]
})
```

---

---
url: /cli/api/commands/init.md
---
# init

Creates configuration file. If TypeScript is detected, the config file will use TypeScript and be named `wagmi.config.ts`. Otherwise, the config file will use JavaScript and be named `wagmi.config.js`.

## Usage

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/commands/init.md","from":229,"to":241}<fsm-vh3gqscxm4e>
wagmi init 
```

## Options

### -c, --config \<path>

`string`

Path to config file.

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/commands/init.md","from":325,"to":361}<fsm-vh3gqscxm4e>
wagmi init --config wagmi.config.ts
```

### -r, --root \<path>

`string`

Root path to resolve config from.

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/commands/init.md","from":444,"to":475}<fsm-vh3gqscxm4e>
wagmi init --root path/to/root
```

### -h, --help

Displays help message.

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/commands/init.md","from":528,"to":546}<fsm-vh3gqscxm4e>
wagmi init --help
```

---

---
url: /core/api/connectors/injected.md
---

# injected

Connector for [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) Ethereum Providers.

## Import

```ts-vue
import { injected } from '{{connectorsPackageName}}'
```

## Usage

```ts-vue{3,7}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { injected } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type InjectedParameters } from '{{connectorsPackageName}}'
```

### shimDisconnect

`boolean | undefined`

* MetaMask and other injected providers do not support programmatic disconnect.
* This flag simulates the disconnect behavior by keeping track of connection status in storage. See [GitHub issue](https://github.com/MetaMask/metamask-extension/issues/10353) for more info.
* Defaults to `true`.

```ts-vue
import { injected } from '{{connectorsPackageName}}'

const connector = injected({
  shimDisconnect: false, // [!code focus]
})
```

### target

`TargetId | (TargetMap[TargetId] & { id: string }) | (() => (TargetMap[TargetId] & { id: string }) | undefined) | undefined`

* [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) Ethereum Provider to target.
* [EIP-6963](https://eips.ethereum.org/EIPS/eip-6963) supported via `createConfig`'s `multiInjectedProviderDiscovery` property.

```ts-vue
import { injected } from '{{connectorsPackageName}}'

const connector = injected({
  target() { // [!code focus]
    return { // [!code focus]
      id: 'windowProvider', // [!code focus]
      name: 'Window Provider', // [!code focus]
      provider: window.ethereum, // [!code focus]
    } // [!code focus]
  }, // [!code focus]
})
```

### unstable\_shimAsyncInject

`boolean | number | undefined`

Watches for async provider injection via the `ethereum#initialized` event. When `true`, defaults to `1_000` milliseconds. Otherwise, uses a provided value of milliseconds.

```ts-vue
import { injected } from '{{connectorsPackageName}}'

const connector = injected({
  unstable_shimAsyncInject: 2_000, // [!code focus]
})
```

---

---
url: /react/api/connectors/injected.md
---

# injected

Connector for [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) Ethereum Providers.

## Import

```ts-vue
import { injected } from '{{connectorsPackageName}}'
```

## Usage

```ts-vue{3,7}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { injected } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type InjectedParameters } from '{{connectorsPackageName}}'
```

### shimDisconnect

`boolean | undefined`

* MetaMask and other injected providers do not support programmatic disconnect.
* This flag simulates the disconnect behavior by keeping track of connection status in storage. See [GitHub issue](https://github.com/MetaMask/metamask-extension/issues/10353) for more info.
* Defaults to `true`.

```ts-vue
import { injected } from '{{connectorsPackageName}}'

const connector = injected({
  shimDisconnect: false, // [!code focus]
})
```

### target

`TargetId | (TargetMap[TargetId] & { id: string }) | (() => (TargetMap[TargetId] & { id: string }) | undefined) | undefined`

* [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) Ethereum Provider to target.
* [EIP-6963](https://eips.ethereum.org/EIPS/eip-6963) supported via `createConfig`'s `multiInjectedProviderDiscovery` property.

```ts-vue
import { injected } from '{{connectorsPackageName}}'

const connector = injected({
  target() { // [!code focus]
    return { // [!code focus]
      id: 'windowProvider', // [!code focus]
      name: 'Window Provider', // [!code focus]
      provider: window.ethereum, // [!code focus]
    } // [!code focus]
  }, // [!code focus]
})
```

### unstable\_shimAsyncInject

`boolean | number | undefined`

Watches for async provider injection via the `ethereum#initialized` event. When `true`, defaults to `1_000` milliseconds. Otherwise, uses a provided value of milliseconds.

```ts-vue
import { injected } from '{{connectorsPackageName}}'

const connector = injected({
  unstable_shimAsyncInject: 2_000, // [!code focus]
})
```

---

---
url: /shared/connectors/injected.md
---
# injected

Connector for [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) Ethereum Providers.

## Import

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/injected.md","from":257,"to":310}<fsm-vh3gqscxm4e>
import { injected } from '{{connectorsPackageName}}'
```

## Usage

```ts-vue{3,7}
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/injected.md","from":340,"to":676}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { injected } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/injected.md","from":706,"to":774}<fsm-vh3gqscxm4e>
import { type InjectedParameters } from '{{connectorsPackageName}}'
```

### shimDisconnect

`boolean | undefined`

* MetaMask and other injected providers do not support programmatic disconnect.
* This flag simulates the disconnect behavior by keeping track of connection status in storage. See [GitHub issue](https://github.com/MetaMask/metamask-extension/issues/10353) for more info.
* Defaults to `true`.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/injected.md","from":1126,"to":1254}<fsm-vh3gqscxm4e>
import { injected } from '{{connectorsPackageName}}'

const connector = injected({
  shimDisconnect: false, // [!code focus]
})
```

### target

`TargetId | (TargetMap[TargetId] & { id: string }) | (() => (TargetMap[TargetId] & { id: string }) | undefined) | undefined`

* [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) Ethereum Provider to target.
* [EIP-6963](https://eips.ethereum.org/EIPS/eip-6963) supported via `createConfig`'s `multiInjectedProviderDiscovery` property.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/injected.md","from":1697,"to":2031}<fsm-vh3gqscxm4e>
import { injected } from '{{connectorsPackageName}}'

const connector = injected({
  target() { // [!code focus]
    return { // [!code focus]
      id: 'windowProvider', // [!code focus]
      name: 'Window Provider', // [!code focus]
      provider: window.ethereum, // [!code focus]
    } // [!code focus]
  }, // [!code focus]
})
```

### unstable\_shimAsyncInject

`boolean | number | undefined`

Watches for async provider injection via the `ethereum#initialized` event. When `true`, defaults to `1_000` milliseconds. Otherwise, uses a provided value of milliseconds.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/injected.md","from":2281,"to":2419}<fsm-vh3gqscxm4e>
import { injected } from '{{connectorsPackageName}}'

const connector = injected({
  unstable_shimAsyncInject: 2_000, // [!code focus]
})
```

---

---
url: /solid/api/connectors/injected.md
---

# injected

Connector for [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) Ethereum Providers.

## Import

```ts-vue
import { injected } from '{{connectorsPackageName}}'
```

## Usage

```ts-vue{3,7}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { injected } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type InjectedParameters } from '{{connectorsPackageName}}'
```

### shimDisconnect

`boolean | undefined`

* MetaMask and other injected providers do not support programmatic disconnect.
* This flag simulates the disconnect behavior by keeping track of connection status in storage. See [GitHub issue](https://github.com/MetaMask/metamask-extension/issues/10353) for more info.
* Defaults to `true`.

```ts-vue
import { injected } from '{{connectorsPackageName}}'

const connector = injected({
  shimDisconnect: false, // [!code focus]
})
```

### target

`TargetId | (TargetMap[TargetId] & { id: string }) | (() => (TargetMap[TargetId] & { id: string }) | undefined) | undefined`

* [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) Ethereum Provider to target.
* [EIP-6963](https://eips.ethereum.org/EIPS/eip-6963) supported via `createConfig`'s `multiInjectedProviderDiscovery` property.

```ts-vue
import { injected } from '{{connectorsPackageName}}'

const connector = injected({
  target() { // [!code focus]
    return { // [!code focus]
      id: 'windowProvider', // [!code focus]
      name: 'Window Provider', // [!code focus]
      provider: window.ethereum, // [!code focus]
    } // [!code focus]
  }, // [!code focus]
})
```

### unstable\_shimAsyncInject

`boolean | number | undefined`

Watches for async provider injection via the `ethereum#initialized` event. When `true`, defaults to `1_000` milliseconds. Otherwise, uses a provided value of milliseconds.

```ts-vue
import { injected } from '{{connectorsPackageName}}'

const connector = injected({
  unstable_shimAsyncInject: 2_000, // [!code focus]
})
```

---

---
url: /vue/api/connectors/injected.md
---

# injected

Connector for [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) Ethereum Providers.

## Import

```ts-vue
import { injected } from '{{connectorsPackageName}}'
```

## Usage

```ts-vue{3,7}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { injected } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type InjectedParameters } from '{{connectorsPackageName}}'
```

### shimDisconnect

`boolean | undefined`

* MetaMask and other injected providers do not support programmatic disconnect.
* This flag simulates the disconnect behavior by keeping track of connection status in storage. See [GitHub issue](https://github.com/MetaMask/metamask-extension/issues/10353) for more info.
* Defaults to `true`.

```ts-vue
import { injected } from '{{connectorsPackageName}}'

const connector = injected({
  shimDisconnect: false, // [!code focus]
})
```

### target

`TargetId | (TargetMap[TargetId] & { id: string }) | (() => (TargetMap[TargetId] & { id: string }) | undefined) | undefined`

* [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) Ethereum Provider to target.
* [EIP-6963](https://eips.ethereum.org/EIPS/eip-6963) supported via `createConfig`'s `multiInjectedProviderDiscovery` property.

```ts-vue
import { injected } from '{{connectorsPackageName}}'

const connector = injected({
  target() { // [!code focus]
    return { // [!code focus]
      id: 'windowProvider', // [!code focus]
      name: 'Window Provider', // [!code focus]
      provider: window.ethereum, // [!code focus]
    } // [!code focus]
  }, // [!code focus]
})
```

### unstable\_shimAsyncInject

`boolean | number | undefined`

Watches for async provider injection via the `ethereum#initialized` event. When `true`, defaults to `1_000` milliseconds. Otherwise, uses a provided value of milliseconds.

```ts-vue
import { injected } from '{{connectorsPackageName}}'

const connector = injected({
  unstable_shimAsyncInject: 2_000, // [!code focus]
})
```

---

---
url: /cli/installation.md
---
# Installation

Install Wagmi CLI via your package manager.

## Package Manager

Install the required package.

::: code-group

```bash [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/installation.md","from":142,"to":162}<fsm-vh3gqscxm4e>
pnpm add @wagmi/cli
```

```bash [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/installation.md","from":181,"to":204}<fsm-vh3gqscxm4e>
npm install @wagmi/cli
```

```bash [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/installation.md","from":224,"to":244}<fsm-vh3gqscxm4e>
yarn add @wagmi/cli
```

```bash [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/installation.md","from":263,"to":282}<fsm-vh3gqscxm4e>
bun add @wagmi/cli
```

:::

## Using Unreleased Commits

If you can't wait for a new release to test the latest features, you can either install from the `canary` tag (tracks the [`main`](https://github.com/wevm/wagmi/tree/main) branch).

::: code-group

```bash [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/installation.md","from":532,"to":559}<fsm-vh3gqscxm4e>
pnpm add @wagmi/cli@canary
```

```bash [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/installation.md","from":578,"to":608}<fsm-vh3gqscxm4e>
npm install @wagmi/cli@canary
```

```bash [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/installation.md","from":628,"to":655}<fsm-vh3gqscxm4e>
yarn add @wagmi/cli@canary
```

```bash [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/installation.md","from":674,"to":700}<fsm-vh3gqscxm4e>
bun add @wagmi/cli@canary
```

:::

Or clone the [Wagmi repo](https://github.com/wevm/wagmi) to your local machine, build, and link it yourself.

```bash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/installation.md","from":827,"to":939}<fsm-vh3gqscxm4e>
git clone https://github.com/wevm/wagmi.git
cd wagmi
pnpm install
pnpm build
cd packages/cli
pnpm link --global
```

Then go to the project where you are using the Wagmi CLI and run `pnpm link --global @wagmi/cli` (or the package manager that you used to link Wagmi CLI globally).

Finally, pull requests are continuously released via [pkg.pr.new](https://pkg.pr.new) and can be installed using the pull request number or short commit ID.

::: code-group

```bash [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/installation.md","from":1297,"to":1340}<fsm-vh3gqscxm4e>
pnpm add https://pkg.pr.new/@wagmi/cli@123
```

```bash [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/installation.md","from":1359,"to":1405}<fsm-vh3gqscxm4e>
npm install https://pkg.pr.new/@wagmi/cli@123
```

```bash [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/installation.md","from":1425,"to":1468}<fsm-vh3gqscxm4e>
yarn add https://pkg.pr.new/@wagmi/cli@123
```

```bash [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/installation.md","from":1487,"to":1529}<fsm-vh3gqscxm4e>
bun add https://pkg.pr.new/@wagmi/cli@123
```

:::

---

---
url: /core/installation.md
---
# Installation

Install Wagmi Core via your package manager, a `<script>` tag, or build from source.

## Package Manager

Install the required packages.

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/installation.md","from":462,"to":504}<fsm-vh3gqscxm4e>
pnpm add @wagmi/core viem@{{viemVersion}}
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/installation.md","from":527,"to":572}<fsm-vh3gqscxm4e>
npm install @wagmi/core viem@{{viemVersion}}
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/installation.md","from":596,"to":638}<fsm-vh3gqscxm4e>
yarn add @wagmi/core viem@{{viemVersion}}
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/installation.md","from":661,"to":702}<fsm-vh3gqscxm4e>
bun add @wagmi/core viem@{{viemVersion}}
```

:::

* [Viem](https://viem.sh) is a TypeScript interface for Ethereum that performs blockchain operations.
* [TypeScript](/react/typescript) is optional, but highly recommended. Learn more about [TypeScript support](/react/typescript).

## CDN

If you're not using a package manager, you can also use Wagmi Core via an ESM-compatible CDN such as [esm.sh](https://esm.sh). Simply add a `<script type="module">` tag to the bottom of your HTML file with the following content.

```html-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/installation.md","from":1193,"to":1417}<fsm-vh3gqscxm4e>
<script type="module">
  import { createClient } from 'https://esm.sh/viem'
  import { createConfig } from 'https://esm.sh/@wagmi/core@{{viemVersion}}'
  import { injected } from 'https://esm.sh/@wagmi/connectors'
</script>
```

## Requirements

Wagmi is optimized for modern browsers. It is compatible with the latest versions of the following browsers.

::: tip
Depending on your environment, you might need to add polyfills. See [Viem Platform Compatibility](https://viem.sh/docs/compatibility) for more info.
:::

## Using Unreleased Commits

If you can't wait for a new release to test the latest features, you can either install from the `canary` tag (tracks the [`main`](https://github.com/wevm/wagmi/tree/main) branch).

::: code-group

```bash-vue [pnpm]
pnpm add {{packageName}}@canary
```

```bash-vue [npm]
npm install {{packageName}}@canary
```

```bash-vue [yarn]
yarn add {{packageName}}@canary
```

```bash-vue [bun]
bun add {{packageName}}@canary
```

:::

Or clone the [Wagmi repo](https://github.com/wevm/wagmi) to your local machine, build, and link it yourself.

```bash-vue
gh repo clone wevm/wagmi
cd wagmi
pnpm install
pnpm build
cd packages/{{packageDir}}
pnpm link --global
```

Then go to the project where you are using Wagmi and run `pnpm link --global {{packageName}}` (or the package manager that you used to link Wagmi globally). Make sure you installed any [required peer dependencies](#package-manager) and their versions are correct.

Finally, pull requests are continuously released via [pkg.pr.new](https://pkg.pr.new) and can be installed using the pull request number or short commit ID.

::: code-group

```bash-vue [pnpm]
pnpm add https://pkg.pr.new/{{packageName}}@123
```

```bash-vue [npm]
npm install https://pkg.pr.new/{{packageName}}@123
```

```bash-vue [yarn]
yarn add https://pkg.pr.new/{{packageName}}@123
```

```bash-vue [bun]
bun add https://pkg.pr.new/{{packageName}}@123
```

:::

## Security

Ethereum-related projects are often targeted in attacks to steal users' assets. Make sure you follow security best-practices for your project. Some quick things to get started.

* Pin package versions, upgrade mindfully, and inspect lockfile changes to minimize the risk of [supply-chain attacks](https://nodejs.org/en/guides/security/#supply-chain-attacks).
* Use [npm](https://docs.npmjs.com)'s [`min-release-age`](https://docs.npmjs.com/cli/v11/using-npm/config#min-release-age) or [pnpm](https://pnpm.io)'s [`minimumReleaseAge`](https://pnpm.io/settings#minimumreleaseage) and [`trustPolicy`](https://pnpm.io/settings#trustpolicy) to mitigate against supply-chain attacks.
* Install the [Socket](https://socket.dev) [GitHub App](https://github.com/apps/socket-security) to help detect and block supply-chain attacks.
* Add a [Content Security Policy](https://cheatsheetseries.owasp.org/cheatsheets/Content_Security_Policy_Cheat_Sheet.html) to defend against external scripts running in your app.
* Pin [GitHub Action](https://x.com/paulmillr/status/1900948425325031448) versions to commits instead of tags. [Actions Up](https://github.com/azat-io/actions-up) is a good tool for using commits instead of tags.

---

---
url: /react/installation.md
---
# Installation

Install Wagmi via your package manager, a `<script>` tag, or build from source.

## Package Manager

Install the required packages.

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/installation.md","from":454,"to":512}<fsm-vh3gqscxm4e>
pnpm add wagmi viem@{{viemVersion}} @tanstack/react-query
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/installation.md","from":535,"to":596}<fsm-vh3gqscxm4e>
npm install wagmi viem@{{viemVersion}} @tanstack/react-query
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/installation.md","from":620,"to":678}<fsm-vh3gqscxm4e>
yarn add wagmi viem@{{viemVersion}} @tanstack/react-query
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/installation.md","from":701,"to":758}<fsm-vh3gqscxm4e>
bun add wagmi viem@{{viemVersion}} @tanstack/react-query
```

:::

* [Viem](https://viem.sh) is a TypeScript interface for Ethereum that performs blockchain operations.
* [TanStack Query](https://tanstack.com/query/v5) is an async state manager that handles requests, caching, and more.
* [TypeScript](/react/typescript) is optional, but highly recommended. Learn more about [TypeScript support](/react/typescript).

## CDN

If you're not using a package manager, you can also use Wagmi via an ESM-compatible CDN such as [esm.sh](https://esm.sh). Simply add a `<script type="module">` tag to the bottom of your HTML file with the following content.

```html-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/installation.md","from":1362,"to":1637}<fsm-vh3gqscxm4e>
<script type="module">
  import React from 'https://esm.sh/react@18.2.0'
  import { QueryClient } from 'https://esm.sh/@tanstack/react-query'
  import { createClient } from 'https://esm.sh/viem@{{viemVersion}}'
  import { createConfig } from 'https://esm.sh/wagmi'
</script>
```

Check out the React docs for info on how to use [React without JSX](https://react.dev/reference/react/createElement#creating-an-element-without-jsx).

## Requirements

Wagmi is optimized for modern browsers. It is compatible with the latest versions of the following browsers.

::: tip
Depending on your environment, you might need to add polyfills. See [Viem Platform Compatibility](https://viem.sh/docs/compatibility) for more info.
:::

## Using Unreleased Commits

If you can't wait for a new release to test the latest features, you can either install from the `canary` tag (tracks the [`main`](https://github.com/wevm/wagmi/tree/main) branch).

::: code-group

```bash-vue [pnpm]
pnpm add {{packageName}}@canary
```

```bash-vue [npm]
npm install {{packageName}}@canary
```

```bash-vue [yarn]
yarn add {{packageName}}@canary
```

```bash-vue [bun]
bun add {{packageName}}@canary
```

:::

Or clone the [Wagmi repo](https://github.com/wevm/wagmi) to your local machine, build, and link it yourself.

```bash-vue
gh repo clone wevm/wagmi
cd wagmi
pnpm install
pnpm build
cd packages/{{packageDir}}
pnpm link --global
```

Then go to the project where you are using Wagmi and run `pnpm link --global {{packageName}}` (or the package manager that you used to link Wagmi globally). Make sure you installed any [required peer dependencies](#package-manager) and their versions are correct.

Finally, pull requests are continuously released via [pkg.pr.new](https://pkg.pr.new) and can be installed using the pull request number or short commit ID.

::: code-group

```bash-vue [pnpm]
pnpm add https://pkg.pr.new/{{packageName}}@123
```

```bash-vue [npm]
npm install https://pkg.pr.new/{{packageName}}@123
```

```bash-vue [yarn]
yarn add https://pkg.pr.new/{{packageName}}@123
```

```bash-vue [bun]
bun add https://pkg.pr.new/{{packageName}}@123
```

:::

## Security

Ethereum-related projects are often targeted in attacks to steal users' assets. Make sure you follow security best-practices for your project. Some quick things to get started.

* Pin package versions, upgrade mindfully, and inspect lockfile changes to minimize the risk of [supply-chain attacks](https://nodejs.org/en/guides/security/#supply-chain-attacks).
* Use [npm](https://docs.npmjs.com)'s [`min-release-age`](https://docs.npmjs.com/cli/v11/using-npm/config#min-release-age) or [pnpm](https://pnpm.io)'s [`minimumReleaseAge`](https://pnpm.io/settings#minimumreleaseage) and [`trustPolicy`](https://pnpm.io/settings#trustpolicy) to mitigate against supply-chain attacks.
* Install the [Socket](https://socket.dev) [GitHub App](https://github.com/apps/socket-security) to help detect and block supply-chain attacks.
* Add a [Content Security Policy](https://cheatsheetseries.owasp.org/cheatsheets/Content_Security_Policy_Cheat_Sheet.html) to defend against external scripts running in your app.
* Pin [GitHub Action](https://x.com/paulmillr/status/1900948425325031448) versions to commits instead of tags. [Actions Up](https://github.com/azat-io/actions-up) is a good tool for using commits instead of tags.

---

---
url: /solid/installation.md
---
# Installation

Install `@wagmi/solid` via your package manager.

## Package Manager

Install the required packages.

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/installation.md","from":380,"to":445}<fsm-vh3gqscxm4e>
pnpm add @wagmi/solid viem@{{viemVersion}} @tanstack/solid-query
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/installation.md","from":468,"to":536}<fsm-vh3gqscxm4e>
npm install @wagmi/solid viem@{{viemVersion}} @tanstack/solid-query
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/installation.md","from":560,"to":625}<fsm-vh3gqscxm4e>
yarn add @wagmi/solid viem@{{viemVersion}} @tanstack/solid-query
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/installation.md","from":648,"to":712}<fsm-vh3gqscxm4e>
bun add @wagmi/solid viem@{{viemVersion}} @tanstack/solid-query
```

:::

* [Viem](https://viem.sh) is a TypeScript interface for Ethereum that performs blockchain operations.
* [TanStack Query](https://tanstack.com/query/v5) is an async state manager that handles requests, caching, and more.
* [TypeScript](/solid/typescript) is optional, but highly recommended. Learn more about [TypeScript support](/solid/typescript).

## Requirements

Wagmi is optimized for modern browsers. It is compatible with the latest versions of the following browsers.

::: tip
Depending on your environment, you might need to add polyfills. See [Viem Platform Compatibility](https://viem.sh/docs/compatibility) for more info.
:::

## Using Unreleased Commits

If you can't wait for a new release to test the latest features, you can either install from the `canary` tag (tracks the [`main`](https://github.com/wevm/wagmi/tree/main) branch).

::: code-group

```bash-vue [pnpm]
pnpm add {{packageName}}@canary
```

```bash-vue [npm]
npm install {{packageName}}@canary
```

```bash-vue [yarn]
yarn add {{packageName}}@canary
```

```bash-vue [bun]
bun add {{packageName}}@canary
```

:::

Or clone the [Wagmi repo](https://github.com/wevm/wagmi) to your local machine, build, and link it yourself.

```bash-vue
gh repo clone wevm/wagmi
cd wagmi
pnpm install
pnpm build
cd packages/{{packageDir}}
pnpm link --global
```

Then go to the project where you are using Wagmi and run `pnpm link --global {{packageName}}` (or the package manager that you used to link Wagmi globally). Make sure you installed any [required peer dependencies](#package-manager) and their versions are correct.

Finally, pull requests are continuously released via [pkg.pr.new](https://pkg.pr.new) and can be installed using the pull request number or short commit ID.

::: code-group

```bash-vue [pnpm]
pnpm add https://pkg.pr.new/{{packageName}}@123
```

```bash-vue [npm]
npm install https://pkg.pr.new/{{packageName}}@123
```

```bash-vue [yarn]
yarn add https://pkg.pr.new/{{packageName}}@123
```

```bash-vue [bun]
bun add https://pkg.pr.new/{{packageName}}@123
```

:::

## Security

Ethereum-related projects are often targeted in attacks to steal users' assets. Make sure you follow security best-practices for your project. Some quick things to get started.

* Pin package versions, upgrade mindfully, and inspect lockfile changes to minimize the risk of [supply-chain attacks](https://nodejs.org/en/guides/security/#supply-chain-attacks).
* Use [npm](https://docs.npmjs.com)'s [`min-release-age`](https://docs.npmjs.com/cli/v11/using-npm/config#min-release-age) or [pnpm](https://pnpm.io)'s [`minimumReleaseAge`](https://pnpm.io/settings#minimumreleaseage) and [`trustPolicy`](https://pnpm.io/settings#trustpolicy) to mitigate against supply-chain attacks.
* Install the [Socket](https://socket.dev) [GitHub App](https://github.com/apps/socket-security) to help detect and block supply-chain attacks.
* Add a [Content Security Policy](https://cheatsheetseries.owasp.org/cheatsheets/Content_Security_Policy_Cheat_Sheet.html) to defend against external scripts running in your app.
* Pin [GitHub Action](https://x.com/paulmillr/status/1900948425325031448) versions to commits instead of tags. [Actions Up](https://github.com/azat-io/actions-up) is a good tool for using commits instead of tags.

---

---
url: /vue/installation.md
---
# Installation

Install Wagmi via your package manager, a `<script>` tag, or build from source.

## Package Manager

Install the required packages.

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/installation.md","from":453,"to":514}<fsm-vh3gqscxm4e>
pnpm add @wagmi/vue viem@{{viemVersion}} @tanstack/vue-query
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/installation.md","from":537,"to":601}<fsm-vh3gqscxm4e>
npm install @wagmi/vue viem@{{viemVersion}} @tanstack/vue-query
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/installation.md","from":625,"to":686}<fsm-vh3gqscxm4e>
yarn add @wagmi/vue viem@{{viemVersion}} @tanstack/vue-query
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/installation.md","from":709,"to":769}<fsm-vh3gqscxm4e>
bun add @wagmi/vue viem@{{viemVersion}} @tanstack/vue-query
```

:::

* [Viem](https://viem.sh) is a TypeScript interface for Ethereum that performs blockchain operations.
* [TanStack Query](https://tanstack.com/query/v5) is an async state manager that handles requests, caching, and more.
* [TypeScript](/vue/typescript) is optional, but highly recommended. Learn more about [TypeScript support](/vue/typescript).

## Requirements

Wagmi is optimized for modern browsers. It is compatible with the latest versions of the following browsers.

::: tip
Depending on your environment, you might need to add polyfills. See [Viem Platform Compatibility](https://viem.sh/docs/compatibility) for more info.
:::

## Using Unreleased Commits

If you can't wait for a new release to test the latest features, you can either install from the `canary` tag (tracks the [`main`](https://github.com/wevm/wagmi/tree/main) branch).

::: code-group

```bash-vue [pnpm]
pnpm add {{packageName}}@canary
```

```bash-vue [npm]
npm install {{packageName}}@canary
```

```bash-vue [yarn]
yarn add {{packageName}}@canary
```

```bash-vue [bun]
bun add {{packageName}}@canary
```

:::

Or clone the [Wagmi repo](https://github.com/wevm/wagmi) to your local machine, build, and link it yourself.

```bash-vue
gh repo clone wevm/wagmi
cd wagmi
pnpm install
pnpm build
cd packages/{{packageDir}}
pnpm link --global
```

Then go to the project where you are using Wagmi and run `pnpm link --global {{packageName}}` (or the package manager that you used to link Wagmi globally). Make sure you installed any [required peer dependencies](#package-manager) and their versions are correct.

Finally, pull requests are continuously released via [pkg.pr.new](https://pkg.pr.new) and can be installed using the pull request number or short commit ID.

::: code-group

```bash-vue [pnpm]
pnpm add https://pkg.pr.new/{{packageName}}@123
```

```bash-vue [npm]
npm install https://pkg.pr.new/{{packageName}}@123
```

```bash-vue [yarn]
yarn add https://pkg.pr.new/{{packageName}}@123
```

```bash-vue [bun]
bun add https://pkg.pr.new/{{packageName}}@123
```

:::

## Security

Ethereum-related projects are often targeted in attacks to steal users' assets. Make sure you follow security best-practices for your project. Some quick things to get started.

* Pin package versions, upgrade mindfully, and inspect lockfile changes to minimize the risk of [supply-chain attacks](https://nodejs.org/en/guides/security/#supply-chain-attacks).
* Use [npm](https://docs.npmjs.com)'s [`min-release-age`](https://docs.npmjs.com/cli/v11/using-npm/config#min-release-age) or [pnpm](https://pnpm.io)'s [`minimumReleaseAge`](https://pnpm.io/settings#minimumreleaseage) and [`trustPolicy`](https://pnpm.io/settings#trustpolicy) to mitigate against supply-chain attacks.
* Install the [Socket](https://socket.dev) [GitHub App](https://github.com/apps/socket-security) to help detect and block supply-chain attacks.
* Add a [Content Security Policy](https://cheatsheetseries.owasp.org/cheatsheets/Content_Security_Policy_Cheat_Sheet.html) to defend against external scripts running in your app.
* Pin [GitHub Action](https://x.com/paulmillr/status/1900948425325031448) versions to commits instead of tags. [Actions Up](https://github.com/azat-io/actions-up) is a good tool for using commits instead of tags.

---

---
url: /core/api/connectors/metaMask.md
---

# metaMask

Connector for [MetaMask Connect](https://github.com/MetaMask/connect-monorepo).

## Import

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add @metamask/connect-evm@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install @metamask/connect-evm@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add @metamask/connect-evm@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add @metamask/connect-evm@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue{3,7}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { metaMask } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [metaMask()],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type MetaMaskParameters } from '{{connectorsPackageName}}'
```

Check out the [MetaMask Connect docs](https://docs.metamask.io/metamask-connect/evm/quickstart/wagmi/) for more info. A few options are omitted that Wagmi manages internally.

### dapp

`DappMetadata | undefined`

Metadata is used to fill details for the UX on confirmation screens in MetaMask, including the following fields:

* `name`: `string` - The name of the dapp.
* `url`: `string` - URL of the dapp (defaults to `window.location.origin`).
* `iconUrl`: `string` - URL to the dapp's favicon or icon.

Defaults to `{ name: window.location.hostname }`.

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  dapp: { // [!code focus]
    name: 'My Wagmi App', // [!code focus]
    url: 'https://example.com', // [!code focus]
    iconUrl: 'https://example.com/favicon.ico', // [!code focus]
  }
})
```

### debug

`boolean | undefined`

Enables debug mode for the MetaMask SDK. When enabled, provides additional logging and debugging information.

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  debug: true // [!code focus]
})
```

### connectAndSign

`string | undefined`

Shortcut to connect and sign a message in a single operation. When provided, the connector will connect to MetaMask and immediately prompt the user to sign the specified message.

This parameter is mutually exclusive with `connectWith` - only one can be used at a time.

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  connectAndSign: 'Sign this message to connect', // [!code focus]
})
```

### connectWith

`{ method: string; params: unknown[] } | undefined`

Allows connecting with any RPC method. When provided, the connector will connect to MetaMask and immediately call the specified RPC method with the given parameters.

This parameter is mutually exclusive with `connectAndSign` - only one can be used at a time.

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  connectWith: { // [!code focus]
    method: 'eth_requestAccounts', // [!code focus]
    params: [], // [!code focus]
  }
})
```

## Advanced

By default, if the EIP-6963 MetaMask injected provider is detected, this connector will replace it.

EIP-6963 defines a standard way for dapps to interact with multiple wallets simultaneously by injecting providers into the browser. Wallets that implement this standard can make their presence known to dapps in a consistent and predictable manner.

See the [`rdns` property](https://wagmi.sh/dev/creating-connectors#properties) for more information.

---

---
url: /react/api/connectors/metaMask.md
---

# metaMask

Connector for [MetaMask Connect](https://github.com/MetaMask/connect-monorepo).

## Import

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add @metamask/connect-evm@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install @metamask/connect-evm@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add @metamask/connect-evm@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add @metamask/connect-evm@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue{3,7}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { metaMask } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [metaMask()],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type MetaMaskParameters } from '{{connectorsPackageName}}'
```

Check out the [MetaMask Connect docs](https://docs.metamask.io/metamask-connect/evm/quickstart/wagmi/) for more info. A few options are omitted that Wagmi manages internally.

### dapp

`DappMetadata | undefined`

Metadata is used to fill details for the UX on confirmation screens in MetaMask, including the following fields:

* `name`: `string` - The name of the dapp.
* `url`: `string` - URL of the dapp (defaults to `window.location.origin`).
* `iconUrl`: `string` - URL to the dapp's favicon or icon.

Defaults to `{ name: window.location.hostname }`.

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  dapp: { // [!code focus]
    name: 'My Wagmi App', // [!code focus]
    url: 'https://example.com', // [!code focus]
    iconUrl: 'https://example.com/favicon.ico', // [!code focus]
  }
})
```

### debug

`boolean | undefined`

Enables debug mode for the MetaMask SDK. When enabled, provides additional logging and debugging information.

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  debug: true // [!code focus]
})
```

### connectAndSign

`string | undefined`

Shortcut to connect and sign a message in a single operation. When provided, the connector will connect to MetaMask and immediately prompt the user to sign the specified message.

This parameter is mutually exclusive with `connectWith` - only one can be used at a time.

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  connectAndSign: 'Sign this message to connect', // [!code focus]
})
```

### connectWith

`{ method: string; params: unknown[] } | undefined`

Allows connecting with any RPC method. When provided, the connector will connect to MetaMask and immediately call the specified RPC method with the given parameters.

This parameter is mutually exclusive with `connectAndSign` - only one can be used at a time.

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  connectWith: { // [!code focus]
    method: 'eth_requestAccounts', // [!code focus]
    params: [], // [!code focus]
  }
})
```

## Advanced

By default, if the EIP-6963 MetaMask injected provider is detected, this connector will replace it.

EIP-6963 defines a standard way for dapps to interact with multiple wallets simultaneously by injecting providers into the browser. Wallets that implement this standard can make their presence known to dapps in a consistent and predictable manner.

See the [`rdns` property](https://wagmi.sh/dev/creating-connectors#properties) for more information.

---

---
url: /shared/connectors/metaMask.md
---
# metaMask

Connector for [MetaMask Connect](https://github.com/MetaMask/connect-monorepo).

## Import

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/metaMask.md","from":269,"to":322}<fsm-vh3gqscxm4e>
import { metaMask } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/metaMask.md","from":569,"to":631}<fsm-vh3gqscxm4e>
pnpm add @metamask/connect-evm@{{connectorDependencyVersion}}
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/metaMask.md","from":654,"to":719}<fsm-vh3gqscxm4e>
npm install @metamask/connect-evm@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/metaMask.md","from":743,"to":805}<fsm-vh3gqscxm4e>
yarn add @metamask/connect-evm@{{connectorDependencyVersion}}
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/metaMask.md","from":828,"to":889}<fsm-vh3gqscxm4e>
bun add @metamask/connect-evm@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue{3,7}
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/metaMask.md","from":923,"to":1259}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { metaMask } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [metaMask()],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/metaMask.md","from":1289,"to":1357}<fsm-vh3gqscxm4e>
import { type MetaMaskParameters } from '{{connectorsPackageName}}'
```

Check out the [MetaMask Connect docs](https://docs.metamask.io/metamask-connect/evm/quickstart/wagmi/) for more info. A few options are omitted that Wagmi manages internally.

### dapp

`DappMetadata | undefined`

Metadata is used to fill details for the UX on confirmation screens in MetaMask, including the following fields:

* `name`: `string` - The name of the dapp.
* `url`: `string` - URL of the dapp (defaults to `window.location.origin`).
* `iconUrl`: `string` - URL to the dapp's favicon or icon.

Defaults to `{ name: window.location.hostname }`.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/metaMask.md","from":1930,"to":2204}<fsm-vh3gqscxm4e>
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  dapp: { // [!code focus]
    name: 'My Wagmi App', // [!code focus]
    url: 'https://example.com', // [!code focus]
    iconUrl: 'https://example.com/favicon.ico', // [!code focus]
  }
})
```

### debug

`boolean | undefined`

Enables debug mode for the MetaMask SDK. When enabled, provides additional logging and debugging information.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/metaMask.md","from":2364,"to":2481}<fsm-vh3gqscxm4e>
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  debug: true // [!code focus]
})
```

### connectAndSign

`string | undefined`

Shortcut to connect and sign a message in a single operation. When provided, the connector will connect to MetaMask and immediately prompt the user to sign the specified message.

This parameter is mutually exclusive with `connectWith` - only one can be used at a time.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/metaMask.md","from":2809,"to":2962}<fsm-vh3gqscxm4e>
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  connectAndSign: 'Sign this message to connect', // [!code focus]
})
```

### connectWith

`{ method: string; params: unknown[] } | undefined`

Allows connecting with any RPC method. When provided, the connector will connect to MetaMask and immediately call the specified RPC method with the given parameters.

This parameter is mutually exclusive with `connectAndSign` - only one can be used at a time.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/metaMask.md","from":3308,"to":3517}<fsm-vh3gqscxm4e>
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  connectWith: { // [!code focus]
    method: 'eth_requestAccounts', // [!code focus]
    params: [], // [!code focus]
  }
})
```

## Advanced

By default, if the EIP-6963 MetaMask injected provider is detected, this connector will replace it.

EIP-6963 defines a standard way for dapps to interact with multiple wallets simultaneously by injecting providers into the browser. Wallets that implement this standard can make their presence known to dapps in a consistent and predictable manner.

See the [`rdns` property](https://wagmi.sh/dev/creating-connectors#properties) for more information.

---

---
url: /solid/api/connectors/metaMask.md
---

# metaMask

Connector for [MetaMask Connect](https://github.com/MetaMask/connect-monorepo).

## Import

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add @metamask/connect-evm@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install @metamask/connect-evm@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add @metamask/connect-evm@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add @metamask/connect-evm@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue{3,7}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { metaMask } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [metaMask()],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type MetaMaskParameters } from '{{connectorsPackageName}}'
```

Check out the [MetaMask Connect docs](https://docs.metamask.io/metamask-connect/evm/quickstart/wagmi/) for more info. A few options are omitted that Wagmi manages internally.

### dapp

`DappMetadata | undefined`

Metadata is used to fill details for the UX on confirmation screens in MetaMask, including the following fields:

* `name`: `string` - The name of the dapp.
* `url`: `string` - URL of the dapp (defaults to `window.location.origin`).
* `iconUrl`: `string` - URL to the dapp's favicon or icon.

Defaults to `{ name: window.location.hostname }`.

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  dapp: { // [!code focus]
    name: 'My Wagmi App', // [!code focus]
    url: 'https://example.com', // [!code focus]
    iconUrl: 'https://example.com/favicon.ico', // [!code focus]
  }
})
```

### debug

`boolean | undefined`

Enables debug mode for the MetaMask SDK. When enabled, provides additional logging and debugging information.

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  debug: true // [!code focus]
})
```

### connectAndSign

`string | undefined`

Shortcut to connect and sign a message in a single operation. When provided, the connector will connect to MetaMask and immediately prompt the user to sign the specified message.

This parameter is mutually exclusive with `connectWith` - only one can be used at a time.

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  connectAndSign: 'Sign this message to connect', // [!code focus]
})
```

### connectWith

`{ method: string; params: unknown[] } | undefined`

Allows connecting with any RPC method. When provided, the connector will connect to MetaMask and immediately call the specified RPC method with the given parameters.

This parameter is mutually exclusive with `connectAndSign` - only one can be used at a time.

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  connectWith: { // [!code focus]
    method: 'eth_requestAccounts', // [!code focus]
    params: [], // [!code focus]
  }
})
```

## Advanced

By default, if the EIP-6963 MetaMask injected provider is detected, this connector will replace it.

EIP-6963 defines a standard way for dapps to interact with multiple wallets simultaneously by injecting providers into the browser. Wallets that implement this standard can make their presence known to dapps in a consistent and predictable manner.

See the [`rdns` property](https://wagmi.sh/dev/creating-connectors#properties) for more information.

---

---
url: /vue/api/connectors/metaMask.md
---

# metaMask

Connector for [MetaMask Connect](https://github.com/MetaMask/connect-monorepo).

## Import

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add @metamask/connect-evm@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install @metamask/connect-evm@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add @metamask/connect-evm@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add @metamask/connect-evm@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue{3,7}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { metaMask } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [metaMask()],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type MetaMaskParameters } from '{{connectorsPackageName}}'
```

Check out the [MetaMask Connect docs](https://docs.metamask.io/metamask-connect/evm/quickstart/wagmi/) for more info. A few options are omitted that Wagmi manages internally.

### dapp

`DappMetadata | undefined`

Metadata is used to fill details for the UX on confirmation screens in MetaMask, including the following fields:

* `name`: `string` - The name of the dapp.
* `url`: `string` - URL of the dapp (defaults to `window.location.origin`).
* `iconUrl`: `string` - URL to the dapp's favicon or icon.

Defaults to `{ name: window.location.hostname }`.

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  dapp: { // [!code focus]
    name: 'My Wagmi App', // [!code focus]
    url: 'https://example.com', // [!code focus]
    iconUrl: 'https://example.com/favicon.ico', // [!code focus]
  }
})
```

### debug

`boolean | undefined`

Enables debug mode for the MetaMask SDK. When enabled, provides additional logging and debugging information.

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  debug: true // [!code focus]
})
```

### connectAndSign

`string | undefined`

Shortcut to connect and sign a message in a single operation. When provided, the connector will connect to MetaMask and immediately prompt the user to sign the specified message.

This parameter is mutually exclusive with `connectWith` - only one can be used at a time.

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  connectAndSign: 'Sign this message to connect', // [!code focus]
})
```

### connectWith

`{ method: string; params: unknown[] } | undefined`

Allows connecting with any RPC method. When provided, the connector will connect to MetaMask and immediately call the specified RPC method with the given parameters.

This parameter is mutually exclusive with `connectAndSign` - only one can be used at a time.

```ts-vue
import { metaMask } from '{{connectorsPackageName}}'

const connector = metaMask({
  connectWith: { // [!code focus]
    method: 'eth_requestAccounts', // [!code focus]
    params: [], // [!code focus]
  }
})
```

## Advanced

By default, if the EIP-6963 MetaMask injected provider is detected, this connector will replace it.

EIP-6963 defines a standard way for dapps to interact with multiple wallets simultaneously by injecting providers into the browser. Wallets that implement this standard can make their presence known to dapps in a consistent and predictable manner.

See the [`rdns` property](https://wagmi.sh/dev/creating-connectors#properties) for more information.

---

---
url: /cli/guides/migrate-from-v1-to-v2.md
description: Guide for migrating from Wagmi CLI v1 to v2.
---

# Migrate from v1 to v2

To get started, install the latest version of the Wagmi CLI.

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/guides/migrate-from-v1-to-v2.md","from":242,"to":262}<fsm-vh3gqscxm4e>
pnpm add @wagmi/cli
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/guides/migrate-from-v1-to-v2.md","from":285,"to":308}<fsm-vh3gqscxm4e>
npm install @wagmi/cli
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/guides/migrate-from-v1-to-v2.md","from":332,"to":352}<fsm-vh3gqscxm4e>
yarn add @wagmi/cli
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/guides/migrate-from-v1-to-v2.md","from":375,"to":394}<fsm-vh3gqscxm4e>
bun add @wagmi/cli
```

:::

::: info Not ready to migrate yet?
The Wagmi CLI v1 docs are still available at [1.x.wagmi.sh/cli](https://1.x.wagmi.sh/cli).
:::

## Changed generated action and hook names

Generated action and hook names now align with [Wagmi v2 naming conventions](/react/guides/migrate-from-v1-to-v2#renamed-hooks). If you want hooks to still follow Wagmi v1 naming conventions, set [`getActionName`](/cli/api/plugins/actions#getactionname) and [`getHookName`](/cli/api/plugins/react#gethookname) to `'legacy'`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/guides/migrate-from-v1-to-v2.md","from":910,"to":1192}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { actions, react } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    actions({
      getActionName: 'legacy', // [!code focus]
    }),
    react({
      getHookName: 'legacy', // [!code focus]
    }),
  ],
})
```

---

---
url: /core/guides/migrate-from-v1-to-v2.md
description: Guide for migrating from Wagmi Core v1 to v2.
---

# Migrate from v1 to v2

Wagmi Core v2 redesigns the core APIs to mesh better with [Viem](https://viem.sh). This major version transforms Wagmi into a light wrapper around Viem, sprinkling in multichain support and account management. As such, there are some breaking changes and deprecations to be aware of outlined in this guide.

To get started, install the latest version of Wagmi and it's required peer dependencies.

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":723,"to":783}<fsm-vh3gqscxm4e>
pnpm add @wagmi/core viem@{{viemVersion}} @wagmi/connectors
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":806,"to":869}<fsm-vh3gqscxm4e>
npm install @wagmi/core viem@{{viemVersion}} @wagmi/connectors
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":893,"to":953}<fsm-vh3gqscxm4e>
yarn add @wagmi/core viem@{{viemVersion}} @wagmi/connectors
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":976,"to":1035}<fsm-vh3gqscxm4e>
bun add @wagmi/core viem@{{viemVersion}} @wagmi/connectors
```

:::

::: info Wagmi Core v2 should be the last major version that will have this many actionable breaking changes.
Moving forward, new functionality will be opt-in with old functionality being deprecated alongside the new features. This means upgrading to the latest major versions will not require immediate changes.
:::

::: info Not ready to migrate yet?
The Wagmi Core v1 docs are still available at [1.x.wagmi.sh/core](https://1.x.wagmi.sh/core).
:::

## Dependencies

### Dropped CommonJS support

Wagmi v2 no longer publishes a separate `cjs` tag since very few people use this tag and ESM is the future. See [Sindre Sorhus' guide](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) for more info about switching to ESM.

## Actions

### Removed `config` singleton

Before v2, when you called [`createConfig`](/core/api/createConfig), it set a global `config` singleton that was used internally by actions. For v2, `config` is now a required first parameter for actions.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":2071,"to":2620}<fsm-vh3gqscxm4e>
import { getAccount, readContract } from '@wagmi/core'
import { parseAbi } from 'viem'
import { config } from './config' // [!code ++]

const account = getAccount() // [!code --]
const account = getAccount(config) // [!code ++]

const balanceOf = readContract({ // [!code --]
const balanceOf = readContract(config, { // [!code ++]
  address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
  abi: parseAbi(['function balanceOf(address) view returns (uint256)']),
  functionName: 'balanceOf',
  args: ['0xd2135CfB216b74109775236E36d4b433F1DF507B'],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

The previous global `config` singleton made it so you couldn't use multiple `Config` objects in the same project. In addition, we think passing `config` is more explicit and makes it easier to understand what's going on. Finally, types can be inferred directly from the `config`, like [chain properties](/core/guides/chain-properties) and more.

### Removed `getContract`

Removed `getContract` export. Use Viem's [`getContract`](https://viem.sh/docs/contract/getContract) instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":3159,"to":3355}<fsm-vh3gqscxm4e>
import { getContract } from '@wagmi/core' // [!code --]
import { getContract } from 'viem' // [!code ++]

const contract = getContract() // [!code --]
const contract = getContract() // [!code ++]
```

### Removed `getNetwork` and `watchNetwork`

The `getNetwork` and `watchNetwork` actions were removed since the connected chain is typically based on the connected account.

* Use [`config.chains`](/core/api/createConfig#chains-1) instead to get `chains`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":3649,"to":3794}<fsm-vh3gqscxm4e>
import { getNetwork } from '@wagmi/core' // [!code --]

const { chains } = getNetwork() // [!code --]
const chains = config.chains // [!code ++]
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

* Use [`getAccount`](/core/api/actions/getConnection) and `config.chains` instead to get `chain`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":3975,"to":4303}<fsm-vh3gqscxm4e>
import { getNetwork } from '@wagmi/core' // [!code --]
import { getAccount } from '@wagmi/core' // [!code ++]
import { config } from './config' // [!code ++]

const { chain } = getNetwork() // [!code --]
const { chainId } = getAccount(config) // [!code ++]
const chain = chains.find(chain => chain.id === chainId) // [!code ++]
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

Before v2, `getNetwork().chain` could result in an invalid chain if the active connector's `chainId` was not configured in the list of `config.chains`. Using `getAccount` and `config.chains` is more work, but ensures that chain is either valid or not defined. You can also use `getAccount(config).chain` if you don't care about the chain being `undefined` when not configured.

* Use `watchAccount` instead of `watchNetwork`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":4814,"to":5306}<fsm-vh3gqscxm4e>
import { watchNetwork } from '@wagmi/core' // [!code --]
import { watchAccount } from '@wagmi/core' // [!code ++]
import { config } from './config' // [!code ++]

const unwatch = watchNetwork((data) => console.log('Changed!', data)) // [!code --]
const unwatch = watchAccount(config, { // [!code ++]
onChange(data) { // [!code ++]
    const chains = config.chains // [!code ++]
    const chain = chains.find(chain => chain.id === data.chainId) // [!code ++]
}, // [!code ++]
}) // [!code ++]
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### Removed `getWebSocketPublicClient` and `watchWebSocketPublicClient`

Viem [Transports](https://viem.sh/docs/clients/intro#transports) now determine the type of client that is returned. You can use [`getPublicClient`](/core/api/actions/getPublicClient) and [`watchPublicClient`](/core/api/actions/watchPublicClient) to retrieve Viem [`PublicClient`](https://viem.sh/docs/clients/public) instances.

Alternatively, you can use [`getClient`](/core/api/actions/getClient) and [`watchClient`](/core/api/actions/watchClient) to retrieve plain Viem [`Client`](https://viem.sh/docs/clients/custom) instances. This is a better option for users that care about optimizing bundle size to be as small as possible.

### Removed `watchReadContract`, `watchReadContracts`, and `watchReadMulticall`

Use [`watchBlockNumber`](/core/api/actions/watchBlockNumber) along with [`readContract`](/core/api/actions/readContract), [`readContracts`](/core/api/actions/readContracts), and [`multicall`](/core/api/actions/multicall) actions instead. Before v2, `watchReadContract`, `watchReadContracts`, and `watchReadMulticall` were all wrappers around `watchBlockNumber` and this simplifies the API.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":6567,"to":7741}<fsm-vh3gqscxm4e>
import { watchReadContract } from '@wagmi/core' // [!code --]
import { watchBlockNumber, readContract } from '@wagmi/core' // [!code ++]
import { config } from './config' // [!code ++]

const unwatch = watchReadContract( // [!code --]
  { // [!code --]
    address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', // [!code --]
    abi: parseAbi(['function balanceOf(address) view returns (uint256)']), // [!code --]
    functionName: 'balanceOf', // [!code --]
    args: ['0xd2135CfB216b74109775236E36d4b433F1DF507B'], // [!code --]
  }, // [!code --]
  (result) => console.log('Changed!', result), // [!code --]
) // [!code --]
const unwatch = watchBlockNumber(config, { // [!code ++]
  onBlockNumber() { // [!code ++]
    const balanceOf = readContract(config, { // [!code ++]
      address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', // [!code ++]
      abi: parseAbi(['function balanceOf(address) view returns (uint256)']), // [!code ++]
      functionName: 'balanceOf', // [!code ++]
      args: ['0xd2135CfB216b74109775236E36d4b433F1DF507B'], // [!code ++]
    }) // [!code ++]
    console.log('Changed!', balanceOf)// [!code ++]
  }, // [!code ++]
}) // [!code ++]
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### Removed `fetchFeeData`

Removed `fetchFeeData`. Use [`estimateFeesPerGas`](/core/api/actions/estimateFeesPerGas) instead.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":7950,"to":8231}<fsm-vh3gqscxm4e>
import { fetchFeeData } from '@wagmi/core' // [!code --]
import { estimateFeesPerGas } from '@wagmi/core' // [!code ++]
import { config } from './config' // [!code ++]

const result = await fetchFeeData() // [!code --]
const result = await estimateFeesPerGas(config) // [!code ++]
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### Removed `prepareWriteContract`

Removed `prepareWriteContract`. Use [`simulateContract`](/core/api/actions/simulateContract) instead.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":8452,"to":8761}<fsm-vh3gqscxm4e>
import { prepareWriteContract } from '@wagmi/core' // [!code --]
import { simulateContract } from '@wagmi/core' // [!code ++]
import { config } from './config' // [!code ++]

const result = await prepareWriteContract({ ... }) // [!code --]
const result = await simulateContract(config, { ... }) // [!code ++]
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### Removed `prepareSendTransaction`

Removed `prepareSendTransaction`. Use [`estimateGas`](/core/api/actions/estimateGas) instead.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":8976,"to":9279}<fsm-vh3gqscxm4e>
import { prepareSendTransaction } from '@wagmi/core' // [!code --]
import { estimateGas } from '@wagmi/core' // [!code ++]
import { config } from './config' // [!code ++]

const result = await prepareSendTransaction({ ... }) // [!code --]
const result = await estimateGas(config, { ... }) // [!code ++]
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### Updated `sendTransaction` and `writeContract` return type

Updated [`sendTransaction`](/core/api/actions/sendTransaction) and [`writeContract`](/core/api/actions/writeContract) return type from ``{ hash: `0x${string}` }`` to `` `0x${string}` ``.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":9588,"to":9691}<fsm-vh3gqscxm4e>
const result = await sendTransaction({ hash: '0x...' })
result.hash // [!code --]
result // [!code ++]
```

### Updated `connect` return type

Updated [`connect`](/core/api/actions/connect) return type from `{ account: Address; chain: { id: number; unsupported?: boolean }; connector: Connector }` to `{ accounts: readonly Address[]; chainId: number }`. This better reflects the ability to have multiple accounts per connector.

### Renamed parameters and return types

All hook parameters and return types follow the naming pattern of `[PascalCaseActionName]Parameters` and `[PascalCaseActionName]ReturnType`. For example, `GetAccountParameters` and `GetAccountReturnType`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":10278,"to":10444}<fsm-vh3gqscxm4e>
import { GetAccountConfig, GetAccountResult } from '@wagmi/core' // [!code --]
import { GetAccountParameters, GetAccountReturnType } from '@wagmi/core' // [!code ++]
```

## Connectors

### Moved Wagmi Connectors to peer dependencies

Wagmi Core v2 no longer exports connectors via the `'@wagmi/core/connectors/*'` entrypoints. Instead, you should install the `@wagmi/connectors` package.

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":10702,"to":10729}<fsm-vh3gqscxm4e>
pnpm add @wagmi/connectors
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":10752,"to":10782}<fsm-vh3gqscxm4e>
npm install @wagmi/connectors
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":10806,"to":10833}<fsm-vh3gqscxm4e>
yarn add @wagmi/connectors
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":10856,"to":10882}<fsm-vh3gqscxm4e>
bun add @wagmi/connectors
```

:::

And import connectors from there.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":10932,"to":10977}<fsm-vh3gqscxm4e>
import { injected } from '@wagmi/connectors'
```

See the [connectors documentation](/core/api/connectors) for more information.

### Updated connector API

In order to maximize type-safety and ease of creating connectors, the connector API changed. Follow the [Creating Connectors guide](/dev/creating-connectors) for more info on creating new connectors and converting Wagmi v1 connectors.

### Removed individual entrypoints

Previously, each connector had its own entrypoint to optimize tree-shaking. Since all connectors now have [`package.json#sideEffects`](https://webpack.js.org/guides/tree-shaking/#mark-the-file-as-side-effect-free) enabled, this is no longer necessary and the entrypoint is unified. Use the `'@wagmi/connectors'` package instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":11697,"to":11948}<fsm-vh3gqscxm4e>
import { InjectedConnector } from '@wagmi/core/connectors/injected' // [!code --]
import { CoinbaseWalletConnector } from '@wagmi/core/connectors/coinbaseWallet' // [!code --]
import { coinbaseWallet, injected } from '@wagmi/connectors' // [!code ++]
```

### Removed `MetaMaskConnector`

The `MetaMaskConnector` was removed since it was nearly the same thing as the `InjectedConnector`. Use the [`injected`](/core/api/connectors/injected) connector instead, along with the [`target`](/core/api/connectors/injected#target) parameter set to `'metaMask'`, for the same behavior.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":12281,"to":12544}<fsm-vh3gqscxm4e>
import { MetaMaskConnector } from '@wagmi/core/connectors/metaMask' // [!code --]
import { injected } from '@wagmi/connectors' // [!code ++]

const connector = new MetaMaskConnector() // [!code --]
const connector = injected({ target: 'metaMask' }) // [!code ++]
```

### Renamed connectors

In Wagmi v1, connectors were classes you needed to instantiate. In Wagmi v2, connectors are functions. As a result, the API has changed. Connectors have the following new names:

* `CoinbaseWalletConnector` is now [`coinbaseWallet`](/core/api/connectors/coinbaseWallet).
* `InjectedConnector` is now [`injected`](/core/api/connectors/injected).
* `SafeConnector` is now [`safe`](/core/api/connectors/safe).
* `WalletConnectConnector` is now [`walletConnect`](/core/api/connectors/walletConnect).

To create a connector, you now call the connector function with parameters.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":13153,"to":13471}<fsm-vh3gqscxm4e>
import { WalletConnectConnector } from '@wagmi/core/connectors/walletConnect' // [!code --]
import { walletConnect } from '@wagmi/connectors' // [!code ++]

const connector = new WalletConnectConnector({ // [!code --]
const connector = walletConnect({ // [!code ++]
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
})
```

### Removed `WalletConnectLegacyConnector`

WalletConnect v1 was sunset June 28, 2023. Use the [`walletConnect`](/core/api/connectors/walletConnect) connector instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":13651,"to":13987}<fsm-vh3gqscxm4e>
import { WalletConnectLegacyConnector } from '@wagmi/core/connectors/walletConnectLegacy' // [!code --]
import { walletConnect } from '@wagmi/connectors' // [!code ++]

const connector = new WalletConnectLegacyConnector({ // [!code --]
const connector = walletConnect({ // [!code ++]
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
})
```

## Chains

### Updated `'@wagmi/core/chains'` entrypoint

Chains now live in the [Viem repository](https://github.com/wevm/viem). As a result, the `'@wagmi/core/chains'` entrypoint now proxies all chains from `'viem/chains'` directly.

### Removed `mainnet` and `sepolia` from main entrypoint

Since the `'@wagmi/core/chains'` entrypoint now proxies `'viem/chains'`, `mainnet` and `sepolia` were removed from the main entrypoint. Use the `'@wagmi/core/chains'` entrypoint instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":14480,"to":14609}<fsm-vh3gqscxm4e>
import { mainnet, sepolia } from '@wagmi/core' // [!code --]
import { mainnet, sepolia } from '@wagmi/core/chains' // [!code ++]
```

## Errors

A number of errors were renamed to better reflect their functionality or replaced by Viem errors.

## Miscellaneous

### Removed internal ENS normalization

Before v2, Wagmi handled ENS name normalization internally for `getEnsAddress`, `getEnsAvatar`, and `getEnsResolver`, using Viem's [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function. This added extra bundle size as full normalization is quite heavy. For v2, you must normalize ENS names yourself before passing them to these actions. You can use Viem's `normalize` function or any other function that performs [UTS-46 normalization](https://unicode.org/reports/tr46).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":15302,"to":15555}<fsm-vh3gqscxm4e>
import { getEnsAddress } from '@wagmi/core'
import { normalize } from 'viem' // [!code ++]
import { config } from './config'

const result = await getEnsAddress(config, {
  name: 'wevm.eth', // [!code --]
  name: normalize('wevm.eth'), // [!code ++]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

By inverting control, Wagmi lets you choose how much normalization to do. For example, maybe your project only allows ENS names that are numeric so no normalization is not needed. Check out the [ENS documentation](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) for more information on normalizing names.

### Removed `configureChains`

The Wagmi v2 `Config` now has native multichain support using the [`chains`](/core/api/createConfig) parameter so the `configureChains` function is no longer required.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":16152,"to":16758}<fsm-vh3gqscxm4e>
import { configureChains, createConfig } from '@wagmi/core' // [!code --]
import { http, createConfig } from '@wagmi/core' // [!code ++]
import { mainnet, sepolia } from '@wagmi/core/chains'

const { chains, publicClient } = configureChains( // [!code --]
  [mainnet, sepolia], // [!code --]
  [publicProvider(), publicProvider()], // [!code --]
) // [!code --]

export const config = createConfig({
  publicClient, // [!code --]
  chains: [mainnet, sepolia], // [!code ++]
  transports: { // [!code ++]
    [mainnet.id]: http(), // [!code ++]
    [sepolia.id]: http(), // [!code ++]
  }, // [!code ++]
})
```

### Removed ABI exports

Import from Viem instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":16821,"to":16920}<fsm-vh3gqscxm4e>
import { erc20ABI } from '@wagmi/core' // [!code --]
import { erc20Abi } from 'viem' // [!code ++]
```

### Removed `'@wagmi/core/providers/*` entrypoints

It never made sense that we would have provider URLs hardcoded in the Wagmi codebase. Use [Viem transports](https://viem.sh/docs/clients/intro#transports) along with RPC provider URLs instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":17177,"to":17352}<fsm-vh3gqscxm4e>
import { alchemyProvider } from '@wagmi/core/providers/alchemy' // [!code --]
import { http } from 'viem' // [!code ++]

const transport = http('https://mainnet.example.com')
```

### Updated `createConfig` parameters

* Removed `autoConnect`. The reconnecting behavior must be managed manually and is not related to the Wagmi `Config`. Use the [`reconnect`](/core/api/actions/reconnect) action instead.
* Removed `publicClient` and `webSocketPublicClient`. Use [`transports`](/core/api/createConfig#transports) or [`client`](/core/api/createConfig#client) instead.
* Removed `logger`. Wagmi no longer logs debug information to console.

### Updated `Config` object

* Removed `config.connector`. Use `config.state.connections.get(config.state.current)?.connector` instead.
* Removed `config.data`. Use `config.state.connections.get(config.state.current)` instead.
* Removed `config.error`. Was unused and not needed.
* Removed `config.lastUsedChainId`. Use `config.state.connections.get(config.state.current)?.chainId` instead.
* Removed `config.publicClient`. Use [`config.getClient()`](/core/api/createConfig#getclient) or [`getPublicClient`](/core/api/actions/getPublicClient) instead.
* Removed `config.status`. Use [`config.state.status`](/core/api/createConfig#status) instead.
* Removed `config.webSocketClient`. Use [`config.getClient()`](/core/api/createConfig#getclient) or [`getPublicClient`](/core/api/actions/getPublicClient) instead.
* Removed `config.clearState`. Was unused and not needed.
* Removed `config.autoConnect()`. Use [`reconnect`](/core/api/actions/reconnect) action instead.
* Renamed `config.setConnectors`. Use `config._internal.setConnectors` instead.
* Removed `config.setLastUsedConnector`. Use `config.storage?.setItem('recentConnectorId', connectorId)` instead.
* Removed `getConfig`. `config` should be passed explicitly to actions instead of using global `config`.

## Deprecations

### Deprecated `getBalance` `token` parameter

Moving forward, `getBalance` will only work for native currencies, thus the `token` parameter is no longer supported. Use [`readContracts`](/core/api/actions/readContracts) instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":19334,"to":20579}<fsm-vh3gqscxm4e>
import { getBalance } from '@wagmi/core' // [!code --]
import { readContracts } from '@wagmi/core' // [!code ++]
import { erc20Abi } from 'viem' // [!code ++]
import { config } from './config' // [!code ++]

const result = await getBalance(config, { // [!code --]
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48', // [!code --]
  token: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // [!code --]
}) // [!code --]
const result = await readContracts(config, { // [!code ++]
  allowFailure: false, // [!code ++]
  contracts: [ // [!code ++]
    { // [!code ++]
      address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // [!code ++]
      abi: erc20Abi, // [!code ++]
      functionName: 'balanceOf', // [!code ++]
      args: ['0x4557B18E779944BFE9d78A672452331C186a9f48'], // [!code ++]
    }, // [!code ++]
    { // [!code ++]
      address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // [!code ++]
      abi: erc20Abi, // [!code ++]
      functionName: 'decimals', // [!code ++]
    }, // [!code ++]
    { // [!code ++]
      address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // [!code ++]
      abi: erc20Abi, // [!code ++]
      functionName: 'symbol', // [!code ++]
    }, // [!code ++]
  ] // [!code ++]
}) // [!code ++]
```

### Deprecated `getBalance` `unit` parameter and `formatted` return value

Moving forward, `getBalance` will not accept the `unit` parameter or return a `formatted` value. Instead you can call `formatUnits` from Viem directly or use another number formatting library, like [dnum](https://github.com/bpierre/dnum) instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":20913,"to":21217}<fsm-vh3gqscxm4e>
import { formatUnits } from 'viem' // [!code ++]
import { getBalance } from '@wagmi/core'

const result = await getBalance({
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
  unit: 'ether', // [!code --]
})
result.formatted // [!code --]
formatUnits(result.value, result.decimals) // [!code ++]
```

### Deprecated `getToken`

Moving forward, `getToken` is no longer supported. Use [`readContracts`](/core/api/actions/readContracts) instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":21371,"to":22664}<fsm-vh3gqscxm4e>
import { getToken } from '@wagmi/core' // [!code --]
import { readContracts } from '@wagmi/core' // [!code ++]
import { erc20Abi } from 'viem' // [!code ++]
import { config } from './config' // [!code ++]

const result = await getToken(config, { // [!code --]
  address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // [!code --]
}) // [!code --]
const result = await readContracts(config, { // [!code ++]
  allowFailure: false, // [!code ++]
  contracts: [ // [!code ++]
    { // [!code ++]
      address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // [!code ++]
      abi: erc20Abi, // [!code ++]
      functionName: 'decimals', // [!code ++]
    }, // [!code ++]
    { // [!code ++]
      address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // [!code ++]
      abi: erc20Abi, // [!code ++]
      functionName: 'name', // [!code ++]
    }, // [!code ++]
    { // [!code ++]
      address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // [!code ++]
      abi: erc20Abi, // [!code ++]
      functionName: 'symbol', // [!code ++]
    }, // [!code ++]
    { // [!code ++]
      address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // [!code ++]
      abi: erc20Abi, // [!code ++]
      functionName: 'totalSupply', // [!code ++]
    }, // [!code ++]
  ] // [!code ++]
}) // [!code ++]
```

### Deprecated `formatUnits` parameters and return values

The `formatUnits` parameter and related return values (e.g. `result.formatted`) are deprecated for the following actions:

* [`estimateFeesPerGas`](/core/api/actions/estimateFeesPerGas)
* `getToken`

Instead you can call `formatUnits` from Viem directly or use another number formatting library, like [dnum](https://github.com/bpierre/dnum) instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v1-to-v2.md","from":23085,"to":23391}<fsm-vh3gqscxm4e>
import { formatUnits } from 'viem' // [!code ++]
import { getToken } from '@wagmi/core'

const result = await getToken({
  address: '0x6B175474E89094C44Da98b954EedeAC495271d0F',
  formatUnits: 'ether',
})
result.totalSupply.formatted  // [!code --]
formatUnits(result.totalSupply.value, 18)  // [!code ++]
```

This allows us to invert control to users so they can handle number formatting however they want, taking into account precision, localization, and more.

### Renamed actions

The following actions were renamed to better reflect their functionality and underlying [Viem](https://viem.sh) actions:

* `fetchBalance` is now [`getBalance`](/core/api/actions/getBalance)
* `fetchBlockNumber` is now [`getBlockNumber`](/core/api/actions/getBlockNumber)
* `fetchEnsAddress` is now [`getEnsAddress`](/core/api/actions/getEnsAddress)
* `fetchEnsAvatar` is now [`getEnsAvatar`](/core/api/actions/getEnsAvatar)
* `fetchEnsName` is now [`getEnsName`](/core/api/actions/getEnsName)
* `fetchEnsResolver` is now [`getEnsResolver`](/core/api/actions/getEnsResolver)
* `fetchToken` is now `getToken`
* `fetchTransaction` is now [`getTransaction`](/core/api/actions/getTransaction)
* `switchNetwork` is now [`switchChain`](/core/api/actions/switchChain)
* `waitForTransaction` is now [`waitForTransactionReceipt`](/core/api/actions/waitForTransactionReceipt)

---

---
url: /react/guides/migrate-from-v1-to-v2.md
description: Guide for migrating from Wagmi v1 to v2.
---

# Migrate from v1 to v2

## Overview

Wagmi v2 redesigns the core APIs to mesh better with [Viem](https://viem.sh) and [TanStack Query](https://tanstack.com/query/v5/docs/react). This major version transforms Wagmi into a light wrapper around these libraries, sprinkling in multichain support and account management. As such, there are some breaking changes and deprecations to be aware of outlined in this guide.

To get started, install the latest version of Wagmi and it's required peer dependencies.

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":775,"to":833}<fsm-vh3gqscxm4e>
pnpm add wagmi viem@{{viemVersion}} @tanstack/react-query
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":856,"to":917}<fsm-vh3gqscxm4e>
npm install wagmi viem@{{viemVersion}} @tanstack/react-query
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":941,"to":999}<fsm-vh3gqscxm4e>
yarn add wagmi viem@{{viemVersion}} @tanstack/react-query
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":1022,"to":1079}<fsm-vh3gqscxm4e>
bun add wagmi viem@{{viemVersion}} @tanstack/react-query
```

:::

::: info Wagmi v2 should be the last major version that will have this many actionable breaking changes.
Moving forward after Wagmi v2, new functionality will be opt-in with old functionality being deprecated alongside the new features. This means upgrading to the latest major versions will not require immediate changes.
:::

::: info Not ready to migrate yet?
The Wagmi v1 docs are still available at [1.x.wagmi.sh/react](https://1.x.wagmi.sh/react).
:::

## Dependencies

### Moved TanStack Query to peer dependencies

Wagmi uses [TanStack Query](https://tanstack.com/query/v5/docs/react) to manage async state, handling requests, caching, and more. With Wagmi v1, TanStack Query was an internal implementation detail. With Wagmi v2, TanStack Query is a peer dependency. A lot of Wagmi users also use TanStack Query in their apps so making it a peer dependency gives them more control and removes some custom Wagmi code internally.

If you don't normally use TanStack Query, all you need to do is set it up and mostly forget about it (we'll provide guidance around version updates).

::: code-group

```tsx [app.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":2209,"to":2640}<fsm-vh3gqscxm4e>
import { QueryClient, QueryClientProvider } from '@tanstack/react-query' // [!code ++]
import { WagmiProvider } from 'wagmi'
import { config } from './config'

const queryClient = new QueryClient() // [!code ++]

function App() {
  return (
    <WagmiProvider config={config}>
      <QueryClientProvider client={queryClient}> // [!code ++]
        {/** ... */}
      </QueryClientProvider> // [!code ++]
    </WagmiProvider>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

For more information on setting up TanStack Query for Wagmi, follow the [Getting Started docs](/react/getting-started#setup-tanstack-query). If you want to set up persistence for your query cache (default behavior before Wagmi v2), check out the [TanStack Query docs](https://tanstack.com/query/v5/docs/react/plugins/persistQueryClient#usage-with-react).

### Dropped CommonJS support

Wagmi v2 no longer publishes a separate `cjs` tag since very few people use this tag and ESM is the future. See [Sindre Sorhus' guide](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) for more info about switching to ESM.

## Hooks

### Removed mutation setup arguments

Mutation hooks are hooks that change network or application state, sign data, or perform write operations through mutation functions. With Wagmi v1, you could pass arguments directly to these hooks instead of using them with their mutation functions. For example:

```ts{3}
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":3644,"to":3726}<fsm-vh3gqscxm4e>
// Wagmi v1
const { signMessage } = useSignMessage({
  message: 'foo bar baz',
})
```

With Wagmi v2, you must pass arguments to the mutation function instead. This follows the same behavior as [TanStack Query](https://tanstack.com/query/v5/docs/react/guides/mutations) mutations and improves type-safety.

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":3958,"to":4288}<fsm-vh3gqscxm4e>
import { useSignMessage } from 'wagmi'

const { signMessage } = useSignMessage({ message: 'foo bar baz' }) // [!code --]
const { signMessage } = useSignMessage() // [!code ++]

<button
  onClick={() => signMessage()} // [!code --]
  onClick={() => signMessage({ message: 'foo bar baz' })} // [!code ++]
>
  Sign message
</button>
```

### Moved TanStack Query parameters to `query` property

Previously, you could pass TanStack Query parameters, like `enabled` and `staleTime`, directly to hooks. In Wagmi v2, TanStack Query parameters are now moved to the `query` property. This allows Wagmi to better support TanStack Query type inference, control for future breaking changes since [TanStack Query is now a peer dependency](#moved-tanstack-query-to-peer-dependencies), and expose Wagmi-related hook property at the top-level of editor features, like autocomplete.

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":4832,"to":5033}<fsm-vh3gqscxm4e>
useReadContract({
  enabled: false, // [!code --]
  staleTime: 1_000, // [!code --]
  query: { // [!code ++]
    enabled: false, // [!code ++]
    staleTime: 1_000, // [!code ++]
  }, // [!code ++]
})
```

### Removed watch property

The `watch` property was removed from all hooks besides [`useBlock`](/react/api/hooks/useBlock) and [`useBlockNumber`](/react/api/hooks/useBlockNumber). This property allowed hooks to internally listen for block changes and automatically refresh their data. In Wagmi v2, you can compose `useBlock` or `useBlockNumber` along with [`React.useEffect`](https://react.dev/reference/react/useEffect) to achieve the same behavior. Two different approaches are outlined for `useBalance` below.

::: code-group

```ts [invalidateQueries]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":5594,"to":6194}<fsm-vh3gqscxm4e>
import { useQueryClient } from '@tanstack/react-query' // [!code ++]
import { useEffect } from 'react' // [!code ++]
import { useBlockNumber, useBalance } from 'wagmi' // [!code ++]

const queryClient = useQueryClient() // [!code ++]
const { data: blockNumber } = useBlockNumber({ watch: true }) // [!code ++]
const { data: balance, queryKey } = useBalance({ // [!code ++]
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
  watch: true, // [!code --]
})

useEffect(() => { // [!code ++]
  queryClient.invalidateQueries({ queryKey }) // [!code ++]
}, [blockNumber, queryClient]) // [!code ++]
```

```ts [refetch]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":6214,"to":6632}<fsm-vh3gqscxm4e>
import { useEffect } from 'react' // [!code ++]
import { useBlockNumber, useBalance } from 'wagmi' // [!code ++]

const { data: blockNumber } = useBlockNumber({ watch: true }) // [!code ++]
const { data: balance, refetch } = useBalance({
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
  watch: true, // [!code --]
})

useEffect(() => { // [!code ++]
  refetch() // [!code ++]
}, [blockNumber]) // [!code ++]
```

:::

This is a bit more code, but removes a lot of internal code from hooks that can slow down your app when not used and gives you more control. For example, you can easily refresh data every five blocks instead of every block.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":6872,"to":7221}<fsm-vh3gqscxm4e>
const { data: blockNumber } = useBlockNumber({ watch: true })
const { data: balance, queryKey } = useBalance({
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
})

useEffect(() => {
  if (blockNumber && blockNumber % 5n === 0n) // [!code focus]
    queryClient.invalidateQueries({ queryKey }) // [!code focus]
}, [blockNumber, queryClient])
```

### Removed suspense property

Wagmi used to support an experimental `suspense` property via TanStack Query. Since TanStack Query [removed `suspense`](https://tanstack.com/query/v5/docs/react/guides/migrating-to-v5#new-hooks-for-suspense) from its `useQuery` hook, it is no longer supported by Wagmi Hooks.

Instead, you can use `useSuspenseQuery` along with TanStack Query-related exports from the `'wagmi/query'` entrypoint.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":7660,"to":8196}<fsm-vh3gqscxm4e>
import { useSuspenseQuery } from '@tanstack/react-query' // [!code ++]
import { useConfig } from 'wagmi' // [!code ++]
import { getBalanceQueryOptions } from 'wagmi/query' // [!code ++]
import { useBalance } from 'wagmi' // [!code --]

const config = useConfig() // [!code ++]
const options = getBalanceQueryOptions(config, { address: '0x…' }) // [!code ++]
const result = useSuspenseQuery(options) // [!code ++]
const result = useBalance({ // [!code --]
  address: '0x…', // [!code --]
  suspense: true, // [!code --]
}) // [!code --]
```

### Removed prepare hooks

`usePrepareContractWrite` and `usePrepareSendTransaction` were removed and replaced with idiomatic Viem alternatives. For `usePrepareContractWrite`, use [`useSimulateContract`](/react/api/hooks/useSimulateContract). Similar to `usePrepareContractWrite`, `useSimulateContract` composes well with `useWriteContract`

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":8550,"to":9533}<fsm-vh3gqscxm4e>
import { usePrepareContractWrite, useWriteContract } from 'wagmi' // [!code --]
import { useSimulateContract, useWriteContract } from 'wagmi' // [!code ++]

const { config } = usePrepareContractWrite({ // [!code --]
const { data } = useSimulateContract({ // [!code ++]
  address: '0x',
  abi: [{
    type: 'function',
    name: 'transferFrom',
    stateMutability: 'nonpayable',
    inputs: [
      { name: 'sender', type: 'address' },
      { name: 'recipient', type: 'address' },
      { name: 'amount', type: 'uint256' },
    ],
    outputs: [{ type: 'bool' }],
  }],
  functionName: 'transferFrom',
  args: ['0x', '0x', 123n],
})
const { write } = useWriteContract(config) // [!code --]
const { writeContract } = useWriteContract() // [!code ++]

<button
  disabled={!Boolean(write)} // [!code --]
  onClick={() => write()} // [!code --]
  disabled={!Boolean(data?.request)} // [!code ++]
  onClick={() => writeContract(data!.request)} // [!code ++]
>
  Write contract
</button>
```

Instead of `usePrepareSendTransaction`, use [`useEstimateGas`](/react/api/hooks/useEstimateGas). You can pass `useEstimateGas` `data` to `useSendTransaction` to compose the two hooks.

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":9730,"to":10643}<fsm-vh3gqscxm4e>
import { usePrepareSendTransaction, useSendTransaction } from 'wagmi' // [!code --]
import { useEstimateGas, useSendTransaction } from 'wagmi' // [!code ++]
import { parseEther } from 'viem'

const { config } = usePrepareSendTransaction({ // [!code --]
const { data } = useEstimateGas({ // [!code ++]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
const { sendTransaction } = useSendTransaction(config) // [!code --]
const { sendTransaction } = useSendTransaction() // [!code ++]

<button
  disabled={!Boolean(sendTransaction)} // [!code --]
  onClick={() => sendTransaction()} // [!code --]
  disabled={!Boolean(data)} // [!code ++]
  onClick={() => sendTransaction({ // [!code ++]
    gas: data, // [!code ++]
    to: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code ++]
    value: parseEther('0.01'), // [!code ++]
  })} // [!code ++]
>
  Send transaction
</button>
```

This might seem like more work, but it gives you more control and is more accurate representation of what is happening under the hood.

### Removed `useNetwork` hook

The `useNetwork` hook was removed since the connected chain is typically based on the connected account. Use [`useAccount`](/react/api/hooks/useConnection) to get the connected `chain`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":11008,"to":11197}<fsm-vh3gqscxm4e>
import { useNetwork } from 'wagmi' // [!code --]
import { useAccount } from 'wagmi' // [!code ++]

const { chain } = useNetwork() // [!code --]
const { chain } = useAccount() // [!code ++]
```

Use `useConfig` for the list of `chains` set up with the Wagmi [`Config`](/react/api/createConfig#chains).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":11316,"to":11505}<fsm-vh3gqscxm4e>
import { useNetwork } from 'wagmi' // [!code --]
import { useConfig } from 'wagmi' // [!code ++]

const { chains } = useNetwork() // [!code --]
const { chains } = useConfig() // [!code ++]
```

### Removed `onConnect` and `onDisconnect` callbacks from `useAccount`

The `onConnect` and `onDisconnect` callbacks were removed from the `useAccount` hook since it is frequently used without these callbacks so it made sense to extract these into a new API, [`useAccountEffect`](/react/api/hooks/useConnectionEffect), rather than clutter the `useAccount` hook.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":11879,"to":12164}<fsm-vh3gqscxm4e>
import { useAccount } from 'wagmi' // [!code --]
import { useAccountEffect } from 'wagmi' // [!code ++]

useAccount({ // [!code --]
useAccountEffect({ // [!code ++]
  onConnect(data) {
    console.log('connected', data)
  },
  onDisconnect() {
    console.log('disconnected')
  },
}) 
```

### Removed `useWebSocketPublicClient`

The Wagmi [`Config`](/react/api/createConfig) does not separate transport types anymore. Simply use Viem's [`webSocket`](https://viem.sh/docs/clients/transports/websocket) transport instead when setting up your Wagmi `Config`. You can get Viem `Client` instance with this transport attached by using [`useClient`](/react/api/hooks/useClient) or [`usePublicClient`](/react/api/hooks/usePublicClient).

### Removed `useInfiniteReadContracts` `paginatedIndexesConfig`

In the spirit of removing unnecessary abstractions, `paginatedIndexesConfig` was removed. Use `useInfiniteReadContracts`'s `initialPageParam` and `getNextPageParam` parameters along with `fetchNextPage`/`fetchPreviousPage` from the result instead or copy `paginatedIndexesConfig`'s implementation to your codebase.

See the [TanStack Query docs](https://tanstack.com/query/v5/docs/react/guides/infinite-queries) for more information on infinite queries.

### Updated `useSendTransaction` and `useWriteContract` return type

Updated [`useSendTransaction`](/react/api/hooks/useSendTransaction) and [`useWriteContract`](/react/api/hooks/useWriteContract) return type from ``{ hash: `0x${string}` }`` to `` `0x${string}` ``.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":13405,"to":13499}<fsm-vh3gqscxm4e>
const result = useSendTransaction()
result.data?.hash // [!code --]
result.data // [!code ++]
```

### Updated `useConnect` return type

Updated [`useConnect`](/react/api/hooks/useConnect) return type from `{ account: Address; chain: { id: number; unsupported?: boolean }; connector: Connector }` to `{ accounts: readonly Address[]; chainId: number }`. This better reflects the ability to have multiple accounts per connector.

### Renamed parameters and return types

All hook parameters and return types follow the naming pattern of `[PascalCaseHookName]Parameters` and `[PascalCaseHookName]ReturnType`. For example, `UseAccountParameters` and `UseAccountReturnType`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":14090,"to":14244}<fsm-vh3gqscxm4e>
import { UseAccountConfig, UseAccountResult } from 'wagmi' // [!code --]
import { UseAccountParameters, UseAccountReturnType } from 'wagmi' // [!code ++]
```

## Connectors

### Updated connector API

In order to maximize type-safety and ease of creating connectors, the connector API changed. Follow the [Creating Connectors guide](/dev/creating-connectors) for more info on creating new connectors and converting Wagmi v1 connectors.

### Removed individual entrypoints

Previously, each connector had it's own entrypoint to optimize tree-shaking. Since all connectors now have [`package.json#sideEffects`](https://webpack.js.org/guides/tree-shaking/#mark-the-file-as-side-effect-free) enabled, this is no longer necessary and the entrypoint is unified. Use the `'wagmi/connectors'` entrypoint instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":14902,"to":15140}<fsm-vh3gqscxm4e>
import { InjectedConnector } from 'wagmi/connectors/injected' // [!code --]
import { CoinbaseWalletConnector } from 'wagmi/connectors/coinbaseWallet' // [!code --]
import { coinbaseWallet, injected } from 'wagmi/connectors' // [!code ++]
```

### Removed `MetaMaskConnector`

The `MetaMaskConnector` was removed since it was nearly the same thing as the `InjectedConnector`. Use the [`injected`](/react/api/connectors/injected) connector instead, along with the [`target`](/react/api/connectors/injected#target) parameter set to `'metaMask'`, for the same behavior.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":15475,"to":15731}<fsm-vh3gqscxm4e>
import { MetaMaskConnector } from 'wagmi/connectors/metaMask' // [!code --]
import { injected } from 'wagmi/connectors' // [!code ++]

const connector = new MetaMaskConnector() // [!code --]
const connector = injected({ target: 'metaMask' }) // [!code ++]
```

### Renamed connectors

In Wagmi v1, connectors were classes you needed to instantiate. In Wagmi v2, connectors are functions. As a result, the API has changed. Connectors have the following new names:

* `CoinbaseWalletConnector` is now [`coinbaseWallet`](/react/api/connectors/coinbaseWallet).
* `InjectedConnector` is now [`injected`](/react/api/connectors/injected).
* `SafeConnector` is now [`safe`](/react/api/connectors/safe).
* `WalletConnectConnector` is now [`walletConnect`](/react/api/connectors/walletConnect).

To create a connector, you now call the connector function with parameters.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":16343,"to":16654}<fsm-vh3gqscxm4e>
import { WalletConnectConnector } from 'wagmi/connectors/walletConnect' // [!code --]
import { walletConnect } from 'wagmi/connectors' // [!code ++]

const connector = new WalletConnectConnector({ // [!code --]
const connector = walletConnect({ // [!code ++]
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
})
```

### Removed `WalletConnectLegacyConnector`

WalletConnect v1 was sunset June 28, 2023. Use the [`walletConnect`](/react/api/connectors/walletConnect) connector instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":16835,"to":17164}<fsm-vh3gqscxm4e>
import { WalletConnectLegacyConnector } from 'wagmi/connectors/walletConnectLegacy' // [!code --]
import { walletConnect } from 'wagmi/connectors' // [!code ++]

const connector = new WalletConnectLegacyConnector({ // [!code --]
const connector = walletConnect({ // [!code ++]
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
})
```

## Chains

### Updated `'wagmi/chains'` entrypoint

Chains now live in the [Viem repository](https://github.com/wevm/viem). As a result, the `'wagmi/chains'` entrypoint now proxies all chains from `'viem/chains'` directly.

### Removed `mainnet` and `sepolia` from main entrypoint

Since the `'wagmi/chains'` entrypoint now proxies `'viem/chains'`, `mainnet` and `sepolia` were removed from the main entrypoint. Use the `'wagmi/chains'` entrypoint instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":17633,"to":17750}<fsm-vh3gqscxm4e>
import { mainnet, sepolia } from 'wagmi' // [!code --]
import { mainnet, sepolia } from 'wagmi/chains' // [!code ++]
```

## Errors

A number of errors were renamed to better reflect their functionality or replaced by Viem errors.

## Miscellaneous

### Removed internal ENS name normalization

Before v2, Wagmi handled ENS name normalization internally for `useEnsAddress`, `useEnsAvatar`, and `useEnsResolver`, using Viem's [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function. This added extra bundle size as full normalization is quite heavy. For v2, you must normalize ENS names yourself before passing them to these hooks. You can use Viem's `normalize` function or any other function that performs [UTS-46 normalization](https://unicode.org/reports/tr46).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":18419,"to":18622}<fsm-vh3gqscxm4e>
import { useEnsAddress } from 'wagmi'
import { normalize } from 'viem/ens' // [!code ++]

const result = useEnsAddress({
  name: 'wevm.eth', // [!code --]
  name: normalize('wevm.eth'), // [!code ++]
})
```

By inverting control, Wagmi let's you choose how much normalization to do. For example, maybe your project only allows ENS names that are numeric so no normalization is not needed. Check out the [ENS documentation](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) for more information on normalizing names.

### Removed `configureChains`

The Wagmi v2 `Config` now has native multichain support using the [`chains`](/react/api/createConfig) parameter so the `configureChains` function is no longer required.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":19176,"to":19764}<fsm-vh3gqscxm4e>
import { configureChains, createConfig } from 'wagmi' // [!code --]
import { http, createConfig } from 'wagmi' // [!code ++]
import { mainnet, sepolia } from 'wagmi/chains'

const { chains, publicClient } = configureChains( // [!code --]
  [mainnet, sepolia], // [!code --]
  [publicProvider(), publicProvider()], // [!code --]
) // [!code --]

export const config = createConfig({
  publicClient, // [!code --]
  chains: [mainnet, sepolia], // [!code ++]
  transports: { // [!code ++]
    [mainnet.id]: http(), // [!code ++]
    [sepolia.id]: http(), // [!code ++]
  }, // [!code ++]
})
```

### Removed ABI exports

Import from Viem instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":19827,"to":19920}<fsm-vh3gqscxm4e>
import { erc20ABI } from 'wagmi' // [!code --]
import { erc20Abi } from 'viem' // [!code ++]
```

### Removed `'wagmi/providers/*` entrypoints

It never made sense that we would have provider URLs hardcoded in the Wagmi codebase. Use [Viem transports](https://viem.sh/docs/clients/intro#transports) along with RPC provider URLs instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":20171,"to":20340}<fsm-vh3gqscxm4e>
import { alchemyProvider } from 'wagmi/providers/alchemy' // [!code --]
import { http } from 'viem' // [!code ++]

const transport = http('https://mainnet.example.com')
```

### Updated `createConfig` parameters

* Removed `autoConnect`. The reconnecting behavior is now managed by React and not related to the Wagmi `Config`. Use `WagmiProvider` [`reconnectOnMount`](/react/api/WagmiProvider#reconnectonmount) or [`useReconnect`](/react/api/hooks/useReconnect) hook instead.
* Removed `publicClient` and `webSocketPublicClient`. Use [`transports`](/react/api/createConfig#transports) or [`client`](/react/api/createConfig#client) instead.
* Removed `logger`. Wagmi no longer logs debug information to console.

### Updated `Config` object

* Removed `config.connector`. Use `config.state.connections.get(config.state.current)?.connector` instead.
* Removed `config.data`. Use `config.state.connections.get(config.state.current)` instead.
* Removed `config.error`. Was unused and not needed.
* Removed `config.lastUsedChainId`. Use `config.state.connections.get(config.state.current)?.chainId` instead.
* Removed `config.publicClient`. Use [`config.getClient()`](/react/api/createConfig#getclient) or [`getPublicClient`](/core/api/actions/getPublicClient) instead.
* Removed `config.status`. Use [`config.state.status`](/react/api/createConfig#status) instead.
* Removed `config.webSocketClient`. Use [`config.getClient()`](/react/api/createConfig#getclient) or [`getPublicClient`](/core/api/actions/getPublicClient) instead.
* Removed `config.clearState`. Was unused and not needed.
* Removed `config.autoConnect()`. Use [`reconnect`](/core/api/actions/reconnect) action instead.
* Renamed `config.setConnectors`. Use `config._internal.setConnectors` instead.
* Removed `config.setLastUsedConnector`. Use `config.storage?.setItem('recentConnectorId', connectorId)` instead.
* Removed `getConfig`. `config` should be passed explicitly to actions instead of using global `config`.

## Deprecations

### Renamed `WagmiConfig`

`WagmiConfig` was renamed to [`WagmiProvider`](/react/api/WagmiProvider) to reduce confusion with the Wagmi [`Config`](/react/api/createConfig) type. React Context Providers usually follow the naming schema `*Provider` so this is a more idiomatic name. Now that Wagmi no longer uses Ethers.js (since Wagmi v1), the term "Provider" is less overloaded.

::: code-group

```tsx [app.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":22580,"to":22936}<fsm-vh3gqscxm4e>
import { WagmiConfig } from 'wagmi' // [!code --]
import { WagmiProvider } from 'wagmi' // [!code ++]
import { config } from './config'

function App() {
  return (
    <WagmiConfig config={config}> // [!code --]
    <WagmiProvider config={config}> // [!code ++]
      {/** ... */}
    </WagmiProvider> // [!code ++]
    </WagmiConfig> // [!code --]
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### Deprecated `useBalance` `token` parameter

Moving forward, `useBalance` will only work for native currencies, thus the `token` parameter is no longer supported. Use [`useReadContracts`](/react/api/hooks/useReadContracts) instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":23228,"to":24391}<fsm-vh3gqscxm4e>
import { useBalance } from 'wagmi' // [!code --]
import { useReadContracts } from 'wagmi' // [!code ++]
import { erc20Abi } from 'viem' // [!code ++]

const result = useBalance({ // [!code --]
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48', // [!code --]
  token: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // [!code --]
}) // [!code --]
const result = useReadContracts({ // [!code ++]
  allowFailure: false, // [!code ++]
  contracts: [ // [!code ++]
    { // [!code ++]
      address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // [!code ++]
      abi: erc20Abi, // [!code ++]
      functionName: 'balanceOf', // [!code ++]
      args: ['0x4557B18E779944BFE9d78A672452331C186a9f48'], // [!code ++]
    }, // [!code ++]
    { // [!code ++]
      address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // [!code ++]
      abi: erc20Abi, // [!code ++]
      functionName: 'decimals', // [!code ++]
    }, // [!code ++]
    { // [!code ++]
      address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // [!code ++]
      abi: erc20Abi, // [!code ++]
      functionName: 'symbol', // [!code ++]
    }, // [!code ++]
  ] // [!code ++]
}) // [!code ++]
```

### Deprecated `useBalance` `unit` parameter and `formatted` return value

Moving forward, `useBalance` will not accept the `unit` parameter or return a `formatted` value. Instead you can call `formatUnits` from Viem directly or use another number formatting library, like [dnum](https://github.com/bpierre/dnum) instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":24725,"to":25035}<fsm-vh3gqscxm4e>
import { formatUnits } from 'viem' // [!code ++]
import { useBalance } from 'wagmi'

const result = useBalance({
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
  unit: 'ether', // [!code --]
})
result.data!.formatted // [!code --]
formatUnits(result.data!.value, result.data!.decimals) // [!code ++]
```

### Deprecated `useToken`

Moving forward, `useToken` is no longer supported. Use [`useReadContracts`](/react/api/hooks/useReadContracts) instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":25194,"to":26405}<fsm-vh3gqscxm4e>
import { useToken } from 'wagmi' // [!code --]
import { useReadContracts } from 'wagmi' // [!code ++]
import { erc20Abi } from 'viem' // [!code ++]

const result = useToken({ // [!code --]
  address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // [!code --]
}) // [!code --]
const result = useReadContracts({ // [!code ++]
  allowFailure: false, // [!code ++]
  contracts: [ // [!code ++]
    { // [!code ++]
      address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // [!code ++]
      abi: erc20Abi, // [!code ++]
      functionName: 'decimals', // [!code ++]
    }, // [!code ++]
    { // [!code ++]
      address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // [!code ++]
      abi: erc20Abi, // [!code ++]
      functionName: 'name', // [!code ++]
    }, // [!code ++]
    { // [!code ++]
      address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // [!code ++]
      abi: erc20Abi, // [!code ++]
      functionName: 'symbol', // [!code ++]
    }, // [!code ++]
    { // [!code ++]
      address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // [!code ++]
      abi: erc20Abi, // [!code ++]
      functionName: 'totalSupply', // [!code ++]
    }, // [!code ++]
  ] // [!code ++]
}) // [!code ++]
```

### Deprecated `formatUnits` parameters and return values

The `formatUnits` parameter and related return values (e.g. `result.formatted`) are deprecated for the following hooks:

* [`useEstimateFeesPerGas`](/react/api/hooks/useEstimateFeesPerGas)
* `useToken`

Instead you can call `formatUnits` from Viem directly or use another number formatting library, like [dnum](https://github.com/bpierre/dnum) instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v1-to-v2.md","from":26829,"to":27102}<fsm-vh3gqscxm4e>
import { formatUnits } from 'viem' // [!code ++]

const result = useToken({
  address: '0x6B175474E89094C44Da98b954EedeAC495271d0F',
  formatUnits: 'ether',
})
result.data!.totalSupply.formatted  // [!code --]
formatUnits(result.data!.totalSupply.value, 18)  // [!code ++]
```

This allows us to invert control to users so they can handle number formatting however they want, taking into account precision, localization, and more.

### Renamed hooks

The following hooks were renamed to better reflect their functionality and underlying [Viem](https://viem.sh) actions:

* `useContractRead` is now [`useReadContract`](/react/api/hooks/useReadContract)
* `useContractReads` is now [`useReadContracts`](/react/api/hooks/useReadContracts)
* `useContractWrite` is now [`useWriteContract`](/react/api/hooks/useWriteContract)
* `useContractEvent` is now [`useWatchContractEvent`](/react/api/hooks/useWatchContractEvent)
* `useContractInfiniteReads` is now [`useInfiniteReadContracts`](/react/api/hooks/useInfiniteReadContracts)
* `useFeeData` is now [`useEstimateFeesPerGas`](/react/api/hooks/useEstimateFeesPerGas)
* `useSwitchNetwork` is now [`useSwitchChain`](/react/api/hooks/useSwitchChain)
* `useWaitForTransaction` is now [`useWaitForTransactionReceipt`](/react/api/hooks/useWaitForTransactionReceipt)

### Miscellaneous

* `WagmiConfigProps` renamed to [`WagmiProviderProps`](/react/api/WagmiProvider#parameters).
* `Context` renamed to [`WagmiContext`](/react/api/WagmiProvider#context).

---

---
url: /core/guides/migrate-from-v2-to-v3.md
description: Guide for migrating from Wagmi v2 to v3.
---

# Migrate from v2 to v3

## Overview

Wagmi v3 gives you total control over connector dependencies. Since Wagmi's initial release, Wagmi included required connector dependencies as part of its package to eliminate the need to manage multiple third-party dependencies.

This worked worked well in the early years as a "batteries-included" approach, but didn't allow for more fine-grained control over your dependency tree. By giving you control over connector dependencies, you can decide to only install what you need, manage version bumps at your own pace, and have total control over what third-party code and licenses you bring into your project

To get started, install the latest version of Wagmi.

::: code-group

```bash [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v2-to-v3.md","from":1011,"to":1034}<fsm-vh3gqscxm4e>
pnpm add @wagmi/core@3
```

```bash [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v2-to-v3.md","from":1053,"to":1079}<fsm-vh3gqscxm4e>
npm install @wagmi/core@3
```

```bash [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v2-to-v3.md","from":1099,"to":1122}<fsm-vh3gqscxm4e>
yarn add @wagmi/core@3
```

```bash [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v2-to-v3.md","from":1141,"to":1163}<fsm-vh3gqscxm4e>
bun add @wagmi/core@3
```

:::

::: info Not ready to migrate yet?
The Wagmi v2 docs are still available at [2.x.wagmi.sh/core](https://2.x.wagmi.sh/core).
:::

## Install Connector Dependencies

All connector dependencies are now optional peer dependencies. This means that if you want to use a specific connector, you need to install its required dependencies.

For example, if you are using the `porto` connector, you also need to install the `porto` npm package. Required connector dependencies are listed below (along with links to npm, GitHub, [Socket](https://socket.dev), and licenses) and on docs pages under the "Install" section.

:::tip Secure your supply-chain
Since you are now responsible for managing connector dependencies, take a look at Wagmi's Security Getting Started section to brush up on some best practices.
:::

:::tip Building a developer tool on top of Wagmi?
If you are developing a library with Wagmi, you should decide if you want to install connector dependencies as part of your library ("batteries-included" approach) or pass the responsibility onto your users (more flexibility and control).
:::

### baseAccount

`baseAccount` requires `@base-org/account`

::: code-group

```bash-vue [pnpm]
pnpm add @base-org/account@{{packageJson?.peerDependencies?.['@base-org/account']}}
```

```bash-vue [npm]
npm install @base-org/account@{{packageJson?.peerDependencies?.['@base-org/account']}}
```

```bash-vue [yarn]
yarn add @base-org/account@{{packageJson?.peerDependencies?.['@base-org/account']}}
```

```bash-vue [bun]
bun add @base-org/account@{{packageJson?.peerDependencies?.['@base-org/account']}}
```

:::

### coinbaseWallet

`coinbaseWallet` requires `@coinbase/wallet-sdk`

::: code-group

```bash-vue [pnpm]
pnpm add @coinbase/wallet-sdk@{{packageJson?.peerDependencies?.['@coinbase/wallet-sdk']}}
```

```bash-vue [npm]
npm install @coinbase/wallet-sdk@{{packageJson?.peerDependencies?.['@coinbase/wallet-sdk']}}
```

```bash-vue [yarn]
yarn add @coinbase/wallet-sdk@{{packageJson?.peerDependencies?.['@coinbase/wallet-sdk']}}
```

```bash-vue [bun]
bun add @coinbase/wallet-sdk@{{packageJson?.peerDependencies?.['@coinbase/wallet-sdk']}}
```

:::

### metaMask

`metaMask` requires `@metamask/connect-evm`

::: code-group

```bash-vue [pnpm]
pnpm add @metamask/connect-evm@{{packageJson?.peerDependencies?.['@metamask/connect-evm']}}
```

```bash-vue [npm]
npm install @metamask/connect-evm@{{packageJson?.peerDependencies?.['@metamask/connect-evm']}}
```

```bash-vue [yarn]
yarn add @metamask/connect-evm@{{packageJson?.peerDependencies?.['@metamask/connect-evm']}}
```

```bash-vue [bun]
bun add @metamask/connect-evm@{{packageJson?.peerDependencies?.['@metamask/connect-evm']}}
```

:::

### porto

`porto` requires `porto`

::: code-group

```bash-vue [pnpm]
pnpm add porto@{{packageJson?.peerDependencies?.['porto']}}
```

```bash-vue [npm]
npm install porto@{{packageJson?.peerDependencies?.['porto']}}
```

```bash-vue [yarn]
yarn add porto@{{packageJson?.peerDependencies?.['porto']}}
```

```bash-vue [bun]
bun add porto@{{packageJson?.peerDependencies?.['porto']}}
```

:::

### safe

`safe` requires `@safe-global/safe-apps-provider` and `@safe-global/safe-apps-sdk`

::: code-group

```bash-vue [pnpm]
pnpm add @safe-global/safe-apps-provider@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-provider']}} @safe-global/safe-apps-sdk@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-sdk']}} 
```

```bash-vue [npm]
npm install @safe-global/safe-apps-provider@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-provider']}} @safe-global/safe-apps-sdk@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-sdk']}} 
```

```bash-vue [yarn]
yarn add @safe-global/safe-apps-provider@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-provider']}} @safe-global/safe-apps-sdk@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-sdk']}} 
```

```bash-vue [bun]
bun add @safe-global/safe-apps-provider@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-provider']}} @safe-global/safe-apps-sdk@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-sdk']}} 
```

:::

### walletConnect

`walletConnect` requires `@walletconnect/ethereum-provider`

::: code-group

```bash-vue [pnpm]
pnpm add @walletconnect/ethereum-provider@{{packageJson?.peerDependencies?.['@walletconnect/ethereum-provider']}}
```

```bash-vue [npm]
npm install @walletconnect/ethereum-provider@{{packageJson?.peerDependencies?.['@walletconnect/ethereum-provider']}}
```

```bash-vue [yarn]
yarn add @walletconnect/ethereum-provider@{{packageJson?.peerDependencies?.['@walletconnect/ethereum-provider']}}
```

```bash-vue [bun]
bun add @walletconnect/ethereum-provider@{{packageJson?.peerDependencies?.['@walletconnect/ethereum-provider']}}
```

:::

## Bumped Minimum TypeScript Version

The minimum supported TypeScript version is now `5.7.3` instead of `5.0.4`. Older versions of TypeScript should continue to work, but since [TypeScript doesn't follow semver](https://www.learningtypescript.com/articles/why-typescript-doesnt-follow-strict-semantic-versioning) we recommend you update to at least `5.7.3`. This should be relatively simple as there haven't been any breaking changes since `5.0.4`.

## Migrate v2 Deprecations

v2 deprecations Review the v2 migration guide for more information.

## Deprecations

### Renamed Account Actions

At the core of Wagmi are connections between apps and Ethereum providers (e.g. EIP-1193), `getAccount`, `switchAccount`, and `watchAccount` are renamed to `getConnection`, `switchConnection`, and `watchConnection` to more accurately represent to how Wagmi works.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v2-to-v3.md","from":1670,"to":1887}<fsm-vh3gqscxm4e>
import {
  getAccount, // [!code --]
  getConnection, // [!code ++]
  switchAccount, // [!code --]
  switchConnection, // [!code ++]
  watchAccount, // [!code --]
  watchConnection, // [!code ++]
} from '@wagmi/core'
```

`switchAccountMutationOptions` is also updated to `switchConnectionMutationOptions`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/migrate-from-v2-to-v3.md","from":1984,"to":2116}<fsm-vh3gqscxm4e>
import {
  switchAccountMutationOptions, // [!code --]
  switchConnectionMutationOptions, // [!code ++]
} from '@wagmi/core/query'

```

---

---
url: /react/guides/migrate-from-v2-to-v3.md
description: Guide for migrating from Wagmi v2 to v3.
---

# Migrate from v2 to v3

## Overview

Wagmi v3 gives you total control over connector dependencies. Since Wagmi's initial release, Wagmi included required connector dependencies as part of its package to eliminate the need to manage multiple third-party dependencies.

This worked worked well in the early years as a "batteries-included" approach, but didn't allow for more fine-grained control over your dependency tree. By giving you control over connector dependencies, you can decide to only install what you need, manage version bumps at your own pace, and have total control over what third-party code and licenses you bring into your project

To get started, install the latest version of Wagmi.

::: code-group

```bash [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v2-to-v3.md","from":1012,"to":1029}<fsm-vh3gqscxm4e>
pnpm add wagmi@3
```

```bash [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v2-to-v3.md","from":1048,"to":1068}<fsm-vh3gqscxm4e>
npm install wagmi@3
```

```bash [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v2-to-v3.md","from":1088,"to":1105}<fsm-vh3gqscxm4e>
yarn add wagmi@3
```

```bash [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v2-to-v3.md","from":1124,"to":1140}<fsm-vh3gqscxm4e>
bun add wagmi@3
```

:::

::: info Not ready to migrate yet?
The Wagmi v2 docs are still available at [2.x.wagmi.sh/react](https://2.x.wagmi.sh/react).
:::

## Install Connector Dependencies

All connector dependencies are now optional peer dependencies. This means that if you want to use a specific connector, you need to install its required dependencies.

For example, if you are using the `porto` connector, you also need to install the `porto` npm package. Required connector dependencies are listed below (along with links to npm, GitHub, [Socket](https://socket.dev), and licenses) and on docs pages under the "Install" section.

:::tip Secure your supply-chain
Since you are now responsible for managing connector dependencies, take a look at Wagmi's Security Getting Started section to brush up on some best practices.
:::

:::tip Building a developer tool on top of Wagmi?
If you are developing a library with Wagmi, you should decide if you want to install connector dependencies as part of your library ("batteries-included" approach) or pass the responsibility onto your users (more flexibility and control).
:::

### baseAccount

`baseAccount` requires `@base-org/account`

::: code-group

```bash-vue [pnpm]
pnpm add @base-org/account@{{packageJson?.peerDependencies?.['@base-org/account']}}
```

```bash-vue [npm]
npm install @base-org/account@{{packageJson?.peerDependencies?.['@base-org/account']}}
```

```bash-vue [yarn]
yarn add @base-org/account@{{packageJson?.peerDependencies?.['@base-org/account']}}
```

```bash-vue [bun]
bun add @base-org/account@{{packageJson?.peerDependencies?.['@base-org/account']}}
```

:::

### coinbaseWallet

`coinbaseWallet` requires `@coinbase/wallet-sdk`

::: code-group

```bash-vue [pnpm]
pnpm add @coinbase/wallet-sdk@{{packageJson?.peerDependencies?.['@coinbase/wallet-sdk']}}
```

```bash-vue [npm]
npm install @coinbase/wallet-sdk@{{packageJson?.peerDependencies?.['@coinbase/wallet-sdk']}}
```

```bash-vue [yarn]
yarn add @coinbase/wallet-sdk@{{packageJson?.peerDependencies?.['@coinbase/wallet-sdk']}}
```

```bash-vue [bun]
bun add @coinbase/wallet-sdk@{{packageJson?.peerDependencies?.['@coinbase/wallet-sdk']}}
```

:::

### metaMask

`metaMask` requires `@metamask/connect-evm`

::: code-group

```bash-vue [pnpm]
pnpm add @metamask/connect-evm@{{packageJson?.peerDependencies?.['@metamask/connect-evm']}}
```

```bash-vue [npm]
npm install @metamask/connect-evm@{{packageJson?.peerDependencies?.['@metamask/connect-evm']}}
```

```bash-vue [yarn]
yarn add @metamask/connect-evm@{{packageJson?.peerDependencies?.['@metamask/connect-evm']}}
```

```bash-vue [bun]
bun add @metamask/connect-evm@{{packageJson?.peerDependencies?.['@metamask/connect-evm']}}
```

:::

### porto

`porto` requires `porto`

::: code-group

```bash-vue [pnpm]
pnpm add porto@{{packageJson?.peerDependencies?.['porto']}}
```

```bash-vue [npm]
npm install porto@{{packageJson?.peerDependencies?.['porto']}}
```

```bash-vue [yarn]
yarn add porto@{{packageJson?.peerDependencies?.['porto']}}
```

```bash-vue [bun]
bun add porto@{{packageJson?.peerDependencies?.['porto']}}
```

:::

### safe

`safe` requires `@safe-global/safe-apps-provider` and `@safe-global/safe-apps-sdk`

::: code-group

```bash-vue [pnpm]
pnpm add @safe-global/safe-apps-provider@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-provider']}} @safe-global/safe-apps-sdk@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-sdk']}} 
```

```bash-vue [npm]
npm install @safe-global/safe-apps-provider@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-provider']}} @safe-global/safe-apps-sdk@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-sdk']}} 
```

```bash-vue [yarn]
yarn add @safe-global/safe-apps-provider@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-provider']}} @safe-global/safe-apps-sdk@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-sdk']}} 
```

```bash-vue [bun]
bun add @safe-global/safe-apps-provider@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-provider']}} @safe-global/safe-apps-sdk@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-sdk']}} 
```

:::

### walletConnect

`walletConnect` requires `@walletconnect/ethereum-provider`

::: code-group

```bash-vue [pnpm]
pnpm add @walletconnect/ethereum-provider@{{packageJson?.peerDependencies?.['@walletconnect/ethereum-provider']}}
```

```bash-vue [npm]
npm install @walletconnect/ethereum-provider@{{packageJson?.peerDependencies?.['@walletconnect/ethereum-provider']}}
```

```bash-vue [yarn]
yarn add @walletconnect/ethereum-provider@{{packageJson?.peerDependencies?.['@walletconnect/ethereum-provider']}}
```

```bash-vue [bun]
bun add @walletconnect/ethereum-provider@{{packageJson?.peerDependencies?.['@walletconnect/ethereum-provider']}}
```

:::

## Bumped Minimum TypeScript Version

The minimum supported TypeScript version is now `5.7.3` instead of `5.0.4`. Older versions of TypeScript should continue to work, but since [TypeScript doesn't follow semver](https://www.learningtypescript.com/articles/why-typescript-doesnt-follow-strict-semantic-versioning) we recommend you update to at least `5.7.3`. This should be relatively simple as there haven't been any breaking changes since `5.0.4`.

## Migrate v2 Deprecations

v2 deprecations Review the v2 migration guide for more information.

## Deprecations

### Renamed Account Hooks

At the core of Wagmi are connections between apps and Ethereum providers (e.g. EIP-1193), `useAccount`, `useAccountEffect`, and `useSwitchAccount` are renamed to `useConnection`, `useConnectionEffect`, and `useSwitchConnection` to more accurately represent to how Wagmi works.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v2-to-v3.md","from":1661,"to":1886}<fsm-vh3gqscxm4e>
import {
  useAccount, // [!code --]
  useConnection, // [!code ++]
  useAccountEffect, // [!code --]
  useConnectionEffect, // [!code ++]
  useSwitchAccount, // [!code --]
  useSwitchConnection, // [!code ++]
} from 'wagmi'
```

### Renamed mutateFn

Renamed custom mutate function names to `mutate`/`mutateAsync` to reduce destructure key renaming fatigue and align with TanStack Query terminology.

##### Before

Had to destructure hook result and often rename keys when using multiple of the same hook. Could decide not to destructure, but syntax becomes awkward for mutate functions (e.g. `connect.connect` or `connect.connectAsync`).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v2-to-v3.md","from":2308,"to":2552}<fsm-vh3gqscxm4e>
const { connect, isPending: connectIsPending } = useConnect()
const { writeContract: transfer, error: transferError, isPending: transferIsPending } = useWriteContract()
const { writeContract: approve, error: approveError } = useWriteContract()
```

##### After

Allows you to name the hook result whatever you want and not worry about also renaming properties.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v2-to-v3.md","from":2676,"to":2901}<fsm-vh3gqscxm4e>
const connect = useConnect() // connect.mutate, connect.isPending
const transfer = useWriteContract() // transfer.mutate, transfer.error, transfer.isPending
const approve = useWriteContract() // approve.mutate, approve.error
```

### Removed `useConnect().connectors` & `useReconnect().connectors`

Moving forward, `useConnect().connectors` and `useReconnect().connectors` are no longer supported. Use [`useConnectors`](/react/api/hooks/useConnectors) instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v2-to-v3.md","from":3144,"to":3411}<fsm-vh3gqscxm4e>
import { useConnect, useReconnect } from 'wagmi' // [!code --]
import { useConnectors } from 'wagmi' // [!code ++]

const { connectors } = useConnect() // [!code --]
const { connectors } = useReconnect() // [!code --]
const connectors = useConnectors() // [!code ++]
```

### Removed `useDisconnect().connectors` & `useSwitchConnection().connectors`

Moving forward, `useDisconnect().connectors` and `useSwitchConnection().connectors` are no longer supported. Use [`useConnections`](/react/api/hooks/useConnections) instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v2-to-v3.md","from":3676,"to":4053}<fsm-vh3gqscxm4e>
import { useDisconnect, useSwitchConnection } from 'wagmi' // [!code --]
import { useConnections } from 'wagmi' // [!code ++]

const { connectors } = useDisconnect() // [!code --]
const { connectors } = useSwitchConnection() // [!code --]
const connections = useConnections() // [!code ++]
const connectors = connections.map((connection) => connection.connector) // [!code ++]
```

### Removed `useSwitchChain().chains`

Moving forward, `useSwitchChain().chains` is no longer supported. Use [`useChains`](/react/api/hooks/useChains) instead.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/migrate-from-v2-to-v3.md","from":4225,"to":4418}<fsm-vh3gqscxm4e>
import { useSwitchChain } from 'wagmi' // [!code --]
import { useChains } from 'wagmi' // [!code ++]

const { chains } = useSwitchChain() // [!code --]
const chains = useChains() // [!code ++]
```

---

---
url: /core/api/connectors/mock.md
---

# mock

Connector for mocking Wagmi functionality.

## Import

```ts-vue
import { mock } from '{{connectorsPackageName}}'
```

## Usage

```ts-vue{3,8-14}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { mock } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [
    mock({
      accounts: [
        '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
        '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
        '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
      ],
    }),
  ],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type MockParameters } from '{{connectorsPackageName}}'
```

### accounts

`readonly [Address, ...Address[]]`

Accounts to use with the connector.

```ts-vue
import { mock } from '{{connectorsPackageName}}'

const connector = mock({
  accounts: [ // [!code focus]
    '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266', // [!code focus]
    '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', // [!code focus]
    '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC', // [!code focus]
    '0x90F79bf6EB2c4f870365E785982E1f101E93b906', // [!code focus]
    '0x15d34aaf54267db7d7c367839aaf71a00a2c6a65', // [!code focus]
    '0x9965507D1a55bcC2695C58ba16FB37d819B0A4dc', // [!code focus]
    '0x976EA74026E726554dB657fA54763abd0C3a0aa9', // [!code focus]
    '0x14dC79964da2C08b23698B3D3cc7Ca32193d9955', // [!code focus]
    '0x23618e81E3f5cdF7f54C3d65f7FBc0aBf5B21E8f', // [!code focus]
    '0xa0Ee7A142d267C1f36714E4a8F75612F20a79720', // [!code focus]
  ], // [!code focus]
})
```

### features

`{ connectError?: boolean | Error | undefined; reconnect?: boolean | undefined; signMessageError?: boolean | Error | undefined; signTypedDataError?: boolean | Error | undefined; switchChainError?: boolean | Error | undefined; } | undefined`

Feature flags that change behavior of Wagmi internals.

```ts-vue
import { mock } from '{{connectorsPackageName}}'
import { UserRejectedRequestError } from 'viem'

const connector = mock({
  accounts: [
    '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
    '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
  ],
  features: { // [!code focus]
    connectError: new UserRejectedRequestError(new Error('Failed to connect.')), // [!code focus]
    reconnect: false, // [!code focus]
  }, // [!code focus]
})
```

#### defaultConnected

`boolean | undefined`

Whether the connector is connected by default.

#### connectError

`boolean | Error | undefined`

Whether to throw an error when `connector.connect` is called.

#### reconnect

`boolean | undefined`

Enables reconnecting to connector.

#### signMessageError

`boolean | Error | undefined`

Whether to throw an error when `'personal_sign'` is called.

#### signTypedDataError

`boolean | Error | undefined`

Whether to throw an error when `'eth_signTypedData_v4'` is called.

#### switchChainError

`boolean | Error | undefined`

Whether to throw an error when `connector.switchChain` is called.

---

---
url: /react/api/connectors/mock.md
---

# mock

Connector for mocking Wagmi functionality.

## Import

```ts-vue
import { mock } from '{{connectorsPackageName}}'
```

## Usage

```ts-vue{3,8-14}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { mock } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [
    mock({
      accounts: [
        '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
        '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
        '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
      ],
    }),
  ],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type MockParameters } from '{{connectorsPackageName}}'
```

### accounts

`readonly [Address, ...Address[]]`

Accounts to use with the connector.

```ts-vue
import { mock } from '{{connectorsPackageName}}'

const connector = mock({
  accounts: [ // [!code focus]
    '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266', // [!code focus]
    '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', // [!code focus]
    '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC', // [!code focus]
    '0x90F79bf6EB2c4f870365E785982E1f101E93b906', // [!code focus]
    '0x15d34aaf54267db7d7c367839aaf71a00a2c6a65', // [!code focus]
    '0x9965507D1a55bcC2695C58ba16FB37d819B0A4dc', // [!code focus]
    '0x976EA74026E726554dB657fA54763abd0C3a0aa9', // [!code focus]
    '0x14dC79964da2C08b23698B3D3cc7Ca32193d9955', // [!code focus]
    '0x23618e81E3f5cdF7f54C3d65f7FBc0aBf5B21E8f', // [!code focus]
    '0xa0Ee7A142d267C1f36714E4a8F75612F20a79720', // [!code focus]
  ], // [!code focus]
})
```

### features

`{ connectError?: boolean | Error | undefined; reconnect?: boolean | undefined; signMessageError?: boolean | Error | undefined; signTypedDataError?: boolean | Error | undefined; switchChainError?: boolean | Error | undefined; } | undefined`

Feature flags that change behavior of Wagmi internals.

```ts-vue
import { mock } from '{{connectorsPackageName}}'
import { UserRejectedRequestError } from 'viem'

const connector = mock({
  accounts: [
    '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
    '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
  ],
  features: { // [!code focus]
    connectError: new UserRejectedRequestError(new Error('Failed to connect.')), // [!code focus]
    reconnect: false, // [!code focus]
  }, // [!code focus]
})
```

#### defaultConnected

`boolean | undefined`

Whether the connector is connected by default.

#### connectError

`boolean | Error | undefined`

Whether to throw an error when `connector.connect` is called.

#### reconnect

`boolean | undefined`

Enables reconnecting to connector.

#### signMessageError

`boolean | Error | undefined`

Whether to throw an error when `'personal_sign'` is called.

#### signTypedDataError

`boolean | Error | undefined`

Whether to throw an error when `'eth_signTypedData_v4'` is called.

#### switchChainError

`boolean | Error | undefined`

Whether to throw an error when `connector.switchChain` is called.

---

---
url: /shared/connectors/mock.md
---
# mock

Connector for mocking Wagmi functionality.

## Import

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/mock.md","from":185,"to":234}<fsm-vh3gqscxm4e>
import { mock } from '{{connectorsPackageName}}'
```

## Usage

```ts-vue{3,8-14}
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/mock.md","from":267,"to":800}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { mock } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [
    mock({
      accounts: [
        '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
        '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
        '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
      ],
    }),
  ],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/mock.md","from":830,"to":894}<fsm-vh3gqscxm4e>
import { type MockParameters } from '{{connectorsPackageName}}'
```

### accounts

`readonly [Address, ...Address[]]`

Accounts to use with the connector.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/mock.md","from":996,"to":1797}<fsm-vh3gqscxm4e>
import { mock } from '{{connectorsPackageName}}'

const connector = mock({
  accounts: [ // [!code focus]
    '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266', // [!code focus]
    '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', // [!code focus]
    '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC', // [!code focus]
    '0x90F79bf6EB2c4f870365E785982E1f101E93b906', // [!code focus]
    '0x15d34aaf54267db7d7c367839aaf71a00a2c6a65', // [!code focus]
    '0x9965507D1a55bcC2695C58ba16FB37d819B0A4dc', // [!code focus]
    '0x976EA74026E726554dB657fA54763abd0C3a0aa9', // [!code focus]
    '0x14dC79964da2C08b23698B3D3cc7Ca32193d9955', // [!code focus]
    '0x23618e81E3f5cdF7f54C3d65f7FBc0aBf5B21E8f', // [!code focus]
    '0xa0Ee7A142d267C1f36714E4a8F75612F20a79720', // [!code focus]
  ], // [!code focus]
})
```

### features

`{ connectError?: boolean | Error | undefined; reconnect?: boolean | undefined; signMessageError?: boolean | Error | undefined; signTypedDataError?: boolean | Error | undefined; switchChainError?: boolean | Error | undefined; } | undefined`

Feature flags that change behavior of Wagmi internals.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/mock.md","from":2124,"to":2609}<fsm-vh3gqscxm4e>
import { mock } from '{{connectorsPackageName}}'
import { UserRejectedRequestError } from 'viem'

const connector = mock({
  accounts: [
    '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
    '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
  ],
  features: { // [!code focus]
    connectError: new UserRejectedRequestError(new Error('Failed to connect.')), // [!code focus]
    reconnect: false, // [!code focus]
  }, // [!code focus]
})
```

#### defaultConnected

`boolean | undefined`

Whether the connector is connected by default.

#### connectError

`boolean | Error | undefined`

Whether to throw an error when `connector.connect` is called.

#### reconnect

`boolean | undefined`

Enables reconnecting to connector.

#### signMessageError

`boolean | Error | undefined`

Whether to throw an error when `'personal_sign'` is called.

#### signTypedDataError

`boolean | Error | undefined`

Whether to throw an error when `'eth_signTypedData_v4'` is called.

#### switchChainError

`boolean | Error | undefined`

Whether to throw an error when `connector.switchChain` is called.

---

---
url: /solid/api/connectors/mock.md
---

# mock

Connector for mocking Wagmi functionality.

## Import

```ts-vue
import { mock } from '{{connectorsPackageName}}'
```

## Usage

```ts-vue{3,8-14}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { mock } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [
    mock({
      accounts: [
        '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
        '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
        '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
      ],
    }),
  ],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type MockParameters } from '{{connectorsPackageName}}'
```

### accounts

`readonly [Address, ...Address[]]`

Accounts to use with the connector.

```ts-vue
import { mock } from '{{connectorsPackageName}}'

const connector = mock({
  accounts: [ // [!code focus]
    '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266', // [!code focus]
    '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', // [!code focus]
    '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC', // [!code focus]
    '0x90F79bf6EB2c4f870365E785982E1f101E93b906', // [!code focus]
    '0x15d34aaf54267db7d7c367839aaf71a00a2c6a65', // [!code focus]
    '0x9965507D1a55bcC2695C58ba16FB37d819B0A4dc', // [!code focus]
    '0x976EA74026E726554dB657fA54763abd0C3a0aa9', // [!code focus]
    '0x14dC79964da2C08b23698B3D3cc7Ca32193d9955', // [!code focus]
    '0x23618e81E3f5cdF7f54C3d65f7FBc0aBf5B21E8f', // [!code focus]
    '0xa0Ee7A142d267C1f36714E4a8F75612F20a79720', // [!code focus]
  ], // [!code focus]
})
```

### features

`{ connectError?: boolean | Error | undefined; reconnect?: boolean | undefined; signMessageError?: boolean | Error | undefined; signTypedDataError?: boolean | Error | undefined; switchChainError?: boolean | Error | undefined; } | undefined`

Feature flags that change behavior of Wagmi internals.

```ts-vue
import { mock } from '{{connectorsPackageName}}'
import { UserRejectedRequestError } from 'viem'

const connector = mock({
  accounts: [
    '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
    '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
  ],
  features: { // [!code focus]
    connectError: new UserRejectedRequestError(new Error('Failed to connect.')), // [!code focus]
    reconnect: false, // [!code focus]
  }, // [!code focus]
})
```

#### defaultConnected

`boolean | undefined`

Whether the connector is connected by default.

#### connectError

`boolean | Error | undefined`

Whether to throw an error when `connector.connect` is called.

#### reconnect

`boolean | undefined`

Enables reconnecting to connector.

#### signMessageError

`boolean | Error | undefined`

Whether to throw an error when `'personal_sign'` is called.

#### signTypedDataError

`boolean | Error | undefined`

Whether to throw an error when `'eth_signTypedData_v4'` is called.

#### switchChainError

`boolean | Error | undefined`

Whether to throw an error when `connector.switchChain` is called.

---

---
url: /vue/api/connectors/mock.md
---

# mock

Connector for mocking Wagmi functionality.

## Import

```ts-vue
import { mock } from '{{connectorsPackageName}}'
```

## Usage

```ts-vue{3,8-14}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { mock } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [
    mock({
      accounts: [
        '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
        '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
        '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
      ],
    }),
  ],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type MockParameters } from '{{connectorsPackageName}}'
```

### accounts

`readonly [Address, ...Address[]]`

Accounts to use with the connector.

```ts-vue
import { mock } from '{{connectorsPackageName}}'

const connector = mock({
  accounts: [ // [!code focus]
    '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266', // [!code focus]
    '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', // [!code focus]
    '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC', // [!code focus]
    '0x90F79bf6EB2c4f870365E785982E1f101E93b906', // [!code focus]
    '0x15d34aaf54267db7d7c367839aaf71a00a2c6a65', // [!code focus]
    '0x9965507D1a55bcC2695C58ba16FB37d819B0A4dc', // [!code focus]
    '0x976EA74026E726554dB657fA54763abd0C3a0aa9', // [!code focus]
    '0x14dC79964da2C08b23698B3D3cc7Ca32193d9955', // [!code focus]
    '0x23618e81E3f5cdF7f54C3d65f7FBc0aBf5B21E8f', // [!code focus]
    '0xa0Ee7A142d267C1f36714E4a8F75612F20a79720', // [!code focus]
  ], // [!code focus]
})
```

### features

`{ connectError?: boolean | Error | undefined; reconnect?: boolean | undefined; signMessageError?: boolean | Error | undefined; signTypedDataError?: boolean | Error | undefined; switchChainError?: boolean | Error | undefined; } | undefined`

Feature flags that change behavior of Wagmi internals.

```ts-vue
import { mock } from '{{connectorsPackageName}}'
import { UserRejectedRequestError } from 'viem'

const connector = mock({
  accounts: [
    '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
    '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    '0x3C44CdDdB6a900fa2b585dd299e03d12FA4293BC',
  ],
  features: { // [!code focus]
    connectError: new UserRejectedRequestError(new Error('Failed to connect.')), // [!code focus]
    reconnect: false, // [!code focus]
  }, // [!code focus]
})
```

#### defaultConnected

`boolean | undefined`

Whether the connector is connected by default.

#### connectError

`boolean | Error | undefined`

Whether to throw an error when `connector.connect` is called.

#### reconnect

`boolean | undefined`

Enables reconnecting to connector.

#### signMessageError

`boolean | Error | undefined`

Whether to throw an error when `'personal_sign'` is called.

#### signTypedDataError

`boolean | Error | undefined`

Whether to throw an error when `'eth_signTypedData_v4'` is called.

#### switchChainError

`boolean | Error | undefined`

Whether to throw an error when `connector.switchChain` is called.

---

---
url: /core/api/actions/multicall.md
---
# multicall

Action for batching up multiple functions on a contract in a single RPC call via the [Multicall3 contract](https://github.com/mds1/multicall).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/multicall.md","from":174,"to":214}<fsm-vh3gqscxm4e>
import { multicall } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/multicall.md","from":261,"to":957}<fsm-vh3gqscxm4e>
import { multicall } from '@wagmi/core'
import { config } from './config'

const wagmigotchiContract = {
  address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
  abi: wagmigotchiABI,
} as const
const mlootContract = {
  address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
  abi: mlootABI,
} as const

const result = await multicall(config, {
  contracts: [
    {
      ...wagmigotchiContract,
      functionName: 'getAlive',
    },
    {
      ...wagmigotchiContract,
      functionName: 'getBoredom',
    },
    {
      ...mlootContract,
      functionName: 'getChest',
      args: [69],
    },
    {
      ...mlootContract,
      functionName: 'getWaist',
      args: [69],
    },
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/multicall.md","from":1028,"to":1083}<fsm-vh3gqscxm4e>
import { type MulticallParameters } from '@wagmi/core'
```

### contracts

`readonly Contract[]`

Set of contracts to call.

#### abi

`Abi | undefined`

The contract's ABI. Check out the [TypeScript docs](/react/typescript#const-assert-abis-typed-data) for how to set up ABIs for maximum type inference and safety.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/multicall.md","from":1379,"to":1688}<fsm-vh3gqscxm4e>
import { multicall } from '@wagmi/core'
import { config } from './config'

const result = await multicall(config, {
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
      abi: mlootABI, // [!code hl]
      functionName: 'getChest',
      args: [69],
    },
    // ...
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

#### address

`Address | undefined`

The contract's address.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/multicall.md","from":1835,"to":2144}<fsm-vh3gqscxm4e>
import { multicall } from '@wagmi/core'
import { config } from './config'

const result = await multicall(config, {
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df', // [!code hl]
      abi: mlootABI,
      functionName: 'getChest',
      args: [69],
    },
    // ...
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

#### args

`readonly unknown[] | undefined`

* Arguments to pass when calling the contract.
* Inferred from [`abi`](#abi) and [`functionName`](#functionname).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/multicall.md","from":2389,"to":2698}<fsm-vh3gqscxm4e>
import { multicall } from '@wagmi/core'
import { config } from './config'

const result = await multicall(config, {
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
      abi: mlootABI,
      functionName: 'getChest',
      args: [69], // [!code hl]
    },
    // ...
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

#### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/multicall.md","from":2883,"to":3210}<fsm-vh3gqscxm4e>
import { multicall } from '@wagmi/core'
import { config } from './config'

const result = await multicall(config, {
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
      abi: mlootABI,
      functionName: 'getChest',
      args: [69],
      chainId: 1, // [!code hl]
    },
    // ...
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

#### functionName

`string | undefined`

* Function to call on the contract.
* Inferred from [`abi`](#abi).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/multicall.md","from":3405,"to":3714}<fsm-vh3gqscxm4e>
import { multicall } from '@wagmi/core'
import { config } from './config'

const result = await multicall(config, {
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
      abi: mlootABI,
      functionName: 'getChest', // [!code hl]
      args: [69],
    },
    // ...
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### allowFailure

`boolean`

Whether or not the Hook should throw if a call reverts. If set to `true` (default), and a call reverts, then `multicall` will fail silently and its error will be logged in the results array. Defaults to `true`.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/multicall.md","from":4040,"to":4372}<fsm-vh3gqscxm4e>
import { multicall } from '@wagmi/core'
import { config } from './config'

const result = await multicall(config, {
  allowFailure: false, // [!code hl]
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
      abi: mlootABI,
      functionName: 'getChest',
      args: [69],
    },
    // ...
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### batchSize

`number`

The maximum size (in bytes) for each calldata chunk. Set to `0` to disable the size limit. Defaults to `1024`.

> Note: Some RPC Providers limit the amount of calldata (`data`) that can be sent in a single `eth_call` request. It is best to check with your RPC Provider to see if there are any calldata size limits to `eth_call` requests.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/multicall.md","from":4821,"to":5150}<fsm-vh3gqscxm4e>
import { multicall } from '@wagmi/core'
import { config } from './config'

const result = await multicall(config, {
  batchSize: 1_024, // [!code hl]
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
      abi: mlootABI,
      functionName: 'getChest',
      args: [69],
    },
    // ...
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`number`

The block number to perform the read against.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/multicall.md","from":5309,"to":5641}<fsm-vh3gqscxm4e>
import { multicall } from '@wagmi/core'
import { config } from './config'

const result = await multicall(config, {
  blockNumber: 69420n, // [!code hl]
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
      abi: mlootABI,
      functionName: 'getChest',
      args: [69],
    },
    // ...
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to read against.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/multicall.md","from":5840,"to":6169}<fsm-vh3gqscxm4e>
import { multicall } from '@wagmi/core'
import { config } from './config'

const result = await multicall(config, {
  blockTag: 'safe', // [!code hl]
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
      abi: mlootABI,
      functionName: 'getChest',
      args: [69],
    },
    // ...
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### multicallAddress

`Address`

Address of multicall contract.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/multicall.md","from":6319,"to":6694}<fsm-vh3gqscxm4e>
import { multicall } from '@wagmi/core'
import { config } from './config'

const result = await multicall(config, {
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
      abi: mlootABI,
      functionName: 'getChest',
      args: [69],
    },
    // ...
  ],
  multicallAddress: '0xca11bde05977b3631167028862be2a173976ca11', // [!code hl]
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/multicall.md","from":6768,"to":6823}<fsm-vh3gqscxm4e>
import { type MulticallReturnType } from '@wagmi/core'
```

## Type Inference

With [`contracts[number]['abi']`](#abi) setup correctly, TypeScript will infer the correct types for [`functionName`](#functionname), [`args`](#args), and the return type. See the Wagmi [TypeScript docs](/core/typescript) for more information.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/multicall.md","from":7108,"to":7162}<fsm-vh3gqscxm4e>
import { type MulticallErrorType } from '@wagmi/core'
```

## Viem

* [`multicall`](https://viem.sh/docs/contract/multicall)

---

---
url: /vue/api/Nuxt.md
---
# Nuxt

[Nuxt Module](https://nuxt.com/docs/guide/concepts/modules) for Wagmi. Adds all [Composables](/vue/api/composables) as [auto-imports](https://nuxt.com/docs/guide/concepts/auto-imports).

## Usage

::: code-group

```ts twoslash [nuxt.config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/Nuxt.md","from":252,"to":2065}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"a2f343760fd46f812e97826b5b6d3f1fdddb4ec07dbbf76cb4790a6383711285","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIBjCGDhpesAGbswMAHIBXegGEhkgOaJeAERiTp8pSvaqAOmHYBbLBFKiJU2QrTKwayiBHMbSAJxVWMMFU0fCQARgA2KjRPVRgGRBA7PUdnVz97JAAGKn58T2Z+GnJEbwBfCnRsXATCEnIouniQFg4uPiSHAxcjRiksOTQNAEkwfqdDVQAefXHu1QpeVKMAGWYMMgBZOOYAPm5h0YGlqZnjhePV9dIt6J3TCysbMR17U4m3Dy9EcIBmPwCgiFEBEojE4ngOm85m4ONIkAAmHJ5UgFIphACs5UqODwtTIbho9CYWFIEBwNgwfHM0Dk/jgAH4NIwRKQpKpeAAfXjiNhwGCc3gzDY0/yTZhgDALAAKnjQnFYYolOwWPNYfJ2AuQzLQrMCAqFIpgk2FUFpMAA8lg5UI4NLZfLjYbLdbhMrubyYBquXIwB0oNx6QtGMBTLww7xkLQNCy2QBdDTijAAblMpQFPr9AdjArAtNY6d9L2k/uQ2e9hd0MCgbigEH4CASJrNcF4nn5M14jQCcHYNt4AHd8OxcgJxZ36AEoLx2GgW4JSPzxD7Cr2wGwZxhW77W1Ap5O6S2pDRVCiXXAAHSmUwAUQK+F41NN/mnLZgM/wZFbvBjesYg+H978GOC7iJ+aAQF+WAFAA1swsQLNYvAAEb8swvBQcEvDgV+kj+NwCxoWgchYM+/bvlhH4PoarYtpIpAiN+OpsluU7BPyZJnjRX58oI24QEhABWMCFAhpBbtOYCwvyj5mtyy4upeYAdkx8BYRBC5wBArAkJ2d7TjQ5gSRR0mGi2ngopucg9nqkCwLwC4AI5yOwC7ocwmG9GAvAAAa2TAAD6Ml0t5fDiqxH5eWRrD5ih9nwFpJBTuIpKGSSEBCYUPlwKQ/CaC53nTuIPkAH4FeuXAvrwVlVueBJwQ2yDIOAEA0G4TZ0q2rl0MJAxVt+MBOQEcpsKwm6acZvDWLAYnsIeljWNEYBoOevAAGIuSICxsVRT6qX6Rm+Y4568Wo56zmVrmsBAzCwFAK0ACoRQsQWqeIEAZkZ23eS9cAAPTeaYUAucJ4GkJubbjj1NBQAR25sZuV03UZbBYHkKFykB+ZTWQtWxhQTV0Mwlj+G43lkwJcCmD9GjIKGvC/b9vAAKrWeyUH8LBsS8Gu5gwHTADkAACub0BTv3MLQvZwPzFB0wzvAAEowKw7nsDp2EYO9YlpRlojZblLkC8Vv0/eL/bxbz54UzLcuM1KpJEOwQN6hxq6U15EZCyLaBi6oEAQKo/gALTimwGAY9LCzAFVzAaPzAAaoTwj8AAs6LhAA7PzvClHjtu8CMUnPLoM6rnTS5gCuQi8IwfDAKUpixqYZPeSAsZ4+40RfAAHCn/yBMESAZ6CpCxE0P0whkiB/CAuT5IU+KIPCuc5NA1QgA8C28NHkIpBMOfcilvD897v0nUY/NXtItCPLYOjMLSd+VlCajBnT1Oe4L/ZweY7C/UQcgYC/W9vzPOYBSjcDcLzaISBQBdmEKuPAs4QClFKEAA"}
import { defineNuxtConfig } from 'nuxt/config'

export default defineNuxtConfig({
  modules: ['@wagmi/vue/nuxt'],
})
```

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/Nuxt.md","from":2088,"to":2290}<fsm-vh3gqscxm4e>
<script setup lang="ts">
// No need to import `useConnection`! // [!code focus]
const connection = useConnection() // [!code focus]
</script>

<template>
  Address: {{ connection.address }}
</template>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

---

---
url: /tempo/actions.md
---
# Overview

| Action | Description |
|--------|-------------|
| **AMM Actions** | |
| [`amm.burn`](/tempo/actions/amm.burn) | Burns liquidity tokens and receives the underlying token pair |
| [`amm.getLiquidityBalance`](/tempo/actions/amm.getLiquidityBalance) | Gets the liquidity balance for an address in a specific pool |
| [`amm.getPool`](/tempo/actions/amm.getPool) | Gets the reserves for a liquidity pool |
| [`amm.mint`](/tempo/actions/amm.mint) | Mints liquidity tokens by providing a token pair |
| [`amm.rebalanceSwap`](/tempo/actions/amm.rebalanceSwap) | Performs a rebalance swap between user and validator tokens |
| [`amm.watchBurn`](/tempo/actions/amm.watchBurn) | Watches for liquidity burn events |
| [`amm.watchMint`](/tempo/actions/amm.watchMint) | Watches for liquidity mint events |
| [`amm.watchRebalanceSwap`](/tempo/actions/amm.watchRebalanceSwap) | Watches for rebalance swap events |
| **Faucet Actions** | |
| [`faucet.fund`](/tempo/actions/faucet.fund) | Funds an account with testnet tokens |
| **Fee Actions** | |
| [`fee.getUserToken`](/tempo/actions/fee.getUserToken) | Gets the user's default fee token preference |
| [`fee.setUserToken`](/tempo/actions/fee.setUserToken) | Sets the user's default fee token preference |
| [`fee.watchSetUserToken`](/tempo/actions/fee.watchSetUserToken) | Watches for user token set events |
| **Nonce Actions** | |
| [`nonce.getNonce`](/tempo/actions/nonce.getNonce) | Gets the nonce for an account and nonce key |
| [`nonce.watchNonceIncremented`](/tempo/actions/nonce.watchNonceIncremented) | Watches for nonce incremented events |
| **Policy Actions** | |
| [`policy.create`](#TODO) | Creates a new transfer policy for token access control |
| [`policy.getData`](#TODO) | Gets the data for a transfer policy, including its type and admin address |
| [`policy.isAuthorized`](#TODO) | Checks if an address is authorized by a transfer policy |
| [`policy.modifyBlacklist`](#TODO) | Modifies the blacklist for a blacklist-type transfer policy |
| [`policy.modifyWhitelist`](#TODO) | Modifies the whitelist for a whitelist-type transfer policy |
| [`policy.setAdmin`](#TODO) | Sets the admin for a transfer policy |
| [`policy.watchAdminUpdated`](#TODO) | Watches for policy admin update events |
| [`policy.watchBlacklistUpdated`](#TODO) | Watches for blacklist update events |
| [`policy.watchCreate`](#TODO) | Watches for policy creation events |
| [`policy.watchWhitelistUpdated`](#TODO) | Watches for whitelist update events |
| **Reward Actions** | |
| [`reward.claim`](/tempo/actions/reward.claim) | Claims accumulated rewards for the caller |
| [`reward.getUserRewardInfo`](/tempo/actions/reward.getUserRewardInfo) | Gets reward information for a specific account |
| [`reward.setRecipient`](/tempo/actions/reward.setRecipient) | Sets or changes the reward recipient for a token holder |
| [`reward.distribute`](/tempo/actions/reward.distribute) | Distributes tokens to opted-in holders |
| [`reward.watchRewardRecipientSet`](/tempo/actions/reward.watchRewardRecipientSet) | Watches for reward recipient set events |
| [`reward.watchRewardDistributed`](/tempo/actions/reward.watchRewardDistributed) | Watches for reward distributed events |
| **Stablecoin DEX Actions** | |
| [`dex.buy`](/tempo/actions/dex.buy) | Buys a specific amount of tokens from the Stablecoin DEX orderbook |
| [`dex.cancel`](/tempo/actions/dex.cancel) | Cancels an order from the orderbook |
| [`dex.createPair`](/tempo/actions/dex.createPair) | Creates a new trading pair on the DEX |
| [`dex.getBalance`](/tempo/actions/dex.getBalance) | Gets a user's token balance on the Stablecoin DEX |
| [`dex.getBuyQuote`](/tempo/actions/dex.getBuyQuote) | Gets the quote for buying a specific amount of tokens |
| [`dex.getOrder`](/tempo/actions/dex.getOrder) | Gets an order's details from the orderbook |
| [`dex.getTickLevel`](/tempo/actions/dex.getTickLevel) | Gets the price level information at a specific tick |
| [`dex.getSellQuote`](/tempo/actions/dex.getSellQuote) | Gets the quote for selling a specific amount of tokens |
| [`dex.place`](/tempo/actions/dex.place) | Places a limit order on the orderbook |
| [`dex.placeFlip`](/tempo/actions/dex.placeFlip) | Places a flip order that automatically flips when filled |
| [`dex.sell`](/tempo/actions/dex.sell) | Sells a specific amount of tokens from the Stablecoin DEX orderbook |
| [`dex.watchFlipOrderPlaced`](/tempo/actions/dex.watchFlipOrderPlaced) | Watches for flip order placed events |
| [`dex.watchOrderCancelled`](/tempo/actions/dex.watchOrderCancelled) | Watches for order cancelled events |
| [`dex.watchOrderFilled`](/tempo/actions/dex.watchOrderFilled) | Watches for order filled events |
| [`dex.watchOrderPlaced`](/tempo/actions/dex.watchOrderPlaced) | Watches for order placed events |
| [`dex.withdraw`](/tempo/actions/dex.withdraw) | Withdraws tokens from the DEX to the caller's wallet |
| **Token Actions** | |
| [`token.approve`](/tempo/actions/token.approve) | Approves a spender to transfer TIP-20 tokens on behalf of the caller |
| [`token.burn`](/tempo/actions/token.burn) | Burns TIP-20 tokens from the caller's balance |
| [`token.burnBlocked`](/tempo/actions/token.burnBlocked) | Burns TIP-20 tokens from a blocked address |
| [`token.changeTransferPolicy`](/tempo/actions/token.changeTransferPolicy) | Changes the transfer policy for a TIP-20 token |
| [`token.create`](/tempo/actions/token.create) | Creates a new TIP-20 token and assigns the admin role to the calling account |
| [`token.getAllowance`](/tempo/actions/token.getAllowance) | Gets the amount of tokens that a spender is approved to transfer on behalf of an owner |
| [`token.getBalance`](/tempo/actions/token.getBalance) | Gets the token balance of an address |
| [`token.getMetadata`](/tempo/actions/token.getMetadata) | Gets the metadata for a TIP-20 token, including name, symbol, decimals, currency, and total supply |
| [`token.grantRoles`](/tempo/actions/token.grantRoles) | Grants one or more roles to an address |
| [`token.mint`](/tempo/actions/token.mint) | Mints new TIP-20 tokens to a recipient |
| [`token.pause`](/tempo/actions/token.pause) | Pauses a TIP-20 token, preventing all transfers |
| [`token.renounceRoles`](/tempo/actions/token.renounceRoles) | Renounces one or more roles from the caller's address |
| [`token.revokeRoles`](/tempo/actions/token.revokeRoles) | Revokes one or more roles from an address |
| [`token.setRoleAdmin`](/tempo/actions/token.setRoleAdmin) | Sets the admin role for another role |
| [`token.setSupplyCap`](/tempo/actions/token.setSupplyCap) | Sets the supply cap for a TIP-20 token |
| [`token.transfer`](/tempo/actions/token.transfer) | Transfers TIP-20 tokens from the caller to a recipient |
| [`token.unpause`](/tempo/actions/token.unpause) | Unpauses a TIP-20 token, allowing transfers to resume |
| [`token.watchAdminRole`](/tempo/actions/token.watchAdminRole) | Watches for role admin update events |
| [`token.watchApprove`](/tempo/actions/token.watchApprove) | Watches for token approval events |
| [`token.watchBurn`](/tempo/actions/token.watchBurn) | Watches for token burn events |
| [`token.watchCreate`](/tempo/actions/token.watchCreate) | Watches for new token creation events |
| [`token.watchMint`](/tempo/actions/token.watchMint) | Watches for token mint events |
| [`token.watchRole`](/tempo/actions/token.watchRole) | Watches for role membership update events |
| [`token.watchTransfer`](/tempo/actions/token.watchTransfer) | Watches for token transfer events |

---

---
url: /tempo/hooks.md
---
# Overview

| Hook   | Description |
|--------|-------------|
| **AMM Hooks** | |
| [`amm.useBurn`](/tempo/hooks/amm.useBurn) | Hook for burning liquidity tokens and receiving the underlying token pair |
| [`amm.useLiquidityBalance`](/tempo/hooks/amm.useLiquidityBalance) | Hook for getting the liquidity balance for an address in a specific pool |
| [`amm.useMint`](/tempo/hooks/amm.useMint) | Hook for minting liquidity tokens by providing a token pair |
| [`amm.usePool`](/tempo/hooks/amm.usePool) | Hook for getting the reserves for a liquidity pool |
| [`amm.useRebalanceSwap`](/tempo/hooks/amm.useRebalanceSwap) | Hook for performing a rebalance swap between user and validator tokens |
| [`amm.useWatchBurn`](/tempo/hooks/amm.useWatchBurn) | Hook for watching liquidity burn events |
| [`amm.useWatchMint`](/tempo/hooks/amm.useWatchMint) | Hook for watching liquidity mint events |
| [`amm.useWatchRebalanceSwap`](/tempo/hooks/amm.useWatchRebalanceSwap) | Hook for watching rebalance swap events |
| **Faucet Hooks** | |
| [`faucet.useFund`](/tempo/hooks/faucet.useFund) | Hook for funding an account with testnet tokens |
| **Fee Hooks** | |
| [`fee.useSetUserToken`](/tempo/hooks/fee.useSetUserToken) | Hook for setting the user's default fee token preference |
| [`fee.useUserToken`](/tempo/hooks/fee.useUserToken) | Hook for getting the user's default fee token preference |
| [`fee.useWatchSetUserToken`](/tempo/hooks/fee.useWatchSetUserToken) | Hook for watching user token set events |
| **Nonce Hooks** | |
| [`nonce.useNonce`](/tempo/hooks/nonce.useNonce) | Hook for getting the nonce for an account and nonce key |
| [`nonce.useWatchNonceIncremented`](/tempo/hooks/nonce.useWatchNonceIncremented) | Hook for watching nonce incremented events |
| **Policy Hooks** | |
| [`policy.useCreate`](#TODO) | Hook for creating a new transfer policy for token access control |
| [`policy.useData`](#TODO) | Hook for getting the data for a transfer policy, including its type and admin address |
| [`policy.useIsAuthorized`](#TODO) | Hook for checking if an address is authorized by a transfer policy |
| [`policy.useModifyBlacklist`](#TODO) | Hook for modifying the blacklist for a blacklist-type transfer policy |
| [`policy.useModifyWhitelist`](#TODO) | Hook for modifying the whitelist for a whitelist-type transfer policy |
| [`policy.useSetAdmin`](#TODO) | Hook for setting the admin for a transfer policy |
| [`policy.useWatchAdminUpdated`](#TODO) | Hook for watching policy admin update events |
| [`policy.useWatchBlacklistUpdated`](#TODO) | Hook for watching blacklist update events |
| [`policy.useWatchCreate`](#TODO) | Hook for watching policy creation events |
| [`policy.useWatchWhitelistUpdated`](#TODO) | Hook for watching whitelist update events |
| **Reward Hooks** | |
| [`reward.useClaim`](/tempo/hooks/reward.useClaim) | Hook for claiming accumulated rewards |
| [`reward.useSetRecipient`](/tempo/hooks/reward.useSetRecipient) | Hook for setting or changing the reward recipient for a token holder |
| [`reward.useDistribute`](/tempo/hooks/reward.useDistribute) | Hook for distributing tokens to opted-in holders |
| [`reward.useUserRewardInfo`](/tempo/hooks/reward.useUserRewardInfo) | Hook for getting reward information for a specific account |
| [`reward.useWatchRewardRecipientSet`](/tempo/hooks/reward.useWatchRewardRecipientSet) | Hook for watching reward recipient set events |
| [`reward.useWatchRewardDistributed`](/tempo/hooks/reward.useWatchRewardDistributed) | Hook for watching reward distributed events |
| **Stablecoin DEX Hooks** | |
| [`dex.useBalance`](/tempo/hooks/dex.useBalance) | Hook for getting a user's token balance on the Stablecoin DEX |
| [`dex.useBuy`](/tempo/hooks/dex.useBuy) | Hook for buying a specific amount of tokens from the Stablecoin DEX orderbook |
| [`dex.useBuyQuote`](/tempo/hooks/dex.useBuyQuote) | Hook for getting the quote for buying a specific amount of tokens |
| [`dex.useCancel`](/tempo/hooks/dex.useCancel) | Hook for canceling an order from the orderbook |
| [`dex.useCreatePair`](/tempo/hooks/dex.useCreatePair) | Hook for creating a new trading pair on the DEX |
| [`dex.useOrder`](/tempo/hooks/dex.useOrder) | Hook for getting an order's details from the orderbook |
| [`dex.usePlace`](/tempo/hooks/dex.usePlace) | Hook for placing a limit order on the orderbook |
| [`dex.usePlaceFlip`](/tempo/hooks/dex.usePlaceFlip) | Hook for placing a flip order that automatically flips when filled |
| [`dex.useTickLevel`](/tempo/hooks/dex.useTickLevel) | Hook for getting the price level information at a specific tick |
| [`dex.useSell`](/tempo/hooks/dex.useSell) | Hook for selling a specific amount of tokens from the Stablecoin DEX orderbook |
| [`dex.useSellQuote`](/tempo/hooks/dex.useSellQuote) | Hook for getting the quote for selling a specific amount of tokens |
| [`dex.useWatchFlipOrderPlaced`](/tempo/hooks/dex.useWatchFlipOrderPlaced) | Hook for watching flip order placed events |
| [`dex.useWatchOrderCancelled`](/tempo/hooks/dex.useWatchOrderCancelled) | Hook for watching order cancelled events |
| [`dex.useWatchOrderFilled`](/tempo/hooks/dex.useWatchOrderFilled) | Hook for watching order filled events |
| [`dex.useWatchOrderPlaced`](/tempo/hooks/dex.useWatchOrderPlaced) | Hook for watching order placed events |
| [`dex.useWithdraw`](/tempo/hooks/dex.useWithdraw) | Hook for withdrawing tokens from the DEX to the caller's wallet |
| **Token Hooks** | |
| [`token.useAllowance`](/tempo/hooks/token.useGetAllowance) | Hook for getting the amount of tokens that a spender is approved to transfer on behalf of an owner |
| [`token.useApprove`](/tempo/hooks/token.useApprove) | Hook for approving a spender to transfer TIP-20 tokens on behalf of the caller |
| [`token.useBalance`](/tempo/hooks/token.useGetBalance) | Hook for getting the token balance of an address |
| [`token.useBurn`](/tempo/hooks/token.useBurn) | Hook for burning TIP-20 tokens from the caller's balance |
| [`token.useBurnBlocked`](/tempo/hooks/token.useBurnBlocked) | Hook for burning TIP-20 tokens from a blocked address |
| [`token.useChangeTransferPolicy`](/tempo/hooks/token.useChangeTransferPolicy) | Hook for changing the transfer policy for a TIP-20 token |
| [`token.useCreate`](/tempo/hooks/token.useCreate) | Hook for creating a new TIP-20 token and assigning the admin role to the calling account |
| [`token.useGrantRoles`](/tempo/hooks/token.useGrantRoles) | Hook for granting one or more roles to an address |
| [`token.useHasRole`](/tempo/hooks/token.useHasRole) | Hook for checking if an address has a specific role |
| [`token.useMetadata`](/tempo/hooks/token.useGetMetadata) | Hook for getting the metadata for a TIP-20 token, including name, symbol, decimals, currency, and total supply |
| [`token.useMint`](/tempo/hooks/token.useMint) | Hook for minting new TIP-20 tokens to a recipient |
| [`token.usePause`](/tempo/hooks/token.usePause) | Hook for pausing a TIP-20 token, preventing all transfers |
| [`token.useRenounceRoles`](/tempo/hooks/token.useRenounceRoles) | Hook for renouncing one or more roles from the caller's address |
| [`token.useRevokeRoles`](/tempo/hooks/token.useRevokeRoles) | Hook for revoking one or more roles from an address |
| [`token.useSetRoleAdmin`](/tempo/hooks/token.useSetRoleAdmin) | Hook for setting the admin role for another role |
| [`token.useSetSupplyCap`](/tempo/hooks/token.useSetSupplyCap) | Hook for setting the supply cap for a TIP-20 token |
| [`token.useTransfer`](/tempo/hooks/token.useTransfer) | Hook for transferring TIP-20 tokens from the caller to a recipient |
| [`token.useUnpause`](/tempo/hooks/token.useUnpause) | Hook for unpausing a TIP-20 token, allowing transfers to resume |
| [`token.useWatchAdminRole`](/tempo/hooks/token.useWatchAdminRole) | Hook for watching role admin update events |
| [`token.useWatchApprove`](/tempo/hooks/token.useWatchApprove) | Hook for watching token approval events |
| [`token.useWatchBurn`](/tempo/hooks/token.useWatchBurn) | Hook for watching token burn events |
| [`token.useWatchCreate`](/tempo/hooks/token.useWatchCreate) | Hook for watching new token creation events |
| [`token.useWatchMint`](/tempo/hooks/token.useWatchMint) | Hook for watching token mint events |
| [`token.useWatchRole`](/tempo/hooks/token.useWatchRole) | Hook for watching role membership update events |
| [`token.useWatchTransfer`](/tempo/hooks/token.useWatchTransfer) | Hook for watching token transfer events |

---

---
url: /cli/api/plugins.md
---
# Plugins

Plugins for managing ABIs, generating code, and more.

## Import

Import via the `'@wagmi/cli/plugins'` entrypoint.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins.md","from":134,"to":181}<fsm-vh3gqscxm4e>
import { etherscan } from '@wagmi/cli/plugins'
```

## Available Plugins

* [`actions`](/cli/api/plugins/actions) Generate type-safe VanillaJS actions from configuration `contracts`.
* [`blockExplorer`](/cli/api/plugins/blockExplorer) Fetch ABIs from Block Explorers that support `?module=contract&action=getabi`.
* [`etherscan`](/cli/api/plugins/etherscan) Fetch ABIs from Etherscan and add into configuration.
* [`fetch`](/cli/api/plugins/fetch) Fetch and parse ABIs from network resource with `fetch`.
* [`foundry`](/cli/api/plugins/foundry) Generate ABIs and watch for Foundry project changes.
* [`hardhat`](/cli/api/plugins/hardhat) Generate ABIs and watch for Hardhat projects changes.
* [`react`](/cli/api/plugins/react) Generate type-safe React Hooks from configuration `contracts`.
* [`sourcify`](/cli/api/plugins/sourcify) Fetch ABIs from Sourcify from configuration `contracts`.

## Create Plugin

Creating plugins to hook into the CLI is quite simple. Plugins most commonly inject contracts into `contracts` config, e.g. [`etherscan`](/cli/api/plugins/etherscan), and/or generate code using the `run` option, e.g. [`react`](/cli/api/plugins/react). All you need to do is write a function that returns the `Plugin` type.

```ts{3-8}
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins.md","from":1378,"to":1687}<fsm-vh3gqscxm4e>
import { type Plugin, defineConfig } from '@wagmi/cli'

function myPlugin(): Plugin {
  // `name` is the only required property.
  name: 'MyPlugin',
  // You likely want to at least include `contracts` or `run`.
  // ...
}

export default defineConfig({
  out: 'src/generated.ts',
  plugins: [myPlugin()],
})
```

---

---
url: /core/api/connectors/porto.md
---

# porto

Connector for [Porto](https://porto.sh).

## Import

```ts-vue
import { porto } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add porto@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install porto@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add porto@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add porto@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { porto } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [porto()], // [!code hl]
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type PortoParameters } from '{{connectorsPackageName}}'
```

See [`Porto.create` Parameters](https://porto.sh/sdk/api/porto/create#parameters)

---

---
url: /react/api/connectors/porto.md
---

# porto

Connector for [Porto](https://porto.sh).

## Import

```ts-vue
import { porto } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add porto@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install porto@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add porto@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add porto@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { porto } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [porto()], // [!code hl]
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type PortoParameters } from '{{connectorsPackageName}}'
```

See [`Porto.create` Parameters](https://porto.sh/sdk/api/porto/create#parameters)

---

---
url: /shared/connectors/porto.md
---
# porto

Connector for [Porto](https://porto.sh).

## Import

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/porto.md","from":227,"to":277}<fsm-vh3gqscxm4e>
import { porto } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/porto.md","from":471,"to":517}<fsm-vh3gqscxm4e>
pnpm add porto@{{connectorDependencyVersion}}
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/porto.md","from":540,"to":589}<fsm-vh3gqscxm4e>
npm install porto@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/porto.md","from":613,"to":659}<fsm-vh3gqscxm4e>
yarn add porto@{{connectorDependencyVersion}}
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/porto.md","from":682,"to":727}<fsm-vh3gqscxm4e>
bun add porto@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/porto.md","from":756,"to":1114}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { porto } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [porto()], // [!code hl]
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/porto.md","from":1144,"to":1209}<fsm-vh3gqscxm4e>
import { type PortoParameters } from '{{connectorsPackageName}}'
```

See [`Porto.create` Parameters](https://porto.sh/sdk/api/porto/create#parameters)

---

---
url: /solid/api/connectors/porto.md
---

# porto

Connector for [Porto](https://porto.sh).

## Import

```ts-vue
import { porto } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add porto@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install porto@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add porto@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add porto@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { porto } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [porto()], // [!code hl]
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type PortoParameters } from '{{connectorsPackageName}}'
```

See [`Porto.create` Parameters](https://porto.sh/sdk/api/porto/create#parameters)

---

---
url: /vue/api/connectors/porto.md
---

# porto

Connector for [Porto](https://porto.sh).

## Import

```ts-vue
import { porto } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add porto@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install porto@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add porto@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add porto@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { porto } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [porto()], // [!code hl]
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type PortoParameters } from '{{connectorsPackageName}}'
```

See [`Porto.create` Parameters](https://porto.sh/sdk/api/porto/create#parameters)

---

---
url: /core/api/actions/prepareTransactionRequest.md
---
# prepareTransactionRequest

Action for preparing a transaction request for signing by populating a nonce, gas limit, fee values, and a transaction type.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/prepareTransactionRequest.md","from":324,"to":380}<fsm-vh3gqscxm4e>
import { prepareTransactionRequest } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/prepareTransactionRequest.md","from":427,"to":675}<fsm-vh3gqscxm4e>
import { prepareTransactionRequest } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

await prepareTransactionRequest(config, {
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: parseEther('1'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/prepareTransactionRequest.md","from":746,"to":817}<fsm-vh3gqscxm4e>
import { type PrepareTransactionRequestParameters } from '@wagmi/core'
```

### account

`Account | Address | undefined`

The Account to send the transaction from.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/prepareTransactionRequest.md","from":944,"to":1266}<fsm-vh3gqscxm4e>
import { prepareTransactionRequest } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

await prepareTransactionRequest(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', // [!code focus]
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: parseEther('1'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### to

`` `0x${string}` | undefined ``

The transaction recipient or contract address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/prepareTransactionRequest.md","from":1437,"to":1760}<fsm-vh3gqscxm4e>
import { prepareTransactionRequest } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

await prepareTransactionRequest(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',  // [!code focus]
  value: parseEther('1'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### accessList

`AccessList | undefined`

The access list.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/prepareTransactionRequest.md","from":1902,"to":2310}<fsm-vh3gqscxm4e>
import { prepareTransactionRequest } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

await prepareTransactionRequest(config, {
  accessList: [ // [!code focus:6]
    {
      address: '0x1',
      storageKeys: ['0x1'],
    },
  ],
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: parseEther('1'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

Chain ID to prepare the transaction request for.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/prepareTransactionRequest.md","from":2501,"to":2891}<fsm-vh3gqscxm4e>
import { prepareTransactionRequest } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { parseEther } from 'viem'
import { config } from './config'

await prepareTransactionRequest(config, {
  chainId: mainnet.id, // [!code focus]
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: parseEther('1'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### data

`` `0x${string}` | undefined ``

A contract hashed method call with encoded args.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/prepareTransactionRequest.md","from":3066,"to":3442}<fsm-vh3gqscxm4e>
import { prepareTransactionRequest } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

await prepareTransactionRequest(config, {
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', // [!code focus]
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: parseEther('1'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### gasPrice

`bigint | undefined`

The price (in wei) to pay per gas. Only applies to [Legacy Transactions](https://viem.sh/docs/glossary/terms#legacy-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/prepareTransactionRequest.md","from":3691,"to":4053}<fsm-vh3gqscxm4e>
import { prepareTransactionRequest } from '@wagmi/core'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

await prepareTransactionRequest(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  gasPrice: parseGwei('20'), // [!code focus]
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: parseEther('1'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxFeePerGas

`bigint | undefined`

Total fee per gas (in wei), inclusive of `maxPriorityFeePerGas`. Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/prepareTransactionRequest.md","from":4340,"to":4706}<fsm-vh3gqscxm4e>
import { prepareTransactionRequest } from '@wagmi/core'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

await prepareTransactionRequest(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  maxFeePerGas: parseGwei('20'), // [!code focus]
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: parseEther('1'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxPriorityFeePerGas

`bigint | undefined`

Max priority fee per gas (in wei). Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/prepareTransactionRequest.md","from":4971,"to":5377}<fsm-vh3gqscxm4e>
import { prepareTransactionRequest } from '@wagmi/core'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

await prepareTransactionRequest(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  maxFeePerGas: parseGwei('20'),
  maxPriorityFeePerGas: parseGwei('2'), // [!code focus]
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: parseEther('1'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### nonce

`number | undefined`

Unique number identifying this transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/prepareTransactionRequest.md","from":5537,"to":5871}<fsm-vh3gqscxm4e>
import { prepareTransactionRequest } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

await prepareTransactionRequest(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: parseEther('1'),
  nonce: 5, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### parameters

`("fees" | "gas" | "nonce" | "type")[] | undefined`

Parameters to prepare.

For instance, if `["gas", "nonce"]` is provided, then only the `gas` and `nonce` parameters will be prepared.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/prepareTransactionRequest.md","from":6157,"to":6511}<fsm-vh3gqscxm4e>
import { prepareTransactionRequest } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

await prepareTransactionRequest(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  parameters: ['gas', 'nonce'], // [!code focus]
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: parseEther('1'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### value

`bigint | undefined`

The transaction recipient or contract address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/prepareTransactionRequest.md","from":6674,"to":6996}<fsm-vh3gqscxm4e>
import { prepareTransactionRequest } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

await prepareTransactionRequest(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  value: parseEther('1'), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/prepareTransactionRequest.md","from":7068,"to":7139}<fsm-vh3gqscxm4e>
import { type PrepareTransactionRequestReturnType } from '@wagmi/core'
```

[`TransactionRequest`](https://viem.sh/docs/glossary/types#transactionrequest)

The transaction request.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/prepareTransactionRequest.md","from":7266,"to":7336}<fsm-vh3gqscxm4e>
import { type PrepareTransactionRequestErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`prepareTransactionRequest`](https://viem.sh/docs/actions/wallet/prepareTransactionRequest)

---

---
url: /solid/api/primitives.md
---
# Primitives

Solid Primitives for accounts, wallets, contracts, transactions, signing, and more.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives.md","from":331,"to":376}<fsm-vh3gqscxm4e>
import { useConnection } from '@wagmi/solid'
```

## Reactive Parameters

In Solid, primitive parameters are passed as getter functions (accessors) to maintain reactivity. This is different from React where parameters are passed directly as objects.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives.md","from":588,"to":642}<fsm-vh3gqscxm4e>
// Solid style
useBlockNumber(() => ({ chainId: 1 }))
```

## Available Primitives

---

---
url: /cli/api/plugins/react.md
---
# react

Plugin for generating type-safe [Wagmi Hooks](/react/api/hooks).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/react.md","from":92,"to":135}<fsm-vh3gqscxm4e>
import { react } from '@wagmi/cli/plugins'
```

## Usage

```ts{2,6}
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/react.md","from":161,"to":311}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { react } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    react(),
  ],
})
```

## Configuration

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/react.md","from":340,"to":394}<fsm-vh3gqscxm4e>
import { type ReactConfig } from '@wagmi/cli/plugins'
```

### abiItemHooks

* Boolean flag to generate abi item hooks (e.g. hooks for each abi function and events).
* Defaults to `true`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/react.md","from":535,"to":600}<fsm-vh3gqscxm4e>
plugins: [
  react({ abiItemHooks: false }), // [!code focus]
],
```

### getHookName

``'legacy' | ((options: { contractName: string; type: 'read' | 'simulate' | 'watch' | 'write' }) => `use${string}`)``

* Function for setting custom hook names.
* Defaults to `` `use${type}${contractName}` ``. For example, `useReadErc20`, `useSimulateErc20`, `useWatchErc20Event`, `useWriteErc20`.
* When `'legacy'` (deprecated), hook names are set to `@wagmi/cli@1` format.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/react.md","from":1006,"to":1312}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { react } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    react({
      getHookName({ contractName, type }) { // [!code focus]
        return `use${contractName}__${type}` // [!code focus]
      }, // [!code focus]
    }),
  ],
})
```

---

---
url: /react/guides/read-from-contract.md
---
# Read from Contract

The [`useReadContract` Hook](/react/api/hooks/useReadContract) allows you to read data on a smart contract, from a `view` or `pure` (read-only) function. They can only read the state of the contract, and cannot make any changes to it. Since read-only methods do not change the state of the contract, they do not require any gas to be executed, and can be called by any user without the need to pay for gas.

The component below shows how to retrieve the token balance of an address from the [Wagmi Example](https://etherscan.io/token/0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2) contract

:::code-group

```tsx [read-contract.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/read-from-contract.md","from":651,"to":1000}<fsm-vh3gqscxm4e>
import { useReadContract } from 'wagmi'
import { wagmiContractConfig } from './contracts'

function ReadContract() {
  const { data: balance } = useReadContract({
    ...wagmiContractConfig,
    functionName: 'balanceOf',
    args: ['0x03A71968491d55603FFe1b11A9e23eF013f75bCF'],
  })

  return (
    <div>Balance: {balance?.toString()}</div>
  )
}
```

```ts [contracts.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/read-from-contract.md","from":1025,"to":1496}<fsm-vh3gqscxm4e>
export const wagmiContractConfig = {
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  abi: [
    {
      type: 'function',
      name: 'balanceOf',
      stateMutability: 'view',
      inputs: [{ name: 'account', type: 'address' }],
      outputs: [{ type: 'uint256' }],
    },
    {
      type: 'function',
      name: 'totalSupply',
      stateMutability: 'view',
      inputs: [],
      outputs: [{ name: 'supply', type: 'uint256' }],
    },
  ],
} as const
```

:::

If `useReadContract` depends on another value (`address` in the example below), you can use the [`query.enabled`](/react/api/hooks/useReadContract#enabled) option to prevent the query from running until the dependency is ready.

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/read-from-contract.md","from":1741,"to":1953}<fsm-vh3gqscxm4e>
const { data: balance } = useReadContract({
  ...wagmiContractConfig,
  functionName: 'balanceOf',
  args: [address],
  query: { // [!code focus]
    enabled: !!address, // [!code focus]
  }, // [!code focus]
})
```

## Loading & Error States

The [`useReadContract` Hook](/react/api/hooks/useReadContract) also returns loading & error states, which can be used to display a loading indicator while the data is being fetched, or an error message if contract execution reverts.

:::code-group

```tsx [read-contract.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/read-from-contract.md","from":2261,"to":2909}<fsm-vh3gqscxm4e>
import { type BaseError, useReadContract } from 'wagmi'

function ReadContract() {
  const { 
    data: balance,
    error, // [!code ++]
    isPending // [!code ++]
  } = useReadContract({
    ...wagmiContractConfig,
    functionName: 'balanceOf',
    args: ['0x03A71968491d55603FFe1b11A9e23eF013f75bCF'],
  })

  if (isPending) return <div>Loading...</div> // [!code ++]

  if (error) // [!code ++]
    return ( // [!code ++]
      <div> // [!code ++]
        Error: {(error as BaseError).shortMessage || error.message} // [!code ++]
      </div> // [!code ++]
    )  // [!code ++]

  return (
    <div>Balance: {balance?.toString()}</div>
  )
}
```

## Refetching On Blocks

The [`useBlockNumber` Hook](/react/api/hooks/useBlockNumber) can be utilized to refetch or [invalidate](https://tanstack.com/query/latest/docs/framework/react/guides/query-invalidation) the contract data on a specific block interval.

:::code-group

```tsx [read-contract.tsx (refetch)]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/read-from-contract.md","from":3225,"to":3845}<fsm-vh3gqscxm4e>
import { useEffect } from 'react'
import { useBlockNumber, useReadContract } from 'wagmi'

function ReadContract() {
  const { data: balance, refetch } = useReadContract({
    ...wagmiContractConfig,
    functionName: 'balanceOf',
    args: ['0x03A71968491d55603FFe1b11A9e23eF013f75bCF'],
  })
  const { data: blockNumber } = useBlockNumber({ watch: true })

  useEffect(() => {
    // want to refetch every `n` block instead? use the modulo operator!
    // if (blockNumber % 5 === 0) refetch() // refetch every 5 blocks
    refetch()
  }, [blockNumber])

  return (
    <div>Balance: {balance?.toString()}</div>
  )
}
```

```tsx [read-contract.tsx (invalidate)]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/read-from-contract.md","from":3889,"to":4700}<fsm-vh3gqscxm4e>
import { useQueryClient } from '@tanstack/react-query'
import { useEffect } from 'react'
import { useBlockNumber, useReadContract } from 'wagmi'

function ReadContract() {
  const queryClient = useQueryClient()
  const { data: balance, refetch } = useReadContract({
    ...wagmiContractConfig,
    functionName: 'balanceOf',
    args: ['0x03A71968491d55603FFe1b11A9e23eF013f75bCF'],
  })
  const { data: blockNumber } = useBlockNumber({ watch: true })

  useEffect(() => {
    // if `useReadContract` is in a different hook/component,
    // you can import `readContractQueryKey` from `'wagmi/query'` and
    // construct a one-off query key to use for invalidation
    queryClient.invalidateQueries({ queryKey })
  }, [blockNumber, queryClient])

  return (
    <div>Balance: {balance?.toString()}</div>
  )
}
```

:::

## Calling Multiple Functions

We can use the [`useReadContract` Hook](/react/api/hooks/useReadContract) multiple times in a single component to call multiple functions on the same contract, but this ends up being hard to manage as the number of functions increases, especially when we also want to deal with loading & error states.

Luckily, to make this easier, we can use the [`useReadContracts` Hook](/react/api/hooks/useReadContracts) to call multiple functions in a single call.

:::code-group

```tsx [read-contract.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/read-from-contract.md","from":5238,"to":6146}<fsm-vh3gqscxm4e>
import { type BaseError, useReadContracts } from 'wagmi'

function ReadContract() {
  const { 
    data,
    error,
    isPending
  } = useReadContracts({ 
    contracts: [{ 
      ...wagmiContractConfig,
      functionName: 'balanceOf',
      args: ['0x03A71968491d55603FFe1b11A9e23eF013f75bCF'],
    }, { 
      ...wagmiContractConfig, 
      functionName: 'ownerOf', 
      args: [69n], 
    }, { 
      ...wagmiContractConfig, 
      functionName: 'totalSupply', 
    }] 
  }) 
  const [balance, ownerOf, totalSupply] = data || [] 

  if (isPending) return <div>Loading...</div>

  if (error)
    return (
      <div>
        Error: {(error as BaseError).shortMessage || error.message}
      </div>
    ) 

  return (
    <>
      <div>Balance: {balance?.toString()}</div>
      <div>Owner of Token 69: {ownerOf?.toString()}</div> 
      <div>Total Supply: {totalSupply?.toString()}</div> 
    </>
  )
}
```

:::

---

---
url: /vue/guides/read-from-contract.md
---
# Read from Contract

## Overview

The [`useReadContract` Composable](/vue/api/composables/useReadContract) allows you to read data on a smart contract, from a `view` or `pure` (read-only) function. They can only read the state of the contract, and cannot make any changes to it. Since read-only methods do not change the state of the contract, they do not require any gas to be executed, and can be called by any user without the need to pay for gas.

The component below shows how to retrieve the token balance of an address from the [Wagmi Example](https://etherscan.io/token/0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2) contract

:::code-group

```vue [ReadContract.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/read-from-contract.md","from":674,"to":1030}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useReadContract } from 'wagmi'
import { wagmiContractConfig } from './contracts'

const { data: balance } = useReadContract({
  ...wagmiContractConfig,
  functionName: 'balanceOf',
  args: ['0x03A71968491d55603FFe1b11A9e23eF013f75bCF'],
})
</script>

<template>
  <div>Balance: {{ balance?.toString() }}</div>
</template>
```

```ts [contracts.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/read-from-contract.md","from":1055,"to":1526}<fsm-vh3gqscxm4e>
export const wagmiContractConfig = {
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  abi: [
    {
      type: 'function',
      name: 'balanceOf',
      stateMutability: 'view',
      inputs: [{ name: 'account', type: 'address' }],
      outputs: [{ type: 'uint256' }],
    },
    {
      type: 'function',
      name: 'totalSupply',
      stateMutability: 'view',
      inputs: [],
      outputs: [{ name: 'supply', type: 'uint256' }],
    },
  ],
} as const
```

:::

If `useReadContract` depends on another value (`address` in the example below), you can use the [`query.enabled`](/vue/api/composables/useReadContract#enabled) option to prevent the query from running until the dependency is ready.

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/read-from-contract.md","from":1776,"to":1988}<fsm-vh3gqscxm4e>
const { data: balance } = useReadContract({
  ...wagmiContractConfig,
  functionName: 'balanceOf',
  args: [address],
  query: { // [!code focus]
    enabled: !!address, // [!code focus]
  }, // [!code focus]
})
```

## Loading & Error States

The [`useReadContract` Composable](/vue/api/composables/useReadContract) also returns loading & error states, which can be used to display a loading indicator while the data is being fetched, or an error message if contract execution reverts.

:::code-group

```vue [ReadContract.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/read-from-contract.md","from":2306,"to":2874}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useReadContract } from 'wagmi'

const { 
  data: balance,
  error, // [!code ++]
  isPending // [!code ++]
} = useReadContract({
  ...wagmiContractConfig,
  functionName: 'balanceOf',
  args: ['0x03A71968491d55603FFe1b11A9e23eF013f75bCF'],
})
</script>

<template>
  <div v-if="isPending">Loading...</div> // [!code ++]

  <div v-else-if="error"> // [!code ++]
    Error: {{ (error as BaseError).shortMessage || error.message }} // [!code ++]
  </div> // [!code ++]

  <div v-else>Balance: {{ balance?.toString() }}</div>
</template>
```

:::

---

---
url: /core/api/actions/readContract.md
---
# readContract

Action for calling a **read-only** function on a contract, and returning the response.

A **read-only** function (constant function) on a Solidity contract is denoted by a pure or view keyword. They can only read the state of the contract, and cannot make any changes to it. Since read-only methods do not change the state of the contract, they do not require any gas to be executed, and can be called by any user without the need to pay for gas.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContract.md","from":607,"to":650}<fsm-vh3gqscxm4e>
import { readContract } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContract.md","from":697,"to":945}<fsm-vh3gqscxm4e>
import { readContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await readContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'totalSupply',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContract.md","from":1051,"to":1109}<fsm-vh3gqscxm4e>
import { type ReadContractParameters } from '@wagmi/core'
```

### abi

`Abi`

The contract's ABI. Check out the [TypeScript docs](/react/typescript#const-assert-abis-typed-data) for how to set up ABIs for maximum type inference and safety.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContract.md","from":1325,"to":1607}<fsm-vh3gqscxm4e>
import { readContract } from '@wagmi/core'
import { abi } from './abi' // [!code focus]
import { config } from './config'

const result = await readContract(config, {
  abi, // [!code focus]
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'totalSupply',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### account

`Account | undefined`

Account to use when calling the contract (`msg.sender`).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContract.md","from":1818,"to":2194}<fsm-vh3gqscxm4e>
import { readContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await readContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'balanceOf',
  args: ['0xd2135CfB216b74109775236E36d4b433F1DF507B'],
  account: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### address

`Address`

The contract's address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContract.md","from":2360,"to":2625}<fsm-vh3gqscxm4e>
import { readContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await readContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f', // [!code focus]
  functionName: 'totalSupply',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### args

`readonly unknown[] | undefined`

* Arguments to pass when calling the contract.
* Inferred from [`abi`](#abi) and [`functionName`](#functionname).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContract.md","from":2901,"to":3220}<fsm-vh3gqscxm4e>
import { readContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await readContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'balanceOf',
  args: ['0xd2135CfB216b74109775236E36d4b433F1DF507B'], // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### blockNumber

`bigint | undefined`

Block number to call contract at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContract.md","from":3416,"to":3707}<fsm-vh3gqscxm4e>
import { readContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await readContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'totalSupply',
  blockNumber: 17829139n, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to call contract at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContract.md","from":3942,"to":4227}<fsm-vh3gqscxm4e>
import { readContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await readContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'totalSupply',
  blockTag: 'safe', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContract.md","from":4448,"to":4792}<fsm-vh3gqscxm4e>
import { readContract } from '@wagmi/core'
import { mainnet } from 'wagmi/chains' // [!code focus]
import { abi } from './abi'
import { config } from './config'

const result = await readContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'totalSupply',
  chainId: mainnet.id, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### functionName

`string`

* Function to call on the contract.
* Inferred from [`abi`](#abi).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContract.md","from":5005,"to":5324}<fsm-vh3gqscxm4e>
import { readContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await readContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'balanceOf', // [!code focus]
  args: ['0xd2135CfB216b74109775236E36d4b433F1DF507B'],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContract.md","from":5431,"to":5489}<fsm-vh3gqscxm4e>
import { type ReadContractReturnType } from '@wagmi/core'
```

`unknown`

* Result of contract read-only function.
* Inferred from [`abi`](#abi), [`functionName`](#functionname), and [`args`](#args).

## Type Inference

With [`abi`](#abi) setup correctly, TypeScript will infer the correct types for [`functionName`](#functionname), [`args`](#args), and the return type. See the Wagmi [TypeScript docs](/core/typescript) for more information.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContract.md","from":5891,"to":5948}<fsm-vh3gqscxm4e>
import { type ReadContractErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`readContract`](https://viem.sh/docs/contract/readContract)

---

---
url: /core/api/actions/readContracts.md
---
# readContracts

Action for calling multiple read methods on a contract.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContracts.md","from":219,"to":263}<fsm-vh3gqscxm4e>
import { readContracts } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContracts.md","from":310,"to":1014}<fsm-vh3gqscxm4e>
import { readContracts } from '@wagmi/core'
import { config } from './config'

const wagmigotchiContract = {
  address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
  abi: wagmigotchiABI,
} as const
const mlootContract = {
  address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
  abi: mlootABI,
} as const

const result = await readContracts(config, {
  contracts: [
    {
      ...wagmigotchiContract,
      functionName: 'getAlive',
    },
    {
      ...wagmigotchiContract,
      functionName: 'getBoredom',
    },
    {
      ...mlootContract,
      functionName: 'getChest',
      args: [69],
    },
    {
      ...mlootContract,
      functionName: 'getWaist',
      args: [69],
    },
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContracts.md","from":1085,"to":1144}<fsm-vh3gqscxm4e>
import { type ReadContractsParameters } from '@wagmi/core'
```

### contracts

`readonly Contract[]`

Set of contracts to call.

#### abi

`Abi | undefined`

The contract's ABI. Check out the [TypeScript docs](/react/typescript#const-assert-abis-typed-data) for how to set up ABIs for maximum type inference and safety.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContracts.md","from":1440,"to":1757}<fsm-vh3gqscxm4e>
import { readContracts } from '@wagmi/core'
import { config } from './config'

const result = await readContracts(config, {
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
      abi: mlootABI, // [!code hl]
      functionName: 'getChest',
      args: [69],
    },
    // ...
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

#### address

`Address | undefined`

The contract's address.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContracts.md","from":1904,"to":2221}<fsm-vh3gqscxm4e>
import { readContracts } from '@wagmi/core'
import { config } from './config'

const result = await readContracts(config, {
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df', // [!code hl]
      abi: mlootABI,
      functionName: 'getChest',
      args: [69],
    },
    // ...
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

#### args

`readonly unknown[] | undefined`

* Arguments to pass when calling the contract.
* Inferred from [`abi`](#abi) and [`functionName`](#functionname).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContracts.md","from":2466,"to":2783}<fsm-vh3gqscxm4e>
import { readContracts } from '@wagmi/core'
import { config } from './config'

const result = await readContracts(config, {
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
      abi: mlootABI,
      functionName: 'getChest',
      args: [69], // [!code hl]
    },
    // ...
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

#### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContracts.md","from":2968,"to":3303}<fsm-vh3gqscxm4e>
import { readContracts } from '@wagmi/core'
import { config } from './config'

const result = await readContracts(config, {
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
      abi: mlootABI,
      functionName: 'getChest',
      args: [69],
      chainId: 1, // [!code hl]
    },
    // ...
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

#### functionName

`string | undefined`

* Function to call on the contract.
* Inferred from [`abi`](#abi).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContracts.md","from":3498,"to":3815}<fsm-vh3gqscxm4e>
import { readContracts } from '@wagmi/core'
import { config } from './config'

const result = await readContracts(config, {
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
      abi: mlootABI,
      functionName: 'getChest', // [!code hl]
      args: [69],
    },
    // ...
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### allowFailure

`boolean`

Whether or not the Hook should throw if a call reverts. If set to `true` (default), and a call reverts, then `readContracts` will fail silently and its error will be logged in the results array. Defaults to `true`.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContracts.md","from":4145,"to":4485}<fsm-vh3gqscxm4e>
import { readContracts } from '@wagmi/core'
import { config } from './config'

const result = await readContracts(config, {
  allowFailure: false, // [!code hl]
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
      abi: mlootABI,
      functionName: 'getChest',
      args: [69],
    },
    // ...
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### batchSize

`number`

The maximum size (in bytes) for each calldata chunk. Set to `0` to disable the size limit. Defaults to `1024`.

> Note: Some RPC Providers limit the amount of calldata (`data`) that can be sent in a single `eth_call` request. It is best to check with your RPC Provider to see if there are any calldata size limits to `eth_call` requests.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContracts.md","from":4934,"to":5271}<fsm-vh3gqscxm4e>
import { readContracts } from '@wagmi/core'
import { config } from './config'

const result = await readContracts(config, {
  batchSize: 1_024, // [!code hl]
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
      abi: mlootABI,
      functionName: 'getChest',
      args: [69],
    },
    // ...
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`number`

The block number to perform the read against.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContracts.md","from":5430,"to":5770}<fsm-vh3gqscxm4e>
import { readContracts } from '@wagmi/core'
import { config } from './config'

const result = await readContracts(config, {
  blockNumber: 69420n, // [!code hl]
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
      abi: mlootABI,
      functionName: 'getChest',
      args: [69],
    },
    // ...
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to read against.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContracts.md","from":5969,"to":6306}<fsm-vh3gqscxm4e>
import { readContracts } from '@wagmi/core'
import { config } from './config'

const result = await readContracts(config, {
  blockTag: 'safe', // [!code hl]
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
      abi: mlootABI,
      functionName: 'getChest',
      args: [69],
    },
    // ...
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### multicallAddress

`Address`

Address of multicall contract.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContracts.md","from":6456,"to":6839}<fsm-vh3gqscxm4e>
import { readContracts } from '@wagmi/core'
import { config } from './config'

const result = await readContracts(config, {
  contracts: [
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
      abi: mlootABI,
      functionName: 'getChest',
      args: [69],
    },
    // ...
  ],
  multicallAddress: '0xca11bde05977b3631167028862be2a173976ca11', // [!code hl]
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContracts.md","from":6912,"to":6971}<fsm-vh3gqscxm4e>
import { type ReadContractsReturnType } from '@wagmi/core'
```

## Type Inference

With [`contracts[number]['abi']`](#abi) setup correctly, TypeScript will infer the correct types for [`functionName`](#functionname), [`args`](#args), and the return type. See the Wagmi [TypeScript docs](/core/typescript) for more information.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/readContracts.md","from":7256,"to":7314}<fsm-vh3gqscxm4e>
import { type ReadContractsErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`multicall`](https://viem.sh/docs/contract/multicall) when supported by current chain.
* [`readContract`](https://viem.sh/docs/contract/readContract) when multicall is not supported.

---

---
url: /core/api/actions/reconnect.md
---
# reconnect

Action for reconnecting [connectors](/core/api/connectors).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/reconnect.md","from":211,"to":251}<fsm-vh3gqscxm4e>
import { reconnect } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/reconnect.md","from":298,"to":487}<fsm-vh3gqscxm4e>
import { reconnect } from '@wagmi/core'
import { injected } from '@wagmi/connectors'
import { config } from './config'

const result = await reconnect(config, { connectors: [injected()] })
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/reconnect.md","from":558,"to":613}<fsm-vh3gqscxm4e>
import { type ReconnectParameters } from '@wagmi/core'
```

### connectors

`(CreateConnectorFn | Connector)[] | undefined`

* [Connectors](/core/api/connectors) to reconnect to.
* Defaults to [`Config['connectors']`](/core/api/createConfig#connectors).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/reconnect.md","from":845,"to":1056}<fsm-vh3gqscxm4e>
import { reconnect } from '@wagmi/core'
import { injected } from '@wagmi/connectors'
import { config } from './config'

const result = await reconnect(config, {
    connectors: [injected()], // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/reconnect.md","from":1128,"to":1183}<fsm-vh3gqscxm4e>
import { type ReconnectReturnType } from '@wagmi/core'
```

`Connection[]`

[Connections](/core/api/createConfig#connection) that were successfully reconnected.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/reconnect.md","from":1306,"to":1360}<fsm-vh3gqscxm4e>
import { type ReconnectErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

---

---
url: /core/api/connectors/safe.md
---

# safe

Connector for [Safe Apps SDK](https://github.com/safe-global/safe-apps-sdk).

## Import

```ts-vue
import { safe } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

```bash-vue [npm]
npm install @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

```bash-vue [yarn]
yarn add @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

```bash-vue [bun]
bun add @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

:::

## Usage

```ts-vue{3,7}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { safe } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [safe()],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type SafeParameters } from '{{connectorsPackageName}}'
```

Check out the [Safe docs](https://github.com/safe-global/safe-apps-sdk/tree/main/packages/safe-apps-sdk) for more info.

### allowedDomains

`RegExp[] | undefined`

```ts-vue
import { safe } from '{{connectorsPackageName}}'

const connector = safe({
  allowedDomains: [/^app\.safe\.global$/], // [!code focus]
})
```

### debug

`boolean | undefined`

```ts-vue
import { safe } from '{{connectorsPackageName}}'

const connector = safe({
  debug: true, // [!code focus]
})
```

### shimDisconnect

`boolean | undefined`

* This flag simulates disconnect behavior by keeping track of connection status in storage.
* Defaults to `false`.

```ts-vue
import { safe } from '{{connectorsPackageName}}'

const connector = safe({
  shimDisconnect: true, // [!code focus]
})
```

---

---
url: /react/api/connectors/safe.md
---

# safe

Connector for [Safe Apps SDK](https://github.com/safe-global/safe-apps-sdk).

## Import

```ts-vue
import { safe } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

```bash-vue [npm]
npm install @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

```bash-vue [yarn]
yarn add @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

```bash-vue [bun]
bun add @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

:::

## Usage

```ts-vue{3,7}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { safe } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [safe()],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type SafeParameters } from '{{connectorsPackageName}}'
```

Check out the [Safe docs](https://github.com/safe-global/safe-apps-sdk/tree/main/packages/safe-apps-sdk) for more info.

### allowedDomains

`RegExp[] | undefined`

```ts-vue
import { safe } from '{{connectorsPackageName}}'

const connector = safe({
  allowedDomains: [/^app\.safe\.global$/], // [!code focus]
})
```

### debug

`boolean | undefined`

```ts-vue
import { safe } from '{{connectorsPackageName}}'

const connector = safe({
  debug: true, // [!code focus]
})
```

### shimDisconnect

`boolean | undefined`

* This flag simulates disconnect behavior by keeping track of connection status in storage.
* Defaults to `false`.

```ts-vue
import { safe } from '{{connectorsPackageName}}'

const connector = safe({
  shimDisconnect: true, // [!code focus]
})
```

---

---
url: /shared/connectors/safe.md
---
# safe

Connector for [Safe Apps SDK](https://github.com/safe-global/safe-apps-sdk).

## Import

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/safe.md","from":274,"to":323}<fsm-vh3gqscxm4e>
import { safe } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/safe.md","from":833,"to":975}<fsm-vh3gqscxm4e>
pnpm add @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/safe.md","from":998,"to":1143}<fsm-vh3gqscxm4e>
npm install @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/safe.md","from":1167,"to":1309}<fsm-vh3gqscxm4e>
yarn add @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/safe.md","from":1332,"to":1473}<fsm-vh3gqscxm4e>
bun add @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

:::

## Usage

```ts-vue{3,7}
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/safe.md","from":1507,"to":1835}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { safe } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [safe()],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/safe.md","from":1865,"to":1929}<fsm-vh3gqscxm4e>
import { type SafeParameters } from '{{connectorsPackageName}}'
```

Check out the [Safe docs](https://github.com/safe-global/safe-apps-sdk/tree/main/packages/safe-apps-sdk) for more info.

### allowedDomains

`RegExp[] | undefined`

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/safe.md","from":2108,"to":2246}<fsm-vh3gqscxm4e>
import { safe } from '{{connectorsPackageName}}'

const connector = safe({
  allowedDomains: [/^app\.safe\.global$/], // [!code focus]
})
```

### debug

`boolean | undefined`

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/safe.md","from":2295,"to":2405}<fsm-vh3gqscxm4e>
import { safe } from '{{connectorsPackageName}}'

const connector = safe({
  debug: true, // [!code focus]
})
```

### shimDisconnect

`boolean | undefined`

* This flag simulates disconnect behavior by keeping track of connection status in storage.
* Defaults to `false`.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/safe.md","from":2579,"to":2698}<fsm-vh3gqscxm4e>
import { safe } from '{{connectorsPackageName}}'

const connector = safe({
  shimDisconnect: true, // [!code focus]
})
```

---

---
url: /solid/api/connectors/safe.md
---

# safe

Connector for [Safe Apps SDK](https://github.com/safe-global/safe-apps-sdk).

## Import

```ts-vue
import { safe } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

```bash-vue [npm]
npm install @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

```bash-vue [yarn]
yarn add @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

```bash-vue [bun]
bun add @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

:::

## Usage

```ts-vue{3,7}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { safe } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [safe()],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type SafeParameters } from '{{connectorsPackageName}}'
```

Check out the [Safe docs](https://github.com/safe-global/safe-apps-sdk/tree/main/packages/safe-apps-sdk) for more info.

### allowedDomains

`RegExp[] | undefined`

```ts-vue
import { safe } from '{{connectorsPackageName}}'

const connector = safe({
  allowedDomains: [/^app\.safe\.global$/], // [!code focus]
})
```

### debug

`boolean | undefined`

```ts-vue
import { safe } from '{{connectorsPackageName}}'

const connector = safe({
  debug: true, // [!code focus]
})
```

### shimDisconnect

`boolean | undefined`

* This flag simulates disconnect behavior by keeping track of connection status in storage.
* Defaults to `false`.

```ts-vue
import { safe } from '{{connectorsPackageName}}'

const connector = safe({
  shimDisconnect: true, // [!code focus]
})
```

---

---
url: /vue/api/connectors/safe.md
---

# safe

Connector for [Safe Apps SDK](https://github.com/safe-global/safe-apps-sdk).

## Import

```ts-vue
import { safe } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

```bash-vue [npm]
npm install @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

```bash-vue [yarn]
yarn add @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

```bash-vue [bun]
bun add @safe-global/safe-apps-provider@{{connectorDependencyVersions?.[0]}} @safe-global/safe-apps-sdk@{{connectorDependencyVersions?.[1]}}
```

:::

## Usage

```ts-vue{3,7}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { safe } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [safe()],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type SafeParameters } from '{{connectorsPackageName}}'
```

Check out the [Safe docs](https://github.com/safe-global/safe-apps-sdk/tree/main/packages/safe-apps-sdk) for more info.

### allowedDomains

`RegExp[] | undefined`

```ts-vue
import { safe } from '{{connectorsPackageName}}'

const connector = safe({
  allowedDomains: [/^app\.safe\.global$/], // [!code focus]
})
```

### debug

`boolean | undefined`

```ts-vue
import { safe } from '{{connectorsPackageName}}'

const connector = safe({
  debug: true, // [!code focus]
})
```

### shimDisconnect

`boolean | undefined`

* This flag simulates disconnect behavior by keeping track of connection status in storage.
* Defaults to `false`.

```ts-vue
import { safe } from '{{connectorsPackageName}}'

const connector = safe({
  shimDisconnect: true, // [!code focus]
})
```

---

---
url: /react/guides/send-transaction.md
---
# Send Transaction

The following guide teaches you how to send transactions in Wagmi. The example below builds on the [Connect Wallet guide](/react/guides/connect-wallet) and uses the [useSendTransaction](/react/api/hooks/useSendTransaction) & [useWaitForTransactionReceipt](/react/api/hooks/useWaitForTransactionReceipt) hooks.

## Example

Feel free to check out the example before moving on:

## Steps

### 1. Connect Wallet

Follow the [Connect Wallet guide](/react/guides/connect-wallet) guide to get this set up.

### 2. Create a new component

Create your `SendTransaction` component that will contain the send transaction logic.

::: code-group

```tsx [send-transaction.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/send-transaction.md","from":857,"to":1131}<fsm-vh3gqscxm4e>
import * as React from 'react'
 
export function SendTransaction() {
  return (
    <form>
      <input name="address" placeholder="0xA0Cf…251e" required />
      <input name="value" placeholder="0.05" required />
      <button type="submit">Send</button>
    </form>
  )
}
```

:::

### 3. Add a form handler

Next, we will need to add a handler to the form that will send the transaction when the user hits "Send". This will be a basic handler in this step.

::: code-group

```tsx [send-transaction.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/send-transaction.md","from":1364,"to":2039}<fsm-vh3gqscxm4e>
import * as React from 'react'
 
export function SendTransaction() {
  async function submit(e: React.FormEvent<HTMLFormElement>) { // [!code ++]
    e.preventDefault() // [!code ++]
    const formData = new FormData(e.target as HTMLFormElement) // [!code ++]
    const to = formData.get('address') as `0x${string}` // [!code ++]
    const value = formData.get('value') as string // [!code ++]
  } // [!code ++]

  return (
    <form> // [!code --]
    <form onSubmit={submit}> // [!code ++]
      <input name="address" placeholder="0xA0Cf…251e" required />
      <input name="value" placeholder="0.05" required />
      <button type="submit">Send</button>
    </form>
  )
}
```

:::

### 4. Hook up the `useSendTransaction` Hook

Now that we have the form handler, we can hook up the [`useSendTransaction` Hook](/react/api/hooks/useSendTransaction) to send the transaction.

::: code-group

```tsx [send-transaction.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/send-transaction.md","from":2286,"to":3161}<fsm-vh3gqscxm4e>
import * as React from 'react'
import { useSendTransaction } from 'wagmi' // [!code ++]
import { parseEther } from 'viem' // [!code ++]
 
export function SendTransaction() {
  const { data: hash, sendTransaction } = useSendTransaction() // [!code ++]

  async function submit(e: React.FormEvent<HTMLFormElement>) { 
    e.preventDefault() 
    const formData = new FormData(e.target as HTMLFormElement) 
    const to = formData.get('address') as `0x${string}` 
    const value = formData.get('value') as string 
    sendTransaction({ to, value: parseEther(value) }) // [!code ++]
  } 

  return (
    <form onSubmit={submit}>
      <input name="address" placeholder="0xA0Cf…251e" required />
      <input name="value" placeholder="0.05" required />
      <button type="submit">Send</button>
      {hash && <div>Transaction Hash: {hash}</div>} // [!code ++]
    </form>
  )
}
```

:::

### 5. Add loading state (optional)

We can optionally add a loading state to the "Send" button while we are waiting confirmation from the user's wallet.

::: code-group

```tsx [send-transaction.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/send-transaction.md","from":3372,"to":4374}<fsm-vh3gqscxm4e>
import * as React from 'react'
import { useSendTransaction } from 'wagmi' 
import { parseEther } from 'viem' 
 
export function SendTransaction() {
  const { 
    data: hash, 
    isPending, // [!code ++]
    sendTransaction 
  } = useSendTransaction() 

  async function submit(e: React.FormEvent<HTMLFormElement>) { 
    e.preventDefault() 
    const formData = new FormData(e.target as HTMLFormElement) 
    const to = formData.get('address') as `0x${string}` 
    const value = formData.get('value') as string 
    sendTransaction({ to, value: parseEther(value) }) 
  } 

  return (
    <form onSubmit={submit}>
      <input name="address" placeholder="0xA0Cf…251e" required />
      <input name="value" placeholder="0.05" required />
      <button 
        disabled={isPending} // [!code ++]
        type="submit"
      >
        Send // [!code --]
        {isPending ? 'Confirming...' : 'Send'} // [!code ++]
      </button>
      {hash && <div>Transaction Hash: {hash}</div>} 
    </form>
  )
}
```

:::

### 6. Wait for transaction receipt (optional)

We can also display the transaction confirmation status to the user by using the [`useWaitForTransactionReceipt` Hook](/react/api/hooks/useWaitForTransactionReceipt).

::: code-group

```tsx [send-transaction.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/send-transaction.md","from":4647,"to":5954}<fsm-vh3gqscxm4e>
import * as React from 'react'
import { 
  useSendTransaction, 
  useWaitForTransactionReceipt // [!code ++]
} from 'wagmi' 
import { parseEther } from 'viem' 
 
export function SendTransaction() {
  const { 
    data: hash, 
    isPending, 
    sendTransaction 
  } = useSendTransaction() 

  async function submit(e: React.FormEvent<HTMLFormElement>) { 
    e.preventDefault() 
    const formData = new FormData(e.target as HTMLFormElement) 
    const to = formData.get('address') as `0x${string}` 
    const value = formData.get('value') as string 
    sendTransaction({ to, value: parseEther(value) }) 
  } 

  const { isLoading: isConfirming, isSuccess: isConfirmed } = // [!code ++]
    useWaitForTransactionReceipt({ // [!code ++]
      hash, // [!code ++]
    }) // [!code ++]

  return (
    <form onSubmit={submit}>
      <input name="address" placeholder="0xA0Cf…251e" required />
      <input name="value" placeholder="0.05" required />
      <button 
        disabled={isPending} 
        type="submit"
      >
        {isPending ? 'Confirming...' : 'Send'} 
      </button>
      {hash && <div>Transaction Hash: {hash}</div>} 
      {isConfirming && <div>Waiting for confirmation...</div>} // [!code ++]
      {isConfirmed && <div>Transaction confirmed.</div>} // [!code ++]
    </form>
  )
}
```

:::

### 7. Handle errors (optional)

If the user rejects the transaction, or the user does not have enough funds to cover the transaction, we can display an error message to the user.

::: code-group

```tsx [send-transaction.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/send-transaction.md","from":6191,"to":7612}<fsm-vh3gqscxm4e>
import * as React from 'react'
import { 
  type BaseError, // [!code ++]
  useSendTransaction, 
  useWaitForTransactionReceipt 
} from 'wagmi' 
import { parseEther } from 'viem' 
 
export function SendTransaction() {
  const { 
    data: hash,
    error, // [!code ++] 
    isPending, 
    sendTransaction 
  } = useSendTransaction() 

  async function submit(e: React.FormEvent<HTMLFormElement>) { 
    e.preventDefault() 
    const formData = new FormData(e.target as HTMLFormElement) 
    const to = formData.get('address') as `0x${string}` 
    const value = formData.get('value') as string 
    sendTransaction({ to, value: parseEther(value) }) 
  } 

  const { isLoading: isConfirming, isSuccess: isConfirmed } = 
    useWaitForTransactionReceipt({ 
      hash, 
    }) 

  return (
    <form onSubmit={submit}>
      <input name="address" placeholder="0xA0Cf…251e" required />
      <input name="value" placeholder="0.05" required />
      <button 
        disabled={isPending} 
        type="submit"
      >
        {isPending ? 'Confirming...' : 'Send'} 
      </button>
      {hash && <div>Transaction Hash: {hash}</div>} 
      {isConfirming && <div>Waiting for confirmation...</div>} 
      {isConfirmed && <div>Transaction confirmed.</div>} 
      {error && ( // [!code ++]
        <div>Error: {(error as BaseError).shortMessage || error.message}</div> // [!code ++]
      )} // [!code ++]
    </form>
  )
}
```

:::

### 8. Wire it up!

Finally, we can wire up our Send Transaction component to our application's entrypoint.

::: code-group

```tsx [app.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/send-transaction.md","from":7764,"to":8229}<fsm-vh3gqscxm4e>
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { WagmiProvider } from 'wagmi'
import { config } from './config'
import { SendTransaction } from './send-transaction' // [!code ++]

const queryClient = new QueryClient()

function App() {
  return (
    <WagmiProvider config={config}>
      <QueryClientProvider client={queryClient}> 
        <SendTransaction /> // [!code ++]
      </QueryClientProvider> 
    </WagmiProvider>
  )
}
```

```tsx [send-transaction.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/send-transaction.md","from":8264,"to":9619}<fsm-vh3gqscxm4e>
import * as React from 'react'
import { 
  type BaseError, 
  useSendTransaction, 
  useWaitForTransactionReceipt 
} from 'wagmi' 
import { parseEther } from 'viem' 
 
export function SendTransaction() {
  const { 
    data: hash,
    error, 
    isPending, 
    sendTransaction 
  } = useSendTransaction() 

  async function submit(e: React.FormEvent<HTMLFormElement>) { 
    e.preventDefault() 
    const formData = new FormData(e.target as HTMLFormElement) 
    const to = formData.get('address') as `0x${string}` 
    const value = formData.get('value') as string 
    sendTransaction({ to, value: parseEther(value) }) 
  } 

  const { isLoading: isConfirming, isSuccess: isConfirmed } = 
    useWaitForTransactionReceipt({ 
      hash, 
    }) 

  return (
    <form onSubmit={submit}>
      <input name="address" placeholder="0xA0Cf…251e" required />
      <input name="value" placeholder="0.05" required />
      <button 
        disabled={isPending} 
        type="submit"
      >
        {isPending ? 'Confirming...' : 'Send'} 
      </button>
      {hash && <div>Transaction Hash: {hash}</div>} 
      {isConfirming && <div>Waiting for confirmation...</div>} 
      {isConfirmed && <div>Transaction confirmed.</div>} 
      {error && ( 
        <div>Error: {(error as BaseError).shortMessage || error.message}</div> 
      )} 
    </form>
  )
}
```

```tsx [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/send-transaction.md","from":9643,"to":10101}<fsm-vh3gqscxm4e>
import { http, createConfig } from 'wagmi'
import { base, mainnet, optimism } from 'wagmi/chains'
import { injected, metaMask, safe, walletConnect } from 'wagmi/connectors'

const projectId = '<WALLETCONNECT_PROJECT_ID>'

export const config = createConfig({
  chains: [mainnet, base],
  connectors: [
    injected(),
    walletConnect({ projectId }),
    metaMask(),
    safe(),
  ],
  transports: {
    [mainnet.id]: http(),
    [base.id]: http(),
  },
})
```

:::

[See the Example.](#example)

---

---
url: /vue/guides/send-transaction.md
---
# Send Transaction

The following guide teaches you how to send transactions in Wagmi. The example below builds on the [Connect Wallet guide](/vue/guides/connect-wallet) and uses the [useSendTransaction](/vue/api/composables/useSendTransaction) & [useWaitForTransactionReceipt](/vue/api/composables/useWaitForTransactionReceipt) composables.

## Example

Feel free to check out the example before moving on:

## Steps

### 1. Connect Wallet

Follow the [Connect Wallet guide](/vue/guides/connect-wallet) guide to get this set up.

### 2. Create a new component

Create your `SendTransaction` component that will contain the send transaction logic.

::: code-group

```tsx [SendTransaction.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/send-transaction.md","from":867,"to":1104}<fsm-vh3gqscxm4e>
<script setup lang="ts">
</script>

<template>
  <form>
    <input name="address" placeholder="0xA0Cf…251e" required />
    <input name="value" placeholder="0.05" required />
    <button type="submit">Send</button>
  </form>
</template>
```

:::

### 3. Add a form handler

Next, we will need to add a handler to the form that will send the transaction when the user hits "Send". This will be a basic handler in this step.

::: code-group

```vue [SendTransaction.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/send-transaction.md","from":1336,"to":1984}<fsm-vh3gqscxm4e>
<script setup lang="ts">
  function submit(event: Event) { // [!code ++]
    const formData = new FormData(event.target as HTMLFormElement) // [!code ++]
    const to = formData.get('address') as `0x${string}` // [!code ++]
    const value = formData.get('value') as string // [!code ++]
    sendTransaction({ to, value: parseEther(value) }) // [!code ++]
  } // [!code ++]
</script>

<template>
  <form> // [!code --]
  <form @submit.prevent="submit"> // [!code ++]
    <input name="address" placeholder="0xA0Cf…251e" required />
    <input name="value" placeholder="0.05" required />
    <button type="submit">Send</button>
  </form>
</template>
```

:::

### 4. Hook up the `useSendTransaction` Composable

Now that we have the form handler, we can hook up the [`useSendTransaction` Composable](/vue/api/composables/useSendTransaction) to send the transaction.

::: code-group

```vue [SendTransaction.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/send-transaction.md","from":2246,"to":3045}<fsm-vh3gqscxm4e>
<script setup lang="ts">
  import { useSendTransaction } from 'wagmi' // [!code ++]
  import { parseEther } from 'viem' // [!code ++]

  const { data: hash, sendTransaction } = useSendTransaction() // [!code ++]

  function submit(event: Event) {
    const formData = new FormData(event.target as HTMLFormElement)
    const to = formData.get('address') as `0x${string}`
    const value = formData.get('value') as string
    sendTransaction({ to, value: parseEther(value) }) // [!code ++]
  }
</script>

<template>
  <form @submit.prevent="submit">
    <input name="address" placeholder="0xA0Cf…251e" required />
    <input name="value" placeholder="0.05" required />
    <button type="submit">Send</button>
    <div v-if="hash">Transaction Hash: {{ hash }}</div> // [!code ++]
  </form>
</template>
```

:::

### 5. Add loading state (optional)

We can optionally add a loading state to the "Send" button while we are waiting confirmation from the user's wallet.

::: code-group

```vue [SendTransaction.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/send-transaction.md","from":3255,"to":4169}<fsm-vh3gqscxm4e>
<script setup lang="ts">
  import { useSendTransaction } from 'wagmi'
  import { parseEther } from 'viem'

  const { 
    data: hash, 
    isPending, // [!code ++]
    sendTransaction 
  } = useSendTransaction()

  function submit(event: Event) {
    const formData = new FormData(event.target as HTMLFormElement)
    const to = formData.get('address') as `0x${string}`
    const value = formData.get('value') as string
    sendTransaction({ to, value: parseEther(value) })
  }
</script>

<template>
  <form @submit.prevent="submit">
    <input name="address" placeholder="0xA0Cf…251e" required />
    <input name="value" placeholder="0.05" required />
    <button :disabled="isPending" type="submit"> // [!code ++]
      <span v-if="isPending">Sending...</span> // [!code ++]
      <span v-else>Send</span> // [!code ++]
    </button>
    <div v-if="hash">Transaction Hash: {{ hash }}</div>
  </form>
</template>
```

:::

### 6. Wait for transaction receipt (optional)

We can also display the transaction confirmation status to the user by using the [`useWaitForTransactionReceipt` Composable](/vue/api/composables/useWaitForTransactionReceipt).

::: code-group

```vue [SendTransaction.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/send-transaction.md","from":4451,"to":5686}<fsm-vh3gqscxm4e>
<script setup lang="ts">
  import { 
    useSendTransaction,
    useWaitForTransactionReceipt, // [!code ++]
  } from 'wagmi'
  import { parseEther } from 'viem'

  const { 
    data: hash, 
    isPending,
    sendTransaction 
  } = useSendTransaction()

  function submit(event: Event) {
    const formData = new FormData(event.target as HTMLFormElement)
    const to = formData.get('address') as `0x${string}`
    const value = formData.get('value') as string
    sendTransaction({ to, value: parseEther(value) })
  }

  const { isLoading: isConfirming, isSuccess: isConfirmed } = // [!code ++]
    useWaitForTransactionReceipt({ // [!code ++]
      hash, // [!code ++]
    }) // [!code ++]
</script>

<template>
  <form @submit.prevent="submit">
    <input name="address" placeholder="0xA0Cf…251e" required />
    <input name="value" placeholder="0.05" required />
    <button :disabled="isPending" type="submit">
      <span v-if="isPending">Sending...</span>
      <span v-else>Send</span>
    </button>
    <div v-if="hash">Transaction Hash: {{ hash }}</div>
    <div v-if="isConfirming">Waiting for confirmation...</div> // [!code ++]
    <div v-if="isConfirmed">Transaction Confirmed!</div> // [!code ++]
  </form>
</template>
```

:::

### 7. Handle errors (optional)

If the user rejects the transaction, or the user does not have enough funds to cover the transaction, we can display an error message to the user.

::: code-group

```vue [SendTransaction.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/send-transaction.md","from":5922,"to":7236}<fsm-vh3gqscxm4e>
<script setup lang="ts">
  import { 
    useSendTransaction,
    useWaitForTransactionReceipt,
  } from 'wagmi'
  import { parseEther } from 'viem'

  const { 
    data: hash, 
    error, // [!code ++]
    isPending,
    sendTransaction 
  } = useSendTransaction()

  function submit(event: Event) {
    const formData = new FormData(event.target as HTMLFormElement)
    const to = formData.get('address') as `0x${string}`
    const value = formData.get('value') as string
    sendTransaction({ to, value: parseEther(value) })
  }

  const { isLoading: isConfirming, isSuccess: isConfirmed } = 
    useWaitForTransactionReceipt({ 
      hash, 
    }) 
</script>

<template>
  <form @submit.prevent="submit">
    <input name="address" placeholder="0xA0Cf…251e" required />
    <input name="value" placeholder="0.05" required />
    <button :disabled="isPending" type="submit">
      <span v-if="isPending">Sending...</span>
      <span v-else>Send</span>
    </button>
    <div v-if="hash">Transaction Hash: {{ hash }}</div>
    <div v-if="isConfirming">Waiting for confirmation...</div> 
    <div v-if="isConfirmed">Transaction Confirmed!</div> 
    <div v-if="error"> // [!code ++]
      Error: {{ (error as BaseError).shortMessage || error.message }} // [!code ++]
    </div> // [!code ++]
  </form>
</template>
```

:::

### 8. Wire it up!

Finally, we can wire up our Send Transaction component to our application's entrypoint.

:::code-group

```vue [App.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/send-transaction.md","from":7386,"to":7785}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnection } from '@wagmi/vue'
import Connection from './Connection.vue'
import Connect from './Connect.vue'
import SendTransaction from './SendTransaction.vue' // [!code ++]

const { isConnected } = useConnection()
</script>

<template>
  <Connection v-if="isConnected" />
  <Connect v-else />
  <SendTransaction v-if="isConnected" /> // [!code ++]
</template>
```

```vue [SendTransaction.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/send-transaction.md","from":7818,"to":9076}<fsm-vh3gqscxm4e>
<script setup lang="ts">
  import { 
    useSendTransaction,
    useWaitForTransactionReceipt,
  } from 'wagmi'
  import { parseEther } from 'viem'

  const { 
    data: hash, 
    error,
    isPending,
    sendTransaction 
  } = useSendTransaction()

  function submit(event: Event) {
    const formData = new FormData(event.target as HTMLFormElement)
    const to = formData.get('address') as `0x${string}`
    const value = formData.get('value') as string
    sendTransaction({ to, value: parseEther(value) })
  }

  const { isLoading: isConfirming, isSuccess: isConfirmed } = 
    useWaitForTransactionReceipt({ 
      hash, 
    }) 
</script>

<template>
  <form @submit.prevent="submit">
    <input name="address" placeholder="0xA0Cf…251e" required />
    <input name="value" placeholder="0.05" required />
    <button :disabled="isPending" type="submit">
      <span v-if="isPending">Sending...</span>
      <span v-else>Send</span>
    </button>
    <div v-if="hash">Transaction Hash: {{ hash }}</div>
    <div v-if="isConfirming">Waiting for confirmation...</div> 
    <div v-if="isConfirmed">Transaction Confirmed!</div> 
    <div v-if="error">
      Error: {{ (error as BaseError).shortMessage || error.message }}
    </div>
  </form>
</template>
```

:::

[See the Example.](#example)

---

---
url: /core/api/actions/sendCalls.md
---
# sendCalls

Action that requests for the wallet to sign and broadcast a batch of calls (transactions) to the network.

[Read more.](https://github.com/ethereum/EIPs/blob/815028dc634463e1716fc5ce44c019a6040f0bef/EIPS/eip-5792.md#wallet_sendcalls)

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendCalls.md","from":389,"to":429}<fsm-vh3gqscxm4e>
import { sendCalls } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendCalls.md","from":476,"to":833}<fsm-vh3gqscxm4e>
import { parseEther } from 'viem'
import { sendCalls } from '@wagmi/core'
import { config } from './config'

const id = await sendCalls(config, {
  calls: [
    {
      to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
      value: parseEther('1')
    },
    {
      data: '0xdeadbeef',
      to: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
    },
  ]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### Synchronous Usage

If you want to wait for the calls to be included in a block before returning, you can use `sendCallsSync`:

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendCalls.md","from":1046,"to":1416}<fsm-vh3gqscxm4e>
import { parseEther } from 'viem'
import { sendCallsSync } from '@wagmi/core'
import { config } from './config'

const receipt = await sendCallsSync(config, {
  calls: [
    {
      to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
      value: parseEther('1')
    },
    {
      data: '0xdeadbeef',
      to: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
    },
  ]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendCalls.md","from":1487,"to":1542}<fsm-vh3gqscxm4e>
import { type SendCallsParameters } from '@wagmi/core'
```

### account

`Account | Address | null | undefined`

Account to execute the calls.

If set to `null`, it is assumed that the wallet will handle filling the sender of the calls.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendCalls.md","from":1758,"to":2190}<fsm-vh3gqscxm4e>
import { parseEther } from 'viem'
import { sendCalls } from '@wagmi/core'
import { config } from './config'

const id = await sendCalls(config, {
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', // [!code focus]
  calls: [
    {
      to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
      value: parseEther('1')
    },
    {
      data: '0xdeadbeef',
      to: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
    },
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### calls

`{ to: Hex, data?: Hex, value?: bigint }[]`

Calls to execute.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendCalls.md","from":2347,"to":2875}<fsm-vh3gqscxm4e>
import { parseEther } from 'viem'
import { sendCalls } from '@wagmi/core'
import { config } from './config'

const id = await sendCalls(config, {
  calls: [ // [!code focus]
    { // [!code focus]
      to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', // [!code focus]
      value: parseEther('1') // [!code focus]
    }, // [!code focus]
    { // [!code focus]
      data: '0xdeadbeef', // [!code focus]
      to: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC', // [!code focus]
    }, // [!code focus]
  ], // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### capabilities

`WalletCapabilities | undefined`

Capability metadata for the calls (e.g. specifying a paymaster).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendCalls.md","from":3075,"to":3595}<fsm-vh3gqscxm4e>
import { parseEther } from 'viem'
import { sendCalls } from '@wagmi/core'
import { config } from './config'

const id = await sendCalls(config, {
  calls: [
    {
      to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
      value: parseEther('1')
    },
    {
      data: '0xdeadbeef',
      to: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
    },
  ],
  capabilities: { // [!code focus]
    paymasterService: { // [!code focus]
      url: 'https://...' // [!code focus]
    } // [!code focus]
  } // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`number | undefined`

The target chain ID to broadcast the calls.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendCalls.md","from":3757,"to":4147}<fsm-vh3gqscxm4e>
import { parseEther } from 'viem'
import { sendCalls } from '@wagmi/core'
import { config } from './config'

const id = await sendCalls(config, {
  calls: [
    {
      to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
      value: parseEther('1')
    },
    {
      data: '0xdeadbeef',
      to: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
    },
  ],
  chainId: 10, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

Connector to get send the calls with.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendCalls.md","from":4308,"to":4811}<fsm-vh3gqscxm4e>
import { parseEther } from 'viem'
import { getConnections } from '@wagmi/core'
import { sendCalls } from '@wagmi/core'
import { config } from './config'

const connections = getConnections(config)
const id = await sendCalls(config, {
  calls: [
    {
      to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
      value: parseEther('1')
    },
    {
      data: '0xdeadbeef',
      to: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
    },
  ],
  connector: connections[0]?.connector, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendCalls.md","from":4883,"to":4938}<fsm-vh3gqscxm4e>
import { type SendCallsReturnType } from '@wagmi/core'
```

`{ id: string; capabilities?: WalletCapabilities | undefined }`

Identifier of the call batch.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendCalls.md","from":5055,"to":5109}<fsm-vh3gqscxm4e>
import { type SendCallsErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`sendCalls`](https://viem.sh/docs/actions/wallet/sendCalls)

---

---
url: /core/api/actions/sendTransaction.md
---
# sendTransaction

Action for creating, signing, and sending transactions to networks.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendTransaction.md","from":237,"to":283}<fsm-vh3gqscxm4e>
import { sendTransaction } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendTransaction.md","from":330,"to":576}<fsm-vh3gqscxm4e>
import { sendTransaction } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await sendTransaction(config, {
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### Synchronous Usage

If you want to wait for the transaction to be included in a block before returning, you can use `sendTransactionSync`:

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendTransaction.md","from":801,"to":1056}<fsm-vh3gqscxm4e>
import { sendTransactionSync } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const receipt = await sendTransactionSync(config, {
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendTransaction.md","from":1127,"to":1188}<fsm-vh3gqscxm4e>
import { type SendTransactionParameters } from '@wagmi/core'
```

### accessList

`AccessList | undefined`

The access list.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendTransaction.md","from":1285,"to":1668}<fsm-vh3gqscxm4e>
import { sendTransaction } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await sendTransaction(config, {
  accessList: [{ // [!code focus]
    address: '0x1', // [!code focus]
    storageKeys: ['0x1'], // [!code focus]
  }], // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### account

`Address | Account | undefined`

Account to use when sending transaction. Throws if account is not found on [`connector`](#connector).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendTransaction.md","from":1899,"to":2219}<fsm-vh3gqscxm4e>
import { sendTransaction } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await sendTransaction(config, {
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

Chain ID to validate against before sending transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendTransaction.md","from":2418,"to":2749}<fsm-vh3gqscxm4e>
import { sendTransaction } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { parseEther } from 'viem'
import { config } from './config'

const result = await sendTransaction(config, {
  chainId: mainnet.id, // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

* Connector to send transaction with.
* Defaults to current connector.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendTransaction.md","from":2943,"to":3305}<fsm-vh3gqscxm4e>
import { getConnections, sendTransaction } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const connections = getConnections(config)
const result = await sendTransaction(config, {
  connector: connections[0]?.connector, // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### data

`` `0x${string}` | undefined ``

A contract hashed method call with encoded args.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendTransaction.md","from":3480,"to":3797}<fsm-vh3gqscxm4e>
import { sendTransaction } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await sendTransaction(config, {
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### gas

`bigint | undefined | null`

Gas provided for transaction execution.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendTransaction.md","from":3958,"to":4256}<fsm-vh3gqscxm4e>
import { sendTransaction } from '@wagmi/core'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

const result = await sendTransaction(config, {
  gas: parseGwei('20'), // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### gasPrice

`bigint | undefined`

The price in wei to pay per gas. Only applies to [Legacy Transactions](https://viem.sh/docs/glossary/terms#legacy-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendTransaction.md","from":4508,"to":4811}<fsm-vh3gqscxm4e>
import { sendTransaction } from '@wagmi/core'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

const result = await sendTransaction(config, {
  gasPrice: parseGwei('20'), // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxFeePerGas

`bigint | undefined`

Total fee per gas in wei, inclusive of [`maxPriorityFeePerGas`](#maxPriorityFeePerGas). Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendTransaction.md","from":5121,"to":5428}<fsm-vh3gqscxm4e>
import { sendTransaction } from '@wagmi/core'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

const result = await sendTransaction(config, {
  maxFeePerGas: parseGwei('20'), // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxPriorityFeePerGas

`bigint | undefined`

Max priority fee per gas in wei. Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendTransaction.md","from":5691,"to":6038}<fsm-vh3gqscxm4e>
import { sendTransaction } from '@wagmi/core'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

const result = await sendTransaction(config, {
  maxFeePerGas: parseGwei('20'),
  maxPriorityFeePerGas: parseGwei('2'), // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### nonce

`number`

Unique number identifying this transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendTransaction.md","from":6191,"to":6468}<fsm-vh3gqscxm4e>
import { sendTransaction } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await sendTransaction(config, {
  nonce: 123, // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### to

`Address`

The transaction recipient or contract address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendTransaction.md","from":6617,"to":6880}<fsm-vh3gqscxm4e>
import { sendTransaction } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await sendTransaction(config, {
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### type

`'legacy' | 'eip1559' | 'eip2930' | undefined`

Optional transaction request type to narrow parameters.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendTransaction.md","from":7077,"to":7359}<fsm-vh3gqscxm4e>
import { sendTransaction } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await sendTransaction(config, {
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  type: 'eip1559', // [!code focus]
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### value

`bigint | undefined`

Value in wei sent with this transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendTransaction.md","from":7516,"to":7780}<fsm-vh3gqscxm4e>
import { sendTransaction } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await sendTransaction(config, {
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B', 
  value: parseEther('0.01'), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendTransaction.md","from":7852,"to":7913}<fsm-vh3gqscxm4e>
import { type SendTransactionReturnType } from '@wagmi/core'
```

[`Hash`](https://viem.sh/docs/glossary/types#hash)

Transaction hash.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/sendTransaction.md","from":8005,"to":8065}<fsm-vh3gqscxm4e>
import { type SendTransactionErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Viem

* [`sendTransaction`](https://viem.sh/docs/actions/wallet/sendTransaction)

---

---
url: /core/api/utilities/serialize.md
---

# serialize

Serialize function that supports `bigint` and `Map`.

## Import

```ts-vue
import { serialize } from '{{packageName}}'
```

## Usage

```ts-vue
import { serialize } from '{{packageName}}'

const result = serialize({ foo: 'wagmi', bar: 123n })
```

## Parameters

### value

`any`

The value to stringify.

### replacer

`(key: string, value: any) => any`

A custom replacer function for handling standard values.

### indent

`number | null | undefined`

The number of spaces to indent the output by.

### circularReplacer

A custom replacer function for handling circular values.

## Return Type

`string`

Stringified value.

---

---
url: /react/api/utilities/serialize.md
---

# serialize

Serialize function that supports `bigint` and `Map`.

## Import

```ts-vue
import { serialize } from '{{packageName}}'
```

## Usage

```ts-vue
import { serialize } from '{{packageName}}'

const result = serialize({ foo: 'wagmi', bar: 123n })
```

## Parameters

### value

`any`

The value to stringify.

### replacer

`(key: string, value: any) => any`

A custom replacer function for handling standard values.

### indent

`number | null | undefined`

The number of spaces to indent the output by.

### circularReplacer

A custom replacer function for handling circular values.

## Return Type

`string`

Stringified value.

---

---
url: /shared/utilities/serialize.md
---
# serialize

Serialize function that supports `bigint` and `Map`.

## Import

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/utilities/serialize.md","from":151,"to":195}<fsm-vh3gqscxm4e>
import { serialize } from '{{packageName}}'
```

## Usage

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/utilities/serialize.md","from":220,"to":319}<fsm-vh3gqscxm4e>
import { serialize } from '{{packageName}}'

const result = serialize({ foo: 'wagmi', bar: 123n })
```

## Parameters

### value

`any`

The value to stringify.

### replacer

`(key: string, value: any) => any`

A custom replacer function for handling standard values.

### indent

`number | null | undefined`

The number of spaces to indent the output by.

### circularReplacer

A custom replacer function for handling circular values.

## Return Type

`string`

Stringified value.

---

---
url: /vue/api/utilities/serialize.md
---

# serialize

Serialize function that supports `bigint` and `Map`.

## Import

```ts-vue
import { serialize } from '{{packageName}}'
```

## Usage

```ts-vue
import { serialize } from '{{packageName}}'

const result = serialize({ foo: 'wagmi', bar: 123n })
```

## Parameters

### value

`any`

The value to stringify.

### replacer

`(key: string, value: any) => any`

A custom replacer function for handling standard values.

### indent

`number | null | undefined`

The number of spaces to indent the output by.

### circularReplacer

A custom replacer function for handling circular values.

## Return Type

`string`

Stringified value.

---

---
url: /core/api/actions/showCallsStatus.md
---
# showCallsStatus

Action to request for the wallet to show information about a call batch that was sent via `sendCalls`.

[Read more.](https://github.com/ethereum/EIPs/blob/1663ea2e7a683285f977eda51c32cec86553f585/EIPS/eip-5792.md#wallet_showcallsstatus)

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/showCallsStatus.md","from":409,"to":455}<fsm-vh3gqscxm4e>
import { showCallsStatus } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/showCallsStatus.md","from":502,"to":646}<fsm-vh3gqscxm4e>
import { showCallsStatus } from '@wagmi/core'
import { config } from './config'

await showCallsStatus(config, {
  id: '0x1234567890abcdef',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/showCallsStatus.md","from":717,"to":778}<fsm-vh3gqscxm4e>
import { type ShowCallsStatusParameters } from '@wagmi/core'
```

### connector

`Connector | undefined`

Connector to show call statuses with.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/showCallsStatus.md","from":894,"to":1154}<fsm-vh3gqscxm4e>
import { getConnections, showCallsStatus } from '@wagmi/core'
import { config } from './config'

const connections = getConnections(config)
await showCallsStatus(config, {
  connector: connections[0]?.connector, // [!code focus]
  id: '0x1234567890abcdef',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### id

`string`

Identifier of the call batch.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/showCallsStatus.md","from":1285,"to":1446}<fsm-vh3gqscxm4e>
import { showCallsStatus } from '@wagmi/core'
import { config } from './config'

await showCallsStatus(config, {
  id: '0x1234567890abcdef', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/showCallsStatus.md","from":1518,"to":1579}<fsm-vh3gqscxm4e>
import { type ShowCallsStatusReturnType } from '@wagmi/core'
```

`bigint`

Most recent block number seen.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/showCallsStatus.md","from":1642,"to":1702}<fsm-vh3gqscxm4e>
import { type ShowCallsStatusErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`showCallsStatus`](https://viem.sh/docs/actions/wallet/showCallsStatus)

---

---
url: /core/api/actions/signMessage.md
---
# signMessage

Action for signing messages.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signMessage.md","from":186,"to":228}<fsm-vh3gqscxm4e>
import { signMessage } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signMessage.md","from":275,"to":406}<fsm-vh3gqscxm4e>
import { signMessage } from '@wagmi/core'
import { config } from './config'

await signMessage(config, { message: 'hello world' })
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signMessage.md","from":477,"to":534}<fsm-vh3gqscxm4e>
import { type SignMessageParameters } from '@wagmi/core'
```

### account

`Address | Account | undefined`

Account to use when signing message. Throws if account is not found on [`connector`](#connector).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signMessage.md","from":716,"to":939}<fsm-vh3gqscxm4e>
import { signMessage } from '@wagmi/core'
import { config } from './config'

const result = await signMessage(config, {
  account: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
  message: 'hello world',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

[Connector](/core/api/connectors) to sign message with.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signMessage.md","from":1118,"to":1356}<fsm-vh3gqscxm4e>
import { getConnection, signMessage } from '@wagmi/core'
import { config } from './config'

const { connector } = getConnection(config)
const result = await signMessage(config, {
  connector, // [!code focus]
  message: 'hello world',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### message

`string | { raw: Hex | ByteArray }`

Message to sign.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signMessage.md","from":1506,"to":1672}<fsm-vh3gqscxm4e>
import { signMessage } from '@wagmi/core'
import { config } from './config'

const result = await signMessage(config, {
  message: 'hello world', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: tip
By default, viem signs the UTF-8 representation of the message. To sign the data representation of the message, you can use the `raw` attribute.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signMessage.md","from":1882,"to":2070}<fsm-vh3gqscxm4e>
import { signMessage } from '@wagmi/core'
import { config } from './config'

const result = await signMessage(config, {
  message: { raw: '0x68656c6c6f20776f726c64' }, // [!code focus]
})
```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signMessage.md","from":2101,"to":2158}<fsm-vh3gqscxm4e>
import { type SignMessageReturnType } from '@wagmi/core'
```

[`Hex`](https://viem.sh/docs/glossary/types#hex)

The signed message.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signMessage.md","from":2250,"to":2306}<fsm-vh3gqscxm4e>
import { type SignMessageErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Viem

* [`signMessage`](https://viem.sh/docs/actions/wallet/signMessage)

---

---
url: /core/api/actions/signTransaction.md
---
# signTransaction

Action for creating and signing transactions to networks.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTransaction.md","from":227,"to":273}<fsm-vh3gqscxm4e>
import { signTransaction } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTransaction.md","from":321,"to":567}<fsm-vh3gqscxm4e>
import { signTransaction } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await signTransaction(config, {
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### Synchronous Usage

If you want to wait for the transaction to be included in a block before returning, you can use `signTransactionSync`:

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTransaction.md","from":794,"to":1049}<fsm-vh3gqscxm4e>
import { signTransactionSync } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const receipt = await signTransactionSync(config, {
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTransaction.md","from":1121,"to":1182}<fsm-vh3gqscxm4e>
import { type SignTransactionParameters } from '@wagmi/core'
```

### accessList

`AccessList | undefined`

The access list.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTransaction.md","from":1280,"to":1663}<fsm-vh3gqscxm4e>
import { signTransaction } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await signTransaction(config, {
  accessList: [{ // [!code focus]
    address: '0x1', // [!code focus]
    storageKeys: ['0x1'], // [!code focus]
  }], // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### account

`Address | Account | undefined`

Account to use when signing transaction. Throws if account is not found on [`connector`](#connector).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTransaction.md","from":1896,"to":2216}<fsm-vh3gqscxm4e>
import { signTransaction } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await signTransaction(config, {
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

Chain ID to validate against before signing transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTransaction.md","from":2417,"to":2748}<fsm-vh3gqscxm4e>
import { signTransaction } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { parseEther } from 'viem'
import { config } from './config'

const result = await signTransaction(config, {
  chainId: mainnet.id, // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

* Connector to sign transaction with.
* Defaults to current connector.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTransaction.md","from":2944,"to":3306}<fsm-vh3gqscxm4e>
import { getConnections, signTransaction } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const connections = getConnections(config)
const result = await signTransaction(config, {
  connector: connections[0]?.connector, // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### data

`` `0x${string}` | undefined ``

A contract hashed method call with encoded args.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTransaction.md","from":3483,"to":3800}<fsm-vh3gqscxm4e>
import { signTransaction } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await signTransaction(config, {
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### gas

`bigint | undefined | null`

Gas provided for transaction execution.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTransaction.md","from":3963,"to":4261}<fsm-vh3gqscxm4e>
import { signTransaction } from '@wagmi/core'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

const result = await signTransaction(config, {
  gas: parseGwei('20'), // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### gasPrice

`bigint | undefined`

The price in wei to pay per gas. Only applies to [Legacy Transactions](https://viem.sh/docs/glossary/terms#legacy-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTransaction.md","from":4515,"to":4818}<fsm-vh3gqscxm4e>
import { signTransaction } from '@wagmi/core'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

const result = await signTransaction(config, {
  gasPrice: parseGwei('20'), // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxFeePerGas

`bigint | undefined`

Total fee per gas in wei, inclusive of [`maxPriorityFeePerGas`](#maxpriorityfeepergas). Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTransaction.md","from":5130,"to":5437}<fsm-vh3gqscxm4e>
import { signTransaction } from '@wagmi/core'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

const result = await signTransaction(config, {
  maxFeePerGas: parseGwei('20'), // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxPriorityFeePerGas

`bigint | undefined`

Max priority fee per gas in wei. Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTransaction.md","from":5702,"to":6049}<fsm-vh3gqscxm4e>
import { signTransaction } from '@wagmi/core'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

const result = await signTransaction(config, {
  maxFeePerGas: parseGwei('20'),
  maxPriorityFeePerGas: parseGwei('2'), // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### nonce

`number`

Unique number identifying this transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTransaction.md","from":6204,"to":6481}<fsm-vh3gqscxm4e>
import { signTransaction } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await signTransaction(config, {
  nonce: 123, // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### to

`Address`

The transaction recipient or contract address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTransaction.md","from":6632,"to":6895}<fsm-vh3gqscxm4e>
import { signTransaction } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await signTransaction(config, {
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### type

`'legacy' | 'eip1559' | 'eip2930' | undefined`

Optional transaction request type to narrow parameters.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTransaction.md","from":7094,"to":7376}<fsm-vh3gqscxm4e>
import { signTransaction } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await signTransaction(config, {
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  type: 'eip1559', // [!code focus]
  value: parseEther('0.01'),
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### value

`bigint | undefined`

Value in wei sent with this transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTransaction.md","from":7535,"to":7798}<fsm-vh3gqscxm4e>
import { signTransaction } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

const result = await signTransaction(config, {
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTransaction.md","from":7871,"to":7932}<fsm-vh3gqscxm4e>
import { type SignTransactionReturnType } from '@wagmi/core'
```

[`Hash`](https://viem.sh/docs/glossary/types#hash)

Transaction hash.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTransaction.md","from":8024,"to":8084}<fsm-vh3gqscxm4e>
import { type SignTransactionErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Viem

* [`signTransaction`](https://viem.sh/docs/actions/wallet/signTransaction)

---

---
url: /core/api/actions/signTypedData.md
---
# signTypedData

Action for signing typed data and calculating an Ethereum-specific [EIP-712](https://eips.ethereum.org/EIPS/eip-712) signature.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTypedData.md","from":291,"to":335}<fsm-vh3gqscxm4e>
import { signTypedData } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTypedData.md","from":382,"to":1034}<fsm-vh3gqscxm4e>
import { signTypedData } from '@wagmi/core'
import { config } from './config'

const result = await signTypedData(config, {
  types: {
    Person: [
      { name: 'name', type: 'string' },
      { name: 'wallet', type: 'address' },
    ],
    Mail: [
      { name: 'from', type: 'Person' },
      { name: 'to', type: 'Person' },
      { name: 'contents', type: 'string' },
    ],
  },
  primaryType: 'Mail',
  message: {
    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTypedData.md","from":1105,"to":1164}<fsm-vh3gqscxm4e>
import { type SignTypedDataParameters } from '@wagmi/core'
```

### account

`Address | Account | undefined`

Account to use when signing data. Throws if account is not found on [`connector`](#connector).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTypedData.md","from":1343,"to":1853}<fsm-vh3gqscxm4e>
import { signTypedData } from '@wagmi/core'
import { config } from './config'
import { types } from './typedData'

const result = await signTypedData(config, {
  account: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
  types,
  primaryType: 'Mail',
  message: {
    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

[Connector](/core/api/connectors) to sign data with.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTypedData.md","from":2071,"to":2596}<fsm-vh3gqscxm4e>
import { getConnection, signTypedData } from '@wagmi/core'
import { config } from './config'
import { types } from './typedData'

const { connector } = getConnection(config)
const result = await signTypedData(config, {
  connector, // [!code focus]
  types,
  primaryType: 'Mail',
  message: {
    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### domain

`TypedDataDomain | undefined`

* The typed data domain.
* If `EIP712Domain` key exists in [`types`](#types), `domain` schema is inferred from it.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTypedData.md","from":2879,"to":3561}<fsm-vh3gqscxm4e>
import { signTypedData } from '@wagmi/core'
import { config } from './config'
import { types } from './typedData'

const result = await signTypedData(config, {
  domain: { // [!code focus]
    name: 'Ether Mail', // [!code focus]
    chainId: 1, // [!code focus]
    verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC', // [!code focus]
    version: '1', // [!code focus]
  }, // [!code focus]
  types,
  primaryType: 'Mail',
  message: {
    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### message

`Record<string, unknown>`

* Data to sign.
* Type inferred from [`types`](#types) and [`primaryType`](#primarytype).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTypedData.md","from":3816,"to":4439}<fsm-vh3gqscxm4e>
import { signTypedData } from '@wagmi/core'
import { config } from './config'
import { types } from './typedData'

const result = await signTypedData(config, {
  types,
  primaryType: 'Mail',
  message: { // [!code focus]
    from: { // [!code focus]
      name: 'Cow', // [!code focus]
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826', // [!code focus]
    }, // [!code focus]
    to: { // [!code focus]
      name: 'Bob', // [!code focus]
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB', // [!code focus]
    }, // [!code focus]
    contents: 'Hello, Bob!', // [!code focus]
  }, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### primaryType

`string`

* The primary type to extract from [`types`](#types) and use in [`message`](#message).
* Type inferred from [`types`](#types).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTypedData.md","from":4718,"to":5171}<fsm-vh3gqscxm4e>
import { signTypedData } from '@wagmi/core'
import { config } from './config'
import { types } from './typedData'

const result = await signTypedData(config, {
  types,
  primaryType: 'Mail', // [!code focus]
  message: {
    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### types

`TypedData`

* The type definitions for the typed data.
* By defining inline or adding a [const assertion](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#const-assertions) to `types`, TypeScript will infer the correct types for [`message`](#message) and [`primaryType`](#primarytype). See the Wagmi [TypeScript docs](/core/typescript) for more information.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTypedData.md","from":5696,"to":6535}<fsm-vh3gqscxm4e>
import { signTypedData } from '@wagmi/core'
import { config } from './config'

const result = await signTypedData(config, {
  types: { // [!code focus]
    Person: [ // [!code focus]
      { name: 'name', type: 'string' }, // [!code focus]
      { name: 'wallet', type: 'address' }, // [!code focus]
    ], // [!code focus]
    Mail: [ // [!code focus]
      { name: 'from', type: 'Person' }, // [!code focus]
      { name: 'to', type: 'Person' }, // [!code focus]
      { name: 'contents', type: 'string' }, // [!code focus]
    ], // [!code focus]
  }, // [!code focus]
  primaryType: 'Mail',
  message: {
    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTypedData.md","from":6607,"to":6666}<fsm-vh3gqscxm4e>
import { type SignTypedDataReturnType } from '@wagmi/core'
```

[`Hex`](https://viem.sh/docs/glossary/types#hex)

The signed data.

## Type Inference

With [`types`](#types) setup correctly, TypeScript will infer the correct types for [`domain`](#domain), [`message`](#message), and [`primaryType`](#primarytype). See the Wagmi [TypeScript docs](/core/typescript) for more information.

::: code-group

```ts twoslash [Inline]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTypedData.md","from":7033,"to":11532}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"44d90fe296d503e3675e18b904994e8969cc43a5fc5d95c28c6ca88739b0e3f3","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BjCMONAAlPgFcAbNROwAGABloASYG1IBLMAHMAvkMog2AQ1INEANiq8YCtPiR7qm+TG0gucPg31zciEVUb5N6xjXK7FFdGxnAmIyVRp6PAAKdV4ZdTgASnY4GXkwABUgqAARdTR1AB5gAB0wdgrOGHUoFl4MdgAFMjgWQS4auobUMsq+qs6wevYwdQBbGEES8HGYaYBuXv6KjtqhhswcKbU0WQUFpYr/dlLy5YG14dGJ7YB3WIM0A7Pl1a72Tcn2aZqoWzhnn1FABdRYvC7vACy6hkvHa1Uu3VO5wh6xGs22ADNSBAxoDzm80Z9ts1SK0wPijhQTod+oSrhjvtQIJS6Qj3sSmaTyazjsiCey0dcvtNmGAaOKASAwSj6RsgttpHJ5LzQWVjtNobDpgA+KJizFpQQAYRYhvk1KwngmPjggn5FU+dpp4L6cqaLTaqOGPVdAsGDJuTOFrNlguGnOmSv20tpQOpDpR3oawruDysof9iI+CqZv3+maOar9K3DDS1cOT7F9Scq7tTTOxuMLbID8q2XM9FNjJfYfLjWfeDemaBZPdrpbbOY7025LBb/d7brL6KDopYErQUplE/dkZ2exV4/OIJ3RzP7AAdNf2AAWdhjCBcK/Xi9isAwbxPgD8JpYH6/Uh2AAH3YbgwFgQ0PygMFFESQRGhxMYZDgGBCgAZTSTJsjyAoACUrG4UhsJwHUyhkMYsCfDhUnSLIcFyfJ1FUWpGAQRACDQNAsDtAB6Xj7nkZDLzgfBeOYLhePULAZCk7wZBYOBeNokiYEYgpVA0LQkAAJgARn0Qx5GMJA9IAZioApSEsawVPotTcOYxwPyQVwQHcTxvDCRB9P8QIcDwQgSHISy6GsMU2HYA0jXYU0wHNQp3RrSoACNeAgRgAGsAFFaCwdKuDJe0B0nbNIPUexiqXOsV2HEBsuMFpGHUbsLzDKciMraZ8C4njEH4qx8CalrLwUltlynaSZAAVVILrOO4vipJky9BuGsBRogZaZAXC9FAvNKMsyjIKK+PSdJES63w3UgvC3Kr2uzQw4GmsAZGCuBYgI1peGCh7dxXfN4GdaYxBgcGIfBvTbygAB2PSAA5GB0lLb1hqAAE4MZ0szYHUFLzLMgBWGBodvSHxpqqdDqy40OhoKBBBxkQEaJtmEbayp9pKqsxnsGRmt4XgzP+2t3SBuAQZAMRmr0vSUtgEQiYx2HYZSsydDMuWdFhkQdIRhGdBRmAdPUPTYbMlWdFlvTKdK94acyunqgZwRoeJjWRD0znz1pbnwWvS92Ghh8nxgF9LwvYKZExDAAAkEnwX92CifU4kMARYvT8VCkDnVLWtKwWkEAA1MgY/jxPGkL21kgAXh1JokJQtCUogCADBanVklA8DIKcGD1QTWlA9g4Fh4D18h6rZ38hgOKANHUgADEwGQYEdU0qztGJwyjBMXRLIsKwmDNNJVDiFyXDcDxbq83xib86ggkC0IQuoMLoiwHEcC0DBkidKLKsc4wDwinMlV4tVGTTBDMeSBU59zRiPHtCej0hzQJAPcIWGY4GtmzPuCW24/bFgmtmCsYDswQLwegtcIAmx4lwaQjkuZZxdl5KgwcQoMGjhbHuFhIAQHsJdGgrhtCxSbiIb2PhM4DzKlVLBLemhtBoz3sZA+RMj7WRPhxJ0F8nCmRvp5Hwukn6fFfsFcIn8OJRG/hAX+mBkggIoe8Kh9YMGwIvNIkUsiYywQ4fbUR3isGPFZF47YhDnggkUdpXQbkDD71MJomyeAQF6KvjpQxd9jGIFvKYl+HEgphFCpEaxtj7H/1XN42B0TtCwwRqokyOSknaJmBMNJzgLLuVvndbyCM8kBQKW/SxJSQA2J/mQBx05vFIOmDUpA2MGkH1vM06wZjnIdMyT03wOkdL9OCIU9+ERrBjLsRMipdVgk4LmYgOW9SQDxLUUgZZ5gtHWGFO0p5mz75ID6QEZ+AyQgWOKccspZyAH8IiSAa55lnkPMac8qyySdEv3WZ8rpRjvI6VyX8sxgygUfxGSc8pyRyFVlcVA2h9DQkrn3IInsi4mGBO2Dw3BYTOxknnPS/xVY6riIzpIxlEZ+EzPpcCaFOhYVGXhSsvAFYPmH3RVk7y2L/L7KGcCr+4y/7JDqlSqFVAtLaERnEqVSyZUcXeaixAsMvnZN+aq8xRSCUgq1ZM2lbD9U7CUaZDGkqElNJeUi/5uArU2sVVs3SuycX5MBU6o5mrTnasqcysc1ydkmv9Qi4+bzZjyruR5JVvh7XBsdYcqxozQVJvdRy7saazIZPuaatFiKWlrPufoxA+bunfJ8iIPZpbhkusTZM3lG5+WzINdvXSRM7lwrNYGlplr21Xwxra3p/a8VxvLUSsFUzFS7DkZ6w1ulYZmDnc27NeA22X2cKu8NPadI6A3bGsthLK2TO/hRTQGB7Ikg9SBJkFYJ1epiWZFmizTIGQXdYT9Yxv32XledNd2zn0AEduBkAwIOhNxL2Cwfg/wulAHNQwl4MB49iAwOzqbTcqDLaYOyDg6QH9KLl3OCQ/e7JUaHWbtfUO3DExJbqEsEA+hQC+gNiQT7dglzM6iAkFIA9ChlB7QvKOcTlRJNKfkNJ2Tgh5OSCQSpv211xT8sEFJ9U1yzI2Yg9a81IBBOfUsIhjRnHMVoYw8x7DpTXUVKc8Jr4iYxPCPOFpw8un0xybEIZ7TxnwT+z6Op0LyxwvKki9g6LCmjNCFU7SPlkoLPaYUZO71lHbONv9WG+jeAAsuatXpNzBaI0+WfQcnzFa/PJBC4mNLCgLx6eEDFxTh54uKGszoDNjyA01Y4vQ+V+tkNPLa+q51OHd19fkNZ2GfrptZteXgJdN7dJ3uaz2p90aAXtY1b54dFTBsGZG8qZQ1mMadPPQq2bmCovyrA0tvwl21X4vjbd3DyXeuMks+CB7w2cslZA8omddmG1fdHL9htZ3skqpLbxjrO6k2beuWjKb0roOHdzVairmPvIXZ4y+vH777tRf07DuLKhSsxNvAjO9H2zBfdk79551PfC05x/Tm7nW7vJAK/dFI2nrls1240u5X2ZcIEp2YYXy3x7uWgMECKHBbD2HYHXdg6h7gyBolhey6l1D6jPhaULgCUsehrYIZAA5gDJvYAAcmFD76knIfdIJ932Cgnvvc+9kwHvdvvCGh/8LScetJSUe79F7hsPv6Ex6DyAhP4f0+R9HDn3MPu89h4j5ntXJeOzB+0/npPBeqRLHw8x39vuKwB7KN3s4dWgs94HxSIfg/B99B6wOTPppbhd79INn3YhjQ5FNrjDGy83sI2yuZRfvrYbZUYErAAgilY0sNl7ZQtreHImIEY5ByAjR9M/4y0nBxPxkPuABCEAUqP/6HPsQKV38AD39gCUogDADQDwDwCIDACoCAC4CgCACf9m9wQ1dBAfc44YAhYIBqRP8UoABCH/RPMAOCVQG0ZiRAUAMKZ6BSMAK9BARQRQIAA"}
import { createConfig, http, signTypedData } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
// ---cut---
const result = await signTypedData(config, {
  types: {
    Person: [
      { name: 'name', type: 'string' },
      { name: 'wallet', type: 'address' },
    ],
    Mail: [
      { name: 'from', type: 'Person' },
      { name: 'to', type: 'Person' },
      { name: 'contents', type: 'string' },
    ],
  },
  primaryType: 'Mail',
  // ^?


  message: {
  // ^?












    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
})
```

```ts twoslash [Const-Asserted]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTypedData.md","from":11568,"to":16402}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"3253afdbde057c102c6b708011549c2795dd31d2584982f81ae20a403b5bdb54","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BjCMONAAkxzkXeAB0w7Ye1IwAhlBYAbDOwAKZOC15jJMuakEidoiVLCz2YcQFsYvfuDMwrAbm27hag0a4X2VtqQCWYAOb2jsIAvhR8wbouGsY2liAA7uLS0jBoQUJOeuqGcu7xklBicHAZOiEAug6ZzvoxALLiPtKqdbnsWjVRbUYm5vEAZqQQpmVZ0e35niCKpMpgY6HhAl06E71x02gQi905btgeVrPzu2ERqyLrcn1HIMxgNI+lINVZ2a55h/HefoGvkUq1RClBAbHEpAYiAAbFRUgE0PgkABWKhoCH+NJ4dwIOF+XCIAAMVEY+Ah4kYNHIMLC6EOeEIJHIaLoUJAAAosMMcJCMABKBRKFQfGKdNY9G6bKy3XbXTjfaa/AIZc4rcX7SX9aZJFJpWUS+U4ApQIrwF7Aiqg8GQpAARgAHHCYAikTC0RisYgZkKwKDpPi7SSyaQKVSkAAmWnUelexlkUE0eh4TncsiYAW3eIykBW9E2xAAZgALE6XUgS9QPWzbn6A4hw0HyZT4zSKHScAziPGWUmvSmIDz04a7kr/rmIVCi46QPD/Ijy+7SJi2e5a2ACQ37sHQy3w4So6vY13mdRWcmuQO0/zYlqrDrUukc1RrVCAOyb2fzxAVvPLvA1vF1yQAtGxDZtqWhA8YwIY8EzPPsL0Ha8pisQpihecd83tadP1dH8q2xelAIJECtybMN60jNtow7I8mTg3sOUQq8BUaZpWg1Do1SuA1M2mIYRn1TiUO9OYWBVZZIjlPirG2ITPmHeITnEgEwFVKTeKle4WCeNBzQ04SFS8NBfGVVTKkwqFbVtCtcIXSsl09EA2OkNcCVRMiwIoqj2wJGD6J7Nl+yQjMtIE0YnzBPMrPDHDnTnPDFz/L0AJnOtYU8ncIKg2j/O7U9GOCljFOmZSFkil87SLD94q/fDHJXIi0qAt1MvAiN92ow88pPRMguY3lQtvagdgq6K7WhDK7O/JKnNS/0WtfUCsqQSCuuguNevgpjU0Gkrjh9KxLLtV84rLGaHOSmjcGIpAlraiiHRyvzNoY/rdqHGTtMeZ09KO59xvrQkavO+qrvmutp1JciWzW3zOwCgr3svPaRNHf6oonCM91LBL7N/JzV1uxAoe3dr6yLZ6EfyvrCJwdgHjYdgAF4LnVBSyo4hSxXGTThuzN5ecMo1FRMv4zkky5ak4r77z1VT3jlES0LNM4qgMhSXK50VuKcaSwuGCLBb1g0RLKiW2aFhSvrkhWrZiM3DrtpZLZNmWtIeXT9KlkVJiMqLTP+Y32CBQQQQBrGKbOvHEA8gm2UZhhidtYkHpbZEqbomntsTvQ4AAV2kNBeAAA0JWgABJgFHEIS+O+toVtXGvwy+O8GKQuk+aglbU3aGvNhzOere5Nkh8cQ4AFOAfH8MAABVDigAARcR0QAHl132jE5rfNE39mYi+gXIgPv2ReMwOLf3nj3eGuXH2D0+DnPkAVZKNXg7lLXd64k+b+tg2glnZ7AUo7MS5Vg7qR9vrYattH7/wdv7c2wCoGKz5ncT2v1vZoOFiOMWZlIHqzUuEKwLkrAAD52QPAGDPXgABhFgND/DhCwOScwVIeCu2HJw6+0sOY+m1u0Hm7w+GHy0sfH2T8vgv3RsA8oksREIPaLLZID5dg4NAf7N+2Csih2gQab+cphEiJgXccK6j7ZnzuMg+BLteEgLEbA0atiHFWKUk7FxqDFE/y+pg54Fi3aaJkfgoOf9QhEPKMHAAdDE9gRZ2CmAgGIdgMSonBweOuSkSSAD89CWCZO2KQdgAAfdg+cwCwBoeuKAwI+S8HkIbHwcAYBrwAMoz3novFe6IABKaR86kE6TgchggfCmCwEkjg09Z4LxwMvVe4hQRSEYAgWMaA0BYB4AAei2UkfwpgfBRLgPgLZzAxBbPEFgHwFzKQ+BYHALZ0yhkwHmeieu4ZXxTVqq6W0pE25eiebMl53TFnJz7mTbytoh6vUCkwe5HBqG0PYAwsATC15GM3gAI2kBARgABrAAorQLAOKxBzF4PYuUlTxCdwpWE1xGxhoEsREoRg4gIH0qkWU0gLRpj4HWZsxAOy0j4FZeyqJdyAkMrkJcnwABVHl8R+UbO2Rcq5USRVirABKiAaqfBSpCJA4O2LcV4rnmMjwvdCTWvSTpLyPD6VymdHAOVYAfBMjgMkPpyhpBMjpZIpRRhtHxHLjAMN4aw02SgK+B0jBwyYqLK+KAABOZN4YCywHEJi35BZkQwBskWCNUquUmvxXQtQNAoC8HTYSe0yJ632k8S4uUphO4+DZSkAs/rvE/2DdMcubLrKYtgISZEybXyvkxQWaEBZrLQlfMDbC0J40wHDOIW0r4CzjuhIO20xbA1yFLXi8tEhK28Bsrm6dhJbRNsBNE2JNkElJJgCkmJwcmQ+AGBgAAEhPfAuT2Dsiof6X69CQOPDXqk8hLC2FpCULwAAamQT9P6/3yFgxwgUzNyEKEac0temKIAQFSOy8hApSnlMqfiGpYcFEiFSRaOjwgGO0Z/ie1eMAUUFKSQAMTAMgCo5D3nJtTtNVuBEvSIv8G5O04KYbUlzdC2CsKEIfWQocB1XQ5Q7wxY69BWYbBSqVv7WRkCmPSpvHce+RnTZaJNOhD+GsGhNF5bp/Rt8zGGxs7g9x4Cr56Y8/EOBAWgnWI8YCczXLfE6Swd50LPwQmObUvXAswNm6ujjhJ66uJu52lIv3Fa9YlOI1pqplGQ4uRjIhBgIFvnTggBKdMMhY1I6zqbjOb5dp2v/JAJV0w1WgUycQDZZa5MfLXTwAAR3zmQDAI8yshXYH1gbSCnaNdIS5jGlVCzWXS112abJlukBq01BaPcKwFbG8V7OhUBpDnMCUcQmJu0iHCi9pwfFRwuPvqXcuVca4lyNZEbY73dCfZCd91RaRfuV2riE2uQOuh+L0rwL7YcUvTr24ge6PWHuesxENjdo3vJD2m7N+bO1yvXjx09jwm83tcJ0ODwOkPdTF3YGXWHAPEc6BB4zkQzO/is4fDD/78PAd3siMjzhaPksR3zAWTHHXzo46yzTgnyd7qXZJ+tXKMKkbnjUwKBnm9BcBGDj9jnf24eBwR+j+XUJp2kWmmDJy4UhupeJy2SmuuXrKYNwt4qZvpMO+AhOrHrvqw2A9+17Xg9ffUy2rdo37BLec7F7buuofCzJq+edcTDU8D3w93Jge2UE9ZyT8jRbfPTebFlzoNP1vuf28xvmIsjcsebh69sD3F2IXe+u1Xw3VOhoeFHPXRNzvOsXR6xDFquavfl/hpXinRU9pN65+LyfaascF6usX4mSu4/L4m6vlTlPFvS9RyE+u9b7rTWnD16XHvSbyfLJUEk0A/K5xxCzS2O8yAkQwAlmvAAA5LcGAeEFMGAaOGASHBQMAaAewGAffFASVGAdovAWEI4BUIgZkN/EAV0CAXxGAeFOgTAWVNgfgToCQZsGAdsBQQqGAVQQgUgaQdLkwSLLASEtQbgfgSEOwBPAzPCoIIILnB3EXP/uIEkD4FMh0kCq8uIFQowjPHRjiDQUtr4P1sdrVigS5FAWIQsJkOrnTkYeYcYRYVYV0Cbn/KQQwgkIYZcJbmAeXHQkvGuhmsmjxsmgWPaASr8u4cmomgSowKOgAIKYp0Kvg8YEqbpFhLwDD2hLxLz2jhjQhOHyLA4QCg7CCkEABCEAmKmRugLh5cmK+RFR+R1RmKVRlRtR9R9RDRlRTRFRbRVRFRJRSwUuMWzw4B36MAKQEA4QhRmKAAhCUTgWpHyKCOwosogKAKyM6ncr6F6HpCACECEEAA"}
import { createConfig, http, signTypedData } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
// ---cut---
const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const

const result = await signTypedData(config, {
  types,
  primaryType: 'Mail',
  // ^?


  message: {
  // ^?












    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
})
```

:::

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/signTypedData.md","from":16427,"to":16485}<fsm-vh3gqscxm4e>
import { type SignTypedDataErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Viem

* [`signTypedData`](https://viem.sh/docs/actions/wallet/signTypedData)

---

---
url: /core/api/actions/simulateContract.md
---
# simulateContract

Action for simulating/validating a contract interaction.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":229,"to":276}<fsm-vh3gqscxm4e>
import { simulateContract } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":323,"to":705}<fsm-vh3gqscxm4e>
import { simulateContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await simulateContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":812,"to":874}<fsm-vh3gqscxm4e>
import { type SimulateContractParameters } from '@wagmi/core'
```

### abi

`Abi`

The contract's ABI. Check out the [TypeScript docs](/react/typescript#const-assert-abis-typed-data) for how to set up ABIs for maximum type inference and safety.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":1090,"to":1506}<fsm-vh3gqscxm4e>
import { simulateContract } from '@wagmi/core'
import { abi } from './abi' // [!code focus]
import { config } from './config'

const result = await simulateContract(config, {
  abi, // [!code focus]
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### accessList

`AccessList | undefined`

The access list.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":1684,"to":2203}<fsm-vh3gqscxm4e>
import { simulateContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await simulateContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  accessList: [{ // [!code focus]
    address: '0x1', // [!code focus]
    storageKeys: ['0x1'], // [!code focus]
  }], // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### account

`Address | Account | undefined`

Account to use when signing data. Throws if account is not found on [`connector`](#connector).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":2463,"to":2919}<fsm-vh3gqscxm4e>
import { simulateContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await simulateContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  account: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### address

`Address`

The contract's address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":3086,"to":3485}<fsm-vh3gqscxm4e>
import { simulateContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await simulateContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f', // [!code focus]
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### args

`readonly unknown[] | undefined`

* Arguments to pass when calling the contract.
* Inferred from [`abi`](#abi) and [`functionName`](#functionname).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":3763,"to":4230}<fsm-vh3gqscxm4e>
import { simulateContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await simulateContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [ // [!code focus]
    '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', // [!code focus]
    123n, // [!code focus]
  ], // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### blockNumber

`bigint | undefined`

Block number to simulate against.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":4427,"to":4852}<fsm-vh3gqscxm4e>
import { simulateContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await simulateContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  blockNumber: 17829139n, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to simulate against.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":5088,"to":5507}<fsm-vh3gqscxm4e>
import { simulateContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await simulateContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  blockTag: 'safe', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

Chain ID to validate against before sending transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":5747,"to":6225}<fsm-vh3gqscxm4e>
import { simulateContract } from '@wagmi/core'
import { mainnet } from 'wagmi/chains' // [!code focus]
import { abi } from './abi'
import { config } from './config'

const result = await simulateContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  chainId: mainnet.id, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

[Connector](/core/api/connectors) to simulate transaction with.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":6448,"to":6919}<fsm-vh3gqscxm4e>
import { getConnection, simulateContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const { connector } = getConnection(config)
const result = await simulateContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  connector, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### dataSuffix

`` `0x${string}` | undefined ``

Data to append to the end of the calldata. Useful for adding a ["domain" tag](https://opensea.notion.site/opensea/Seaport-Order-Attributions-ec2d69bf455041a5baa490941aad307f).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":7263,"to":7723}<fsm-vh3gqscxm4e>
import { simulateContract } from '@wagmi/core'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

const result = await simulateContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  dataSuffix: '0xdeadbeef', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### functionName

`string`

* Function to call on the contract.
* Inferred from [`abi`](#abi).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":7937,"to":8267}<fsm-vh3gqscxm4e>
import { simulateContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await simulateContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'approve', // [!code focus]
  args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', 123n]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### gas

`bigint | undefined`

Gas provided for transaction execution.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":8457,"to":8913}<fsm-vh3gqscxm4e>
import { simulateContract } from '@wagmi/core'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

const result = await simulateContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  gas: parseGwei('20'), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### gasPrice

`bigint | undefined`

The price in wei to pay per gas. Only applies to [Legacy Transactions](https://viem.sh/docs/glossary/terms#legacy-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":9201,"to":9662}<fsm-vh3gqscxm4e>
import { simulateContract } from '@wagmi/core'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

const result = await simulateContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  gasPrice: parseGwei('20'), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxFeePerGas

`bigint | undefined`

Total fee per gas in wei, inclusive of [`maxPriorityFeePerGas`](#maxPriorityFeePerGas). Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":10008,"to":10473}<fsm-vh3gqscxm4e>
import { simulateContract } from '@wagmi/core'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

const result = await simulateContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  maxFeePerGas: parseGwei('20'), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxPriorityFeePerGas

`bigint | undefined`

Max priority fee per gas in wei. Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":10772,"to":11277}<fsm-vh3gqscxm4e>
import { simulateContract } from '@wagmi/core'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

const result = await simulateContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  maxFeePerGas: parseGwei('20'),
  maxPriorityFeePerGas: parseGwei('2'), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### nonce

`number`

Unique number identifying this transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":11466,"to":11879}<fsm-vh3gqscxm4e>
import { simulateContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await simulateContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  nonce: 123, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### type

`'legacy' | 'eip1559' | 'eip2930' | undefined`

Optional transaction request type to narrow parameters.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":12112,"to":12530}<fsm-vh3gqscxm4e>
import { simulateContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await simulateContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  type: 'eip1559', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### value

`bigint | undefined`

Value in wei sent with this transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":12723,"to":13185}<fsm-vh3gqscxm4e>
import { simulateContract } from '@wagmi/core'
import { parseEther } from 'viem'
import { abi } from './abi'
import { config } from './config'

const result = await simulateContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  value: parseEther('0.01'), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":13293,"to":13355}<fsm-vh3gqscxm4e>
import { type SimulateContractReturnType } from '@wagmi/core'
```

The simulation result and write request.

### request

Write request that includes [parameters](#parameters).

### response

`unknown`

* Result of contract simulation.
* Inferred from [`abi`](#abi), [`functionName`](#functionname), and [`args`](#args).

## Type Inference

With [`abi`](#abi) setup correctly, TypeScript will infer the correct types for [`functionName`](#functionname), [`args`](#args), and [`value`](#value). See the Wagmi [TypeScript docs](/core/typescript) for more information.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/simulateContract.md","from":13876,"to":13937}<fsm-vh3gqscxm4e>
import { type SimulateContractErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`simulateContract`](https://viem.sh/docs/contract/simulateContract)

---

---
url: /cli/api/plugins/sourcify.md
---
# sourcify

Plugin for fetching ABIs from [Sourcify](https://sourcify.dev/). Sourcify is a decentralized, open-source, smart contract verification and metadata repository.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/sourcify.md","from":190,"to":236}<fsm-vh3gqscxm4e>
import { sourcify } from '@wagmi/cli/plugins'
```

## Usage

```ts{2,6-13}
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/sourcify.md","from":265,"to":569}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { sourcify } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    sourcify({
      contracts: [
        {
          name: 'deposit',
          address: '0x00000000219ab540356cbb839cbe05303d7705fa',
        },
      ],
    }),
  ],
})
```

## Configuration

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/sourcify.md","from":598,"to":655}<fsm-vh3gqscxm4e>
import { type SourcifyConfig } from '@wagmi/cli/plugins'
```

### cacheDuration

`number | undefined`

* Duration in milliseconds to cache ABIs.
* Defaults to `1_800_000` (30 minutes).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/sourcify.md","from":790,"to":1161}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { sourcify } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    sourcify({
      cacheDuration: 300_000, // [!code focus]
      chainId: 100,
      contracts: [
        {
          name: 'Deposit',
          address: '0x00000000219ab540356cbb839cbe05303d7705fa',
        },
      ],
    }),
  ],
})
```

### chainId

`number`

Chain ID to use for fetching ABI. If `address` is an object, `chainId` is used to select the address. See [Sourcify docs](https://docs.sourcify.dev/docs/chains) for supported chains.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/sourcify.md","from":1379,"to":1817}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { sourcify } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    sourcify({
      chainId: 100, // [!code focus]
      contracts: [
        {
          name: 'Community',
          address: {
            100: '0xC4c622862a8F548997699bE24EA4bc504e5cA865',
            137: '0xC4c622862a8F548997699bE24EA4bc504e5cA865',
          },
        },
      ],
    }),
  ],
})
```

### contracts

`{ name: string; address?: Address | Record<number, Address> | undefined }[]`

Contracts to fetch ABIs for.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/api/plugins/sourcify.md","from":1952,"to":2378}<fsm-vh3gqscxm4e>
import { defineConfig } from '@wagmi/cli'
import { sourcify } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    sourcify({
      chainId: 100,
      contracts: [ // [!code focus]
        { // [!code focus]
          name: 'Deposit', // [!code focus]
          address: '0x00000000219ab540356cbb839cbe05303d7705fa', // [!code focus]
        }, // [!code focus]
      ], // [!code focus]
    }),
  ],
})
```

---

---
url: /react/guides/ssr.md
---

# SSR

Wagmi uses client-only external stores (such as `localStorage` and `mipd`) to show the user the most relevant data as quickly as possible on first render.

However, the caveat of using these external client stores is that frameworks which incorporate SSR (such as Next.js) will throw hydration warnings on the client when it identifies mismatches between the server-rendered HTML and the client-rendered HTML.

To stop this from happening, you can toggle on the [`ssr`](/react/api/createConfig#ssr) property in the Wagmi Config.

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/ssr.md","from":567,"to":842}<fsm-vh3gqscxm4e>
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

const config = createConfig({ // [!code focus:99]
  chains: [mainnet, sepolia],
  ssr: true, // [!code ++]
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

Turning on the `ssr` property means that content from the external stores will be hydrated on the client after the initial mount.

## Persistence using Cookies

As a result of turning on the `ssr` property, external persistent stores like `localStorage` will be hydrated on the client **after the initial mount**.

This means that you will still see a flash of "empty" data on the client (e.g. a `"disconnected"` account instead of a `"reconnecting"` account, or an empty address instead of the last connected address) until after the first mount, when the store hydrates.

In order to persist data between the server and the client, you can use cookies.

### 1. Set up cookie storage

First, we will set up cookie storage in the Wagmi Config.

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/ssr.md","from":1599,"to":2060}<fsm-vh3gqscxm4e>
import { 
  createConfig, 
  http, 
  cookieStorage, // [!code ++]
  createStorage // [!code ++]
} from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export function getConfig() {
  return createConfig({
    chains: [mainnet, sepolia],
    ssr: true,
    storage: createStorage({  // [!code ++]
      storage: cookieStorage, // [!code ++]
    }),  // [!code ++]
    transports: {
      [mainnet.id]: http(),
      [sepolia.id]: http(),
    },
  })
}
```

### 2. Hydrate the cookie

Next, we will need to add some mechanisms to hydrate the stored cookie in Wagmi.

#### Next.js App Directory

In our `app/layout.tsx` file (a [Server Component](https://nextjs.org/docs/app/building-your-application/rendering/server-components)), we will need to extract the cookie from the `headers` function and pass it to [`cookieToInitialState`](/react/api/utilities/cookieToInitialState).

We will need to pass this result to the [`initialState` property](/react/api/WagmiProvider#initialstate) of the `WagmiProvider`. The `WagmiProvider` **must** be in a Client Component tagged with `"use client"` (see `app/providers.tsx` tab).

::: code-group

```tsx [app/layout.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/ssr.md","from":2768,"to":3450}<fsm-vh3gqscxm4e>
import { type ReactNode } from 'react'
import { headers } from 'next/headers' // [!code ++]
import { cookieToInitialState } from 'wagmi' // [!code ++]

import { getConfig } from './config'
import { Providers } from './providers'

export default async function Layout({ children }: { children: ReactNode }) {
  const initialState = cookieToInitialState( // [!code ++]
    getConfig(), // [!code ++]
    (await headers()).get('cookie') // [!code ++]
  ) // [!code ++]
  return (
    <html lang="en">
      <body>
        <Providers> // [!code --]
        <Providers initialState={initialState}> // [!code ++]
          {children}
        </Providers>
      </body>
    </html>
  )
}

```

```tsx [app/providers.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/ssr.md","from":3482,"to":4309}<fsm-vh3gqscxm4e>
'use client'

import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { type ReactNode, useState } from 'react'
import { type State, WagmiProvider } from 'wagmi'

import { getConfig } from './config'

type Props = {
  children: ReactNode,
  initialState: State | undefined, // [!code ++]
}

export function Providers({ children }: Props) {  // [!code --]
export function Providers({ children, initialState }: Props) {  // [!code ++]
  const [config] = useState(() => getConfig())
  const [queryClient] = useState(() => new QueryClient())

  return (
    <WagmiProvider config={config}> // [!code --]
    <WagmiProvider config={config} initialState={initialState}> // [!code ++]
      <QueryClientProvider client={queryClient}>
        {children}
      </QueryClientProvider>
    </WagmiProvider>
  )
}

```

```tsx [app/config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/ssr.md","from":4337,"to":4771}<fsm-vh3gqscxm4e>
import { 
  createConfig, 
  http, 
  cookieStorage,
  createStorage 
} from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export function getConfig() {
  return createConfig({
    chains: [mainnet, sepolia],
    ssr: true,
    storage: createStorage({  // [!code ++]
      storage: cookieStorage, // [!code ++]
    }),  // [!code ++]
    transports: {
      [mainnet.id]: http(),
      [sepolia.id]: http(),
    },
  })
}
```

:::

#### Next.js Pages Directory

Would you like to contribute this content? Feel free to [open a Pull Request](https://github.com/wevm/wagmi/pulls)!

#### Vanilla SSR

Would you like to contribute this content? Feel free to [open a Pull Request](https://github.com/wevm/wagmi/pulls)!

---

---
url: /vue/guides/ssr.md
---

# SSR

Wagmi uses client-only external stores (such as `localStorage` and `mipd`) to show the user the most relevant data as quickly as possible on first render.

However, the caveat of using these external client stores is that frameworks which incorporate SSR (such as Next.js) will throw hydration warnings on the client when it identifies mismatches between the server-rendered HTML and the client-rendered HTML.

To stop this from happening, you can toggle on the [`ssr`](/vue/api/createConfig#ssr) property in the Wagmi Config.

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/ssr.md","from":565,"to":850}<fsm-vh3gqscxm4e>
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

const config = createConfig({ // [!code focus:99]
  chains: [mainnet, sepolia],
  ssr: true, // [!code ++]
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

Turning on the `ssr` property means that content from the external stores will be hydrated on the client after the initial mount.

## Persistence using Cookies

As a result of turning on the `ssr` property, external persistent stores like `localStorage` will be hydrated on the client **after the initial mount**.

This means that you will still see a flash of "empty" data on the client (e.g. a `"disconnected"` account instead of a `"reconnecting"` account, or an empty address instead of the last connected address) until after the first mount, when the store hydrates.

In order to persist data between the server and the client, you can use cookies.

### 1. Set up cookie storage

First, we will set up cookie storage in the Wagmi Config.

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/ssr.md","from":1607,"to":2039}<fsm-vh3gqscxm4e>
import { 
  createConfig, 
  http, 
  cookieStorage, // [!code ++]
  createStorage // [!code ++]
} from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  ssr: true,
  storage: createStorage({  // [!code ++]
    storage: cookieStorage, // [!code ++]
  }),  // [!code ++]
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

### 2. Hydrate the cookie

Next, we will need to add some mechanisms to hydrate the stored cookie in Wagmi.

#### Nuxt.js

Would you like to contribute this content? Feel free to [open a Pull Request](https://github.com/wevm/wagmi/pulls)!

#### Vanilla SSR

Would you like to contribute this content? Feel free to [open a Pull Request](https://github.com/wevm/wagmi/pulls)!

---

---
url: /core/api/actions/switchChain.md
---
# switchChain

Action for switching the target chain for a connector or the Wagmi [`Config`](/core/api/createConfig#config).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/switchChain.md","from":267,"to":309}<fsm-vh3gqscxm4e>
import { switchChain } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/switchChain.md","from":356,"to":529}<fsm-vh3gqscxm4e>
import { switchChain } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

await switchChain(config, { chainId: mainnet.id })
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: tip
When connected, `switchChain` will switch the target chain for the connector. When not connected, `switchChain` will switch the target chain for the Wagmi [`Config`](/core/api/createConfig#config).
:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/switchChain.md","from":811,"to":868}<fsm-vh3gqscxm4e>
import { type SwitchChainParameters } from '@wagmi/core'
```

### addEthereumChainParameter

`{ chainName: string; nativeCurrency?: { name: string; symbol: string; decimals: number } | undefined; rpcUrls: readonly string[]; blockExplorerUrls?: string[] | undefined; iconUrls?: string[] | undefined } | undefined`

[EIP-3085 parameters](https://eips.ethereum.org/EIPS/eip-3085) to use when adding chain to connector (when supported).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/switchChain.md","from":1277,"to":1603}<fsm-vh3gqscxm4e>
import { switchChain } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const result = await switchChain(config, {
  addEthereumChainParameter: { // [!code focus]
    iconUrls: ['https://example.com/icon.png'], // [!code focus]
  }, // [!code focus]
  chainId: mainnet.id,
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to switch to.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/switchChain.md","from":1771,"to":1979}<fsm-vh3gqscxm4e>
import { switchChain } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const result = await switchChain(config, {
  chainId: mainnet.id, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector`

[Connector](/core/api/connectors) to switch chain with.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/switchChain.md","from":2146,"to":2446}<fsm-vh3gqscxm4e>
import { getConnection, switchChain } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const connection = getConnection(config)
const result = await switchChain(config, {
  chainId: mainnet.id,
  connector: connection?.connector, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/switchChain.md","from":2518,"to":2575}<fsm-vh3gqscxm4e>
import { type SwitchChainReturnType } from '@wagmi/core'
```

`Chain`

Chain that was switched to.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/switchChain.md","from":2634,"to":2690}<fsm-vh3gqscxm4e>
import { type SwitchChainErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Viem

* [`switchChain`](https://viem.sh/docs/actions/wallet/switchChain) when connected.

---

---
url: /core/api/actions/switchConnection.md
---
# switchConnection

Action for switching the current account.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/switchConnection.md","from":214,"to":261}<fsm-vh3gqscxm4e>
import { switchConnection } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/switchConnection.md","from":308,"to":540}<fsm-vh3gqscxm4e>
import { getConnections, switchConnection } from '@wagmi/core'
import { config } from './config'

const connections = getConnections(config)
const result = await switchConnection(config, {
  connector: connections[0]?.connector,
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/switchConnection.md","from":611,"to":673}<fsm-vh3gqscxm4e>
import { type SwitchConnectionParameters } from '@wagmi/core'
```

### connector

`Connector`

[Connector](/core/api/connectors) to switch to.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/switchConnection.md","from":787,"to":1036}<fsm-vh3gqscxm4e>
import { getConnections, switchConnection } from '@wagmi/core'
import { config } from './config'

const connections = getConnections(config)
const result = await switchConnection(config, {
  connector: connections[0]?.connector, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/switchConnection.md","from":1108,"to":1170}<fsm-vh3gqscxm4e>
import { type SwitchConnectionReturnType } from '@wagmi/core'
```

### accounts

`readonly [Address, ...Address[]]`

Connected accounts from connector.

### chainId

`number`

Connected chain ID from connector.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/switchConnection.md","from":1338,"to":1399}<fsm-vh3gqscxm4e>
import { type SwitchConnectionErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

---

---
url: /react/guides/tanstack-query.md
---
# TanStack Query

Wagmi Hooks are not only a wrapper around the core [Wagmi Actions](/core/api/actions), but they also utilize [TanStack Query](https://tanstack.com/query/v5) to enable trivial and intuitive fetching, caching, synchronizing, and updating of asynchronous data in your React applications.

Without an asynchronous data fetching abstraction, you would need to handle all the negative side-effects that comes as a result, such as: representing finite states (loading, error, success), handling race conditions, caching against a deterministic identifier, etc.

## Queries & Mutations

Wagmi Hooks represent either a **Query** or a **Mutation**.

**Queries** are used for fetching data (e.g. fetching a block number, reading from a contract, etc), and are typically invoked on mount by default. All queries are coupled to a unique [Query Key](#query-keys), and can be used for further operations such as refetching, prefetching, or modifying the cached data.

**Mutations** are used for mutating data (e.g. connecting/disconnecting accounts, writing to a contract, switching chains, etc), and are typically invoked in response to a user interaction. Unlike **Queries**, they are not coupled with a query key.

## Terms

* **Query**: An asynchronous data fetching (e.g. read data) operation that is tied against a unique Query Key.
* **Mutation**: An asynchronous mutating (e.g. create/update/delete data or side-effect) operation.
* **Query Key**: A unique identifier that is used to deterministically identify a query. It is typically a tuple of the query name and the query arguments.
* **Stale Data**: Data that is unused or inactive after a certain period of time.
* **Query Fetching**: The process of invoking an async query function.
* **Query Refetching**: The process of refetching **rendered** queries.
* **[Query Invalidation](https://tanstack.com/query/v5/docs/react/guides/query-invalidation)**: The process of marking query data as stale (e.g. inactive/unused), and refetching **rendered** queries.
* **[Query Prefetching](https://tanstack.com/query/v5/docs/react/guides/prefetching)**: The process of prefetching queries and seeding the cache.

## Persistence via External Stores

By default, TanStack Query persists all query data in-memory. This means that if you refresh the page, all in-memory query data will be lost.

If you want to persist query data to an external storage, you can utilize TanStack Query's [`createSyncStoragePersister`](https://tanstack.com/query/v5/docs/react/plugins/createSyncStoragePersister) or [`createAsyncStoragePersister`](https://tanstack.com/query/v5/docs/react/plugins/createAsyncStoragePersister) to plug external storage like `localStorage`, `sessionStorage`, [IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) or [`AsyncStorage`](https://reactnative.dev/docs/asyncstorage) (React Native).

### Sync Storage

Below is an example of how to set up Wagmi + TanStack Query with sync external storage like `localStorage` or `sessionStorage`.

#### Install

::: code-group

```bash [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":3074,"to":3157}<fsm-vh3gqscxm4e>
pnpm i @tanstack/query-sync-storage-persister @tanstack/react-query-persist-client
```

```bash [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":3176,"to":3258}<fsm-vh3gqscxm4e>
npm i @tanstack/query-sync-storage-persister @tanstack/react-query-persist-client
```

```bash [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":3278,"to":3363}<fsm-vh3gqscxm4e>
yarn add @tanstack/query-sync-storage-persister @tanstack/react-query-persist-client
```

```bash [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":3382,"to":3464}<fsm-vh3gqscxm4e>
bun i @tanstack/query-sync-storage-persister @tanstack/react-query-persist-client
```

:::

#### Usage

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":3492,"to":4792}<fsm-vh3gqscxm4e>
// 1. Import modules. // [!code hl]
import { createSyncStoragePersister } from '@tanstack/query-sync-storage-persister' // [!code hl]
import { QueryClient } from '@tanstack/react-query' // [!code hl]
import { PersistQueryClientProvider } from '@tanstack/react-query-persist-client' // [!code hl]
import { WagmiProvider, deserialize, serialize } from 'wagmi' // [!code hl]

// 2. Create a new Query Client with a default `gcTime`. // [!code hl]
const queryClient = new QueryClient({ // [!code hl]
  defaultOptions: { // [!code hl]
    queries: { // [!code hl]
      gcTime: 1_000 * 60 * 60 * 24, // 24 hours // [!code hl]
    }, // [!code hl] 
  }, // [!code hl]
}) // [!code hl]

// 3. Set up the persister. // [!code hl]
const persister = createSyncStoragePersister({ // [!code hl]
  serialize, // [!code hl]
  storage: window.localStorage, // [!code hl]
  deserialize, // [!code hl]
}) // [!code hl]

function App() {
  return (
    <WagmiProvider config={config}>
      {/* 4. Wrap app in PersistQueryClientProvider */} // [!code hl]
      <PersistQueryClientProvider // [!code hl]
        client={queryClient} // [!code hl]
        persistOptions={{ persister }} // [!code hl]
      > // [!code hl]
        {/* ... */}
      </PersistQueryClientProvider> // [!code hl]
    </WagmiProvider>
  )
}
```

Read more about [Sync Storage Persistence](https://tanstack.com/query/v5/docs/react/plugins/createSyncStoragePersister).

### Async Storage

Below is an example of how to set up Wagmi + TanStack Query with async external storage like [`IndexedDB`](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) or [`AsyncStorage`](https://reactnative.dev/docs/asyncstorage).

#### Install

::: code-group

```bash [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":5218,"to":5302}<fsm-vh3gqscxm4e>
pnpm i @tanstack/query-async-storage-persister @tanstack/react-query-persist-client
```

```bash [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":5321,"to":5404}<fsm-vh3gqscxm4e>
npm i @tanstack/query-async-storage-persister @tanstack/react-query-persist-client
```

```bash [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":5424,"to":5510}<fsm-vh3gqscxm4e>
yarn add @tanstack/query-async-storage-persister @tanstack/react-query-persist-client
```

```bash [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":5529,"to":5612}<fsm-vh3gqscxm4e>
bun i @tanstack/query-async-storage-persister @tanstack/react-query-persist-client
```

:::

#### Usage

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":5640,"to":7019}<fsm-vh3gqscxm4e>
// 1. Import modules. // [!code hl]
import AsyncStorage from '@react-native-async-storage/async-storage' // [!code hl]
import { createAsyncStoragePersister } from '@tanstack/query-async-storage-persister' // [!code hl]
import { QueryClient } from '@tanstack/react-query' // [!code hl]
import { PersistQueryClientProvider } from '@tanstack/react-query-persist-client' // [!code hl]
import { WagmiProvider, deserialize, serialize } from 'wagmi' // [!code hl]

// 2. Create a new Query Client with a default `gcTime`. // [!code hl]
const queryClient = new QueryClient({ // [!code hl]
  defaultOptions: { // [!code hl]
    queries: { // [!code hl]
      gcTime: 1_000 * 60 * 60 * 24, // 24 hours // [!code hl]
    }, // [!code hl] 
  }, // [!code hl]
}) // [!code hl]

// 3. Set up the persister. // [!code hl]
const persister = createAsyncStoragePersister({ // [!code hl]
  serialize, // [!code hl]
  storage: AsyncStorage, // [!code hl]
  deserialize, // [!code hl]
}) // [!code hl]

function App() {
  return (
    <WagmiProvider config={config}>
      {/* 4. Wrap app in PersistQueryClientProvider */} // [!code hl]
      <PersistQueryClientProvider // [!code hl]
        client={queryClient} // [!code hl]
        persistOptions={{ persister }} // [!code hl]
      > // [!code hl]
        {/* ... */}
      </PersistQueryClientProvider> // [!code hl]
    </WagmiProvider>
  )
}
```

Read more about [Async Storage Persistence](https://tanstack.com/query/v5/docs/react/plugins/createAsyncStoragePersister).

## Query Keys

Query Keys are typically used to perform advanced operations on the query such as: invalidation, refetching, prefetching, etc.

Wagmi exports Query Keys for every Hook, and they can be retrieved via the [Hook (React)](#hook-react) or via an [Import (Vanilla JS)](#import-vanilla-js).

Read more about **Query Keys** on the [TanStack Query docs.](https://tanstack.com/query/v5/docs/react/guides/query-keys)

### Hook (React)

Each Hook returns a `queryKey` value. You would use this approach when you want to utilize the query key in a React component as it handles reactivity for you, unlike the [Import](#import-vanilla-js) method below.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":7811,"to":7926}<fsm-vh3gqscxm4e>
import { useBlock } from 'wagmi' // [!code hl]

function App() {
  const { queryKey } = useBlock() // [!code hl]
}
```

### Import (Vanilla JS)

Each Hook has a corresponding `get<X>QueryOptions` function that returns a query key. You would use this method when you want to utilize the query key outside of a React component in a Vanilla JS context, like in a utility function.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":8198,"to":8456}<fsm-vh3gqscxm4e>
import { getBlockQueryOptions } from 'wagmi/query' // [!code hl]
import { config } from './config'

function perform() {
  const { queryKey } = getBlockQueryOptions(config, { // [!code hl]
    chainId: config.state.chainId // [!code hl]
  }) // [!code hl]
}
```

::: warning

The caveat of this method is that it does not handle reactivity for you (e.g. active account/chain changes, argument changes, etc). You would need to handle this yourself by explicitly passing through the arguments to `get<X>QueryOptions`.

:::

## Invalidating Queries

Invalidating a query is the process of marking the query data as stale (e.g. inactive/unused), and refetching the queries that are already rendered.

Read more about **Invalidating Queries** on the [TanStack Query docs.](https://tanstack.com/query/v5/docs/react/guides/query-invalidation)

#### Example: Watching a Users' Balance

You may want to "watch" a users' balance, and invalidate the balance after each incoming block. We can invoke `invalidateQueries` inside a `useEffect` with the block number as it's only dependency – this will refetch all rendered balance queries when the `blockNumber` changes.

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":9362,"to":9871}<fsm-vh3gqscxm4e>
import { useQueryClient } from '@tanstack/react-query' 
import { useEffect } from 'react' 
import { useBlockNumber, useBalance } from 'wagmi' 

function App() {
  const queryClient = useQueryClient()
  const { data: blockNumber } = useBlockNumber({ watch: true }) // [!code hl]
  const { data: balance, queryKey } = useBalance() // [!code hl]
  
  useEffect(() => { // [!code hl]
    queryClient.invalidateQueries({ queryKey }) // [!code hl]
  }, [blockNumber]) // [!code hl]

  return <div>{balance}</div>
}
```

#### Example: After User Interaction

Maybe you want to invalidate a users' balance after some interaction. This would mark the balance as stale, and consequently refetch all rendered balance queries.

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":10085,"to":10720}<fsm-vh3gqscxm4e>
import { useBalance } from 'wagmi'

function App() {
  // 1. Extract `queryKey` from the useBalance Hook. // [!code hl]
  const { queryKey } = useBalance() // [!code hl]

  return (
    <button
      onClick={async () => {
        // 2. Invalidate the query when the user clicks "Invalidate". // [!code hl]
        await queryClient.invalidateQueries({ queryKey }) // [!code hl]
      }}
    >
      Invalidate
    </button>
  )
}

function Example() {
  // 3. Other `useBalance` Hooks in your rendered React tree will be refetched! // [!code hl]
  const { data: balance } = useBalance() // [!code hl]

  return <div>{balance}</div>
}
```

## Fetching Queries

Fetching a query is the process of invoking the query function to retrieve data. If the query exists and the data is not invalidated or older than a given `staleTime`, then the data from the cache will be returned. Otherwise, the query will fetch for the latest data.

::: code-group

```tsx [example.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":11051,"to":11396}<fsm-vh3gqscxm4e>
import { getBlockQueryOptions } from 'wagmi'
import { queryClient } from './app'
import { config } from './config'

export async function fetchBlockData() {
  return queryClient.fetchQuery( // [!code hl]
    getBlockQueryOptions(config, { // [!code hl]
      chainId: config.state.chainId, // [!code hl]
    } // [!code hl]
  )) // [!code hl]
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Retrieving & Updating Query Data

You can retrieve and update query data imperatively with `getQueryData` and `setQueryData`. This is useful for scenarios where you want to retrieve or update a query outside of a React component.

Note that these functions do not invalidate or refetch queries.

::: code-group

```tsx [example.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":11820,"to":12536}<fsm-vh3gqscxm4e>
import { getBlockQueryOptions } from 'wagmi'
import type { Block } from 'viem'
import { queryClient } from './app'
import { config } from './config'

export function getPendingBlockData() {
  return queryClient.getQueryData( // [!code hl]
    getBlockQueryOptions(config, { // [!code hl]
      chainId: config.state.chainId, // [!code hl]
      tag: 'pending' // [!code hl]
    } // [!code hl]
  )) // [!code hl]
}

export function setPendingBlockData(data: Block) {
  return queryClient.setQueryData( // [!code hl]
    getBlockQueryOptions(config, { // [!code hl]
      chainId: config.state.chainId, // [!code hl]
      tag: 'pending' // [!code hl]
    }, // [!code hl]
    data // [!code hl]
  )) // [!code hl]
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Prefetching Queries

Prefetching a query is the process of fetching the data ahead of time and seeding the cache with the returned data. This is useful for scenarios where you want to fetch data before the user navigates to a page, or fetching data on the server to be reused on client hydration.

Read more about **Prefetching Queries** on the [TanStack Query docs.](https://tanstack.com/query/v5/docs/react/guides/prefetching)

#### Example: Prefetching in Event Handler

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":13109,"to":13782}<fsm-vh3gqscxm4e>
import { Link } from 'next/link'
import { getBlockQueryOptions } from 'wagmi'

function App() {
  const config = useConfig()
  const chainId = useChainId()

  // 1. Set up a function to prefetch the block data. // [!code hl]
  const prefetch = () => // [!code hl]
    queryClient.prefetchQuery(getBlockQueryOptions(config, { chainId })) // [!code hl]
  

  return (
    <Link
      // 2. Add event handlers to prefetch the block data // [!code hl] 
      // when user hovers over or focuses on the button. // [!code hl]
      onMouseEnter={prefetch} // [!code hl]
      onFocus={prefetch} // [!code hl]
      to="/block-details"
    >
      Block details
    </Link>
  )
}
```

## SSR

It is possible to utilize TanStack Query's SSR strategies with Wagmi Hooks & Query Keys. Check out the [Server Rendering & Hydration](https://tanstack.com/query/v5/docs/react/guides/ssr) & [Advanced Server Rendering](https://tanstack.com/query/v5/docs/react/guides/advanced-ssr) guides.

## Devtools

TanStack Query includes dedicated [Devtools](https://tanstack.com/query/latest/docs/framework/react/devtools) that assist in visualizing and debugging your queries, their cache states, and much more. You will have to pass a custom `queryKeyFn` to your `QueryClient` for Devtools to correctly serialize BigInt values for display. Alternatively, You can use the `hashFn` from `@wagmi/core/query`, which already handles this serialization.

#### Install

::: code-group

```bash [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":14578,"to":14616}<fsm-vh3gqscxm4e>
pnpm i @tanstack/react-query-devtools
```

```bash [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":14635,"to":14672}<fsm-vh3gqscxm4e>
npm i @tanstack/react-query-devtools
```

```bash [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":14692,"to":14732}<fsm-vh3gqscxm4e>
yarn add @tanstack/react-query-devtools
```

```bash [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":14751,"to":14788}<fsm-vh3gqscxm4e>
bun i @tanstack/react-query-devtools
```

:::

#### Usage

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/tanstack-query.md","from":14816,"to":15226}<fsm-vh3gqscxm4e>
import {
  QueryClient,
  QueryClientProvider,
} from "@tanstack/react-query";
import { ReactQueryDevtools } from "@tanstack/react-query-devtools"; // [!code hl]
import { hashFn } from "@wagmi/core/query"; // [!code hl]

const queryClient = new QueryClient({
  defaultOptions: { // [!code hl]
    queries: { // [!code hl]
      queryKeyHashFn: hashFn, // [!code hl]
    }, // [!code hl]
  }, // [!code hl]
});
```

---

---
url: /solid/guides/tanstack-query.md
---
# TanStack Query

[TanStack Query](https://tanstack.com/query/latest) is a powerful asynchronous state management library for Solid. It provides features like caching, deduplication, background refetching, and more.

## Overview

`@wagmi/solid` uses TanStack Query under the hood to handle data fetching, caching, and state management. This means you get all the benefits of TanStack Query while using Wagmi primitives.

## Setup

To use `@wagmi/solid`, you need to wrap your app with both `WagmiProvider` and `QueryClientProvider`:

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/guides/tanstack-query.md","from":541,"to":927}<fsm-vh3gqscxm4e>
import { QueryClient, QueryClientProvider } from '@tanstack/solid-query'
import { WagmiProvider } from '@wagmi/solid'
import { config } from './config'

const queryClient = new QueryClient()

function App() {
  return (
    <WagmiProvider config={config}>
      <QueryClientProvider client={queryClient}>
        {/* Your app */}
      </QueryClientProvider>
    </WagmiProvider>
  )
}
```

## Query States

When using Wagmi query primitives like `useBalance` or `useBlockNumber`, you have access to TanStack Query's state properties:

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/guides/tanstack-query.md","from":1084,"to":1437}<fsm-vh3gqscxm4e>
import { useBalance } from '@wagmi/solid'

function Balance() {
  const balance = useBalance(() => ({
    address: '0x...',
  }))

  return (
    <div>
      {balance.isPending && <p>Loading...</p>}
      {balance.isError && <p>Error: {balance.error?.message}</p>}
      {balance.isSuccess && <p>Balance: {balance.data?.formatted}</p>}
    </div>
  )
}
```

## Query Options

Wagmi primitives accept TanStack Query options through the `query` parameter:

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/guides/tanstack-query.md","from":1546,"to":1846}<fsm-vh3gqscxm4e>
import { useBalance } from '@wagmi/solid'

function Balance() {
  const balance = useBalance(() => ({
    address: '0x...',
    query: {
      enabled: true,
      refetchInterval: 5000, // Refetch every 5 seconds
      staleTime: 1000, // Consider data stale after 1 second
    },
  }))

  // ...
}
```

## Further Reading

For more information about TanStack Query, check out:

* [TanStack Query Solid Documentation](https://tanstack.com/query/latest/docs/framework/solid/overview)
* [Query Basics](https://tanstack.com/query/latest/docs/framework/solid/guides/queries)
* [Mutations](https://tanstack.com/query/latest/docs/framework/solid/guides/mutations)

---

---
url: /vue/guides/tanstack-query.md
---
# TanStack Query

Wagmi Composables are not only a wrapper around the core [Wagmi Actions](/core/api/actions), but they also utilize [TanStack Query](https://tanstack.com/query/v5) to enable trivial and intuitive fetching, caching, synchronizing, and updating of asynchronous data in your Vue applications.

Without an asynchronous data fetching abstraction, you would need to handle all the negative side-effects that comes as a result, such as: representing finite states (loading, error, success), handling race conditions, caching against a deterministic identifier, etc.

## Queries & Mutations

Wagmi Composables represent either a **Query** or a **Mutation**.

**Queries** are used for fetching data (e.g. fetching a block number, reading from a contract, etc), and are typically invoked on mount by default. All queries are coupled to a unique [Query Key](#query-keys), and can be used for further operations such as refetching, prefetching, or modifying the cached data.

**Mutations** are used for mutating data (e.g. connecting/disconnecting accounts, writing to a contract, switching chains, etc), and are typically invoked in response to a user interaction. Unlike **Queries**, they are not coupled with a query key.

## Terms

* **Query**: An asynchronous data fetching (e.g. read data) operation that is tied against a unique Query Key.
* **Mutation**: An asynchronous mutating (e.g. create/update/delete data or side-effect) operation.
* **Query Key**: A unique identifier that is used to deterministically identify a query. It is typically a tuple of the query name and the query arguments.
* **Stale Data**: Data that is unused or inactive after a certain period of time.
* **Query Fetching**: The process of invoking an async query function.
* **Query Refetching**: The process of refetching **rendered** queries.
* **[Query Invalidation](https://tanstack.com/query/v5/docs/vue/guides/query-invalidation)**: The process of marking query data as stale (e.g. inactive/unused), and refetching **rendered** queries.
* **[Query Prefetching](https://tanstack.com/query/v5/docs/vue/guides/prefetching)**: The process of prefetching queries and seeding the cache.

## Query Keys

Query Keys are typically used to perform advanced operations on the query such as: invalidation, refetching, prefetching, etc.

Wagmi exports Query Keys for every Composable, and they can be retrieved via the [Composable (Vue)](#composable-vue) or via an [Import (Vanilla JS)](#import-vanilla-js).

Read more about **Query Keys** on the [TanStack Query docs.](https://tanstack.com/query/v5/docs/vue/guides/query-keys)

### Composable (Vue)

Each Composable returns a `queryKey` value. You would use this approach when you want to utilize the query key in a Vue component as it handles reactivity for you, unlike the [Import](#import-vanilla-js) method below.

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/tanstack-query.md","from":2923,"to":3117}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBalance } from '@wagmi/vue' // [!code hl]

const { data: balance } = useBalance() // [!code hl]
</script>

<template>
  <div>{{ balance }}</div>
</template>
```

### Import (Vanilla JS)

Each Hook has a corresponding `get<X>QueryOptions` function that returns a query key. You would use this method when you want to utilize the query key outside of a Vue component in a Vanilla JS context, like in a utility function.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/tanstack-query.md","from":3387,"to":3654}<fsm-vh3gqscxm4e>
import { getBalanceQueryOptions } from '@wagmi/vue/query' // [!code hl]
import { config } from './config'

function perform() {
  const { queryKey } = getBalanceQueryOptions(config, { // [!code hl]
    chainId: config.state.chainId // [!code hl]
  }) // [!code hl]
}
```

::: warning

The caveat of this method is that it does not handle reactivity for you (e.g. active account/chain changes, argument changes, etc). You would need to handle this yourself by explicitly passing through the arguments to `get<X>QueryOptions`.

:::

## Invalidating Queries

Invalidating a query is the process of marking the query data as stale (e.g. inactive/unused), and refetching the queries that are already rendered.

Read more about **Invalidating Queries** on the [TanStack Query docs.](https://tanstack.com/query/v5/docs/vue/guides/query-invalidation)

#### Example: Watching a Users' Balance

You may want to "watch" a users' balance, and invalidate the balance after each incoming block. We can invoke `invalidateQueries` inside a `watchEffect` – this will refetch all rendered balance queries when the `blockNumber` changes.

```vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/tanstack-query.md","from":4514,"to":5091}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useQueryClient } from '@tanstack/vue-query' 
import { useBlockNumber, useBalance } from '@wagmi/vue' 
import { watchEffect } from 'vue' 

const queryClient = useQueryClient()
const { data: blockNumber } = useBlockNumber({ watch: true }) // [!code hl]
const { data: balance, queryKey } = useBalance() // [!code hl]
  
watchEffect(() => { // [!code hl]
  queryClient.invalidateQueries({ queryKey }) // [!code hl]
}) // [!code hl]
</script>

<template>
  <div>Block Number: {{ blockNumber }}</div>
  <div>Balance: {{ balance }}</div>
</template>
```

#### Example: After User Interaction

Maybe you want to invalidate a users' balance after some interaction. This would mark the balance as stale, and consequently refetch all rendered balance queries.

```vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/tanstack-query.md","from":5305,"to":5722}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBalance } from '@wagmi/vue'

// 1. Extract `queryKey` from the useBalance Hook. // [!code hl]
const { queryKey } = useBalance() // [!code hl]
</script>

<template>
  // 2. Add a button that invalidates the balance query. // [!code hl]
  <button @click="queryClient.invalidateQueries({ queryKey })"> // [!code hl]
    Invalidate // [!code hl]
  </button> // [!code hl]
</template>
```

```vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/tanstack-query.md","from":5734,"to":5963}<fsm-vh3gqscxm4e>
<script setup lang="ts">
// 3. Other `useBalance` Hooks in your rendered Vue tree will be refetched! // [!code hl]
const { data: balance } = useBalance() // [!code hl]
</script>

<template>
  <div>{{ balance }}</div>
</template>
```

## Fetching Queries

Fetching a query is the process of invoking the query function to retrieve data. If the query exists and the data is not invalidated or older than a given `staleTime`, then the data from the cache will be returned. Otherwise, the query will fetch for the latest data.

::: code-group

```tsx [example.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/tanstack-query.md","from":6294,"to":6651}<fsm-vh3gqscxm4e>
import { getBlockQueryOptions } from '@wagmi/vue/query'
import { queryClient } from './main'
import { config } from './config'

export async function fetchBlockData() {
  return queryClient.fetchQuery( // [!code hl]
    getBlockQueryOptions(config, { // [!code hl]
      chainId: config.state.chainId, // [!code hl]
    } // [!code hl]
  )) // [!code hl]
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Retrieving & Updating Query Data

You can retrieve and update query data imperatively with `getQueryData` and `setQueryData`. This is useful for scenarios where you want to retrieve or update a query outside of a Vue component.

Note that these functions do not invalidate or refetch queries.

::: code-group

```tsx [example.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/tanstack-query.md","from":7069,"to":7813}<fsm-vh3gqscxm4e>
import type { GetBalanceReturnType } from '@wagmi/vue/actions'
import { getBalanceQueryOptions } from '@wagmi/vue/query'
import { queryClient } from './app'
import { config } from './config'

export function getBalanceData() {
  return queryClient.getQueryData( // [!code hl]
    getBalanceQueryOptions(config, { // [!code hl]
      chainId: config.state.chainId, // [!code hl]
    } // [!code hl]
  )) // [!code hl]
}

export function setBalanceData(parameters: Partial<GetBalanceReturnType>) {
  return queryClient.setQueryData( // [!code hl]
    getBalanceQueryOptions(config, { // [!code hl]
      chainId: config.state.chainId, // [!code hl]
    }, // [!code hl]
    data => ({ ...data, ...parameters }) // [!code hl]
  )) // [!code hl]
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Prefetching Queries

Prefetching a query is the process of fetching the data ahead of time and seeding the cache with the returned data. This is useful for scenarios where you want to fetch data before the user navigates to a page, or fetching data on the server to be reused on client hydration.

Read more about **Prefetching Queries** on the [TanStack Query docs.](https://tanstack.com/query/v5/docs/vue/guides/prefetching)

#### Example: Prefetching in Event Handler

```vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/tanstack-query.md","from":8380,"to":8853}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConfig, useChainId, useQueryClient } from '@wagmi/vue'
import { getBlockQueryOptions } from '@wagmi/vue/query'

const config = useConfig()
const chainId = useChainId()
const queryClient = useQueryClient()

const prefetch = () => 
  queryClient.prefetchQuery(getBlockQueryOptions(config, { chainId })) 
</script>

<template>
  <a
    @mouseenter="prefetch" 
    @focus="prefetch" 
    href="..."
  >
    Block details
  </a>
</template>
```

## SSR

It is possible to utilize TanStack Query's SSR strategies with Wagmi Composables & Query Keys. Check out the [SSR guide](https://tanstack.com/query/latest/docs/framework/vue/guides/ssr).

## Devtools

TanStack Query includes dedicated [Devtools](https://tanstack.com/query/latest/docs/framework/vue/devtools) that assist in visualizing and debugging your queries, their cache states, and much more. You will have to pass a custom `queryKeyFn` to your `QueryClient` for Devtools to correctly serialize BigInt values for display. Alternatively, You can use the `hashFn` from `@wagmi/core/query`, which already handles this serialization.

#### Install

::: code-group

```bash [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/tanstack-query.md","from":9547,"to":9583}<fsm-vh3gqscxm4e>
pnpm i @tanstack/vue-query-devtools
```

```bash [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/tanstack-query.md","from":9602,"to":9637}<fsm-vh3gqscxm4e>
npm i @tanstack/vue-query-devtools
```

```bash [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/tanstack-query.md","from":9657,"to":9695}<fsm-vh3gqscxm4e>
yarn add @tanstack/vue-query-devtools
```

```bash [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/tanstack-query.md","from":9714,"to":9749}<fsm-vh3gqscxm4e>
bun i @tanstack/vue-query-devtools
```

:::

#### Usage

::: code-group

```vue [App.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/tanstack-query.md","from":9802,"to":9938}<fsm-vh3gqscxm4e>
<script setup>
import { VueQueryDevtools } from '@tanstack/vue-query-devtools'
</script>

<template>
  <VueQueryDevtools />
</template>
```

```vue [main.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/tanstack-query.md","from":9961,"to":10535}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { createApp } from 'vue'
import { WagmiPlugin } from '@wagmi/vue'
import { QueryClient, VueQueryPlugin } from '@tanstack/vue-query'

import App from './App.vue'
import { config } from './config' 

const queryClient = new QueryClient({ // [!code hl]
  defaultOptions: { // [!code hl]
    queries: { // [!code hl]
      queryKeyHashFn: hashFn, // [!code hl]
    }, // [!code hl]
  }, // [!code hl]
}) // [!code hl]

createApp(App)
  .use(WagmiPlugin, { config })
  .use(VueQueryPlugin, { queryClient }) // [!code hl]
  .mount('#app')
</script>
```

:::

---

---
url: /core/api/connectors/tempoWallet.md
---

# tempoWallet

Connector for the Tempo Wallet dialog.

## Import

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add accounts@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install accounts@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add accounts@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add accounts@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { tempo } from '{{packageName}}/chains'
import { tempoWallet } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [tempo],
  connectors: [tempoWallet()], // [!code hl]
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})
```

`tempoWallet` is a thin Wagmi wrapper around the `accounts` dialog adapter.

## Parameters

```ts-vue
import { type TempoWalletParameters } from '{{connectorsPackageName}}'
```

`tempoWallet` accepts the Tempo Accounts dialog parameters together with provider options like [`authorizeAccessKey`](#authorizeaccesskey).

### host (optional)

`string`

Override the Tempo Wallet dialog host.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  host: 'https://wallet.tempo.xyz', // [!code focus]
})
```

### dialog (optional)

`Window | HTMLElement | ShadowRoot | string`

Override where the dialog mounts.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  dialog: '#tempo-wallet-root', // [!code focus]
})
```

### icon (optional)

`` `data:image/${string}` ``

Optional connector icon override.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  icon: 'data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg"></svg>', // [!code focus]
})
```

### name (optional)

`string`

Optional connector display name.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  name: 'My Tempo Wallet', // [!code focus]
})
```

### rdns (optional)

`string`

Optional reverse-DNS identifier.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  rdns: 'com.example.tempo-wallet', // [!code focus]
})
```

### authorizeAccessKey (optional)

`() => { expiry: number, ... }`

Default access-key authorization parameters to attach to `wallet_connect`.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  authorizeAccessKey() {
    return {
      expiry: 60 * 60,
    }
  }, // [!code focus]
})
```

See the [Accounts SDK docs](https://docs.tempo.xyz/accounts) for more info on Tempo Wallet flows and access-key authorization.

---

---
url: /react/api/connectors/tempoWallet.md
---

# tempoWallet

Connector for the Tempo Wallet dialog.

## Import

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add accounts@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install accounts@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add accounts@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add accounts@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { tempo } from '{{packageName}}/chains'
import { tempoWallet } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [tempo],
  connectors: [tempoWallet()], // [!code hl]
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})
```

`tempoWallet` is a thin Wagmi wrapper around the `accounts` dialog adapter.

## Parameters

```ts-vue
import { type TempoWalletParameters } from '{{connectorsPackageName}}'
```

`tempoWallet` accepts the Tempo Accounts dialog parameters together with provider options like [`authorizeAccessKey`](#authorizeaccesskey).

### host (optional)

`string`

Override the Tempo Wallet dialog host.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  host: 'https://wallet.tempo.xyz', // [!code focus]
})
```

### dialog (optional)

`Window | HTMLElement | ShadowRoot | string`

Override where the dialog mounts.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  dialog: '#tempo-wallet-root', // [!code focus]
})
```

### icon (optional)

`` `data:image/${string}` ``

Optional connector icon override.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  icon: 'data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg"></svg>', // [!code focus]
})
```

### name (optional)

`string`

Optional connector display name.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  name: 'My Tempo Wallet', // [!code focus]
})
```

### rdns (optional)

`string`

Optional reverse-DNS identifier.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  rdns: 'com.example.tempo-wallet', // [!code focus]
})
```

### authorizeAccessKey (optional)

`() => { expiry: number, ... }`

Default access-key authorization parameters to attach to `wallet_connect`.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  authorizeAccessKey() {
    return {
      expiry: 60 * 60,
    }
  }, // [!code focus]
})
```

See the [Accounts SDK docs](https://docs.tempo.xyz/accounts) for more info on Tempo Wallet flows and access-key authorization.

---

---
url: /shared/connectors/tempoWallet.md
---
# tempoWallet

Connector for the Tempo Wallet dialog.

## Import

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/tempoWallet.md","from":231,"to":287}<fsm-vh3gqscxm4e>
import { tempoWallet } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/tempoWallet.md","from":488,"to":537}<fsm-vh3gqscxm4e>
pnpm add accounts@{{connectorDependencyVersion}}
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/tempoWallet.md","from":560,"to":612}<fsm-vh3gqscxm4e>
npm install accounts@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/tempoWallet.md","from":636,"to":685}<fsm-vh3gqscxm4e>
yarn add accounts@{{connectorDependencyVersion}}
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/tempoWallet.md","from":708,"to":756}<fsm-vh3gqscxm4e>
bun add accounts@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/tempoWallet.md","from":785,"to":1146}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { tempo } from '{{packageName}}/chains'
import { tempoWallet } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [tempo],
  connectors: [tempoWallet()], // [!code hl]
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})
```

`tempoWallet` is a thin Wagmi wrapper around the `accounts` dialog adapter.

## Parameters

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/tempoWallet.md","from":1253,"to":1324}<fsm-vh3gqscxm4e>
import { type TempoWalletParameters } from '{{connectorsPackageName}}'
```

`tempoWallet` accepts the Tempo Accounts dialog parameters together with provider options like [`authorizeAccessKey`](#authorizeaccesskey).

### host (optional)

`string`

Override the Tempo Wallet dialog host.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/tempoWallet.md","from":1551,"to":1696}<fsm-vh3gqscxm4e>
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  host: 'https://wallet.tempo.xyz', // [!code focus]
})
```

### dialog (optional)

`Window | HTMLElement | ShadowRoot | string`

Override where the dialog mounts.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/tempoWallet.md","from":1815,"to":1956}<fsm-vh3gqscxm4e>
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  dialog: '#tempo-wallet-root', // [!code focus]
})
```

### icon (optional)

`` `data:image/${string}` ``

Optional connector icon override.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/tempoWallet.md","from":2057,"to":2243}<fsm-vh3gqscxm4e>
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  icon: 'data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg"></svg>', // [!code focus]
})
```

### name (optional)

`string`

Optional connector display name.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/tempoWallet.md","from":2323,"to":2459}<fsm-vh3gqscxm4e>
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  name: 'My Tempo Wallet', // [!code focus]
})
```

### rdns (optional)

`string`

Optional reverse-DNS identifier.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/tempoWallet.md","from":2539,"to":2684}<fsm-vh3gqscxm4e>
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  rdns: 'com.example.tempo-wallet', // [!code focus]
})
```

### authorizeAccessKey (optional)

`() => { expiry: number, ... }`

Default access-key authorization parameters to attach to `wallet_connect`.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/tempoWallet.md","from":2843,"to":3024}<fsm-vh3gqscxm4e>
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  authorizeAccessKey() {
    return {
      expiry: 60 * 60,
    }
  }, // [!code focus]
})
```

See the [Accounts SDK docs](https://docs.tempo.xyz/accounts) for more info on Tempo Wallet flows and access-key authorization.

---

---
url: /solid/api/connectors/tempoWallet.md
---

# tempoWallet

Connector for the Tempo Wallet dialog.

## Import

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add accounts@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install accounts@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add accounts@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add accounts@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { tempo } from '{{packageName}}/chains'
import { tempoWallet } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [tempo],
  connectors: [tempoWallet()], // [!code hl]
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})
```

`tempoWallet` is a thin Wagmi wrapper around the `accounts` dialog adapter.

## Parameters

```ts-vue
import { type TempoWalletParameters } from '{{connectorsPackageName}}'
```

`tempoWallet` accepts the Tempo Accounts dialog parameters together with provider options like [`authorizeAccessKey`](#authorizeaccesskey).

### host (optional)

`string`

Override the Tempo Wallet dialog host.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  host: 'https://wallet.tempo.xyz', // [!code focus]
})
```

### dialog (optional)

`Window | HTMLElement | ShadowRoot | string`

Override where the dialog mounts.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  dialog: '#tempo-wallet-root', // [!code focus]
})
```

### icon (optional)

`` `data:image/${string}` ``

Optional connector icon override.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  icon: 'data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg"></svg>', // [!code focus]
})
```

### name (optional)

`string`

Optional connector display name.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  name: 'My Tempo Wallet', // [!code focus]
})
```

### rdns (optional)

`string`

Optional reverse-DNS identifier.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  rdns: 'com.example.tempo-wallet', // [!code focus]
})
```

### authorizeAccessKey (optional)

`() => { expiry: number, ... }`

Default access-key authorization parameters to attach to `wallet_connect`.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  authorizeAccessKey() {
    return {
      expiry: 60 * 60,
    }
  }, // [!code focus]
})
```

See the [Accounts SDK docs](https://docs.tempo.xyz/accounts) for more info on Tempo Wallet flows and access-key authorization.

---

---
url: /tempo/connectors/tempoWallet.md
---

# tempoWallet

Connector for the Tempo Wallet dialog.

## Import

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add accounts@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install accounts@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add accounts@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add accounts@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { tempo } from '{{packageName}}/chains'
import { tempoWallet } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [tempo],
  connectors: [tempoWallet()], // [!code hl]
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})
```

`tempoWallet` is a thin Wagmi wrapper around the `accounts` dialog adapter.

## Parameters

```ts-vue
import { type TempoWalletParameters } from '{{connectorsPackageName}}'
```

`tempoWallet` accepts the Tempo Accounts dialog parameters together with provider options like [`authorizeAccessKey`](#authorizeaccesskey).

### host (optional)

`string`

Override the Tempo Wallet dialog host.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  host: 'https://wallet.tempo.xyz', // [!code focus]
})
```

### dialog (optional)

`Window | HTMLElement | ShadowRoot | string`

Override where the dialog mounts.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  dialog: '#tempo-wallet-root', // [!code focus]
})
```

### icon (optional)

`` `data:image/${string}` ``

Optional connector icon override.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  icon: 'data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg"></svg>', // [!code focus]
})
```

### name (optional)

`string`

Optional connector display name.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  name: 'My Tempo Wallet', // [!code focus]
})
```

### rdns (optional)

`string`

Optional reverse-DNS identifier.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  rdns: 'com.example.tempo-wallet', // [!code focus]
})
```

### authorizeAccessKey (optional)

`() => { expiry: number, ... }`

Default access-key authorization parameters to attach to `wallet_connect`.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  authorizeAccessKey() {
    return {
      expiry: 60 * 60,
    }
  }, // [!code focus]
})
```

See the [Accounts SDK docs](https://docs.tempo.xyz/accounts) for more info on Tempo Wallet flows and access-key authorization.

---

---
url: /vue/api/connectors/tempoWallet.md
---

# tempoWallet

Connector for the Tempo Wallet dialog.

## Import

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add accounts@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install accounts@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add accounts@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add accounts@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue
import { createConfig, http } from '{{packageName}}'
import { tempo } from '{{packageName}}/chains'
import { tempoWallet } from '{{connectorsPackageName}}' // [!code hl]

export const config = createConfig({
  chains: [tempo],
  connectors: [tempoWallet()], // [!code hl]
  multiInjectedProviderDiscovery: false,
  transports: {
    [tempo.id]: http(),
  },
})
```

`tempoWallet` is a thin Wagmi wrapper around the `accounts` dialog adapter.

## Parameters

```ts-vue
import { type TempoWalletParameters } from '{{connectorsPackageName}}'
```

`tempoWallet` accepts the Tempo Accounts dialog parameters together with provider options like [`authorizeAccessKey`](#authorizeaccesskey).

### host (optional)

`string`

Override the Tempo Wallet dialog host.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  host: 'https://wallet.tempo.xyz', // [!code focus]
})
```

### dialog (optional)

`Window | HTMLElement | ShadowRoot | string`

Override where the dialog mounts.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  dialog: '#tempo-wallet-root', // [!code focus]
})
```

### icon (optional)

`` `data:image/${string}` ``

Optional connector icon override.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  icon: 'data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg"></svg>', // [!code focus]
})
```

### name (optional)

`string`

Optional connector display name.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  name: 'My Tempo Wallet', // [!code focus]
})
```

### rdns (optional)

`string`

Optional reverse-DNS identifier.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  rdns: 'com.example.tempo-wallet', // [!code focus]
})
```

### authorizeAccessKey (optional)

`() => { expiry: number, ... }`

Default access-key authorization parameters to attach to `wallet_connect`.

```ts-vue
import { tempoWallet } from '{{connectorsPackageName}}'

const connector = tempoWallet({
  authorizeAccessKey() {
    return {
      expiry: 60 * 60,
    }
  }, // [!code focus]
})
```

See the [Accounts SDK docs](https://docs.tempo.xyz/accounts) for more info on Tempo Wallet flows and access-key authorization.

---

---
url: /core/guides/testing.md
---
# Testing

---

---
url: /react/guides/testing.md
---
# Testing

---

---
url: /core/api/transports.md
---
# Transports

[`createConfig`](/core/api/createConfig) can be instantiated with a set of Transports for each chain. A Transport is the intermediary layer that is responsible for executing outgoing JSON-RPC requests to the RPC Provider (e.g. Alchemy, Infura, etc).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/transports.md","from":555,"to":590}<fsm-vh3gqscxm4e>
import { http } from '@wagmi/core'
```

## Built-In Transports

Available via the `'@wagmi/core'` entrypoint.

---

---
url: /react/api/transports.md
---
# Transports

[`createConfig`](/react/api/createConfig) can be instantiated with a set of Transports for each chain. A Transport is the intermediary layer that is responsible for executing outgoing JSON-RPC requests to the RPC Provider (e.g. Alchemy, Infura, etc).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/transports.md","from":556,"to":585}<fsm-vh3gqscxm4e>
import { http } from 'wagmi'
```

## Built-In Transports

Available via the `'wagmi'` entrypoint.

---

---
url: /solid/api/transports.md
---
# Transports

[`createConfig`](/solid/api/createConfig) can be instantiated with a set of Transports for each chain. A Transport is the intermediary layer that is responsible for executing outgoing JSON-RPC requests to the RPC Provider (e.g. Alchemy, Infura, etc).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/transports.md","from":556,"to":592}<fsm-vh3gqscxm4e>
import { http } from '@wagmi/solid'
```

## Built-In Transports

Available via the `'@wagmi/solid'` entrypoint.

---

---
url: /vue/api/transports.md
---
# Transports

[`createConfig`](/vue/api/createConfig) can be instantiated with a set of Transports for each chain. A Transport is the intermediary layer that is responsible for executing outgoing JSON-RPC requests to the RPC Provider (e.g. Alchemy, Infura, etc).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/transports.md","from":554,"to":588}<fsm-vh3gqscxm4e>
import { http } from '@wagmi/vue'
```

## Built-In Transports

Available via the `'@wagmi/vue'` entrypoint.

---

---
url: /core/typescript.md
---
# TypeScript

## Requirements

Wagmi Core is designed to be as type-safe as possible! Things to keep in mind:

* Types currently require using TypeScript {{typescriptVersion}}.
* [TypeScript doesn't follow semver](https://www.learningtypescript.com/articles/why-typescript-doesnt-follow-strict-semantic-versioning) and often introduces breaking changes in minor releases.
* Changes to types in this repository are considered non-breaking and are usually released as patch  changes (otherwise every type enhancement would be a major version!).
* It is highly recommended that you lock your `@wagmi/core` and `typescript` versions to specific patch releases and upgrade with the expectation that types may be fixed or upgraded between any release.
* The non-type-related public API of Wagmi Core still follows semver very strictly.

To ensure everything works correctly, make sure your `tsconfig.json` has [`strict`](https://www.typescriptlang.org/tsconfig#strict) mode set to `true`.

::: code-group

```json [tsconfig.json]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/typescript.md","from":1175,"to":1225}<fsm-vh3gqscxm4e>
{
  "compilerOptions": {
    "strict": true
  }
}
```

:::

## Const-Assert ABIs & Typed Data

Wagmi Core can infer types based on [ABIs](https://docs.soliditylang.org/en/latest/abi-spec.html#json) and [EIP-712](https://eips.ethereum.org/EIPS/eip-712) Typed Data definitions, powered by [Viem](https://viem.sh) and [ABIType](https://github.com/wevm/abitype). This achieves full end-to-end type-safety from your contracts to your frontend and enlightened developer experience by autocompleting ABI item names, catching misspellings, inferring argument and return types (including overloads), and more.

For this to work, you must either [const-assert](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#const-assertions) ABIs and Typed Data (more info below) or define them inline. For example, `useReadContract`'s `abi` configuration parameter:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/typescript.md","from":2054,"to":2145}<fsm-vh3gqscxm4e>
const result = await readContract({
  abi: […], // <--- defined inline // [!code focus]
})
```

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/typescript.md","from":2156,"to":2259}<fsm-vh3gqscxm4e>
const abi = […] as const // <--- const assertion // [!code focus]
const result = readContract({ abi })
```

If type inference isn't working, it's likely you forgot to add a `const` assertion or define the configuration parameter inline. Also, make sure your ABIs, Typed Data definitions, and [TypeScript configuration](#requirements) are valid and set up correctly.

::: tip
Unfortunately [TypeScript doesn't support importing JSON `as const` yet](https://github.com/microsoft/TypeScript/issues/32063). Check out the [Wagmi CLI](/cli/getting-started) to help with this! It can automatically fetch ABIs from Etherscan and other block explorers, resolve ABIs from your Foundry/Hardhat projects, and more.
:::

Anywhere you see the `abi` or `types` configuration property, you can likely use const-asserted or inline ABIs and Typed Data to get type-safety and inference. These properties are also called out in the docs.

Here's what [`readContract`](/core/api/actions/readContract) looks like with and without a const-asserted `abi` property.

::: code-group

```ts twoslash [Const-Asserted]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/typescript.md","from":3245,"to":8469}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"ce7669bfd8403077642e11ee62585359f9005b3491bb5cb9aa7196e861042c9f","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvUjGZQAwpLSlmYgDwjJ/dgHNedGmChxeisNp0VemsHDS9mAI3b76MIyYCCz3gB9pslCSrBi8wgDWkADuYMgAulZCouKSAHLMALYwrobGpkoqYgBiwmISYOlZak7sVgA6IFiCMg1+vA1E7DBRDQB8VjZ2DqQ6JgbueWbKqmglyeWeI3DVzvWNzTCt/h1dPZQCpSkVmTC9vYw2FojWWrpWWMwqWTSkcNcASoFThWgACo8nF7LGqJQ7lSowKyPUYDW46Xrca6/UgQDLsOAwNSfOTfGafNDNMAAFWwmJBB3maROUKWZzqYHYGSwEFI9hkOIKM0oICCIgQiAIaDQWDeAHpRVFmDo0QA6OD4UWaGSi5hYdgqsqSOCi9kKTlibl2R4MRAATiorHcOjQ+CQAEYAExUNDQmAmkC63EGi3sMC4RAABioInwALEZCQpoAvhR0KS8IQSORnQY8IM2fBBKw0NdnDpfQwqEbWUgAKxBkCWsDW22IABsztd7pkcCzhcrvv9TpAIbDLyQdZjcZwCeIEZT9CYbE4PACHLA03UZgsal1wVCqHpvG3vEcrAgInCAFFaFh9zJXtdgFud7e12AQrxYPxmG2rzfb5+50EH6EwCdrgaI8bTIOARGYMAGgAbg/L8d3vR9mlYQDBWFMVRTdfBQPAsAZQkaDYLg791wcNUAFVSGQ9pUJFRBxVVdgZUw7CILwiAVTVAipDgqMYO47deNgvcD3CIlGRga5HQDaS+NvGxFzQN5eGvfjPwQ0J3DgMiGSTOA2E+OAIFYJN31Uoj1IcKAoBbJSGgDWgYEcpzHLtAAWKAAHY7QADhEB1HFcjyoFNU0HQAZlgJw7TCsLSxgNzXOcriiLvQISOEw95HZGgoGucKA280siu82SeNKr8LIyNt2HA1hWDC0yUvgtLf0s6z4FskB7PAu07UcWAA1LU0PI8xwwrrMLerrDyAwdbzvLrfyYAdZg7Q8sLhrrHq7WSpriNajLwiy2Qcsk1zYvGgM7XKz9BNUu7bxlJ7eDc3gMhZbInplG6k3YfgMAACS4fAAH5rkYC4OHcHNTChhc1C+/peAeJ43VA64ADUyD+wHgf+VGgT4ABeXpeGRVF0UxRwICM2QwARNphGfTsoD4mNlNgr62YSDnVK5+l2Ys47mBoMw/TEFkiliOIkYs5Avp5hpHDYCCRBgAB5fgGisOWFfOS5dGuZddARp6kZRwF0d4bE9QXH58ct15TZlBEkRRNEMWd3p6UZZlWW/L1215fkaPQyVpUY+VFQ+jj1RmcptU9fV22LE061LC0rRte1uxdEY3TwJO7a5H0/SQbtex+CNEAdO0h2oeMBUTcdqFTAV0xucxDfyLudFXFrH03VTDpPM8PsvXnzIH0Jn1fbNGr2iz/yyFDgKw14cN2pqLKQlD8CFWjxWYjfWPwkAbqnuQSIYiiqIafe0Lo2OmJAk/cIkWOt9um6Hp3Q6xJXi9B00kAw3Xkj8JSKlL4/kfJpbS7BdL6XgEZEyk9F7TzajZFC9lnLOTcp5HyfkApBRCuFSKjhoqxXiq5RKTkv7QPSvuTK2UYC5V4PlQqxUL47l/hVDBVVsw1TYPVBe28MFyHanATq3VVp9QGkNEaY0JpTRmnNBaS0VprQ2h5Lasj6FwQsodYWp0XrnVLJda6hEeE/xul9Uxb0Pq8H5qpX6/0gbyjBrwCGIg4Yw3kL4r29wATPCtljUgON3H4AdiE14xNSbkw9lTGmloIIM38EzGA2g/SswFlYKBO5nFRh5vk7chSdYYOMTAMWMAJakClvEXoho84mg8t5TO1Zs71kbPnd0BsdDcg4GXGuwZQxV3IIgMKrl66YBHE3McyZW6TgFIwLAKIcCsgwHwCRWDeAAAN7IABJgB2HCdWKMuymnGkjBWKsNYkAeW6ToAuAptkdQGZ2JAYURl9mrg6aZjcCDzO5DQJZIAVlrLIJgLZzhrhyxKftR8y8JLUWVqwVWGstbn1ghZGZyKGhJE1JBLFqkLJGhoAAWUEC6ZwHBMAoU6N0L+FlfRNEUrCjBQ8GGtVxShV5Uj9HbiXgBaiEAYhkC/kUm6FkIBUtZUpOFVjBUYJ5dRQQBYHSljrBKuIbM8nYowUilC6JPBYFWWOKARQWSeDqky5VpIUIEqOLaq+rUyUwEpdS9gtKMD0t2M6mBoQWVUvlRy+FqUXWPhVQ0PlcABUIr/MKhooq/SkAlXqsyzUI2hCjSAGNcahWAKTeskWLJtVSowTK4Uwb2VZt4JygxdqcAoWpkZMtuS0FKtrYa6iTy0AmrNSQKA/qSI5sdeUYdrqXQUqpTUb1vrGXEvDQG3gQa2XxrrQrcttbK1yprcu+WT0dXtvhWUjtTinrc0uSWRAbkHmVizrWL51Amx4BqO8oZrlvljPLv82ZgKkzArbj2LU9gyAiA8rXbw7A90kXrZ25d3alYq1EBiidkb7XUTHZINDoQ3UetnewOl1EGV7C3cu1dIba1wbUo2vFuarI2XzQaxNIBk3isXTwo9JKK2yureu6jS6R0YYaGqhcGqtUcYElx9m8KC10eNaalEg7LWkGtawHDvBR1gmw5J9deGZ00sIz64jfrdPMrALu/jYbM3LpzXm3TgnWqIdY2K1NumZOKvXXZhjHUmNdpYxAYtaBS3ua445x8O6+MKozfBoTTaUXJLbWADz3H/OFpAL2/tSnWEaa05SIlZGSL6c9XOkzC7CutQozB1qB6ZRhZsyRSLa7daHt1We09J6L0CziFek0dpSzdluZ080z6el4DAxBu0UH33+k/T2UZMxq4eV/f6f9LcQXunBYFyFmyKSEohM25DatNZbGogpgdrCVNqdOw0TLinzU3Zcymk7IA2gNGC+EdwZF3gAEkGi9ftOndpdyb25xfQKLDxwsgzbLF+xb4y/mxgbn+gAjoIMgGBAOgq2+sqFe2jgHZRUd1Dr3tggHO9li1VqbWk57W6LLD3adJtcy9t71AICfbAN9v7IAAc3qB/ejptZHSPOeSASHEIYeIAzvNn5COVujgAxOTbZrce7ehJR/dbHSDXH2bQI5JzfQ6HOT1oszT7TDWB50ubede2vqWFLkbld4c/qR7ivAaOMdY5VxCjZWyljVcHtr3XhzjnKCNybvndpLeC5Bzb8HuaHel39E7hb4Z5du4Bc3BZG20wgYCK2eeu5dAFj5xqmXQ3awNlG3bgULY2xS5F7L79gYFcCk96QTHyu8+2AzIXmGeZS9m6uTXIqVuq+i+bJmbMjeK5p/7K3hIwHYB4F9iyewwAA7J14FGAQ7teAAHIAAC4c0TRxkAf+k9IO71+zLwImDhJSEa38XMQFw4Tpu3DG64B/7JFAAEKeAbSOjyDMABjuRQCuSli+TeTnTLRHhHgFSmjTT8DyDgH8CxQeSmh+QH4UA3g1DXATaQarA3gS7CoH6oroqay4FX6QR0Ff4B51q/60CeABjyD8BYHzR2h1gAAirkjgpoAhC0dYjg5iYUAYCBzArkdYq03kYU3kDo/AGqdoMAB+CQAs3AtBt+aA9I3IzwzASAoA4wtg5QeAikIAUYUYQAA="}
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

const erc721Abi = [
  {
    name: 'balanceOf',
    type: 'function',
    stateMutability: 'view',
    inputs: [{ type: 'address', name: 'owner' }],
    outputs: [{ type: 'uint256' }],
  },
  {
    name: 'isApprovedForAll',
    type: 'function',
    stateMutability: 'view',
    inputs: [
      { type: 'address', name: 'owner' },
      { type: 'address', name: 'operator' },
    ],
    outputs: [{ type: 'bool' }],
  },
  {
    name: 'getApproved',
    type: 'function',
    stateMutability: 'view',
    inputs: [{ type: 'uint256', name: 'tokenId' }],
    outputs: [{ type: 'address' }],
  },
  {
    name: 'ownerOf',
    type: 'function',
    stateMutability: 'view',
    inputs: [{ type: 'uint256', name: 'tokenId' }],
    outputs: [{ type: 'address' }],
  },
  {
    name: 'tokenURI',
    type: 'function',
    stateMutability: 'pure',
    inputs: [{ type: 'uint256', name: 'tokenId' }],
    outputs: [{ type: 'string' }],
  },
] as const
// ---cut---
import { readContract } from '@wagmi/core'

const result = await readContract(config, {
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  abi: erc721Abi,
  functionName: 'balanceOf',
  // ^?



  args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'],
  // ^?
})

result
// ^?
```

```ts twoslash [Not Const-Asserted]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/typescript.md","from":8509,"to":12310}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"32e9700c30963257f6c79b087bc2f37aa4f1bb4bb135b24ec22d2f898493f29f","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvUjGZQAwpLSlmYgDwjJ/dgHNedGmChxeisNp0VemsHDS9mAI3b76MIyYCCz3gB9pslCSrBi8wgDWkADuYMgAulZCouKSAHLMALYwrobGpkoqYgBiwmISYOlZak7sVgA6IFiCMg1+vA1E7DBRDQB8VjZ2DqQ6JgbueWbKqmglyeWeI3DVzvWNzTCt/h1dPZQCpSkVmTC9vYw2FojWWrpWWMwqWTSkcNcASoFThWgACo8nF7LGqJQ7lSowKyPUYDW46Xrca6/UgQDLsOAwNSfOTfGafNDNMAAFWwmJBB3maROUKWZzqYHYGSwEFI9hkOIKM0oICCIgQiAIaDQWDeAHpRVFmDo0QA6OD4UWaGSi5hYdgqsqSOCi9kKTlibl2R4MRAATiorHcOjQ+CQAEYAExUNDQmAmkC63EGi3sMC4RAABioInwALEZCQpoAvhR0KS8IQSORnQY8IM2fBBKw0NcItEwIaXaykABWIMgS1ga22xAANmdrvdMjgWYYPr9SCdIBDYZeSFrMbjOATxAjKfoTDYnB4AQ5YGm6jMFjUuuCoVQ9N4W94jlYEBE4QAorQsHuZK9rsBN9ub6uwCFeLB+MxW5frzeP7OgvfQmATtcGkPG0yDgERmDABoAG530/bc7wfZpWAAwVhTFUU3XwECwLAGUJCgmDYK/NcHDVABVUgkPaFCRUQcVVXYGUMKw8DcIgFU1XwqRYKjaCuK3HiYN3fdwiJRkYGuR0Ayk3ibxsBc0DeXgrz4j94NCdw4FIhkkzgNhPjgCBWCTN8VMItSHCgKBm0UhoA1oGAHMchy7QAFigAB2O0AA4RAdRwXPcqBTVNB0AGZYCcO1QtCksYFclynM4wjb0CYihIPeR2RoKBrjCgMvJLQqvJk7iSs/cyMlbdgwNYVhQpM5K4NSn8LKs+AbJAOywLtO1HFgAMS1Ndz3McULa1Cnra3cgMHS8rzaz8mAHWYO13NCoba26u0ksaoiWvS8JMtkbKJJcmKxoDO0yo/ASVNum8ZUe3hXN4DIWWyR6ZWupN2H4DAAAkuHwAB+a5GAuDh3BzUxIfnNRPv6XgHieN0QOuAA1MhfoBoH/hRoE+AAXl6XhkVRdFMUcCBDNkMAETaYQn19GAoF4mMlJgz62YSDmVK5+l2fMo7mBoMw/TEFkiliOJEeUh7HrZ+I1kcNhwJEGAAHl+AaKxzOQT6ZYuOFriXXR4cexHkcBNHeGxPV5x+PHrdec2ZQRJEUTRDFXd6elGWZVkvy9NseX3flqLQyVpQY+VFXe9j1RmcptU9fUQ6NYs6xLC0rRte0uyLHQ3TwVOHa5dt/S7HsfgjRAHTtQdqHjAVEzHahUwFdMbnMXQTbhFdmofDcVIO49T3ei9ebMwfQifF9swa3bzL/LJkKAzDXmwnbGvMxDkPwIUaPFJjN5YvCQGu6e5GI+jyMohoD9Q2iE8Y4DT5wiQE+3m7rvu7cDtEqvZ6DopIBmunJH4ik5awXMhpLS7AdJ6XgIZYyU8l4z1atZZCdknJOVch5byvl/KBWCmFCKjgooxTii5BKjlv5X2/A+A6wsTq8DygVIql9tx/3Khgyq2ZqpsDqovHeGC5BtTgB1LqK1er9UGsNUa41JrTVmvNRay1VrrXcptGR9CYEYOYVlFmp1zq1kulw/iv9rqfWei5V671eD8xUj9P6gN5Sg14ODEQsNobyB8T7e4AJng20xqQbGbj8BO2Ca8ImJMyZe0ptTS04F6b+EZjAbQfpWYCysNArcTiow8zyY4hWOS9oPhYTAMWMAJakClvEXohZjRIHcl5HOVY851gbCMYunc4Tcg4B2OuwZQw13IIgUKLlG6YGHC3UcyZ24TgFIwLAKIcCsgwHwcRWDeAAAM7IABJgB2DCVWKMuymmZ1NOWSs1YWndKLu6bZ7UBnMyQKFEZvZa4Ommc3Ag8zuQ0CWSAFZayyCYC2c4ERvAV7iV4Cc30OhrozLhQiqs10jQ0AALKCBdM4DgmBrhoqRTBX0TQFLQpvCiolyhEUWJhf+eFtL0UwSjPEa6EBcXkqgQRbc1KmWnJJXddlAt4iXJNK5dy7S7kTIeb0kANRXlDJcp8sZnZfmzP+UmQFHduxansGQEQ7l67eHYNC2FNLBXItJJaulMFMUwBxXi9gBKMC2pZSpMluKeWmT5TagVdrfVbgtQGj1N42VxA5Vy71lK/U4HdUK8NIqwARvFfaEsXZbmdPNNQRseBDXGrtKapV/oVXdlGTMWu7kNX+i1W3IF7pQUQHWRCikmpjhAOJWmxAdpazZwrLnGsjo5XuiSO2iEJbSyqsreMn5sYm6aoAI6CDIBgHVwKm0ts2W2o4EIE3dt7f2rNQ6C55oFGO3dJxJ2IH7dXGd6r50opHNq8cjbVnNvBdu6EcAPG7zAJECAMR4gMyMBk5mUAD1DWlZ0sthd5XfuvTmu94ZZ01rwMu1d6631go2VspYv6MF5kA9LEDTMsmQalQOjpNZYNnoVUsRD06UMPqHLW1uCyG1pn1QEFsC8wj/vzN2h0hVoM1nrLmnpTZMzZmvcO8tXzxkBjQwKDDpA12vq47YDMvHoZEZiEJkTVGZXibg1JnTsmq4VuY4GQpwZoC1v9iyewwAg5p14FGAQnteAAHIAACUc0RxxkN5+k9Iu7NlbLwQmDhJTsAzHOeSRse6WDQc8yR1xvN2SKAAIU8OtR08hmABjclAFyJYfJeTOktQ8h58qmimvweQxX+AxXcqaXy3mKDXhqNcAtJrVjXgveCRl3mVasDVprfgnXQsQVm1ub91xkCZdoJ4AM8h+Btbmr2gAIi5Rwpp9vzVrI4Es0UAw1eYC5WsK0vKhS8g6fgwm7QwG8wkAW3AZsRezPSbkzxmBIFAOMWw5Q8AKRAFGKMQA=="}
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

declare const erc721Abi: {
  name: string;
  type: string;
  stateMutability: string;
  inputs: {
    type: string;
    name: string;
  }[];
  outputs: {
    type: string;
  }[];
}[]
// ---cut---
import { readContract } from '@wagmi/core'

const result = await readContract(config, {
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  abi: erc721Abi,
  functionName: 'balanceOf',
  // ^?



  args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'],
  // ^?
})

result
// ^?
```

:::

You can prevent runtime errors and be more productive by making sure your ABIs and Typed Data definitions are set up appropriately. 🎉

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/typescript.md","from":12470,"to":17525}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"1302572cb196fc0dde6d7e01c4f069233f8e54486c2e57cde92bd7a1bf18508b","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvUjGZQAwpLSlmYgDwjJ/dgHNedGmChxeisNp0VemsHDS9mAI3b76MIyYCCz3gB9pslCSrBi8wgDWkADuYMgAulZCouKSAHLMALYwrobGpkoqYgBiwmISYOlZak7sVgA6IFiCMg1+vA1E7DBRDQB8VjZ2DqQ6JgbueWbKqmglyeWeI3DVzvWNzTCt/h1dPZQCpSkVmTC9vYw2FojWWrpWWMwqWTSkcNcASoFThWgACo8nF7LGqJQ7lSowKyPUYDW46Xrca6/UgQDLsOAwNSfOTfGafNDNMAAFWwmJBB3maROUKWZzqYHYGSwEFI9hkOIKM0oICCIgQiAIaDQWDeAHpRVFmDo0QA6OD4UWaGSi5hYdgqsqSOCi9kKTlibl2R4MRAATiorHcOjQ+CQAEYAExUNDQmAmkC63EGi3sMC4RAABioInwALEZCQpoAvhR0KS8IQSORnQYmGxODwAhywNN1GYLGpdcFQqh6bxy7xHKwICJwgBRWhYasyV7XYBliudotgEK8WD8ZiCVhoNsdzvjrNBHuhMAna4NOs2shwETMMANADcY4nFe7vearHnguFYtFbvwy9XYBlEk3253k+LDjVAFVSIf2seRYhxar2DLz0vNcbwgFU1TvKQdyjLdIPLaDtyrGtwiJRkYGuR0A0wmDOxsXM0DeXh21g8c91Cdw4BfBkkzgNhPjgCBWCTUdiIfUiHCgKAZDgAiGgDWgYAEwSBLtAAWKAAHY7QADhEB1HBE8SoFNU0HQAZlgJw7VU1SAFYYFEkShIgh8u0CJ9ENreR2RoKBrjUgMpJ0pypOwqDXInNiMiHcRV1YVhVOYkzdzM6d2M4+AeJAPjVztO1HFgAMdNNcTxMcVSADZVNi9LxIDB0pKk9K5JgB1mDtcTVOS9KYrtYygsfUKLPCKzZBs9CRN0jKAztdzx3g4j+s7GVht4UTeAyFlsmGmVeqTdh+AwAAJLh8AAfmuRgLg4dwR1MbaczUab+l4B4njdZdrgANTIealpW/4zqBPgAF5el4ZFUXRTFHAgBjZDABE2mEftfRgKAYJjQjt2miGEih4iYfpSG2Ja5gaDMP0xBZIpYjiY62OQaa4YaRw2DXEQYAAeX4LZeGm3hVPGya6ZG7ZqAgcJ3Bfd4AEkGisAmifOS5dGufNdEO4bjtOwELt4bE9RzH4Htl15JZlBEkRRNEMXV3p6UZZlWUnL0GCoXl+S/U9JWlf95UVSawPVGZym1T19TNkAjVZJARJEi0rRte0nWoV13XdpWuR9P0kBDkMwxeJAAxjOMcATYgIxTeg8EGewRZ0MW4ULELe1LYimobJtJtbeHWJL0J+0HYdAvqtjZyyI9FwvV4rzqoK2IPI98CFb9xUAnvgNvEBerruQnz/N8PwaYeTx/J2AKXCfrwkJ2+763rBorJqUI70aHUwgNetwn4CKI2ep17cjKPYajaPgBimNr1v67CrjIr4oSQlRISWkrJeSillJqQ0o4LSul9J+yMtPe8O42JNVRm1Xg9lHLORnhWQ+Hkf5eWHOwXy/kW79x/nIcK3EjzRTKnFBKSUUppUytlXK+VCrFVKuVSq4lqr0L3vfcy1ZLLWTBu1Tq6Vuq4LggfXq9MxoTRkCzGa245oLWWvKdavBNoiH2rteQ+i9b3ABM8OW11SC3U0fgFWZjXgvTeh9HW31fqWjXIDfwwMYDaD9ODJGVg74VkRmAKMcNAnlmCcjH+6CYAYxgFjUgON4i9ENC6H2iAdLiQDmAa0tpEDpWdGHHOcJuQcBjogOOoYfgRkQFpFO1B4wCkTJnagqYBSMCwCiHArIMB8CoX/WhtAigACFPCVUdPIZgAYxJQBEjpGSUkOolTrHWBypocr8HkNM/gulxKmlkg0VJxokDpXNCAS0OSg6ICyaHEYbo8D9IiqU0GSBVLBiqTMGpDp6mYDTk0jOyZWnZ3aZ0iA3TMB9OcNcAm4SGq9nbmhT8pNWDkypjTJBxE2K/MRQ0JImp1wYtMnPUKRoaAAFlBAumcBwTAR5OjdD3mxX0TR8LQp/mXIRoVsVHkedxQRwViXwrnJ+CAMQyB71Cb1NiEBKUsoIjC5B5YsWkiPIIX0aAHQ6XShKuIEMAnbjbsKho6JPBYFBSQKARQWSeD8oyn+3LPx4qOHawVoRSUwApVS9gNKMB0t2C6h+oRmWUvley2FRLA28AdQ0XlcB+VKp/gio8oq/SkAlfqliArI3RpALG+NcKZxGpAGCsgaMWQ6qlT/GVwoQ1stdbwDlKD7UqqRa4it/iv4JvrUmz8Og3SmvNWDANT4c1OvKMOklLpyWUpqD6v1DLCVZqfMG1lBaG1E0rfW6tcq62RsJsNXVHbYWRIzUNYasMjnpMdAU85gc8lvNuX290NRnnlP9iAeO1TyAVJ+Y0ggALuQ0GBR+rU9gyAiHEg6O03h2C7qfI2rtkae0kzJqINFE7eyjrBJIDDbqp0epndS9gtLPz0r2JuyNK7Q31oQyRZtOAeUcT/vmw1p8GgpvFYuuCh7MVVtlbWtdtGI0jpbQ0NVOZNXaq47wSVR6DWJqLSas1KILVWtIDa1guGo2iZAGOnD0m2Lus9bO4jvrSP+oMz/KjcHQpCaXVynTebpPCdCsh4tYq03SchuG+zmHHNMYiixhTbHi3dLLZ5g+PGXO9m3QJhVmbEMiYY62hi7aQmnt84WkLT6B0qaHZZ+tWHKQEoo0+IzhHvWmfneR+T9brOCY3bVyNsXV2CwPXqztKiOvHvPUjOIl6TRaTtNk3JkZCl3PdOByD0HnCvv9O+z9nzv3iV/X8kAZAUSAu9oNv2I2rmOmDNAf0+Vz5UG0Bck4eBfSwFoDKfC3J2BQDwBtgAtCdgML2tKZM+w6QDbSQAkhwLwAA5ChlFmNqYNGB7wdEvBID2C4HAXQs4qzZDQBAbTQPQcgGRaiyHIA2jGrgLljOlrrW2oJ2zHLynSe03Yx5/HhP2aczANzPmIBgcyl4AAEUe7wDAMrxr/RB2DvH6LgerVKTAEgrBnukE23NpAOl3kJy+at/0/6kx/eAx0rpZAIUUnxRCI8uOIfooG/aXbt7Ll5IO4++5Ao9PHCyIrjJKuv2x3V+nLXWd3S65LT0vpSxrjIF4rQTwAZ5D8D2QVO06VuciUcKaJPhV0qOB0tpAMKzmAiXSmVKSqkpIOn4Jqu0mwQD9aoNt+0FU9t5PfWkp9Dyliu5vYt8M37vkJBA7AK7TIWT2GACbD2MmBDaxBwAARtmiB2MhQfrjABHPCFw4QZdjdcYHfERljNNBMqZMy5kLKWQ6FZayNlbJEjszJ+yHTA4oB2Go1wptQZg/fyCTvjcg9N/E6md+H/B4bU33D0j2j1NFj3j0T2TzAPSjTwz1UizzrBzzz2kkL2L1LxgGBwSCRm4G5GeGYCQFAHGFsHKDwHuyjCjCAA"}
// @errors: 2820
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

const erc721Abi = [
  {
    name: 'balanceOf',
    type: 'function',
    stateMutability: 'view',
    inputs: [{ type: 'address', name: 'owner' }],
    outputs: [{ type: 'uint256' }],
  },
  {
    name: 'isApprovedForAll',
    type: 'function',
    stateMutability: 'view',
    inputs: [
      { type: 'address', name: 'owner' },
      { type: 'address', name: 'operator' },
    ],
    outputs: [{ type: 'bool' }],
  },
  {
    name: 'getApproved',
    type: 'function',
    stateMutability: 'view',
    inputs: [{ type: 'uint256', name: 'tokenId' }],
    outputs: [{ type: 'address' }],
  },
  {
    name: 'ownerOf',
    type: 'function',
    stateMutability: 'view',
    inputs: [{ type: 'uint256', name: 'tokenId' }],
    outputs: [{ type: 'address' }],
  },
  {
    name: 'tokenURI',
    type: 'function',
    stateMutability: 'pure',
    inputs: [{ type: 'uint256', name: 'tokenId' }],
    outputs: [{ type: 'string' }],
  },
] as const
// ---cut---
import { readContract } from '@wagmi/core'

readContract(config, {
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  abi: erc721Abi,
  functionName: 'balanecOf',
  args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'],
})
```

## Configure Internal Types

For advanced use-cases, you may want to configure wagmi's internal types. Most of wagmi's types relating to ABIs and EIP-712 Typed Data are powered by [ABIType](https://github.com/wevm/abitype). See the [ABIType docs](https://abitype.dev) for more info on how to configure types.

---

---
url: /react/typescript.md
---
# TypeScript

## Requirements

Wagmi is designed to be as type-safe as possible! Things to keep in mind:

* Types currently require using TypeScript {{typescriptVersion}}.
* [TypeScript doesn't follow semver](https://www.learningtypescript.com/articles/why-typescript-doesnt-follow-strict-semantic-versioning) and often introduces breaking changes in minor releases.
* Changes to types in this repository are considered non-breaking and are usually released as patch changes (otherwise every type enhancement would be a major version!).
* It is highly recommended that you lock your `wagmi` and `typescript` versions to specific patch releases and upgrade with the expectation that types may be fixed or upgraded between any release.
* The non-type-related public API of Wagmi still follows semver very strictly.

To ensure everything works correctly, make sure your `tsconfig.json` has [`strict`](https://www.typescriptlang.org/tsconfig#strict) mode set to `true`.

::: code-group

```json [tsconfig.json]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/typescript.md","from":1159,"to":1209}<fsm-vh3gqscxm4e>
{
  "compilerOptions": {
    "strict": true
  }
}
```

:::

## Config Types

By default React Context does not work well with type inference. To support strong type-safety across the React Context boundary, there are two options available:

* Declaration merging to "register" your `config` globally with TypeScript.
* `config` property to pass your `config` directly to hooks.

### Declaration Merging

[Declaration merging](https://www.typescriptlang.org/docs/handbook/declaration-merging.html) allows you to "register" your `config` globally with TypeScript. The `Register` type enables Wagmi to infer types in places that wouldn't normally have access to type info via React Context alone.

To set this up, add the following declaration to your project. Below, we co-locate the declaration merging and the `config` set up.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/typescript.md","from":1993,"to":2394}<fsm-vh3gqscxm4e>
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

declare module 'wagmi' { // [!code focus]
  interface Register { // [!code focus]
    config: typeof config // [!code focus]
  } // [!code focus]
} // [!code focus]

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

Since the `Register` type is global, you only need to add it once in your project. Once set up, you will get strong type-safety across your entire project. For example, query hooks will type `chainId` based on your `config`'s `chains`.

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/typescript.md","from":2652,"to":5076}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"296ef5d0fbed904e9f4bc9bf96c55b1f47345dcdd993965e6d5420eb1c6583d7","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAhVhBEBrAHKCAtgCMyAHhGT+7AOa86NMFDi8AwoZO8AvLfvHdpGMyiTWGXqgAdKV4QrUUVAFFaLEUPUjhEXmAgkNTUjy8fP1h+ZkFWNETk4LTS3gzvMF9eMGYNGESAkAi0fDI4EWYwJoBuFLLSiqzpUlZGgjQ0LASAehmYVvbOsAA6CV7+gfTPSurmLHYAVVHx/EnpxDn99hWFtvjltYgZ642S0oBfPvevzd4wpTKAAq7HqiQAjAAmAAMsO+aQMYDQpGYYgSST+aSGVT8MDAcEOYHYJHibAASvAIKwSUVMQNsXsoFAPHB0U1obQYFzuVzwQAWKAAdnBAA4RJCtHzBVAAJwyyEAZlgzC04IVCoArDB+XyeW8tlidsMASobBkaFBEoroSKNXaRfCBr93obMjjeBp8uJOqxWAraS76Ub3V5mfA2SAOZ1weCtLBoRqZYLBVoFQA2BUxtOC6GQkUitMSmCQ5jgwUKpNp6Pg/UGkIMvwm5RmzwWiF8zXp6Hgx1lZ1pfupFbD3j8j0QDy8YcrXu8EnsfgYAASXHwAH5EoxGCIOHjCrZd0jdNOAHwUXhYZgo+o0eKJABqZAXy9XAAUr3UFu0+I4T7xX6QEAaOwsi6FoEBUp4YAnnwAA+0iWDARhgDAUDfB857FGk07oQAumevAiPgzDsGAACSUBmPQeJWIRrjIE0REkfiTS4cgYCaDopBsU07BQKxTh0WARjGAxIBMaRcCsexnFkDxIB8ax56yKwMBiAAIswaDMIJWgmKRaAnowl7Xl+8QbrwhyyAogLqNoZDvqZt5wPorjnhJ5FQMpMCqRpWnMDBiRWfI4RqLJpAUmggikGAQLYDAugqWpaCadpJ5BKCWATmg0jWaFdlcZQIDeCICCIBMUyzDMADuzDGMBKxwPgMwZGILwHDMhAQMocAzDIIW2eFRVwNppAMIgMpUKpYDGK0SD8lQo3GAseD9TZKgFWQRUcChSDQlQTEomIW0TRh6DxXghAkkVND0EwbCcDwuUDRt4W6HYwkmO4wbVIE7xNlEMQTu0AZbA2vA5HkBSg3W5Q/X4tRgrwTQtPcHRdLWdbg9FYzIxVFxzHcSxdE8mMGuD1zHLjTRnJVlztTcRMPCTEgM2TA6zoOoShSCSNQrC0KzoiyKomg6JYUGbrVHiBJEiScDkpS1JkDDWPw7woYshGHI8jy/JCqK4qStKcqKsqqrqlqOp6iAs5g+rTYtlpqFWgqNp2hqDp0iEXODOrnoFOwPp+qr5Pq5r4bjFGpaxvGibJqmGZZjmeYFkWJZlhWgpVjH7OS7sjahU7bajh2Gpdj23u8L7vvTqX46TjhfzzouK5NRZW47uwe6JDYh5oMew4ESZn7OQ+T6t2+H43t+Th/gBQEgQl4GQV0MG8PBwg5KRqHoZhfxN2AHz4ee4Ib6OMZ2jG4LnnpxgGUZI8z+ZoeHx83BBXlg32RFCzRbF8VB4rHSkSDQWUxrPXWmFH+RUSplXxlVWq9UbhNRap4Nq1xOoQR6n1L+r0YFUBGlecafJ9ogGmrNfA80+SLSvMtcaIA1r5SGlNHeSBIQHWIkdW8e0zrUAuuVMggFyCENGuNDUgopp4koUgSR4loC4EQIqSEHCQBGGmp+PApFYC0BWGLIqfE8BCIALTKMhKY/MxjBQ3XMHgOKOBeAAHIoQKkcbwECNQIA5S4HAEwtQwgwF4GgCAQT4pOLPvBa+V8Yzny3khHeUBHErG2jAEgrAjGkGEdtNhSjOEfmOuQRAZY+GYBwJdYgW1Fq2PKsZQCOAxoYD4B5CiEJFTDTEUgCRUiZpzUQHIpaK1yrNKgNk3auTxJcNFidYpuEDoKK0WA7KSRIHMJ/tXAQgENBOKQcBRxQQghMO/lxRgwBCLEVIi00cipq7cCKjeZgSBQDmBlhIMAeB9EfA+EAA==="}
// @errors: 2322
import { type Config } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

declare module 'wagmi' {
  interface Register {
    config: Config<readonly [typeof mainnet, typeof sepolia]>
  }
}
// ---cut---
import { useBlockNumber } from 'wagmi'

useBlockNumber({ chainId: 123 })
```

You just saved yourself a runtime error and you didn't even need to pass your `config`. 🎉

### Hook `config` Property

For cases where you have more than one Wagmi `config` or don't want to use the declaration merging approach, you can pass a specific `config` directly to hooks via the `config` property.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/typescript.md","from":5395,"to":5913}<fsm-vh3gqscxm4e>
import { createConfig, http } from 'wagmi'
import { mainnet, optimism } from 'wagmi/chains'

export const configA = createConfig({ // [!code focus]
  chains: [mainnet], // [!code focus]
  transports: { // [!code focus]
    [mainnet.id]: http(), // [!code focus]
  }, // [!code focus]
}) // [!code focus]

export const configB = createConfig({ // [!code focus]
  chains: [optimism], // [!code focus]
  transports: { // [!code focus]
    [optimism.id]: http(), // [!code focus]
  }, // [!code focus]
}) // [!code focus]
```

As you expect, `chainId` is inferred correctly for each `config`.

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/typescript.md","from":6000,"to":11819}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"11543ad9699c8fdbef7c0ce7ac938f71b77d113989b5f3a8de83d428479463c3","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAhVhBEBrAHKCAtgCMyAHhGT+7AOa86NMFDi8AwoZO8AvLfvGKvEfmbswASShm9DCW1gZgRsbIADognt5gcDEAushgmjqkKTHsUMlOHq7RsV4+iSApadpkWSA5ye6yrDBiACLMaMz5WiY+aAB8jFjMpMwaMDSkcAD8iLwAqrIKSmrpZAAKw6PjZHD6ru5xPv4NME2t7cx93LML8ooq6lWkAErjgqRgACrYMLqNzWg2h0+lEwOwNFgIKQ0NJFvcVk9KCAoEoEIgCGg0Fg4IgAPS4gDuzGMGnYADo4PhcaQYMwxLjmFh2LjCBBlHBcTI7stHhkkXAOtCkABOKhNMDGND4JAARgALFRBcZxnguUsHqtyGKfLhEAAGKhxEZiMgigC+FHQPzwhBIWuo5iYbE4PFh3I1T10dnCJl0NOYKLArAwvFQoN4Ed4WnhAFFaFhFDTJrNgOHI+n/YHg7xYPxmIJWGgU2n06XeJnJNmwFtZjEY1KdiJmGAYgBuEtlyMVoMh96sWsYrE4/HjfCN5tkiRtjud8u0rMhxnsOakfu8GL4THYvEMplk0fjsCTiC79jTqSds3ti8Rq8d6PLT7gmCzGUAJj1n+v6bCaGNaBxXhUxvUtu2zYI4DmME7TgNhXjgCBWDtYsQNnMDFygKAaTgQCYj1WgYEIojCPlKAAHYZQADhEN8tDlMioGFYU3wAZlgZgtBlFiWIAVhgeU5WI89ZwzedKxDB8VBsf0aCgWZWL1SieOUyjv0vNSy3Q3gNALcQm1YVgWJQkSuzEnteADLD4FwkB8KbGUZS0WA9R44UyLIrQWIANhYhyvLIvU30oyivNomA32YGUyJYtyvPsmVhJMucA3EqN4Wk2lZNfOVeO8vUZQ00s7xA4r0zJcreHlbSoRgXhyrJQq7XYfgMAACS4fAZl4RhGBEDhgiLWx+rANBdHqvp3CGEYxgmQCADUyGatqOo2abtkmPhHD6Xg1lICBSVkXQtAgRDaTAK5eAAH2kSwYCMMAYCga8zSSCbKvcbpjF6AYpq2WauuAsryue655jhHlNVeNB3i+H4xvKkEwQhKEYTVeFeVNKgURENFB23fEiRJclKWpWl6SXFkTvZTlwY9PkqAFYYGEQOUDRAcVJWlRB5UVYZlWZkA0YhxFtQepA30NLx/1NfULStHA8DIPb7UZoVEB4sixWCTmkE12JoF1Vi3wlkAjHFLY8B8WBaDJACkRyRXSFIABaI231d4LnbIpEaHoPBvhwXgAHJ3xYoPeHYaxIBhLg4BMato1qtAIF4TBA5DoOySRJoSFYR3leznVxclzYTXIbmyLl6hrXRW1MYdP30UGPacGhDA+EOPw5Mq1j+UFZmNa1iUpV13nSH5vBO/8QuxcQE2jTpCZZUry1q4V2viHr32BebiBW8wDvXFmb0Ij9MzszDEDJOUOMExq5MgJnUyUvM3N80LYykq06sxgHesx0mE2FsIBCpoXPr2VcA5NxDh3AeQBE4pwgKfppcBFkmQrjXBuLcw5Tz7gbPAo8EhTyJTLKVSMZCIzXyfL/Hun49SFV/P+QCgNOxaQglBdgME4LwEQshR+qFWGoMsthGy+FiLEVIhRaitF6KMWYmxWknFuJ8QEkJJBAiUEv2zNfDK7RHryRYopZSPFVLIN4BQ0CqCdKFnYPpQyn8TJaWEdZAcdlIqOWcq5dynkfJ+QCkFEKYUIpRRimROK7iSEiS0jomS+jKo5R4nlAqZiLEWPqvE6qNI6rAw7E1Fq7VKRdR6n1dgA1j7DVGuNSamwZo7FmAtUgS0Cn4FWn9HYm1tq7X2pHX4x1TrNgutdYQuYdRPVBC9Pofcma6xlEPHWiAvJjwnuiMIEQZ6GxLtLcuvkq5p11AQTe9pt6T0kAKAoPpjAAEFj6uDPlokMl90zX1vomOp/CwH3JzHdd+g0WGONQT/F864QD/0PJEj5C5pCQOBdA/GuI4FwCAcecFgjPlLgwVA7BO4lx4IAYihBJ4lwotvIVCxVDnyvg/F+DsjDF7MLMWwhIHCuGsHgrwsgDiolCMwiI1xBFxEkTlORKiNE6IMSYqxdiSjeL8TlIJIixLLGfJiZlOJCklIqVAeQrVEYtLWL0mwex7yv7cqsjhPl8UnIwBcm5Dy3lfIyn8oFYKoUdDBOirFeKirRLKvSrE7u8pcpeXyjq8xpLCrpKqhoGq2SGq5MWvkjqRTeoVPKaUka8MyRvV+rUh+DSmkrRqetV0W0dp7QOr0k6TQBl8CGbde6j1nqvSmWrMiop2baxHogPWSoVQrNcJc9ZxdiilyXogGKuya4HLtD7R0TdnRcD4ELOmegT6+i0o8yMzz4yvIfn8pVkK366U5RC1KgKBwAHksDiAOhoXgLz77eufpCvsmKYH4j3jeyOelcWHmReopKyVIXouhVg99p5nafvBN+2xv6CHHmIQB9SHYyXwmoUCql9CaWSD/HSk9z7UpQEjlgQQNAADiWwABii8oQYHw5oyFMp6NcrRTylxwKxGuS8jxS5WguNvhgC0EQZF6JkRsEpD8b4cqXOFMpKKNgWhvh4m+fgMmn0kpSaGrSrA3wXtIyRtAF7jRNGYz6xjpnUXAbY+ajjtAoD8BgG5EKlFWJsRlMwZgxsYCURlDxTzXkvLChc/wN8Ih+BRS8kpTzZF1Nhs0wyqxulbGGqMsa/5rGzWiNoJazxtqfEOqdQE114VIoerCV6pD6XIUqr0d3OUQVQo+VDRYszqVITQjYBZ3VqCmNpcA0B1KzibN4VoFoGMfHKMiA1sKByPE9QUTCXKYT9WWKXLlOFgTLRYByhlOFvUXkYy5EqyJFr2qEufNYDKAAyh0SwwwoByEaVAZUXWBvmV6/uwDTjrNZaYjYYU/ARByi8vwZiMZKKRREHqWANhHJRVkflPUwo9QsXB5ROUY2ErHdnKdjTGi3vZmMFwXatiYBGbpCZvrp7zJDay/VuhDPGdM+ZyzhnlHFW44JyGS76plCve+5lvl9PWci9F4z3zHOtOoJ09JCAOEWj7XiAAWWstrDlVPLODZ+0LzDYu9es5i9js7+PtNvhjKQYTb4ZSPZyC9jXDGteC9s8L/Xrvxdykl+dyFOmbvNigPdm3z2gWfc1zT7Xzvddu7dzKPUnuTfS7fJ8CAAAZGUKucLEhgBsHC6uQ8O7D07kbLuo/R68nH9MaSKpRpjfVRqCblqFNmMU1NQ102VIRtUtas16n1+aa03NJbOnlp6UdKtZ1Bk3RGQ9MZYAJnuBjx9HoI0fpFv+py2v4zQa3F5xjF4bwPgB1+ONUE4J2uo1pgiemyJUQ2ixQTYkpIKRUn9OTJklM2QcmXZf+uqtmbI7mV2jzNQHzH2oLBfrvkOuOpsovDLHqJOuvCAErFCC2szDHnrBzF2nrAYLAOLCxMbFQGbMEBbOiFbHQLbAgFQA7OiErK7Hge7NxJRF7LOo3CAIfsHKHOHJHLwNHBZDhPHBxE0KnCnHsuwXqJnNnDALnPnMgaLLqCxNAWXMvPAfsnXEcnOiALvPvO3B4CUF3JSixCgbKPNgAVzD2iAQLFPFAJAfISOlskoavHsjaIcswTvFgC3GQAfOchEDchcncpCpupQrGDuvfPSvHp8keh/PbgemejWMClel+nAHeg+kmLFlpK+jCnfriFBgdD+gikiogqGq1jTugqBnjDgkuJBtetBgKLBnkQSohs1uGveGhhSrwJhgwjhkwsxlpERnAAZjABRmMNRmILRvzj1q9kUdmLTnyjAFxjxnxsKKFIJstu5OJspoFNJrJjxPJopspqpsKLFpzpzqbnpliKRuTn1MHmYpMSGB9tcaHlMeHiNvZo5mRM5q5lAO5p5gJj5n5m+AFkFipqFuFmElFm+IboUcbjjlLp8vqslgZKlnntEQXryrZjltal4nar4o6v4i6kEqVqEuEg5KkagjVllLwPVoEk1vFmEZCmfp1lETcZVBMQRiiexiNmNhNlNm2rNvNhFktiJqxGthtoJttrtjHgdkdpCXjtCV7qlJdr7ndqQA9k9nbkiUyXcfjtTo8YXrZLQH9gDkDiDmDhDjKFDjDnDiJgxIjsjqjsFBjjGFjtKXFvjscagkTnACTiIGTsZlcVqayTqaiUXpHiXvruzkbjKQ8dztbvCGMRlkGXqcXqGXrhLhGS6dqdzm+LLvLorj4OnrIBKLnvcd1vGeyYmSGcmaLhCTSRmbwDpubpbtbqqX6V9qagmfhEmZWSLvKOXlGXWW+Iqf7sqYHmqcWVzhZE8eWV2frjHr2fntmDpknqnvmZntnrIKQHGVZrqR2RWdOUzo6nOemZGJGnKJkrVBviBHkg3p1E3imm3mmgNJmtmqvm8vmompSP3sWh0mWt0odH0tWudLWpPndKMk2pMgzP3LKFbiYUgIssAePKAasiYNYQoWOjsg4VOqoS4ScgkDCEhcYHID4afBuvutunfEmKEbWREb8mOd/LETEPEdUUkcESkWmUyekWBnCtkTBiIHBvioQhACSWiiUZgmUdikyJUQkbkfgvxQhkSmmakoVOSjQu0dhiNF0VET0cRqRgMVRjRqQHRoyQGbcSySWVue2QRHMbxvxssVaWJhJhsatlsTsUpipmpmxVCchrSfKbpvpucb6ZualJqf1sZROduXZg5k5pFh8V8V5r8f5oFsFsCRFmCdWf6ZGaQjCZCnCXYoibRW2WWW4g5Fajat4van4s6oEm6gSZ6hEh5WZalGSXEpSY1ixI0XKeZPSWuOqaFcFSFeOdMbZpyTxJNtNryQtl5AKStsKe+KKTADtntpKYce1d5eZAqbdkOSqbbi2Sap8n1SFQLhZQaYDsDqDmbqaeaTALDpxFaVADaSjmjg6U6WOUcVlalB6V6T6RTjtVVo7hZZ2XuczuGStbWTzrGUZQ1WycNlOYDd2TxIeUyTLntDmRoMrqroWRuRDQNZOTubDVWQjaFfWRbmRFbiOT9SxuZYVbQADXjZ+D2QpW9WtQORtQHs2YFVDXTrubTbOQzR1QuYninmntZKubHEWeldjeFTTdzWXrzSVBGlXqedGlkheemFec0smiUmUq3o+VUrwDmsWj3o0u+S0i+RtE4EPr+ZWv0oBVdMBQ2jPhMoYdzG+O2hgaYUsoha4HIChbYTAdssKC9IaAbJbMjNCEBG6DvpqOYgIOWsHITKSEHKCKCF/rvowMADofEP4PoQcEfF4SYJcuYtwMneAZqGnRnUcAGqxDnRcrMPhXIIXUiDNMwEgKAOYBBBIGAHgHbGaGaEAA="}
// @errors: 2322
import { type Config } from 'wagmi'
import { mainnet, optimism } from 'wagmi/chains'

declare const configA: Config<readonly [typeof mainnet]>
declare const configB: Config<readonly [typeof optimism]>
// ---cut---
import { useBlockNumber } from 'wagmi'

useBlockNumber({ chainId: 123, config: configA })
useBlockNumber({ chainId: 123, config: configB })
```

This approach is more explicit, but works well for advanced use-cases, if you don't want to use React Context or declaration merging, etc.

## Const-Assert ABIs & Typed Data

Wagmi can infer types based on [ABIs](https://docs.soliditylang.org/en/latest/abi-spec.html#json) and [EIP-712](https://eips.ethereum.org/EIPS/eip-712) Typed Data definitions, powered by [Viem](https://viem.sh) and [ABIType](https://github.com/wevm/abitype). This achieves full end-to-end type-safety from your contracts to your frontend and enlightened developer experience by autocompleting ABI item names, catching misspellings, inferring argument and return types (including overloads), and more.

For this to work, you must either [const-assert](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#const-assertions) ABIs and Typed Data (more info below) or define them inline. For example, `useReadContract`'s `abi` configuration parameter:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/typescript.md","from":12779,"to":12869}<fsm-vh3gqscxm4e>
const { data } = useReadContract({
  abi: […], // <--- defined inline // [!code focus]
})
```

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/typescript.md","from":12880,"to":12988}<fsm-vh3gqscxm4e>
const abi = […] as const // <--- const assertion // [!code focus]
const { data } = useReadContract({ abi })
```

If type inference isn't working, it's likely you forgot to add a `const` assertion or define the configuration parameter inline. Also, make sure your ABIs, Typed Data definitions, and [TypeScript configuration](#requirements) are valid and set up correctly.

::: tip
Unfortunately [TypeScript doesn't support importing JSON `as const` yet](https://github.com/microsoft/TypeScript/issues/32063). Check out the [Wagmi CLI](/cli/getting-started) to help with this! It can automatically fetch ABIs from Etherscan and other block explorers, resolve ABIs from your Foundry/Hardhat projects, generate React Hooks, and more.
:::

Anywhere you see the `abi` or `types` configuration property, you can likely use const-asserted or inline ABIs and Typed Data to get type-safety and inference. These properties are also called out in the docs.

Here's what [`useReadContract`](/react/api/hooks/useReadContract) looks like with and without a const-asserted `abi` property.

::: code-group

```ts twoslash [Const-Asserted]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/typescript.md","from":14001,"to":18502}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"d7475b91e63cc31608c546a0ebb47f73a765bd7e10587f2f8d3a8df8fdf837c6","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAlGMygBhSWlLMxAHhGS4aXswBG7XnRpgocXgEETvAD69SiqJNYZpYANaQA7mDIALoUAsJiEmAAcswAtjBm9DCW1qpg6ppoAGLh4pIx8VrG7KEAOiBYgi7ljrzlROwwfuUAfKG6YPqGpADm1ubJVrxpGWI5onlgNr1wRSZlFVUwNU71jc2UYRORBTBtvB387D2JFkNpRycAvMOSl6GyrDBiACLMaMy8NwpKIxqv72YcxKWwi+TiMFCzBmLRajCw0IhNFIcAA/IheABVWQ/FRqf5oAAKiPiyNmxVCQm24PiUJm7TuxweMCeAI+LW4GOx8lcf0yCjQVTAABVsDBgZTcjsIXS+szWWg3uzSmB2LEsBBSAYZDzfvjMpQQG4RAhEAQ0GgsHBEAB6G1+Zg9WLsAB0cHwNpcmRtzCw7BthAg3jgNp1uL5YkN+mhDEQAE4qE8wD00PgkABGACsVA+vRgsZAYd5+sjifYYFwiAADFQRPhEWIyEg4wBfCjoMV4Qgkcg58x4DpdKCAjEmHrlgxOYSwI4VqCG42mkDC/AJVhcAxwQQiETwOBCVgeZzwCCsEhQXjDj4CTW8VMJACOgjIGBdUdzsYALAmQEmU2nEE/HNoR6fM8CvZhDQ4CskAAJlresCSbRAAA42w7HAu2IJs+3oJg2E4HhpBxYt0gJLQvTcMAj1QFVeHo48lHcTwwAhDFyiMNhmFEGAAHl+HKABuOiGMo5i7zFdiQCpMEwCEkT6LE6jPGjGgAFlBA+EwOEwKSGiaeSpFE1xxPLSo0GtRiqJo4AFIYxSTOUiScCkpQoBcOA4EM+z7KUo9WPiKSIACMhvIYlsgmEoyHKYpyIE08zLL8zxaOinzkucmApMECdYMzAA2ML6IiqK214Wy0oygKsrqEB2DgGwsCwUhsKgLJNRsQ8iqs8TMBc2qZMmbqMtUmANK09gdIwPT1mGxyjzMzSkvmlKKp84zYqPPqavKNyPK8kAovWmLrJYtjauCitSG6sq1uOjLttcqB3L3brfJW3hqqCnANDQTUbsiuyMviy0loxDLUuOnqnMe2qjAgU8AdK0I7pO8Svtq0C0Ea5rWrmzbPFh8pBsifHTt4UbxuKKaZoMw6gY+xaLPBj7kBddnAcqj6QcSlmCd4NmOeR8q7PZl1hdR3gxdKkI4a4nj+PKUIIbF2WLiZXgxwnOEEQ0UkyDRLkSL1MjMmJPX8wNrQxY5I3dTxU2xAFIVRRwa32ZaFU1Q1LViPtiMGCoRcuwtK1bXtR1nTdD0vTEH0/QDBHg1DY2HdGQOQGjLUkEzFDE2Sf8M2zagQLAs0ixN9OoPLSt4JAOsG2RDMAHZ0OoTszW7HDqH7M14Ran7MD4Pa93RXgAAMq1oAASYB9FIcsehbcfamnGBZxgecqCz2Nm7z38C9TJBm+AvMCxHzzq5gxAAGYEMb5DYLb7asJ7Q0aDwvvccHjBh5MMeIaSyqudDi8tdyK3plzfmRNpJSkkGTcSlNNLU3YLpWq+kNhHQ2uTJmy1+aQ3uh9GBF8DpYPWsAwKF0QrXUgfZEqDN+Y8zBtDGydl3rQMkrVHK6Q8qFVoeFTmt0GHkwxuUeqOMWrnnaqQTqrAEEw04cTOBcl+FoyckgiaNN0GzVUSwzwuC+bkwIeQohiiQAkLetg9GICQCXVCrooRaV2Hk2Ic9fali1H+RsRAH67x/oOM5s48STDmZ6IFpLIJCj+ocQRnIgJEthHWMoeULGEi8a6IemYkm8CMkfQ0SgtBaw6ZkLCQYsJgsXSBKsXFBKzCVZCxVI4+y0tGko1FuzGWq9LDrxrlvTOH4Mw32Ln+I+t9T5YzwMUK+lYgL10QpkR+z8O4EGwr2Hun9656AMGQEQzdYLpjsOwQx4ljFhNESATi64FYCVyRw6JsDqQqJKSND46lkHaVQdNbRxTElOTKYAth1StpmIsboyJXjkm2OoUjX5R4Ql4KMREoFhMzHcLQLwmFYAmnIs+jY8RTVJGb2kbI+RwL7nZKebClSryxrvMmp82mmCqW8H+azJFniUX3NBSU8FZ1IV2JoSU7FJi7k7XMW416YKcXnJ8WQPxgq7L0KgeTeFxynKnN5ZlKS8NEbxNaSLZVSSxWpIJek55pjyXKNJdS94tLNEMu+Uyw1fywC83Karc1jDamhPqZUhJaUWlYraQGjpjSgjvhjBmT8NYD7JlGT+XMEyzQ7L2Qckw0ykCzIbkhcgiBW7tnbphTuqz369xAP3WVWpf6gkmLsMeoCrngJubUMRDVTVSI6l1EALaQAmtxueFYVCroQJ7X9bwyRMRyAAJKDrXhvPpO8i531jYXRA6Y66JrLg82SuwM2IGLtmhZuan4FpfmaJ8L5S0bIrT/PgFK63arAXxZtqw6ptv7USztcSe19sJVAQd5QBUjtfWOid07Z3dPnRG7Oa7MzLpGQBdd4yt33ohHug98zGzHqWUWlZb9cIFhvWQIe3Q+gANZgKjEk8Z5z3UIvZeQQukzl6dB2M6YULDMPgBWZm7z4zD3T+Q9WG4I4crCAC9pAMBXsI9/Yj1aQKG3KZRieU9Z7z3o+PRjU5IMse3gMtdHH85xu48hvjfQBP3xzSJ09yyu5rI/gWQcBgIKjmOBOJjPS5wLggCaPAK41wbgptuXcnkDxHg8qec8l5AQ3lIHeVcvAJOvlY3BT88GuOZtM+BQEe6kNzIfrmqsom8BJekwOLZ0WPiufHOkDzUGg4+aXP53g64uhbh3HuMLngItnk3pVz4/Bbz3kS8+STb49ORsQLBNLRnV08dLgWCCuW65CabtWCKtZoBie9pqAwwA/bhhLAYFsAgWqxF4AAcgdE6dgF2VQqic+VfrvATs3ArmnAkjA7okIxBdqeWQABCNgb5xnXcoZgVZPzPU/LnEQKE0swFggAUSR1WFCcZ8rN34MoSH/AhnNzjCIWCF2KAiWKBiFN+zDmk6MqhyhF3LncSbST+7ck2f0QUxiZAf3aA2CrMofgBOUIoXTPlF4n4jBxklyhfK+UjBwZvlWFHzBPz5WYOxm+KFYL8DyumGAF2QiNO4KziCKpDSkkgogUAAxOiRDwBZEALYWxAA="}
const erc721Abi = [
  {
    name: 'balanceOf',
    type: 'function',
    stateMutability: 'view',
    inputs: [{ type: 'address', name: 'owner' }],
    outputs: [{ type: 'uint256' }],
  },
  {
    name: 'isApprovedForAll',
    type: 'function',
    stateMutability: 'view',
    inputs: [
      { type: 'address', name: 'owner' },
      { type: 'address', name: 'operator' },
    ],
    outputs: [{ type: 'bool' }],
  },
  {
    name: 'getApproved',
    type: 'function',
    stateMutability: 'view',
    inputs: [{ type: 'uint256', name: 'tokenId' }],
    outputs: [{ type: 'address' }],
  },
  {
    name: 'ownerOf',
    type: 'function',
    stateMutability: 'view',
    inputs: [{ type: 'uint256', name: 'tokenId' }],
    outputs: [{ type: 'address' }],
  },
  {
    name: 'tokenURI',
    type: 'function',
    stateMutability: 'pure',
    inputs: [{ type: 'uint256', name: 'tokenId' }],
    outputs: [{ type: 'string' }],
  },
] as const
// ---cut---
import { useReadContract } from 'wagmi'

const { data } = useReadContract({
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  abi: erc721Abi,
  functionName: 'balanceOf',
  // ^?



  args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'],
  // ^?
})

data
// ^?
```

```ts twoslash [Not Const-Asserted]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/typescript.md","from":18542,"to":21616}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"8afd1fa05b7ad31ca46677e8331b056e5b32b376177ca9b18ff226265a7cdaaa","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAlGMygBhSWlLMxAHhGS4aXswBG7XnRpgocXgEETvAD69SiqJNYZpYANaQA7mDIALoUAsJiEmAAcswAtjBm9DCW1qpg6ppoAGLh4pIx8VrG7KEAOiBYgi7ljrzlROwwfuUAfKG6YPqGpADm1ubJVrxpGWI5onlgNr1wRSZlFVUwNU71jc2UYRORBTBtvB387D2JFkNpRycAvMOSl6GyrDBiACLMaMy8NwpKIxqv72YcxKWwi+TiMFCzBmLRajCw0IhNFIcAA/IheABVWQ/FRqf5oAAKiPiyNmxVCQm24PiUJm7TuxweMCeAI+LW4GOx8lcf0yCjQVTAABVsDBgZTcjsIXS+szWWg3uzSmB2LEsBBSAYZDzfvjMpQQG4RAhEAQ0GgsHBEAB6G1+Zg9WLsAB0cHwNpcmRtzCw7BthAg3jgNp1uL5YkN+mhDEQAE4qE8wD00PgkABGACsVA+vRgsZAYd5+sjifYYFwiAADFQRPhEWIyEg4wBfCjoMV4Qgkcg58x4DpdKCAjHCXwQAKG42mkDC/AJVhcAxwQQiETwOBCVgeZzwCCsEhQXjDj4CTW8VMJACOgjIGBdUdzsYALAmQEmU2nEM+c9Cevm8BPZhDQ4CskAAJlresCSbRAAA42w7HAu2IJs+3oJg2E4HhpBxYt0gJLRgBVXhSN4MAIQxfRSHLHoAG4SLIzAcCo9RaIYqQyOjGgAFlBA+EwOEwViaOTDiyN4ctKjQa1eGIziJNI5iYBE9jGMU8jKN4ai1IU3gW2CcSyIgfjpNk+SNKUsVVLE9T9MMlUDJCOoQCMNhmFEGAAHl+HKUIvTcMAd2Qcoq1oGwq2UfgAHY4zguD0wANheZ8jDjNK4MSxKjEzABmXKqwAUUK5hn0S5h0zg3K4PA/hwMzdNlhAZyLiZLxxwCOEEQ0UkyDRLk8L1AjMmJHr8z6oi7Io+IbPouzlNmozSO4mA+IE9ghIwRa7Kk/jzLsiSFu0tjbL0iTppU47RLmvSnKW3gTMtPaMQsyyjp006JLuxzggWNzF08ny/N3JR3E8EKQDCiKoti+KkpStKMqynL8qKkqyoqqqarqhqmpaxkelCMd/DADkBt1PFhrEAUhVFHBJr0i7tr096TpuiSVrW4pNuZiTdpkl6DqY6yrt0yzNJm0XPrI769MeszBbO4WWKl9mZYcsAnL+9zAd8zYArB3hkBdE3nOJidSZVNUNS1XCKYjBgqGnLsLStW17UdZ03Q9L0xB9P0AwgIMQyLIbRkdkBoy1JBMzgxNkk/DNs2oP8ALNUPKfDkDy0rSCQDrBtkQzaLEOoTszW7NDqH7M14VICAcC1DA+CUKAXDgfreAAAzCgASYAPp6Fsu9qYRYCOCsoEfGMkGiuP3wT1NZ9/PMC1b9uEDLMDEFyqDC9g8DS+UlCe0NGgMNrrB68bzAW5MdE5KmrTB/u1nrvuzn+O59hhNV+7+f2krKyKsX5C1IkzP+dlZYSXls9R+QCLwi1AbdDWTlR6WBgBPGAU8qBR1jOmXKycPxLx3ivf8a8TDZ23j+fO0FMgHyPuXAgqFezVwvvnPQBgyAiGiuBdMdh2CK3Os/Nmr8kGiLsp/daPNIF6QAUIt64j35gIlpdZBX0NYwNMnA16Gk35i3VkEDiTlp7R0QOmZ8NYF7JhIW+XM5C8DcN4fwyhW9Kw0ILjBcgiAS7tjLshCuLCz41xAHXBuZBb6gkmLsB+g90HjxzjgyOT4k672sYncxed7FpxAFSME0QIRUMrMnTx9DvGHz8cfM0N47zBPYWEm+zconSniLEtm8TMGJNMfgvK8cbFfnTFk1OBY8nRMKW4mOe8vEQUYQE5hp90IFgaREppf5O4GyCp4c2ARggdKwUkvBGY4JEMXl+Gh2S14zCKc2KZZSZmVKYTU0gGA6lLKvuEpuLcZgPw2TubZgQgh7K6bglJ5jjl9Iyec4ZeA1nXPjLcxs5TZmVnmVXc+BZBwGCAqOHwJMpwQBNHgOcC4lzaVXOuDuW4dzt33IeY8gIzykAvPOXgTz7zdIgs+NJxCzlkJyUBOFgyEVF2rMivAbLXkDk4fSj4OKOpgHxYSs0xLeCLi6CuNcG4qWeBpQebBMrPj8HPJeVlt5nkPhBTPRA4EuUQpIVC1egFASCrzqUxFSAqwthCBw2AeBraagMMAO24YSwGBbAIeusReAAHIHROnYNGlUKpMVyQNfpL4wb8Lh0YK9deG4MTRrClkAAQjYXKcZBnKGYFWZ8UAoDPljiIOCXKYDgWKlWOCcZErRX4MoGt/BCGxREOBaNFBGLFAxE4vhAix2cVGS0y60b/oeXXD5UdSawAbtImsjEyBC3hUijFOKCVkqpXSnFZGeUCrFVKuVSq1Var1UatGkIjluAbqAiqQ0pJgKIFAAMTokQ8AyRAC2FsQA"}
declare const erc721Abi: {
  name: string;
  type: string;
  stateMutability: string;
  inputs: {
    type: string;
    name: string;
  }[];
  outputs: {
    type: string;
  }[];
}[]
// ---cut---
import { useReadContract } from 'wagmi'

const { data } = useReadContract({
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  abi: erc721Abi,
  functionName: 'balanceOf',
  // ^?



  args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'],
  // ^?
})

data
// ^?
```

:::

You can prevent runtime errors and be more productive by making sure your ABIs and Typed Data definitions are set up appropriately. 🎉

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/typescript.md","from":21789,"to":25510}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"0a7ec06948f56913d5c1a0817fa61f890c5a7843c9839243ebabed5019be8a0e","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAlGMygBhSWlLMxAHhGS4aXswBG7XnRpgocXgEETvAD69SiqJNYZpYANaQA7mDIALoUAsJiEmAAcswAtjBm9DCW1qpg6ppoAGLh4pIx8VrG7KEAOiBYgi7ljrzlROwwfuUAfKG6YPqGpADm1ubJVrxpGWI5onlgNr1wRSZlFVUwNU71jc2UYRORBTBtvB387D2JFkNpRycAvMOSl6GyrDBiACLMaMy8NwpKIxqv72YcxKWwi+TiMFCzBmLRajCw0IhNFIcAA/IheABVWQ/FRqf5oAAKiPiyNmxVCQm24PiUJm7TuxweMCeAI+LW4GOx8lcf0yCjQVTAABVsDBgZTcjsIXS+szWWg3uzSmB2LEsBBSAYZDzfvjMpQQG4RAhEAQ0GgsHBEAB6G1+Zg9WLsAB0cHwNpcmRtzCw7BthAg3jgNp1uL5YkN+mhDEQAE4qE8wD00PgkABGACsVA+vRgsZAYd5+sjifYYFwiAADFQRPhEWIyEg4wBfCjoMV4Qgkcg58xMNicHjSHHF9IErRetxgDy8VAq3iL5yudyeMAQjHlIxsZiiGAAeX45QA3Aul1PV7xMDhNyAqWCwCez4uLzPPNGaABZQQfEwcTC3g0TRPlI54rm+vDlpUaDWsuSiXvOoFLmB8EQdeMC3koUAuHAcAgchyGvrO67xLeEABGQ+FLi2QSnkhcHTrOEA/tBsFEZ4iEEShjGeOht6COWaAAEyZgAbFRi40XRba8MAz4MZeJEYXUIDsHANhYFgpDEDAUBZJqNisKwEkKWhYq3vekwmexvAfjA36/uw/4YIB6zWeBs5QT+bEeRxcn0YRvlXuZKlYTheEgHRXEvkFSlkRRpAmTJ/nRaZs58aFUDYfAEVRdFNlxSpEA4BoaCakltHyTZzGWt5GI2Zx+VBRlW4QBAxmRfJUkqslVWxRuKk9PmGlaTpUDuah6UheUlmRBNPG2R8X4/sUzmucBnX0TZXkwfVQXIC6h2VVtQU1axe2TRxh0usdvX0dd0mhClS4PT1IQqdurC7iIB5HiAtTXbwADMvCxJqCSA6s1BBskmJyAAkuUoQNeRFakBi11BADh28OmoPg7wkNpRxZXeMk8NQBjR2hBcTK8BWPZwgiGikmQaJcqOerjpkxIs/mbNaNdHIc7qeLc2IApCqKOCC4dLQqmqGpaiOosRgwVDGqa5qWtadoOk6rrup6ihiD6foBm1wahpzYujOrIDRlqSAACzpomyQpmmiBZjm0JDQWRZc3bhocBWSBCbW9YEk21Zth2OBdjpvbUP2ZrwtpJWYHwxQXQtjUxZd9MDVuO57oe82Xi1d5SpIFcQXZDmrewAEqUBGx5QXC07T5hf5wRNlV2FOUmYFheFeUqOUZtyHdSdhdnXVxNzs9XED9NhaCSJ4nT9Rt1PX1Y/F6p6madpJB6QZRl11NN4qbNtc753l4Nytf7Ny5rduY/S/d7nCEr/3Zq68h64RHtxRSR9J6JW/ndVKa9b7lBAbleSo8FrjxAMVMg7xyowOOqgy8C9dpLz7vgsyCCQBGDah1DuvBZ6wPARBdB/sRpn10tfXi6976Pm/jZF+jk1qfw2jQ7aYBzrEMxsI06LFF4NQkT1fe91DqPVkvJV6YAaJRlzLGUSbsQBJk9kgIGvs8wFmKCHcslYjEgDrA2ZE4c47UE7GabsTY+z0DwB0LoZARAAHYhLpjsOwP+EE+4FSPp9b6v12HBXIVw6JfCm4tzWEIg+XdREyP2gA0hN9lKIKyuFMBT9GGQIShVSR89pFEIalkhhOT+KbzEmU+RKi55oKPmpFhY19KkEMtQ1JldOE124eUhaCS35JJAG3aJv9iE1KKXUzK2VQHf2yWuEpaMkoKLgUA8hSDClL3QZg0qOCaGz1WbwQhPc85zKXlXSh7UmnqK2bUtZpFBrDVPmNaJVc4k8KCmMpy791rt36RBGZsijojIIZUq5CE5FPJachNR9DFzIqCJomMSBRKiXdsmVMzZjH+zwN4vxASTDmLDogKxNjo7kEQD4hx6FiWkG0snR2sYfEJj0R7fF3sI7WOgJWISAAOISNY7xOWSBCPA5ZYC0BdDBQ07AoDMtIAAWhFWKtV6YqyZnTNqoShoaDuLNNLBIAByEuX0KwiHLiAc1kFrCQAMFwOAxx1xGCeFeCAMSLVWsiXa2o5QOmfPPt03pKx3loE6efSNE8EqBqhqTWGCNI3CFgEcCsUBzUul4C8ZVvAMDMVBooKQlqKGlx+na81qIQ4wBIKwVVmoKWVmdpHWxMchKMqcQQJORrU4gHTkcrOoJJi7FvBEm1dqMVO3pVy/RvL0z8tzESs0XDdgtpdu22l9iQgCtgDK9UmoDDABVuGEsBgWwCG0rEXg5r9bOktY+MAgdbYEkYM9HOZhSC+P8YEigZ510DXNZO54h5zUAfUdwQ0pJmBIFAAMTokQ8CKpbC2IAA="}
// @errors: 2820
const erc721Abi = [
  {
    name: 'balanceOf',
    type: 'function',
    stateMutability: 'view',
    inputs: [{ type: 'address', name: 'owner' }],
    outputs: [{ type: 'uint256' }],
  },
  {
    name: 'isApprovedForAll',
    type: 'function',
    stateMutability: 'view',
    inputs: [
      { type: 'address', name: 'owner' },
      { type: 'address', name: 'operator' },
    ],
    outputs: [{ type: 'bool' }],
  },
  {
    name: 'getApproved',
    type: 'function',
    stateMutability: 'view',
    inputs: [{ type: 'uint256', name: 'tokenId' }],
    outputs: [{ type: 'address' }],
  },
  {
    name: 'ownerOf',
    type: 'function',
    stateMutability: 'view',
    inputs: [{ type: 'uint256', name: 'tokenId' }],
    outputs: [{ type: 'address' }],
  },
  {
    name: 'tokenURI',
    type: 'function',
    stateMutability: 'pure',
    inputs: [{ type: 'uint256', name: 'tokenId' }],
    outputs: [{ type: 'string' }],
  },
] as const
// ---cut---
import { useReadContract } from 'wagmi'

useReadContract({
  abi: erc721Abi,
  functionName: 'balanecOf',
})
```

## Configure Internal Types

For advanced use-cases, you may want to configure Wagmi's internal types. Most of Wagmi's types relating to ABIs and EIP-712 Typed Data are powered by [ABIType](https://github.com/wevm/abitype). See the [ABIType docs](https://abitype.dev) for more info on how to configure types.

---

---
url: /solid/typescript.md
---
# TypeScript

## Requirements

`@wagmi/solid` is designed to be as type-safe as possible! Things to keep in mind:

* Types currently require using TypeScript {{typescriptVersion}}.
* [TypeScript doesn't follow semver](https://www.learningtypescript.com/articles/why-typescript-doesnt-follow-strict-semantic-versioning) and often introduces breaking changes in minor releases.
* Changes to types in this repository are considered non-breaking and are usually released as patch changes (otherwise every type enhancement would be a major version!).
* It is highly recommended that you lock your `@wagmi/solid` and `typescript` versions to specific patch releases and upgrade with the expectation that types may be fixed or upgraded between any release.
* The non-type-related public API of Wagmi still follows semver very strictly.

To ensure everything works correctly, make sure your `tsconfig.json` has [`strict`](https://www.typescriptlang.org/tsconfig#strict) mode set to `true`.

::: code-group

```json [tsconfig.json]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/typescript.md","from":1175,"to":1225}<fsm-vh3gqscxm4e>
{
  "compilerOptions": {
    "strict": true
  }
}
```

:::

## Config Types

By default Solid Context does not work well with type inference. To support strong type-safety across the Solid Context boundary, there are two options available:

* Declaration merging to "register" your `config` globally with TypeScript.
* `config` property to pass your `config` directly to primitives.

### Declaration Merging

[Declaration merging](https://www.typescriptlang.org/docs/handbook/declaration-merging.html) allows you to "register" your `config` globally with TypeScript. The `Register` type enables Wagmi to infer types in places that wouldn't normally have access to type info via Solid Context alone.

To set this up, add the following declaration to your project. Below, we co-locate the declaration merging and the `config` set up.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/typescript.md","from":2013,"to":2435}<fsm-vh3gqscxm4e>
import { http, createConfig } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

declare module '@wagmi/solid' { // [!code focus]
  interface Register { // [!code focus]
    config: typeof config // [!code focus]
  } // [!code focus]
} // [!code focus]

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

Since the `Register` type is global, you only need to add it once in your project. Once set up, you will get strong type-safety across your entire project. For example, query primitives will type `chainId` based on your `config`'s `chains`.

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/typescript.md","from":2697,"to":5821}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"27f72e6eb6261410d5ea826717da884abdb710c1600590e05d55d49a8093f14a","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAhVhBEBrAHKCAtgCMyAHhGT+7AOa86NMFDi8AwoZO8AvLfvHdpGMyiTWGXqgAdKV4QrUUVAFFaLEUPUjhEXmAgkNTUjy8fP1h+ZkFWNETk4LTS3gzvMF9eMGYNGESAkAi0fDI4EWYwJoBuFLLSiqzpUlZGgjQ0LASAehmYVvbOsAA6CV7+gfTPSurmLHYAVVHx/EnpxDn99hWFtvjltYgZ642S0oBfPvevzd4wpTKAAq7HqiQAjAAmAAMsO+aQMYDQpGYYgSST+aSGVT8MDAcEOYHYJHibAASvAIKwSUVMQNsXsoFAPHB0U1obQYFzuVzwQAWKAAdnBAA4RJCtHzBVAAJwyyEAZlgzC04IVCoArDB+XyeW8tlidsMASobBkaFBEoroSKNXaRfCBr93obMjjeBp8uJOqxWAraS76Ub3V5mfA2SAOZ1weCtLBoRqZYLBVoFQA2BUxtOC6GQkUitMSmCQ5jgwUKpNp6Pg/UGkIMvwm5RmzwWiF8zXp6Hgx1lZ1pfupFbD3j8j0QDy8YcrXu8EnsfgYAASXHwAH5EoxGCIOHjCrZd0jdNOAHwUXhYZgo+o0eKJABqZAXy9XAAUr3UFu0+I4T7xX6QEAaOwsi6FoEBUp4YAnnwAA+0iWDARhgDAUDfB857FGk07oQAumevAiPgzDsGAACSUBmPQeJWIRrjIE0REkfiTS4cgYCaDopBsU07BQKxTh0WARjGAxIBMaRcCsexnFkDxIB8ax56yKwMBiAAIswaDMIJWgmKRaAnowl7Xl+8QbtIsgKIC6jaGQKzvqZt5wPorjnhJ5FQMpMCqRpWnMDBiQyPI4RqLJpArBSaCCKQYBAtgMC6CpaloJp2knkELAcFwfC1PUcCXiIMCWSFNnhUEoJYBOaAldZKi2VxlAgN4IgIIgExTLMMwAO7MMYwErHA+AzHAVJ8S8BwzIQEDKHAMzBXVYV2eQVBwNppAMIgMpUKpYDGK0SD8lQ63GAseALaFDVkE1HAoUg0JUExKJiNdW0YegCV4IQJJNTQ9BMGwnA8LVl3hbodjCSY7jBtUgTvE2UQxBO7QBlsDa8DkeQFKjdblDDfh5Q0vBNC09wdF0tZ1ujMVjMTHUXHMdxLF0TyUwa6PXMctNNGcnWXBNNxMw8LMSALbMDrOg6hKFIJgqOMJwn8iLIqiaDolhQZutUeIEkSJJwOSlLUmQONU/jvChiyEYcjyPL8kKoripK0pyoqyqquqWo6nqICzmj5tNi2WmoVaCo2naGoOnSIRS4M5uegU7A+n6pvs+blvhuMUalrG8aJsmqYZlmOZ5gWRYlmWFaClWOfi5ruyNqFQdtqOHYal2PbR7wsex9OrfjpOOF/POi4rkNFlbju7B7okNiHmgx7DgRJmfs5D5PqPb4fje35OH+AFASBiXgZBXQwbw8HCDkpGoehmF/EPYAfPh57ghfo4xnaMbgueenGAZRkV473MkFKyoNloOW3mZFyp5uCgNKvVcKkUFgxTiglReKwMpEg0FVDaIMyrLSai1Nq9Muq9X6jcIaI0xpQAFlNCCs15pgIIY1Va61NpSh2nifa+BDp8mOleU6m0QAXRYddHaN8kCQkesRZ6t57rvWoJ9dqZBAIrRAGtK8m1CxcL2gdRAkJ+HiWgLgAxCo+QaioEYXan48CkVgLQFYasmp8TwKogAtIqCx7jMx8k8XyX65g8AAEFSDGE0HuXgEB+C8EwDgXgAByRgP4/zAEIsRUiFEISKh6N3BJvAQI1AgDVLgcATC1DCMVNAEALxQNvFEmJcTioJMcqvdo4NXDQy1n4VA/xQqI1iCjJIeNukYyQljfcaT0aE3GKTZm3RfYjIbiMbmpD+ZC3JqsdYiyOYHC5qcc4XVri3EWMLLZzxXiLK+N3XJTZZZEyhLCaEuS+7gg1APYqOE5wbxfOPTc2556z3nhg5edShmPlIM+Me+BWnAOBr+f8gFgKgVge/K+MBpwJJWP0GwbBWC8DKcYWo0VJweBJVIJp1gElpI8lk+WCpckfHyV0Si1LCKojaPciyHFlposQshW+6TmIUQsm/eC38v4xj5dfFCaECUGBwAAaRgBgCya1IV7WlUhG+cqACOggyCqsSAAGQgrIAA8sBBeABFA1pAMDmqwOISQLk/4GXPAAcQWItK6pAIikDUfFHAv99JInPOjZA04X5031Ya5VGAmjvyaLG+1AAxBZf5L78p1bkxEIkLIQxEiC9+ryPlThHFmmVgrepoCIhZE+qkuglpHJCMtfdK0YuHMyycpEDA4K0uwSp2L3hAjaLEhK1homJNpVAbtxVe1AUvOISp/wFjdS5BStoshx04DgMOsoQbmlQgVPkwpkASmsnKSqVSsSalNMSWKj+byNTfy1QK2dKwbowBIKwNxAaJw3UkQYmRH4XrkEQG8xRTSvrEHEdQIJ7VjKARwBtDAfAZ2ivfhKl9UqO3vqapojaSBhS6J4cRgRYSzrtRnYBu6wHxKyNVq9Qxz9HomLsTg6qwzRGIN5R8AQSLEkAAFyHAWoRwWdQQgg8aWlxLcKTeCMBpRkzy2SFTd24NwJqN5mBIFAOYHWEgwB4GcR8D4QA==="}
// @errors: 2345
import { type Config } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

declare module '@wagmi/solid' {
  interface Register {
    config: Config<readonly [typeof mainnet, typeof sepolia]>
  }
}
// ---cut---
import { useBlockNumber } from '@wagmi/solid'

useBlockNumber(() => ({ chainId: 123 }))
```

### Primitive `config` Property

For cases where you have more than one Wagmi `config` or don't want to use the declaration merging approach, you can pass a specific `config` directly to primitives via the `config` property.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/typescript.md","from":6058,"to":6590}<fsm-vh3gqscxm4e>
import { http, createConfig } from '@wagmi/solid'
import { mainnet, optimism } from '@wagmi/solid/chains'

export const configA = createConfig({ // [!code focus]
  chains: [mainnet], // [!code focus]
  transports: { // [!code focus]
    [mainnet.id]: http(), // [!code focus]
  }, // [!code focus]
}) // [!code focus]

export const configB = createConfig({ // [!code focus]
  chains: [optimism], // [!code focus]
  transports: { // [!code focus]
    [optimism.id]: http(), // [!code focus]
  }, // [!code focus]
}) // [!code focus]
```

As you expect, `chainId` is inferred correctly for each `config`.

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/typescript.md","from":6677,"to":14109}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"6db931da3d5d995c7840071ad1e449e536b2569da9cadac7a5f1a18cd2f5e66d","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAhVhBEBrAHKCAtgCMyAHhGT+7AOa86NMFDi8AwoZO8AvLfvGKvEfmbswASShm9DCW1gZgRsbIADognt5gcDEAushgmjqkKTHsUMlOHq7RsV4+iSApadpkWSA5ye6yrDBiACLMaMz5WiY+aAB8jFjMpMwaMDSkcAD8iNKyCkpq6WQAdAAKw6PjZHD6ru5xPv4NME2t7cx93LMy8ooq6lWkKwBK44KkYAAq2DC6jc00G0On0omAWBwuHwwFs4EMRDA5ndFo8MmD2BosBBSGgkQsHstyFQoEoEIgCGg0Fg4IgAPS0gDuzGMGnYKzg+FpcAgHCgtOYWHYtMIEGUcFpt3xSyelBAcA6OKQAE4qE0wMY0PgkABGAAsVAVxnGeEl92lGVlHDAuEQAAYqHERmIyMqAL4UdC/PCEEhE6jmJhsTg8PFm1F6OzhEy6UgwZgksCsDC8VBg3jp3haM0AUVoWEUscms2AaYzZdj8ckSd4sH4zEErDQxdLZdbvArCerMLGsxi2c1OxEzDAMQA3C22xmO1Xkx9WL2KVSafTxvhB8OVhIxxPJ+2453kwL2ABVUjz3gxfCU6l0/mClar9dgTcQO/sbdSSeu8ef9PfidZosXwYjAszagATLaUE/mWYRoE6aA0rwJa/q206JsmwRwMeYDsL6cBsG83KsL6zaobu6HVvGUCxnASExLatAwMxLHMXqUAAOzagAHCI4FaLqHFQEqSrgQAzLAzBaNqYliQArDAeq6qxH67uW+4zpmZo2BWNBQLM4m2txckmdxMFfuZbaUcmGgNuIQ6sKwYlkWpU4aRhvDUbR9EgIxQ7atqWiwLaclKhxHFaGJABsYkBVFHG2uB3HcVF/EwOBzDahxYlhVF/naqprl7pWHmASoOlxnpYG6vJ0W2tqlmtv+qHNWWKztbweq8Bo2KIu1KyNb67D8BgAASXD4DMvCMIwIgcMETa2PNYBoLo/V9O4QwjGMExIQAamQw1jRNGzbdskx8I4fS8GspAQKysi6FoEA8nGYBXLwAA+0iWDARjWlAP6ukkG2de43TGL0AxbVsu1TaaKKEusmw7Tsa3tVcNzzGGSNvGgHzfL86MrKCuGYtiuIIwSMrEqS3rXsujLMqy7KcsRORvsKL1ihK2OIzTcoKgwiCCaqwQalqiB6gawxGsLIBU+aLqqj4NrgQ6XgIS6drup6OB4GQd1+vKwzC6lYvqpqSC6tqDrQGrYm6nJVBGGqWx4D4sC0CsiGyjkBukKQAC04lO0HYm2hxQc27KND0HgACCpDGJoC28BA/C8JgOC8AA5Iwl3XcAHglH4+mdeJo4FFGxizJGEQxu51aoFpiy5vmvVFshxUHjWf31o2xY95p3agReID9mukxDiOIBV9Z0hnguV5Lrej7TxuW5z8PHlHqe56Xgzt5Hg+A4b8+EhvmOvDfjfVf9Z1UXdb1vD9VXQ0jeNHJTTNc3sAtddlqrXWptFG519qHU/idMBu1C43Tug9P4z1XrDg+p9fqudeDsGsJAXEXA4AmBhFmREaAIC8BhqjUg6dM7Z0RLnU6sM0b12jAvFuZVlDtwLDsIeC9awD0WsXBeo8FyTyfNfBec5l5HxXGfOAM8XziKboeQU+8pGr3pCfdecjN6viPNfW+t92HAR7BXKCtp74dW1HJZ+sZX7tXfpA4639Zi/yAYA/+K1iagwoeA2YB1SBHS/vgBhlCQxXXgfdbBfx1p8G+sIWAGCVilhsGwVgvACHGBhPjWxsZslSFodYXOxdDhlzApXauEQ66uEbiVZuxd2GcM7khQRSi+51jsjw1pwjx6iPPoo2ps4l7jxXjeGRU9tEXwgP03ue8hmH3UW+U+4z5GXz0dvAxFiViPxsX1exvAP5OMmi42abiloeOARjUBZ1dp+McUEkJ4C4G3UiY9GJX0fq1lVlADBnlLB52KcwTwMBjEwCmpUDI7z4l/S+VXEp/gprakhb9f6MBAbpIMDgAA0jADAU15QBPVEiz5AMq4AEdBBkFxbMAAMi9WQAB5Vkq0ACKFLSAYHpVgcQkhdgQ16O4AA4uMKU4ZSDZkDtiH4OBwY9BWu4VhMR2GipiO4Yub8b4g3cDEcllLsUYBiO87VbKMAADFZ7XTicimFFSTBTWYcYLx7yH6Ip6rYh+lriWoqrkyNAngprIKaMOJ1HVwI7Lse1TBwxEQ+AMJido7BiFJNQl8NcWdfjWAznnOFUBI22JjfdIY4hiGZnGAyZi+S1yyDTTgOASa2xSroRBMSmDsG8FwZ5OihCpJNCzmQ2hedtS5xWJaGAJBWAByNpaVWSB1bFE2M6cgUs5K62oF6ckPplb+njuSQYd0cA4gwHwbNCKiXQoBrKE2ipEBcQthLJAHEZbJ2NOSbNU7rQzo1vOiYM7dQrtod6Ygm647y13RAfdmAj2uDta4d59qam91TKhBpeYuFdxQhRVpfCOnIR3JOIRWwRGyJnoVVyEi5mLlGbSLRKyplz1w1ZVpsyD4UcZpoojOir50fIhmVqPHGpGJAmUsxjU4IIWafRne1YsI4TwjsQi8AeSkRw9xhjAzPJQBovAHyjFWKsXYlxXi/FBLCVEhJOM0lZIKSUipLjRVJPJnYRVdoqKDIR2MqZRqZZeOqd7rZRs7AHJORckVBeXktMLj8plQKwVQrhUijFOKCUkopTShlLKOUOJ5SiyRtSC9HO6Rc51Gqck6oNQk95u+E5nW6jDW/CcBygk/xOec9xC0vFXMYV3fxgToHXJ2E8hBUSnovUDe9WJHyz1erBMDC1E2UVQAvULJAxlb1W0QFFR9cs8BhAiG+tWn6taLrEtxP9a6CCAb9MB7bPLcQ7ZMAnKpNd4OaUQ2WZDHdCziZU/Ztp/Dguka6QRnp7HZ6ebw60yRwzpFUZBwo2zIXGMqPIyM1j95qMcbWWDv8jUKsCZMRBYTE5ROAsQv9tCrTpO4XwvJ4iSn0MI7U2FuiEWmK6bYrqTiPE+ICSEiJcSkkLPyUUrqZSLEcsYbU/lyqhXDLubkmZcrWOft+fsqk5yym7OhY095Fn+UgowBCmFCK0VYraniolZKqUdBpeyrlfK4vweS+0gV8uepapRXqkrirFXqu1fsfVu5E0mt/wAWctrIDyEwO4bwbrUCOQPNgU4a6zzEHDZQWN0982gYg0W6bZUYlVuSwfdQWWz7YiuATntj9c7DvWyiqd/W66LuxwDDuoMUJQz8wyLoODrD6fpne6hr7Eve5YcHhrhnvdukxE5eIB6GheCNMLA7nzmlIfzMo2Buf2D7JLKfHDpX6lGdI+Yyj4+gog5b4xDvgLe/z4vk417nH/GzQgoMoT1CxOxDD8d6P7BWBBAaABUtgTUSdsQMAycR9NJtRIDJ9NImdtMmJQooo5IE4tBkDwIYAWgRAOJBIOIbBjJIJwIaoE4lQTIsobAWhwI5JwJ+BSCV8mon8JMF5WBwJ6VACAC0B6UnQmhYDV8PIYCJ87N0wtdNNmdx5GIoB+AYAwoUpuJxIJJtRmBmBwJMDuIrEVCoooolR5D+BwIRB+AsoopjIVCOIGCvMmDvsF4VcAs1c+DydGdtdwsJDaA9cYsjd4tTdzdksrd0pMpbdMt7d4cAcndFgnMqpeBdQkpUoYpLCoCPIsQcQ2B7Cj9e5BD+9hDRCdcXCtBsx0CTURA5IOIlQAo5JI4jDdQcCoixIE5dRDDMCWhYAbZDDbQopsxchgi1IKsLDmDWlWBtQABlDoSwYYKAOQAJKAI0FItyNTdIiTeIqiJw8QhiWgESGwJUfgEQXUKKfgUSbMbiTKEQW0WAGwQKLKYzeqW0JUW0MSfY7iXUXIgqTo3cbovjXotTYwLgW6ALGAbgwFXgoQ3LRjJYxAqIsxcEiEyEqE6E8Ek1Bg14kQvo7UKUaYxExwsQ0EyCGE7EnEiEqxeEpXFg8CHSCAOiFoe6eIAAWS03FjIFRJ+wQJZzBNxJZJxLMOeLeKsL6PAnFRwPAmRImKmMBIWMPBBKZKxNZMlLxN1AJPeN7lYKGOHCgFGPGJyCFIyJFPUwxPFKlN1LMW1FtFlK5LU1YK+AgGpW1GpLomZBgA2DojpOFN/3gLFJcOZL1KlLNyNJ6NQl91dV2QGgDwCTjyOWmma1DxsCAXa0jz6y60D3jyjwuiTwiVTwDTejQTmxhWm01U6ntEzFlX6EGATOmCxmRGpgyGRhjN2BiRLJFVxneE+AbS8XRHJhxE7zLM3RJBEDJBY1vCZBZDZA5C5B5A5iPC5lFHFEVlFVzyvQNOdhADVDvSln1BLyfXlknMJCr0QALxrxJ21ltAbxtBAENmxGnOFgJ0L2tltnL1gBnUdjnNdmCHdnJE9joB9gQCoH9nJENhDjvPDhQOjm1Bb23RACThTjGBWmoWrToQLiTOKVLn8DKTElhVcEewbj71bhUCX2jxaTUzHwER+2nxAFn2vzgAXywtIGmTX2R2hyvwel33R0mUot3hPzUUoyPEvy5RIvoth1WUFH0SrlvmdSfj9PDQcSDMOWD1OQjPOSjJ8RuRjzjOCU2B+VbXbXwS7WLVIWjM60gv7XoSLJ72qXQsHyaU6Vwv7mwxwqnyBxn04vn0XxQ07iYurHXx7PpFopvxEDvwmQPwZJYqhwWXYo8vlFvwYof0xzvkiqEr9wGn2UUskpazD08Qjzkuj1j0OQT36yTJTyG0SWSVSXSS7WyURFyQJigsKTgviAQoriQptVrhcCe2MpzEcs+zMtHwsvHyspHhsqIrsuwTIparIGcsGVPxor6pCq8rCq3nnkRxPGosCov2Cu4uWQxz4vWQEs2W2REvVQayD2ORDxWla2SsuW0tCVuXEvuSLJ+SVP+Q8EBTXBBTBUJEz2tWPTAltBepJXRTAxgD1TxXgh8FMA9UmzRR1XZSmlpVJN+KZV0FZUpWIp5SenzMFWFRxieHFSNgbRlUhjlR+yKCVUJBVW7nVRmy1RADBowD1QNW+iNUpTNRiFmyhSzzqugye3WmDS2RdRfndQzK+p9T9VmFTKDW+gflDW2ojU8jzVEALXjUTQnBTRIXTUgtzmzVzWjWlrjSLR7R0DQDLWCCzkrUVprTrVbAbQHXEhbRwQgDwU7UyW7RIT7V+AHVtCHRHTHQnRPJVnfS3IO13MXSsQPIA19CApAywD3TIAgxLiqqgARQ+uBvm1PJ1HAhVHnPFjW2L0NDL1fS9ptG3MdD9p/UDqb2DoNFbxAFA3A0PRZtQocG+l71aVewzBMtasdLRPavaU6vmJmOspMVsu31Ioco+yGo5P4Jcvms33GuWv32mq7rbvgP8o31R3YA4v7qnvv14vfBHsqxahfyAkE14AlJE0kHghJx/1HuTCgH/0AJgGALGFALEHAPpIXjmO+01MZJcJgGQNQPQKVFSiwKqPCgIJoMShILILkgoKoJoLoKVHMM5JeMJO5PYKpEAL+LmjHg1KdIEPpNSOdO1JcKkJkI4jkIUKgCUJULUI0PAi0J0NoP0MMMyxMPAnZMPzgYsjlM0hsMC3VwwfPq1OyJWLcIN1i2NwSzNyS0t1S38IyyywClgbntKmd2l3LiiJS1iMV3YYSIpmSNbocLSOwe7twf4d8loFyPyMKOKNKPKMy0qNwPElqPqKwKaO1BaLaI6JYex3UeNPlMGOGOVNIDGMFPQdnp+xfuEIMd3hdJWLWI2K2J2L2IOO1COJOLONwKEkuOuNuOSgeOzCePce3vgY0erE+LgG+IRFQYBJ4d0cMecJWLdPdMlLhK3oRJ+36JRJ0ZwYibwdqYlPqZZPxKaYQZNOJLujJIpJ8CtNkHVAdMqY6cWK6eMbqd6dxOYc8c1NYN5I4n5NVMmKCdfvCbmaMcYkWaWZhL1C9MwerAVN8ZVMCafuBPmaOZ6ZOdOcNIGcKeTFNPNMtK0xtLtNkFIDufRMOdoGOeechM9LeZ3qq0sRq3FoDNQl2ucVDIOsWmkvDxOtStjIut606zCWT0G0eiFoz3jszLABm0+tRUTqXO3IXLWw2xXK2xfVcE3Lzs1gLq3JOw9FXUb3OxLq3XljCHlDqrkBrodT7wAmaqHrQ3ed+0suCfw17t6v7oGqlbkZ+1crP3csntCp4tozydCwXrcrfBXq4p1ZWsmUf1WdYYH1f33sPqJ2PrE3sN4SvqAJALAPZUBb0faYudFIeaQN/u/owP/tSfwMIJAZqLAYgeoNoPoK3u9IKa8c0lYKQc4PKd2c11aVCbCYZMieMYIdkOMJIbIdUJgHULkk0O0N0LoaMMYZWb2Y8e+2aesLslsMcm4flfueBcEcNzixN0SwtxS2tykbt2y3jf2Yc0Uec2UeiKoaQqtd4cSI6HPBmYnc6n0fkYOZqeMdMbkgKKKJKKsSsaihseqPsYgkcZgGaINNcbVeaebaRMVJGP8e2fVM7dmI3dzf9eic2O2N2J5ISaSZgFOOklSagHSZuLuOydyeCfvcGd7mKdKd+J4IzbgM6eBdBbBYhMabiN9d4FabNC9eqeWIWaeaw7xLknOd4dYJJNGY0CpJpKmYBZ9c3b9Yw7I/I/BPrcTbWZ5NID5IFLVNQ5CJmTzcec4+hLOchd46fb8YCaE6I/Q+3fE4k/Bdedw+o/AjNItImd+fwWmffdE/9cw844hY0/yYzF9O5v9wRfiv2qksjJSqLPOp63jMrIGxeSQRGzTPGyZtJZmypasSvNpaL02yztcDkBZd9oXTr2BjthvOfJbNxGLnXKeBvgEAQTzgAAE+zWQhzeRc4wQwRUuMgZo4FGBKqjhXdxIDgUK6qE4b5uBuBiu+Z2zSAyukyKuo6qvELaua5Zg7tjA5BGvuBZQdpmAkBQBzAsIJAwA8BfZXRXQgA=="}
// @errors: 2345
import { type Config } from '@wagmi/solid'
import { mainnet, optimism } from '@wagmi/solid/chains'

declare const configA: Config<readonly [typeof mainnet]>
declare const configB: Config<readonly [typeof optimism]>
// ---cut---
import { useBlockNumber } from '@wagmi/solid'

useBlockNumber(() => ({ chainId: 123, config: configA }))
useBlockNumber(() => ({ chainId: 123, config: configB }))
```

This approach is more explicit, but works well for advanced use-cases, if you don't want to use Solid Context or declaration merging, etc.

## Reactive Parameters

In Solid, primitive parameters are passed as getter functions (accessors) to maintain reactivity. This is different from React where parameters are passed directly as objects.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/typescript.md","from":14461,"to":14612}<fsm-vh3gqscxm4e>
// React style (NOT used in @wagmi/solid)
useBlockNumber({ chainId: 1 })

// Solid style (used in @wagmi/solid)
useBlockNumber(() => ({ chainId: 1 }))
```

This allows Wagmi to react to changes in your parameters automatically when using Solid's reactive primitives like `createSignal`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/typescript.md","from":14755,"to":14999}<fsm-vh3gqscxm4e>
import { createSignal } from 'solid-js'
import { useBlockNumber } from '@wagmi/solid'

const [chainId, setChainId] = createSignal(1)

// Block number will automatically update when chainId changes
useBlockNumber(() => ({ chainId: chainId() }))
```

## Configure Internal Types

For advanced use-cases, you may want to configure Wagmi's internal types. Most of Wagmi's types relating to ABIs and EIP-712 Typed Data are powered by [ABIType](https://github.com/wevm/abitype). See the [ABIType docs](https://abitype.dev) for more info on how to configure types.

---

---
url: /vue/typescript.md
---
# TypeScript

## Requirements

Wagmi is designed to be as type-safe as possible! Things to keep in mind:

* Types currently require using TypeScript {{typescriptVersion}}.
* [TypeScript doesn't follow semver](https://www.learningtypescript.com/articles/why-typescript-doesnt-follow-strict-semantic-versioning) and often introduces breaking changes in minor releases.
* Changes to types in this repository are considered non-breaking and are usually released as patch changes (otherwise every type enhancement would be a major version!).
* It is highly recommended that you lock your `wagmi` and `typescript` versions to specific patch releases and upgrade with the expectation that types may be fixed or upgraded between any release.
* The non-type-related public API of Wagmi still follows semver very strictly.

To ensure everything works correctly, make sure your `tsconfig.json` has [`strict`](https://www.typescriptlang.org/tsconfig#strict) mode set to `true`.

::: code-group

```json [tsconfig.json]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/typescript.md","from":1157,"to":1207}<fsm-vh3gqscxm4e>
{
  "compilerOptions": {
    "strict": true
  }
}
```

:::

## Config Types

By default Vue Plugins does not work well with type inference. To support strong type-safety across the Vue Plugins boundary, there are two options available:

* Declaration merging to "register" your `config` globally with TypeScript.
* `config` property to pass your `config` directly to composables.

### Declaration Merging

[Declaration merging](https://www.typescriptlang.org/docs/handbook/declaration-merging.html) allows you to "register" your `config` globally with TypeScript. The `Register` type enables Wagmi to infer types in places that wouldn't normally have access to type info via a Vue Plugin alone.

To set this up, add the following declaration to your project. Below, we co-locate the declaration merging and the `config` set up.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/typescript.md","from":1992,"to":2403}<fsm-vh3gqscxm4e>
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from 'wagmi/chains'

declare module '@wagmi/vue' { // [!code focus]
  interface Register { // [!code focus]
    config: typeof config // [!code focus]
  } // [!code focus]
} // [!code focus]

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

Since the `Register` type is global, you only need to add it once in your project. Once set up, you will get strong type-safety across your entire project. For example, query composables will type `chainId` based on your `config`'s `chains`.

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/typescript.md","from":2667,"to":5186}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"21ee40fb2fb12112e58ba8b16f5d7f9ef29efdee74e4bd47b38d17e1aa2e8800","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAhVhBEBrAHKCAtgCMyAHhGT+7AOa86NMFDi8AwoZO8AvLfvHdpGMyiTWGXqgAdKV4QrUUVAFFaLEUPUjhEXmAgkNTUjy8fP1h+ZkFWNETk4LTS3gzvMF9eMGYNGESAkAi0fDI4EWYwJoBuFLLSiqzpUlZGgjQ0LASAehmYVvbOsAA6CV7+gfTPSurmLHYAVVHx/EnpxDn99hWFtvjltYgZ642S0oBfPvevzd4wpTKAAq7HqiQAjAAmAAMsO+aQMYDQpGYYgSST+aSGVT8MDAcEOYHYJHibAASvAIKwSUVMQNsXsoFAPHB0U1obQYFzuVzwQAWKAAdnBAA4RJCtHzBVAAJwyyEAZlgzC04IVCoArDB+XyeW8tlidsMASobBkaFBEoroSKNXaRfCBr93obMjjeBp8uJOqxWAraS76Ub3V5mfA2SAOZ1weCtLBoRqZYLBVoFQA2BUxtOC6GQkUitMSmCQ5jgwUKpNp6Pg/UGkIMvwm5RmzwWiF8zXp6Hgx1lZ1pfupFbD3j8j0QDy8YcrXu8EnsfgYAASXHwAH5EoxGCIOHjCrZd0jdNOAHwUXhYZgo+o0eKJABqZAXy9XAAUr3UFu0+I4T7xX6QEAaOwsi6FoEBUp4YAnnwAA+0iWDARhgDAUDfB857FGk07oQAumevAiPgzDsGAACSUBmPQeJWIRrjIE0REkfiTS4cgYCaDopBsU07BQKxTh0WARjGAxIBMaRcCsexnFkDxIB8ax56yKwMBiAAIswaDMIJWgmKRaAnowl7Xl+8QAPobrwhyyAogLqNoZDvqZt5wPorjnhJ5FQMpMCqRpWnMDBiQ2fI4RqLJpAUmggikGAQLYDAugqWpaCadpJ5BKCWATmg0i2eFDlcZQIDeCICCIBMUyzDMADuzDGMBKxwPgMxEIIMAvAcMwGBoOVwCqqlwDMMhhfZkUlXA2mkAwiAylQqlgMYrRIPyVDTcYCx4KNdkqEVZAlRwKFINCVBMSiYgHXNGHoIleCECSJU0PQTBsJwPD5WNe2RbodjCSY7jBtUgTvE2UQxBO7QBlsDa8DkeQFNDdblEDfi1GCvBNC09wdF0tZ1rDsVjJjVUXHMdxLF0Tz4wasPXMcxNNGc1WXF1NwUw8VMSGzNMDrOg6hOFIIY1CsLQrOiLIqiaDolhQZutUeIEkSJIDawFJwFSNIYoGZR00yLIRhyPI8vyQqiuKkrSnKirKqq6pajqeogLOMOo/84UtlpqFWgqNp2hqDp0iEAuDO7noFOwPp+kjBPu6GhvjFGpaxvGibJqmGZZjmeYFkWJZlhWgpVinvPy7sjae+aPujh2Gpdj2we8KHofTrX46TjhfzzouK4tVZW47uwe6JDYh5oMew4ESZn6uQ+T692+H43t+Th/gBQEgUl4GQV0MG8PBwg5KRqHoZhfxd2AHz4ee4IH6OMZ2jG4LnnpxgGUZM8rxZVmhbtEWOVIM5We7RJ4rGCtZAq41AHRVivFRKYDMpEj6rlT6/99rkCoGVCqpMar1UajcFqbUOpsx6kBfqg14AjSgd9QBk1pqzT5BqBaeJlr4FWnydaV5NqzRADtQqE0FonyQJCM6xELq3hOjdagd1KpkEApgkAU0ryzULCwpaK1ECCjOtAXAiBFSQlESAIwi1Px4FIrAWgKwZYlT4ngeRABaAxkIHF+wVA4wUT1zB4ASjgXgAByKECp/G8BAjUCAeUuBwBMLUMIMBeBoAgAkxKAT1JciwAAWWYBgHQFJ+C6DvvBZ+T8Yz3yPkhE+UATz+JWIdGAJBWD2NIAow6wj9FiI/JdcgiAyzSMwDge6xADrrW8ZVYygEcAzQwHwLyFErJpJgJk7JuSkIFPvsUjUz8ymIWQqhE89CVFIDUSARabCkDaOoNwralVZlQFacddp4lxHSyur03COjYDmJQTNJIaCBGAObgIQCGgAkAAF8HAWITAfxQQgj8OgVxRgwBCLEVIhRCEipm7cBKjeZgSBQDmCVhIMAeAbEfA+EAA"}
// @errors: 2322
import { type Config } from '@wagmi/vue'
import { mainnet, sepolia } from 'wagmi/chains'

declare module '@wagmi/vue' {
  interface Register {
    config: Config<readonly [typeof mainnet, typeof sepolia]>
  }
}
// ---cut---
import { useBlockNumber } from '@wagmi/vue'

useBlockNumber({ chainId: 123 })
```

You just saved yourself a runtime error and you didn't even need to pass your `config`. 🎉

### Hook `config` Property

For cases where you have more than one Wagmi `config` or don't want to use the declaration merging approach, you can pass a specific `config` directly to composables via the `config` property.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/typescript.md","from":5511,"to":6039}<fsm-vh3gqscxm4e>
import { createConfig, http } from '@wagmi/vue'
import { mainnet, optimism } from '@wagmi/vue/chains'

export const configA = createConfig({ // [!code focus]
  chains: [mainnet], // [!code focus]
  transports: { // [!code focus]
    [mainnet.id]: http(), // [!code focus]
  }, // [!code focus]
}) // [!code focus]

export const configB = createConfig({ // [!code focus]
  chains: [optimism], // [!code focus]
  transports: { // [!code focus]
    [optimism.id]: http(), // [!code focus]
  }, // [!code focus]
}) // [!code focus]
```

As you expect, `chainId` is inferred correctly for each `config`.

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/typescript.md","from":6126,"to":12100}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"9b5b0298b470a179bc3ea33df03ba8ced7d88ec92e62fe07acf70060b35435dd","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAhVhBEBrAHKCAtgCMyAHhGT+7AOa86NMFDi8AwoZO8AvLfvGKvEfmbswASShm9DCW1gZgRsbIADognt5gcDEAushgmjqkKTHsUMlOHq7RsV4+iSApadpkWSA5ye6yrDBiACLMaMz5WiY+aAB8jFjMpMwaMDSkcAD6APyIvACqsgpKaulkAArDo+NkcPqu7nE+/g0wTa3tzH3c80vyiirqVaQASuOCpGAAKtgwuo1mmg2h0+lEwOwNFgIKQ0NJlo81i9KCAoEoEIgCGg0Fg4IgAPT4gDuzGMGnYADo4Ph8URBDB8cwsOx8QYoRA4MwtE04PiZA9Vs8Mii4B1YUgAJxUJpgYxofBIACMABYqGLjOM8PyVk91uRpT5cIgAAxUOIjMRkSUAXwo6D+eEIJH11HMTDYnB48IFupeujs4RMulIMGYaLArAwvFQ4N4cd43NWAFFaFhFCHJvNgLH47mQ2HJJHeLB+MxBKw0Fmc7ma7x8+Gi2AdvMYkn5XsRMwwDEANzV2vx+uFqOfVgtrE4vGE8b4DtdikSXv9gd10MNqNM9gLUhj3gxfDY3EExnMikzudgBcQE/sJdSAfWvv3uOP/uJlTfSEweaKgBMxoAp9czCNALTQPFeGzZ8ayHCMo2COAFghZ1OVYd44AgVhnSraCV1goswygEM4AgmJjVoGBKKoyiVSgAB2RUAA4RF/LRlToqAJQlX8AGZYC5RUeJ4gBWGAVWVai7xXPM12HBNERsfMaCgeZeONRjhM0xigIfHTa3wqMNHLcRO1YVgeJw6TB1kuDeEI4jSJAcjO0VRUtFgY1hIlOi6K0HiADYeNc/y6ONX9GMY/zWJgX9mEVOieO8/yXMVKSrNXAtbPfZRFNDZSf2VESAuNRU9JrV9oIq3MKRq3gVV4DQYRgXgaopMrnXYfgMAACS4fA5l4RhGBEDhgkrWxRrANBdFavp3CGEYxgmCCADUyE6nq+q2RbdkmPhHD6XgNlICByVkXQtAgTDQzAG5eAAH2kSwYCMMAYCgJ9rSSOa6vcbpjF6AYFp2ZbZjuBFBT1baQb2GaapucGfSRDJ3jQT4fj+OGKTBCF2Vhb0dWRq0qDREQMQnI9CRJMlKWpWl6RvVlTuhTluXgPkId9YUqFFYYGEQZVhOlYI5QVRAVTVYYNX5kBtURIViZADg3qQX8zS8MCrRNW17RwPAyBOl1efFRAouF2V5SQOizWgI1eN/NWQCMGUdjwHxYFoClwJRHJ9dIUgAFp7d/AOeONHiA7olEaHoPBfhwXgAHI/x4xPeHYaxIDhLg4BMJs2d4NAIELv4k5aSisAAWWYDAdHefhdEVB6npLQ0oD6ROKRRJoSFYP3De7w1VfV7ZLXIcW6J16gHUxJ1FZjmXBhOnBYQwPhjj8KABvLmAq5ruuXsb5vhFbt725FMV+bNpWRctxBreoKXNUxDf/EHlXEEd81mDHpVJ7taeetZ7EHnm6TES8IAr0wOvVw28K7V1rjAeu/pXDNwDBEYMNkiwxmgtlFMaYmqZkgsuaymUiwljLBWSy6UDK8CbGMccbZZyTE7N2EAZU8JYJHDuccB5JzHnPCw+ci52EkP0lwuyzJty7n3IeKcN4zztiEZeCQN40q1iqvGTRcZsqfgYXVf8gF+wgTAhBKCnCyHwQSEhdgKE2DoUwthYhuEBy0PsvARy5FqLUVogxZirF2KcW4nxUMWhBIiTEsqCSVF1HSVodlXK7R3qqTDhpLSHCtEZLjLQoyFZ2CmXMtQqybioBEQ8eOZycU3IeS8j5PygVgqhXCpFaKsV4qJToslKpsSLHrnkqsRJ+U6qFWEsVUqYjeDaMmWVVqwyGpNRajVdq60uq9WpANIaI12BjXmDYSa01ZrzW2EtPY8w1qkA2ms/A0MTl7ScIdY6p0M7/EutdLsd1Honxem3T631j7PVeu9PoF8+ZW38ubUWSBwWP1INLPAYQIjvztiPTW48gpT0wEAggICXQL3hZIUUBRAzGAAIK7NcJgyx0ZzHxjwamdMpznG9LkhQ4yRS4kSPod+PcIAmEXh6a4iRo5eFyIEUouArCrwCvEVSzc0iRX8MJJuRRzCJXCOvJuaV0z+xTN0V+H8hjjRlRMT/cC7KZJUoQjYuxaF4COLIOawVsrSkOQqRRbxNFlT0SYixNiHEuK8X4mEoSolxKSVES4mVfSElKWSbwNSaThLaQmVMi1fTckmTYIUplNCJHuJIm6lK7kYCeW8r5AKQVFQhTChFKKOg2kJSSilLVaa5IxrynGlURV/IlSydqyqMzar1UaiGRZbV+wdVWX1DZw19m7P2VjH6wNbmrRWZtakNzdpegOkdE6Z0XlXSaO8vgnyAU/PBF9YFPNL5IEYqqG+FsxYP3VM/WIrgSVIuHsUUeEwkCJQxTPbFzpo5gJACwDgXA+By0hn6dBQZaE4NzHSghGYzETNoayqhObimcubDygA8lgcQZ0NC8HwQy0gLbSF9OFTyvhlN8SQOIxnEyKqLxSojelDKfS5U8Lo6KpVzIA5MchCx/JbHlFXjUZx3SOqyp6v0Ya41khQKmrQ5G7jLKM5YEEDQAA4jsAAYqamEGBHVRrkoqczHLnVlILTyrxXl/LCRJVoJzv4YAtBEHRdidEbAaX/L+QqJKJSaXijYFov5hK/n4CFqjL4+2puo3JVgv58O6Z02gfDFomjWdbbZKz2GuOadsvmzxtAoD8BgN5SKjFeJ8UVMwZgDsYCMUVMJZr/l/ISjq/wX8Ih+DxX8hpZrdF4v9pXEl7JEiM35KzRZIrzLSsuvKQ52gRaallvqZW6tzS60xTio2zpzaZM4ape2pJKleDKnClFQKiW+20OhLCNgeXksFbexZ5bdnytaCTG5wzIhhJ0QlK5YSxoGKdOVN5m7PESXKkGx5losBlSKkG8afySZcineklNibTq+msEVAAZQ6JYYYUA5AXKgBqT7JWiyFZpcV+nG4Vv2bIrQLiNgJT8BEMqfy/BuJJkYnFEQxpYA2DcvFQJJVjQSnDsLu9f3Uo48mw99DEjjBcGOvkmA2Wf65cWwTuSZW3U3YAhby3Vvrc29twBQzWq8e0KJ4TOnJSftm8NXb73PuLftcd49iRqXFIcjgC0U68RK4eJFg6o3X2CJs/K+b33KefdjdV5kjXVLUtJlIN538ioqc5Fp3HmCebE+e9T1Xm3KoA9Z8J7+UnXYoAU6LzT7lTObM8Yr2t5P1f++y7rxp53v5vgQAADKKijyRUkMAtgkVj53pbCePe969wP1PVah+5imbM4dCzWrLIuVO9Z8xNlzomtsqai6jk7WWmctdVzN3LX2g8vdzyLqHpuh8lu3yz6/J+kVFNATB6CmiBmOS3TBkWE5iJlIGf1hlmluGgKRgVjeA+C+Hjn+FmnBEhGezhGgy5kVlJnJno3kWpnJCpBpDpAZE3CZnZFZh5A5hQL1BBRNlCwhTvglhhThUxAINgM/UQB4hRVNS1mNAAyxQNhhFYP5lckdhlEhXvhtlgFVh4gdioGdmCFdkxHdjoC9gQCoF9kxANiDlUJDiKkjhA1jkxEwKThTjTgzjoQgGzhIjzi5CaELmLkxWakTh3j3kQWQSAP+VPiBU7m7hgF7n7ikINA/iEO/VRT/nEKNCA1ASsLAywGXjIGgQ8BKE3jgV3gQQPgbkCNPWCPPmvVBXFj/A4KfUllhVfVfigAENiO/l/gnkSMdBxUsMXnSMgUyLXiJQiDyL8MKJQWJTQQpQQ072Qwo3U2XyjEw3GiX2N1si5XHEI2YzgFI3I0IXG1oVo1kUVUYyI1E1FHE0ETVRUQgF2LzSkT4wOIY03GE2OLOlY3OMlVUU1QzwSzkzfERD0W5SU2MRU1MWsww2010xgAMzGGMzEFMzdwkUZwmTmLsh7w5xgCcxczcwlCik8xhx8n82izCmC1C2EnC0i2i1iwlHGzxydyDzSwy1031xGg7yRPewZzp3yxX1dTW0q2qzolq3qygEa2aw8zaw61/C6x6xi360G06RG1/HTz7R33V2Hxm2MjmzMgWyWPj1Z1Xw5w2xLVqXLQaSrSaVrVaUOw6S6VcmuPOwUljSuxuxaXuxTUDypTwNe1L05KjERI02RNNzWz+wByBxBzBwhyG2hx814nh0R08xRzRyAMx2xyVMzw01pOzxJzJxb1IEp2pxL21LLypV9OZ2m1s25I5y5x5z5wFyFxF0VDFwlylx8w4ll3lx4kV2VGV2pJVORK1zgB1xED1xyxZL9LZN1PLKcloD7w3yrwdy+Pxx1N4Bd0RHhLLNWw52nJnN9393nPTIbxDxInDw0Ej2j1lEX1ZNLO7z1MnM3K3LT232WKLBzzzzogLzb3zIvJZxROvPIlvLvNt1r13LdIbyb3JxzPfJHK43dwnN/PX3/IAuNAfMXNSzH0n2n05A1Hn1kFIFXKvJgqnLgvguty3yAp+Ogj32VHmVHUPwnUf2nTP1nSv3Gj2SYpv14GXS3Qf2P3XWuQgJf3uV3SeXOleSPVuhPV/0BQ+gvT+RKL/yBWkKVAlOqKhVqJ4LfWJSaOENaPRQAS8I6OAzVFAzCEJQRRMDkHJWJUpT6UQ1pURG2NQ1BIkQWNwrklWII2eIzi2PpR2PnO9OkDuIpnkRExeLOPFXeKuN8rHMkS3ACtIOPEeOCrExEAkwuKk0+J7NTKQz+P1XjQt2UymhBNLzBLgEy0hKMxM1IDMy9KiuLJLOgvXMnPROxMxPc1xObL8wCyJLhxJLJKixizi0iu+LTOApS3pJxEZOHJco+2qsXIDI515Jq2G0FOFJazFM62616xlKG3lMVM/JpJGtslmwKS1M/PqvZ0nINNLTqQrUaRrRaXrUtKbW6UGq/IuyGSdLux4gysXI9N3ALL8tquZzOt+3+2EkB2B1B3a3DKhxh2jIRz/DjJgFR3RyTO7NdPrxS0zOb1bzzMgtzSLI5KirmsnMrN5350F1/GF1F3FxgElzCWbKgFbIVwik7KTBVxTKGrVwxtsj7IHKHINzxrOzwoatgqIt9znO+sLMJ0LxXJmq/OJtFrFrtx3Mlr8uDxOkPIjx8HQpjxwrluBsryVrt12uGu5qfMppfLfNxqmq5JFoIqNoAuVCQqltGtAuzNzOL0Fq7xN1RJvMIodqAOdrVtHwnynw8VnywvPNHMvJ9p/PtoduIv8mdt3yHUopHWahougknR4pnS2R2UvzGjYo4vv14HOUuS2j4r2Ff0Ev3U/zeTEqCLkqkrAEvQUvFh4nvXkLvmfSfhllMuMDkE0riJELRQlC+iUKSNwJhDhGAAJnlj1EmQED3STgAAFyCWRqDE5wRwQ+DUDGBZ6GiDUhCBiTB5h+6SVJluAd6YC96D6cj/Aj6jhXAz7XA5BL6UQlpmAkBQBzAEIJAwA8BvZrRrQgA"}
// @errors: 2322
import { type Config } from '@wagmi/vue'
import { mainnet, optimism } from '@wagmi/vue/chains'

declare const configA: Config<readonly [typeof mainnet]>
declare const configB: Config<readonly [typeof optimism]>
// ---cut---
import { useBlockNumber } from '@wagmi/vue'

useBlockNumber({ chainId: 123, config: configA })
useBlockNumber({ chainId: 123, config: configB })
```

This approach is more explicit, but works well for advanced use-cases, if you don't want to use a Vue Plugin or declaration merging, etc.

## Const-Assert ABIs & Typed Data

Wagmi can infer types based on [ABIs](https://docs.soliditylang.org/en/latest/abi-spec.html#json) and [EIP-712](https://eips.ethereum.org/EIPS/eip-712) Typed Data definitions, powered by [Viem](https://viem.sh) and [ABIType](https://github.com/wevm/abitype). This achieves full end-to-end type-safety from your contracts to your frontend and enlightened developer experience by autocompleting ABI item names, catching misspellings, inferring argument and return types (including overloads), and more.

For this to work, you must either [const-assert](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#const-assertions) ABIs and Typed Data (more info below) or define them inline. For example, `useReadContract`'s `abi` configuration parameter:

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/typescript.md","from":13059,"to":13149}<fsm-vh3gqscxm4e>
const { data } = useReadContract({
  abi: […], // <--- defined inline // [!code focus]
})
```

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/typescript.md","from":13160,"to":13268}<fsm-vh3gqscxm4e>
const abi = […] as const // <--- const assertion // [!code focus]
const { data } = useReadContract({ abi })
```

If type inference isn't working, it's likely you forgot to add a `const` assertion or define the configuration parameter inline. Also, make sure your ABIs, Typed Data definitions, and [TypeScript configuration](#requirements) are valid and set up correctly.

::: tip
Unfortunately [TypeScript doesn't support importing JSON `as const` yet](https://github.com/microsoft/TypeScript/issues/32063). Check out the [Wagmi CLI](/cli/getting-started) to help with this! It can automatically fetch ABIs from Etherscan and other block explorers, resolve ABIs from your Foundry/Hardhat projects, generate Vue Composables, and more.
:::

Anywhere you see the `abi` or `types` configuration property, you can likely use const-asserted or inline ABIs and Typed Data to get type-safety and inference. These properties are also called out in the docs.

Here's what [`useReadContract`](/vue/api/composables/useReadContract) looks like with and without a const-asserted `abi` property.

::: code-group

```ts twoslash [Const-Asserted]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/typescript.md","from":14289,"to":18787}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"c81ecea55f2b27ad2c18ae6e5fc3ad6aed33ef72a35b2bb465243c2101cb267c","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAlGMygBhSWlLMxAHhGS4aXswBG7XnRpgocXgEETvAD69SiqJNYZpYANaQA7mDIALoUAsJiEmAAcswAtjBm9DCW1qpg6ppoAGLh4pIx8VrG7KEAOiBYgi7ljrzlROwwfuUAfKHMpADm1ubJVrxpGWI5onlgNl1wRSZlFVUwNU71jc2UYaORBTBtvLpg/OydiRb9aQdHALwDkuehsqwwYgAizGjMvFcKSoMaz6/M0xK6wi+TiMHakxaLUYWA6YJopDgAH0APyIXgAVVkXxUal+aAACnD4gipsVQkINqD4hDuqE9rdePdHmgXm8Wtx0Vj5K4fpkFGgqmAACrYGCAim5TZg2lwO4wB5/dmlMDsWJYCCkAwyHnfPGZSggNwiBCIAhoNBYOCIAD0Nr8zE6sXYADo4PgbURBDAbcwsOwbYQIN44DadTi+WJDfoOgxEABOKgPMCdND4JAARgArFQ3l0YHGQOHefqo0n2GBcIgAAxUET4OFiMhIeMAXwo6DFeEIJHIufMeD2+l4UH+6IU/C0wlgB0rUBatQnWhMnQraBahuNppAwvwCVYXAMcEEIhE8DgQlYHmc8AgrBIUBH/wEmt4aYSAEdvaQMC7o3m4yzAAWJNklTdNEBA6gOk6As8FHN5DQ4SskAAJjrBt8WbRAAA5207HBu2IZt+3oJg2E4HhpGxEt0nxLQXCUdxPFQFVeHYm8mLAa8wDBdFyiMNhmFEGAAHl+HKABuNiOMYtxuM8TAcH4kBKRBMApJk9i5OYpk3hoABZQQ3hMDhMBUhomk0qRZNcXSK0qNBrU4+Tr1YmyONsrjryUmAVKUKAXDgOBrM8zydIU3hePiFSIACMhQo41sgmkjyXN0iBjMc5yIrc4AtLC3LFLFFTBDXVCswANkS9jktS9teHytKiqivi6hAdg4BsLAsFIYioCyTUbCvGr0si3yVLUsZRpamNDOM4ozIwCyVhmuzIoc4ycvWvKCvCnbiuU9qAqCkKQFSsKvNczxor89q4srUhRoaprLu0g63xK46oEC89Rv27ybra8oIBwDQ0E1Z6UoKlrMstLb0Ra9y3rGnyvoEiA7yh+rQleq7dNulTYLQbrev6tbAc+o7yimyIKeuvTXhgIyTPYJaVqs86YY+zanMRj7kBdIXoeaj64ey/nKcF4WccagqhZdWW8fYhX6pCdrBIPETxPKUIkYesh0QV9WzkOUIVzXaFYQ0EkyGRNFMRovU6MyIkbYLO2tAVjkuSd3EXbEAUhVFHAvaFloVTVDUtWo3V/aGBgqC3bsLStW17UdZ03Q9L0fT9AMgxDMM/cjROQBjLUkEqgBmUCUzTTMc2g/NC2LZ2E6Qisq3QkB60bBFMwAdnw6guzNHsSOoAczRhPqwcwPgTvPFTq1oLIACEbGr+MM1Q5RmGrICfqArMcJEHCgOrmBUIAURv6scPjSrB/4ZRD/4aus0H+MRFQ8p/1jEgHCtcQDJnAkgQeuYYJwTNEvYKncUKIBAX3LC5BECoRHr5IivZDQ0DIjPMm88MCLxMJLBmyN8aRUJhrIS2sJJc1FpTCa7VaaSHprpOazMFqmXYOZdqllVgXUodeXm20pbK0Kh9Zh5Q4FnSEZdFq1CQbxSegwzydVuaU3FgjVGLEJEAwZtIos5UqrYxVC9TRDMlEdS6j1PqD5BqkGGqwdh410aqSlGwtRwjPCcJZotXhy1+GrW8e9SmoiyG6QoQoqR7jZH/R8a1GK90VHPVxntRJRj4mhMkZTaxoMyCvEhjkjRjCGbaL5ro3g0TcmGPcUYTGLiSkiwsWUgmwMQDE1JvYmAUBXFo2ph4qkGkcmzX0lw1m7Ngmc3kVUiJVTpYuhFgYjKWUdFI2NkreWQstlpVVuYoIADK6IAzEBWsoCwINyQVAlueBigIKrFBFBmRsIYI7KPQi49iJ9invg3uegDBkBEIPVCGY7DsEiZFGpiiOma2EmeHWozYmDNYSM2ZYymb+J4Xw5YMzLH2TABLBZ+jMlxJ+qdBJYSrEdINqo2ZpSVmRQqWI8hJKqW6SMWVdIFVqrNN2YyniHTOrdP6o45x/TDp3Rpp4tF+LIp+O4WzQJHNBFypEYS9ZAs2VVKyeSv6OSBVA2Scox6aS5ZpUNVTKVIBsmzMtfksGRS6UFQZYk5lkLdoWtJYMhpWM+XmPSW0qhHSul2PJkiph7jUUSsZvNSZyrpmqqDeqolGyZZqs8O6hZmyA3ms8vssArT807IOUcuMpym5gKuYmZuxM8BApBWCkwDykBPMwi8tBw93lYK+Tg0ihZZ4FK1MQ4EYwtgqThXQ/+VAK7ltPnXcBJye55jrWaVFWwW2ICbs8psaC3kESrCAL8ZAMC4OniAQdRC+DrthbQhF9Cy2Nxwguq5u8bmrqGepDd5ZEHbvbbutCmCx4EG+Wev5l6yAL0MJMdEyByirxsNWZQ/Bv44RwhmSqTwgJGHjDhnClVKpGCzNXau1Y77MCApVZgGZgE4VQvwCqGYFggEOTOgCmZ4znKrRBKCK6YE2smJumtO6B7oKA58o935T39qYIQyDI6YLOTgyABDSGUPxjQxhrDOG8MEaIyRsjN8KNUZo9XOjDGsxMfKKx8u7GTmcZfTx99/HFNCYwv3V54nD0Tx+XgwsQ4DAIWYOOGAk5pyha7vORcoXlyHEtpuCAJo8C7n3IeJkJ4zzBUvNeIKd4HxPjeC+Ugb49y8GPT+P8bHAHoKAs+i59cnO1v40Fzdb7e7/tE9WLzeByvSd+f5gFBXgu8CXOF2cvSFxOCXBbdIG4k6Je3Cl3gB5hzHlPOebLnhcv3l6UNorJXPxScq7Z6rqFauOdbc5wsLWf1VjayJ7CXWQj/NgHgKOmoDDAFjhGUsBhWwCD6rEXgAByAAAg6J0AZc7A5VCqALjU9v/auG3eO+JGB41keiYHq8N5bx3nvA+R8oAnzPhfK+t976P2fq/d+n9v6/2BxQGSxR0QNtBeCpnNkb3JOB5O+9jPYcaSF+xRTsHse0EQ8h1D6HMPYdwxpvTxHSPkco9R2j9HGMwGByEcx3BBdBZVIaEkzAkCgF6GAOAkQ8BORAK2VsQA"}
const erc721Abi = [
  {
    name: 'balanceOf',
    type: 'function',
    stateMutability: 'view',
    inputs: [{ type: 'address', name: 'owner' }],
    outputs: [{ type: 'uint256' }],
  },
  {
    name: 'isApprovedForAll',
    type: 'function',
    stateMutability: 'view',
    inputs: [
      { type: 'address', name: 'owner' },
      { type: 'address', name: 'operator' },
    ],
    outputs: [{ type: 'bool' }],
  },
  {
    name: 'getApproved',
    type: 'function',
    stateMutability: 'view',
    inputs: [{ type: 'uint256', name: 'tokenId' }],
    outputs: [{ type: 'address' }],
  },
  {
    name: 'ownerOf',
    type: 'function',
    stateMutability: 'view',
    inputs: [{ type: 'uint256', name: 'tokenId' }],
    outputs: [{ type: 'address' }],
  },
  {
    name: 'tokenURI',
    type: 'function',
    stateMutability: 'pure',
    inputs: [{ type: 'uint256', name: 'tokenId' }],
    outputs: [{ type: 'string' }],
  },
] as const
// ---cut---
import { useReadContract } from '@wagmi/vue'

const { data } = useReadContract({
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  abi: erc721Abi,
  functionName: 'balanceOf',
  // ^?



  args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'],
  // ^?
})

data
// ^?
```

```ts twoslash [Not Const-Asserted]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/typescript.md","from":18827,"to":21842}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"fd8f5c57d72097f21d1a246c1505fe478b32857ce6eeba0f9c882f247122d11d","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAlGMygBhSWlLMxAHhGS4aXswBG7XnRpgocXgEETvAD69SiqJNYZpYANaQA7mDIALoUAsJiEmAAcswAtjBm9DCW1qpg6ppoAGLh4pIx8VrG7KEAOiBYgi7ljrzlROwwfuUAfKHMpADm1ubJVrxpGWI5onlgNl1wRSZlFVUwNU71jc2UYaORBTBtvLpg/OydiRb9aQdHALwDkuehsqwwYgAizGjMvFcKSoMaz6/M0xK6wi+TiMHakxaLUYWA6YJopDgAH0APyIXgAVVkXxUal+aAACnD4gipsVQkINqD4hDuqE9rdePdHmgXm8Wtx0Vj5K4fpkFGgqmAACrYGCAim5TZg2lwO4wB5/dmlMDsWJYCCkAwyHnfPGZSggNwiBCIAhoNBYOCIAD0Nr8zE6sXYADo4PgbURBDAbcwsOwbYQIN44DadTi+WJDfoOgxEABOKgPMCdND4JAARgArFQ3l0YHGQOHefqo0n2GBcIgAAxUET4OFiMhIeMAXwo6DFeEIJHIufMeD2+l4UH+6IU/C0wlgB0rUBatQnU58/jALUNxtNIGF+ASrC4BjgghEIngcCErA8zngEFYJCgI/+Ak1vDTCQAjt7SBgXdG83GswAFiTZJU3TRBgOoDpOgLPBRzeQ0OErJAACY6wbfFm0QAAOdtOxwbtiGbft6CYNhOB4aRsRLdJ8S0YAVV4JjeDAMF0X0UgK06ABuRjmMwHB2PULjeKkZiYxoABZQQ3hMDhMCEziU1E5jeArSo0GtXgGLE1SmIEmBFJEvi9JYtimWE5STN4VtghU5iIBkjStJ00z9LFIyrN0my7JVWyQjqEAjDYZhRBgAB5fhyjuSzOmCUIzkOUJhF8CAAmhWENBJMhkTRTFqL1WjMiJLKCxy+jrNY+JPJ46yDJq+ymIkmBpNk9h5IwBrrPUmSXOs1T6ospTau81SqsMobjO8/zGt4RzLV69FXLcwaOKm1SZr8+LAuC/cwsi6LJpTbbEs6ZKVzStdOXy3VcSKsQBSFUUcAq7zxq67zVti2bmta4oOo+1Ses0pb+v4jyjpGtyzOqyHZs27z5uc0HRvBwS4eshH/NmXbQtPA61jW46ApS1cWhVNUNS1KjbsjBgqE3bsLStW17UdZ03Q9L0fT9AMgxDMMCruoZ6ZAGMtSQAA2ABmECUzTTMcyg/NC2LQqRcQisqzQkB60bBFMwAdjw6guzNHtiOoAczRhUgIBwLUMD4JQoBcOAtPKataCyAAhGxpfjDMUOUZhq0AqAoEArNsJEbDAOlmAUIAUST6tsPjSXDf4ZQw/4aWs0N+MRBQ8o/1jJBsNlkBkzApBDdzaDYLNF23YQctkMQKu9cw8hEBQk2DMI3tDRoUibawO2HcwZ2TBRsbzKJqG0YmxefreKSZP+9gFIx7zgb61H3PR1ewaY97d423zEacxbtNP18IZP6ar/8suJcQDNANravQIVzuG5VngYomsO6QW7pkLC/cOymwIubIifYrZj11noAwZARCGxQhmOw7A57MXPk/Aaj9vrWV+pvOS29OoX2YvvXBpkvrDVmvPWGBDmII1UkjW+y06FEIYZjF+wQ35xk/krGuf9EzKxgoWNBGCsEmBAVWMBGEIG92NtAwecDh4kULLbe2ZBp7AjGFsGqgjFbYTlrXD+Os8ySLwJSEE0QwTyKQErcBTZe5QPwlWEAn4yAYBHtbEAOip5OwMdKZhsUTEf2juYv+QcAE2LNHYwxjj25VhcUotxqEB5mwIPA/xSCgl6JCdBLSi8BFUHFkI+M39RHgUgtYpuIASlOITOhfWkDsmwO8V+PxWimAT10Y7Z2kwarlLFv+TM1SYl1PiY05pqSWxtJ7lktROSLYINHoWIcBh4LMHHDASc04Dla3nIuA5y5UrpQ3BAE0eAdx7gPEyY8p53YXivG7W895HxvGfKQV8u5eA+O/L+CpEy+6ATMT/eWMyJGNN2S0uJusMkGxrJ0rxQLemIK2Sg75ezeBLiObOGApynAEoulchmNytz3N4PuYcR4TxnjeZ4D5d5iW4t+f8j8PSQXjPLuCyFtSkD1MboWeFCzLFLOUUgasrYQjINgHgSmmoDDABphGUsBhWwCDtrEXgAByAAAg6J0AZub6pVCqbZ2kOXaquGrYW+JGDLRbmedE+qva+39oHYOodw6R2jrHeOicU5pwzlnHOgE84FyLihfVFA+LFHRNIzB2CE1iSSWEia+rcb7X4PGy1YBC1MRKeiZAHraA2GrMofghdsLYQzJLJ4gEjDxlbdhSWksjBZmltLasKdmCAUlswDMldsIoX4ChLMGYYD6pCH5bghbdkqkNCSZgSBQC9DAHASIeBNIgFbK2IAA==="}
declare const erc721Abi: {
  name: string;
  type: string;
  stateMutability: string;
  inputs: {
    type: string;
    name: string;
  }[];
  outputs: {
    type: string;
  }[];
}[]
// ---cut---
import { useReadContract } from '@wagmi/vue'

const { data } = useReadContract({
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  abi: erc721Abi,
  functionName: 'balanceOf',
  // ^?



  args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e'],
  // ^?
})

data
// ^?
```

:::

You can prevent runtime errors and be more productive by making sure your ABIs and Typed Data definitions are set up appropriately. 🎉

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/typescript.md","from":22015,"to":25793}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"a8bdf07964e5e57f195e43b7354ec3ed1fdcf454f5eca95c72e560cff7e4b73d","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgAlGMygBhSWlLMxAHhGS4aXswBG7XnRpgocXgEETvAD69SiqJNYZpYANaQA7mDIALoUAsJiEmAAcswAtjBm9DCW1qpg6ppoAGLh4pIx8VrG7KEAOiBYgi7ljrzlROwwfuUAfKHMpADm1ubJVrxpGWI5onlgNl1wRSZlFVUwNU71jc2UYaORBTBtvLpg/OydiRb9aQdHALwDkuehsqwwYgAizGjMvFcKSoMaz6/M0xK6wi+TiMHakxaLUYWA6YJopDgAH0APyIXgAVVkXxUal+aAACnD4gipsVQkINqD4hDuqE9rdePdHmgXm8Wtx0Vj5K4fpkFGgqmAACrYGCAim5TZg2lwO4wB5/dmlMDsWJYCCkAwyHnfPGZSggNwiBCIAhoNBYOCIAD0Nr8zE6sXYADo4PgbURBDAbcwsOwbYQIN44DadTi+WJDfoOgxEABOKgPMCdND4JAARgArFQ3l0YHGQOHefqo0n2GBcIgAAxUET4OFiMhIeMAXwo6DFeEIJHIufMTDYnB40mxJfS+K0LiU7k8qBVvEXzlcs94YDB6PKRjYzFEMAA8vxygBuBdL6duMAeXiYHCbkCUkFgE9nxcX1cxmgAWUEbxMHEwe8GiaF8pHPFcr08CtKjQa1lxnSDeHnMCl3AhDr1vGB7yUKAXDgOBQNQ1D30Q9d4nvCAAjIQil1bIJTxQ+DL2vCBfxguCSOvZCiLQ5jPEw+9BArNAACYswANhoxc6IY9teGAV8mNXMisLqEB2DgGwsCwUhiBgKAsk1GxWFYKSlMQgS1MfMYzM4zxPxgH8/3YACMCAlZbIg69oN/DivLnBTGOI/ybzFbCoFw+ACJABieLfEKVIoqjSDMuTAri8yMLCtScLw6LYriuy1w3NSIBwDQ0E1VL6MUorWMtXz0SK7jCpCyytwgCBTJixSZJVNLaoSkryk6AstJ0vSoE89D+Oy8prMiaa+KZN5v1/YpXPckCesYoqfNgpqQuQF0Tpq3aQvq9jDpmpCTpdM6BsYu7ZNCdKl2e/qQjU7dWF3EQDyPEBaju3gAGZeFiTUEhBpZqGDZIMTkABJcpQmayjK1IdE7qCYGTt4DMIah3gYcyudKu8ZIkagbHTtCM5DlCSte2hWENBJMhkTRTExz1CdMiJdmC05rQ7o5LledxfmxAFIVRRwUWTpaFU1Q1LVR11KWhgYKhjVNc1LWtO0HSdV13U9b1fX9QNOpDMNJcjHWQBjLUkAAFnEpNklTdNEGzXMOlGwtiz57XDQ4SskBEusG3xZsa3bTscG7PS+2oAczRhXTyswPhimu5aWvim7Eu+nc90PJbV3ah8pUkKvEIcpyNvYQC1OA1YCuL5b9r8m6i6Ioqa9yqKzOCkvhpADHqJ21C+vOm7LsasmkLenih7mothLEyTZ9oh7XsGifyLUjTxt0kgDKMkyG6yu8rLr589+7j9Vsc9b/1btz2485+V97guq4B7j2WsPCKeUx68WUpPaeKU/6PQyhve+5QR74UgS/UiMDyqvCqvAs6IDVxLwOivYBUCLKbyMJ1bqXdeDzwQWQ68pcRpjW0hffSt9ZrINrlSJ+NCipNw/i5L+W1O5Hx7mAK6JCcZ8IumxZezVpH9UPk9E6L15KKQ+mAOi0Y8xxnEp7EAyYfZIFBgHfMhZijhwrFWUxIB6yNgRFHRO1Auxmh7M2fs9A8B7H0GYUgIgADsIkMx2HYIAxCA8ipMJAD9P6AMOGhS4Qteuf9+Fv2bp/NuyxtoyJugAkha9B5tU3qg/KikCGYJPuUWB1VcnLSIX3QuhSKl31UuUIS6Qd61KUeohey1oln1YZNQypBjLULEdXTeyTeETMbukwRm0f45Nmd5CR8ijrNIYZwtpIBSnoJXtEmp8DlGIOKVwvZf8WmeEOdgyqcCaHzyubwBp4SuKbIwa0+8lCurdK0ScrZxUqkgCDufSaCSa7TISQI5yizsmiL6aufJCjTp1MIXI4hyL7pqMKZo+hi5cVBB0bGJAASMxexTGmFsZig54DIIE4JoSrGR0QLY+xcdyCIACc4zCtLSC6TTi7OMAAON25LjF+2jnY6AVYRJCpErWB8LlkhgjwBWWAtAXSwUNOwKAvLSAAFpZXyv1RmasEkTUiUNDQLxZp5YJAAORbnLo8SuIB7W8A0muCABguBwEOOuIwDwbwQESQ6p4MAYBYC/MwDARgeT8C0E636FdAa1HKIMial8RljMWGpEFQzL65uqclV1aa4aUzAIjFGQMnDCFgAcSsUAWj2pdLwJ4OreAYFYhDRQUhHUxPLv9V19qUThxgCQVgerNRMqrKKuxsdMjxxEty1xBBU5WoziALOZUyC52BGMLYXznUiFdUS12iARVispRK6lBY8DTK2DO92McHFLronWaVqr1SagMMADWEZSwGFbAIXSsReD2oAAIm2dBbGAjrnxgBDlrfEjA3r5z8fSkJMwzwPpKva2JlYT38HtRQfq3BDQkmYEgUAvQwB+skHgLVrZWxAA="}
// @errors: 2820
const erc721Abi = [
  {
    name: 'balanceOf',
    type: 'function',
    stateMutability: 'view',
    inputs: [{ type: 'address', name: 'owner' }],
    outputs: [{ type: 'uint256' }],
  },
  {
    name: 'isApprovedForAll',
    type: 'function',
    stateMutability: 'view',
    inputs: [
      { type: 'address', name: 'owner' },
      { type: 'address', name: 'operator' },
    ],
    outputs: [{ type: 'bool' }],
  },
  {
    name: 'getApproved',
    type: 'function',
    stateMutability: 'view',
    inputs: [{ type: 'uint256', name: 'tokenId' }],
    outputs: [{ type: 'address' }],
  },
  {
    name: 'ownerOf',
    type: 'function',
    stateMutability: 'view',
    inputs: [{ type: 'uint256', name: 'tokenId' }],
    outputs: [{ type: 'address' }],
  },
  {
    name: 'tokenURI',
    type: 'function',
    stateMutability: 'pure',
    inputs: [{ type: 'uint256', name: 'tokenId' }],
    outputs: [{ type: 'string' }],
  },
] as const
// ---cut---
import { useReadContract } from '@wagmi/vue'

useReadContract({
  abi: erc721Abi,
  functionName: 'balanecOf',
})
```

## Configure Internal Types

For advanced use-cases, you may want to configure Wagmi's internal types. Most of Wagmi's types relating to ABIs and EIP-712 Typed Data are powered by [ABIType](https://github.com/wevm/abitype). See the [ABIType docs](https://abitype.dev) for more info on how to configure types.

---

---
url: /core/api/transports/unstable_connector.md
---

# unstable\_connector

The `unstable_connector` Transport connects to a JSON-RPC API via the provided Connector.

For example, if the provided Connector is `injected` and the end-user uses MetaMask, then outgoing JSON-RPC requests will be sent via the MetaMask EIP-1193 Provider (`window.ethereum`).

## Import

```ts-vue
import { unstable_connector } from '{{packageName}}'
```

## Usage

```ts-vue
import { 
  createConfig, 
  fallback,
  unstable_connector, // [!code hl]
} from '{{packageName}}'
import { mainnet } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet],
  connectors: [injected()],
  transports: {
    [mainnet.id]: fallback([
      unstable_connector(injected), // [!code hl]
      http('https://foo-bar-baz.quiknode.pro/...')
    ])
  },
})
```

::: warning
It is **highly recommended** to use the `unstable_connector` Transport inside of a `fallback` Transport. This ensures that if the Connector request fails, the Transport will fall back to a different Transport in the fallback set.

Some common cases for a Connector request to fail are:

* Chain ID mismatches,
* Connector RPC not supporting the requested method and/or only supporting a subset of methods for connected accounts,
* Rate-limiting of Connector RPC.
  :::

## Parameters

### connector

`Connector`

The Connector to use for the Transport.

```ts
import { unstable_connector } from 'wagmi'
import { safe } from 'wagmi/connectors'

const transport = unstable_connector(safe) // [!code focus]
```

### key (optional)

`string`

A key for the Transport. Defaults to `"connector"`.

```ts
import { unstable_connector } from 'wagmi'
import { injected } from 'wagmi/connectors'

const transport = unstable_connector(injected, { 
  key: 'injected',  // [!code focus]
})
```

### name (optional)

`string`

A name for the Transport. Defaults to `"Connector"`.

```ts
import { unstable_connector } from 'wagmi'
import { injected } from 'wagmi/connectors'

const transport = unstable_connector(injected, { 
  name: 'Injected',  // [!code focus]
})
```

### retryCount (optional)

`number`

The max number of times to retry when a request fails. Defaults to `3`.

```ts
import { unstable_connector } from 'wagmi'
import { injected } from 'wagmi/connectors'

const transport = unstable_connector(injected, {
  retryCount: 5, // [!code focus]
})
```

### retryDelay (optional)

`number`

The base delay (in ms) between retries. By default, the Transport will use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) (`~~(1 << count) * retryDelay`), which means the time between retries is not constant.

```ts
import { unstable_connector } from 'wagmi'
import { injected } from 'wagmi/connectors'

const transport = unstable_connector(injected, {
  retryDelay: 100, // [!code focus]
})
```

---

---
url: /react/api/transports/unstable_connector.md
---

# unstable\_connector

The `unstable_connector` Transport connects to a JSON-RPC API via the provided Connector.

For example, if the provided Connector is `injected` and the end-user uses MetaMask, then outgoing JSON-RPC requests will be sent via the MetaMask EIP-1193 Provider (`window.ethereum`).

## Import

```ts-vue
import { unstable_connector } from '{{packageName}}'
```

## Usage

```ts-vue
import { 
  createConfig, 
  fallback,
  unstable_connector, // [!code hl]
} from '{{packageName}}'
import { mainnet } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet],
  connectors: [injected()],
  transports: {
    [mainnet.id]: fallback([
      unstable_connector(injected), // [!code hl]
      http('https://foo-bar-baz.quiknode.pro/...')
    ])
  },
})
```

::: warning
It is **highly recommended** to use the `unstable_connector` Transport inside of a `fallback` Transport. This ensures that if the Connector request fails, the Transport will fall back to a different Transport in the fallback set.

Some common cases for a Connector request to fail are:

* Chain ID mismatches,
* Connector RPC not supporting the requested method and/or only supporting a subset of methods for connected accounts,
* Rate-limiting of Connector RPC.
  :::

## Parameters

### connector

`Connector`

The Connector to use for the Transport.

```ts
import { unstable_connector } from 'wagmi'
import { safe } from 'wagmi/connectors'

const transport = unstable_connector(safe) // [!code focus]
```

### key (optional)

`string`

A key for the Transport. Defaults to `"connector"`.

```ts
import { unstable_connector } from 'wagmi'
import { injected } from 'wagmi/connectors'

const transport = unstable_connector(injected, { 
  key: 'injected',  // [!code focus]
})
```

### name (optional)

`string`

A name for the Transport. Defaults to `"Connector"`.

```ts
import { unstable_connector } from 'wagmi'
import { injected } from 'wagmi/connectors'

const transport = unstable_connector(injected, { 
  name: 'Injected',  // [!code focus]
})
```

### retryCount (optional)

`number`

The max number of times to retry when a request fails. Defaults to `3`.

```ts
import { unstable_connector } from 'wagmi'
import { injected } from 'wagmi/connectors'

const transport = unstable_connector(injected, {
  retryCount: 5, // [!code focus]
})
```

### retryDelay (optional)

`number`

The base delay (in ms) between retries. By default, the Transport will use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) (`~~(1 << count) * retryDelay`), which means the time between retries is not constant.

```ts
import { unstable_connector } from 'wagmi'
import { injected } from 'wagmi/connectors'

const transport = unstable_connector(injected, {
  retryDelay: 100, // [!code focus]
})
```

---

---
url: /vue/api/transports/unstable_connector.md
---

# unstable\_connector

The `unstable_connector` Transport connects to a JSON-RPC API via the provided Connector.

For example, if the provided Connector is `injected` and the end-user uses MetaMask, then outgoing JSON-RPC requests will be sent via the MetaMask EIP-1193 Provider (`window.ethereum`).

## Import

```ts-vue
import { unstable_connector } from '{{packageName}}'
```

## Usage

```ts-vue
import { 
  createConfig, 
  fallback,
  unstable_connector, // [!code hl]
} from '{{packageName}}'
import { mainnet } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet],
  connectors: [injected()],
  transports: {
    [mainnet.id]: fallback([
      unstable_connector(injected), // [!code hl]
      http('https://foo-bar-baz.quiknode.pro/...')
    ])
  },
})
```

::: warning
It is **highly recommended** to use the `unstable_connector` Transport inside of a `fallback` Transport. This ensures that if the Connector request fails, the Transport will fall back to a different Transport in the fallback set.

Some common cases for a Connector request to fail are:

* Chain ID mismatches,
* Connector RPC not supporting the requested method and/or only supporting a subset of methods for connected accounts,
* Rate-limiting of Connector RPC.
  :::

## Parameters

### connector

`Connector`

The Connector to use for the Transport.

```ts
import { unstable_connector } from 'wagmi'
import { safe } from 'wagmi/connectors'

const transport = unstable_connector(safe) // [!code focus]
```

### key (optional)

`string`

A key for the Transport. Defaults to `"connector"`.

```ts
import { unstable_connector } from 'wagmi'
import { injected } from 'wagmi/connectors'

const transport = unstable_connector(injected, { 
  key: 'injected',  // [!code focus]
})
```

### name (optional)

`string`

A name for the Transport. Defaults to `"Connector"`.

```ts
import { unstable_connector } from 'wagmi'
import { injected } from 'wagmi/connectors'

const transport = unstable_connector(injected, { 
  name: 'Injected',  // [!code focus]
})
```

### retryCount (optional)

`number`

The max number of times to retry when a request fails. Defaults to `3`.

```ts
import { unstable_connector } from 'wagmi'
import { injected } from 'wagmi/connectors'

const transport = unstable_connector(injected, {
  retryCount: 5, // [!code focus]
})
```

### retryDelay (optional)

`number`

The base delay (in ms) between retries. By default, the Transport will use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) (`~~(1 << count) * retryDelay`), which means the time between retries is not constant.

```ts
import { unstable_connector } from 'wagmi'
import { injected } from 'wagmi/connectors'

const transport = unstable_connector(injected, {
  retryDelay: 100, // [!code focus]
})
```

---

---
url: /shared/transports/unstable_connector.md
---
# unstable\_connector

The `unstable_connector` Transport connects to a JSON-RPC API via the provided Connector.

For example, if the provided Connector is `injected` and the end-user uses MetaMask, then outgoing JSON-RPC requests will be sent via the MetaMask EIP-1193 Provider (`window.ethereum`).

## Import

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/unstable_connector.md","from":508,"to":561}<fsm-vh3gqscxm4e>
import { unstable_connector } from '{{packageName}}'
```

## Usage

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/unstable_connector.md","from":586,"to":983}<fsm-vh3gqscxm4e>
import { 
  createConfig, 
  fallback,
  unstable_connector, // [!code hl]
} from '{{packageName}}'
import { mainnet } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet],
  connectors: [injected()],
  transports: {
    [mainnet.id]: fallback([
      unstable_connector(injected), // [!code hl]
      http('https://foo-bar-baz.quiknode.pro/...')
    ])
  },
})
```

::: warning
It is **highly recommended** to use the `unstable_connector` Transport inside of a `fallback` Transport. This ensures that if the Connector request fails, the Transport will fall back to a different Transport in the fallback set.

Some common cases for a Connector request to fail are:

* Chain ID mismatches,
* Connector RPC not supporting the requested method and/or only supporting a subset of methods for connected accounts,
* Rate-limiting of Connector RPC.
  :::

## Parameters

### connector

`Connector`

The Connector to use for the Transport.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/unstable_connector.md","from":1614,"to":1758}<fsm-vh3gqscxm4e>
import { unstable_connector } from 'wagmi'
import { safe } from 'wagmi/connectors'

const transport = unstable_connector(safe) // [!code focus]
```

### key (optional)

`string`

A key for the Transport. Defaults to `"connector"`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/unstable_connector.md","from":1852,"to":2030}<fsm-vh3gqscxm4e>
import { unstable_connector } from 'wagmi'
import { injected } from 'wagmi/connectors'

const transport = unstable_connector(injected, { 
  key: 'injected',  // [!code focus]
})
```

### name (optional)

`string`

A name for the Transport. Defaults to `"Connector"`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/unstable_connector.md","from":2126,"to":2305}<fsm-vh3gqscxm4e>
import { unstable_connector } from 'wagmi'
import { injected } from 'wagmi/connectors'

const transport = unstable_connector(injected, { 
  name: 'Injected',  // [!code focus]
})
```

### retryCount (optional)

`number`

The max number of times to retry when a request fails. Defaults to `3`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/unstable_connector.md","from":2426,"to":2600}<fsm-vh3gqscxm4e>
import { unstable_connector } from 'wagmi'
import { injected } from 'wagmi/connectors'

const transport = unstable_connector(injected, {
  retryCount: 5, // [!code focus]
})
```

### retryDelay (optional)

`number`

The base delay (in ms) between retries. By default, the Transport will use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) (`~~(1 << count) * retryDelay`), which means the time between retries is not constant.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/unstable_connector.md","from":2884,"to":3060}<fsm-vh3gqscxm4e>
import { unstable_connector } from 'wagmi'
import { injected } from 'wagmi/connectors'

const transport = unstable_connector(injected, {
  retryDelay: 100, // [!code focus]
})
```

---

---
url: /shared/create-chain.md
---
## Create Chain

Import the `Chain` type from Viem and create a new object that is asserted `as const` and `satisfies` the type. You can also use the `defineChain` function from Viem.

::: code-group

```ts twoslash [as const satisfies Chain]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/create-chain.md","from":242,"to":2021}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"b104f720769e0d28b42cc38edb3952d146e5b9902d8a7bead95767460071c100","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAJMcvAML5m7MAB4AZhFIBbZmhqk4vOjTBRVIsWABishUrKqAPrwCummFPEwovALzDR4g/MXKzl67bD2KXgBjCzg0CDk1ehhNVQAlGCDZKAkw0nEAc0CrAGtIAHcwAD5ecytYP3snXgSk0hS0zOywPIhCkrLfOygS52AAHTBeYd4AI1YIIJyAUVosCdITAH5EXgGhkc3kHJgMVcawDIBdVZ1xACEJqdn52TIAbkHNzYrmC1Y0U9cwS8mZuYWDyeIwAvqUfBVuo8NsMkmA0KRmEE0HAVrwAAqLJTsKQYCTrZ4jba7fYIzInFy6IQQeGI5HggmE57IOAQCykIIwACSUFWYAsclGZApZzA1NpSLQ4PKNihwMJYM6kP8UGhmzBADI1vLnjE4AkMuw0hg0aLxQjJdKuiq1Uy9QBVMDsEgqNgJVmsF2m77mulSpWym06zZyd5odhBNisADM3qpNIt9IDlVVOpBHQhgfstuGADp87wAJy8OR3Xj53M53hSGDwONuWtwaSGTwmK3K+wZmUp6EgwbsORYWRS0WUEBhZikBiIACMABYqKwYhk0PgkABWKhoScZGDTkCjxd2JAABioQVEfrISHnIIo6GwuEQBGI1636jwcLCJd0/k+axBMcJynJA5wADkXZdVyQAB2Lcdz3PAFHEP8xw4fwkAAJnPS9JWvWdozvB8cDwQgXTHGh6DwAQYGCGlvz6QCqGA6cADYFxAJdDmgxBN2oBD9y/BgjwwxBsJAC9Jzw8gxMLIjqEfPAyFIWQgO3EDEBgs9OKgtdEELc9oCfGdo1Y7TbC45g5CfEBxFgWhcxRMd2CgJTSFIABaEyzI8sCYI8wsKI/Z8ABVH14AByYAQQi3goAgeBeEgKU4EUI1cX4fBaLoHBkSqGjItFCLc2BMLBCimLeCNEsjTgTJMtomRWAmfJ6qwFScCndhEqkFTIgKiKitWFzAjAKyYFGtKSCEdlFjAIIMECUgsCCe1SFYBBIJIVg3JU8gRKfcTJKvGTo3XeSaNI199uoYKQBYDguD4ArRWbDxjBUKINC0Sk3BbD7vG7bpqlFdwjC8dssygQIQjCCIvpiH7amSVIyUOZpWnaSGU2qZH6lR9J0Z8THimx7pem1GExiuf5bkWFQ0UZQliT2XgDmOL5dF+a4ATuUgqxeGw3g+TmLhpm5AX5tMyaDKm4UTFE0UxPdw1xfFgyJHZWfZkUfQTP0GQ15nWXZTkeT5AUhVIXX4wlJNMx7I3eEVB25SpzVKaZNQwH1GBDWNesxX1y1kzdr2HSdF1UtYd0IE9MhA99EPXdlr3Qw+CMo1jUWg7t/0U+zNMu2tQuqYrIsSzLCsqxrOsc70Rs3vBttQ5VYuO1TMA+ydQdh1+sA1MnacwO0riVz0vj1N3fdD0448xJwqS8pkudzqOQzYDwAchynNZ+HC0VnerPrIqIbq5AiwZBhyvuhJ/FC92qaLeC4OifZStK4FsRLZ+s7ckFAOoPU7AaTUQQCCEEQA="}
// @errors: 1360
import { type Chain } from 'viem'

export const mainnet = {} as const satisfies Chain
```

```ts twoslash [defineChain]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/create-chain.md","from":2054,"to":3714}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"51816265e78622b289e1e5f943b76d80bfbe0a867d81b51ec6327613f6e28499","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvWP3ZgYAYXzM5AHn4RSAW2ZoapOLzo0wUQ0pVgAYpp16ycCrxGS4aZ8rlH6MU+c9g6ra6+nAAfGGMIgGIHpbcsQAKpDB67PwYqgCCcHDsAOaBFmrCMnIwUGFO0ZYRADpg7FpYmu5l8sVglCBuzKQMiACcVKy++Wj4SACMU1RoffmpeO2KAd0c8kgADFQ1pMxiZEiDAL4U6Ni4iATER3PGeC5gbrw6cvJoscANvL+8AEasCAiADWAFFaFggSkDAB+L4/P5I5AgmAYWJuUhyfIAXVinQAQkDQRCoZoyABuRFI34yZiCVifXiE4ngyHQynU3gnXgAH14pRgsnkUD5AtMQvKUCpUj+TzQ+zEcHhvG+sppvGQtAxCuxeOZAQUkgVB3c/LVGo1yDgEEEpBEMAAklBYmBBFp/mR9Z0jWATWIxYLhRUZZbuYGJcHpVykb44AAlGD5diYjAqn3GxVm8UraPqmlxgCqjRIBjYiZtrFL6cNmdNEdzoctWgZ4hEbFYAGYa5Zff7s0GpU3fjz+YORcPeOwXbw3R7OfmAHTL3gADle5N4y8Xk/4MHgPbkVn3cFU27CDclE4aJ26vX6SAALMMQKMwONJogAOxzBZLa5vGAHzrOUSAAEy7MoWZHIgUydmcFw4HghClt0ND0EwbCcDw0hXqsliqJ0NjaCEDhOJ0hEBMRdihBEUQxAaBFEcE9gGGECSqlygLAmyZIwsqCL5siqLorwmJ6viAREjxpIcqQk5InSraSZY0kkuy5LyVyo45nhopjpGQ5cvKWYCZxQl/FqOpYu+3q1n6WZihaYaWTadoOs6rrup6pB2b2dYBgZjYxn8OnjiGIW/HGibJqmh5gH2jlBXpCl/EWJYOOW8AQFWZDxYl9bJVGqW/C2jLsO2rBdvlAUDoZ175mF9URUuK6DBuKRbsuu4nvFx7wGey4XkVRlgCcDRNC0/S4cGnR3vMD6IAArC+b4ftMszUH+AwgCsc0jKBiAQSAeymjBYHwec1CXHgZCkJo819AMX6bWtEzgbs0BXBdj5LVQshvswWhXCAciwLQi5oAgVDTrdpCkAAtD9S0I6uq5I2hDzXFkpD5O6vjuBA/C8JgOC8AA5MAJzk1OhiQO4XB5IUzCAjAJMQLwWB9EDqRkLwRMk5cFMUcxJGseE5OLoiAAqQuU9TtOvCmeTviT+BsxoVUQAA7tinP3Tg/TsPAAj3Vogtk+TItUSxtHk7E05OGAPNO7o7AkAodopKIGBOKQWAiIWpCsNDr4wCQrBw/d5AHZsR2QdzhzkIgnZLScOKfbAeCTa0qozeUnThvwZsU0QxtaOTDQNHQU3uE8LyAR8vAALz5x0ASMFT3DdMD8xIKAxhxhIXTXFDIAnCcQA=="}
// @errors: 2345
import { defineChain } from 'viem'

export const mainnet = defineChain({})
```

:::

Now, add the missing required properties to the object until the error goes away.

::: code-group

```ts twoslash [as const satisfies Chain]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/create-chain.md","from":3863,"to":8924}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"7eb538e5797ec32b451699fd0f71747694cdee2f09698daad95d805d237f68ce","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAJMcvAML5m7MAB4AZhFIBbZmhqk4vOjTBRVIsWABishUrKqAPrwCummFPEwovALzDR4g/MXKzl67bD2KXgBjCzg0CDk1ehhNVQAlGCDZKAkw0nEAc0CrAGtIAHcwAD5ecytYP3snXgSk0hS0zOywPIhCkrLfOygS52AAHTBeYd4AI1YIIJyAUVosCdITAH5EXgGhkc3kHJgMVcawDIBdVZ1xACEJqdn52TIAbkHNzYrmC1Y0U9cwS8mZuYWDyeIwAvqUfBVuo8NsMkmA0KRmEE0HAVrwAAqLJTsKQYCTrZ4jba7fYIzInFy6IQQeGI5HggmE57IOAQCykIIwACSUFWYAsclGZApZzA1NpSLQ4PKNihwMJYM6kP8UGhmzBADI1vLnjE4AkMuw0hg0aLxQjJdKuiq1Uy9QBVMDsEgqNgJVmsF2m77mulSpWym06zZyd5odhBNisADM3qpNIt9IDlVVOpBHQhgfstuGADp87wAJy8OR3Xj53M53hSGDwONuWtwaSGTwmK3K+wZmUp6EgwbsORYWRS0WUEBhZikBiIACMABYqKwYhk0PgkABWKhoScZGDTkCjxd2JAABioQVEfrISHnIIo6GwuEQBGI1636jwcLCJd0/k+2phXhFmYKAaVYDBeHYXleBnKtgNAsBwN4MBmDkGBVn6EBplXMgYAFTC4JgECwIglDwxIIR2UWMAgj2ACmSAoiEKQlC0IwrCcNIAjgxGeCSN4OAMEFCBWHY6YABUAAluMAzY+MQiDYCCAc2DgVYZwADirEFCOIhSgKwIJ7VIVg1Popl5KQ14w1WRkGOGSyIPwJQsFWRzeGQTDnLQLA1IAej8vd8FzNDSByJdc3YCBMKOKt1W03TmIg8Y/huQEVFsniHKY/jrI+TLZIsnL9NY9DeEw7D8BMSMwBk+zeOKpD2VE8qCBc/zAs4uAasi6KQDi0EEp1dy4UTFECoY9y9QNI0ETouz7PckCoEWOAzMwk9aBPbadt2k8hAAJmmE8AHY5xgIQADZCwAQRPKA9FGA7C0LE7zhuy6hBOqADpgGcYDqpkdKyxi9KQh0nRdOA3XgESXQm+rQaS3hltW9aQE26Y5xuoIoCgS7NNgaYABFzsun6pBPaNRkLUYpEug6oCCAnNL0IRbrnKBmEB+r3JSqYhGAmhoJnS6TpO6NxfXAbhmBwrsrBiDQw+CMo2jBH6orGXeDl+LBhBMcJynJA5w0xdl1XJATq3Hc9zwBRxD/McOH8JADvPS9JWvWdozvB8cDwQgXTHGh6CYLBSAgHApwwPgoL5AUhXIKhQKCBBny5YnIKGflBTIatDEN7djcQBnzcOS3EHd6hbf3KDnePRBow9ycvfIKu/eoR9A9fZPqA/Z9GAjqOyEwPhStJdJDjHVP05ASSBWYMAAFp4OYcYYGQ1DcCoI3pxOmdy5XNdEAXGvSF3fdSob13T5bq924OzuBCfF9g/fMPB+H6Ox638iLqojEWiXxdAADlFDOgAaQaitEZ6TDnpRaBQCIKhCqKMCCF5dBF0nNOQsh8QBLgrifecNsL522fGRSBiCYEYBvk+TcIBMEPzds/buz4g5vn7p/EAQ9I4/1jlvNiAkyTT13sXacM4TyFiPpXM+xdL54GvkeW+DCmFtzdieVhAd2G9xDgPHh39R4CMEsJFqBwMhwLTngA6y9LrBE9siNsExRHjnETeA6Z9CHHyQJdUhCjnwmNGCJOhG577qKbuuLRr8OF91DvuXhI8Y58CUipUyCc859z3jeaM0iCEWxPmbc+/iQApIUKZEJiBVEOOUBuTR94u7aLfpwuJ4c+FGL4KQQyxk0nmWGMSOi5iRTfDiF0kycAqx5X/KKEZRkxm9ksQgkSS5kRRSGBAKQNR0RCDUJoIc4gUTYJLjOdc1s8lEKtn48hIBOmzPKcop8vjGHVO9k/epL8e7vy4fEwxSTeCTJAeIGZ3SEBiJwTeE61cvGV1OfIq5kyKmnLUY49uc4okfOafohJ/C+DeVckjfi5jkBHEORIjSzczneLvkUq5uKEVhORTeSJby2FNNiZin5v9+b/FuIsFQaIFr9MnuSAFPwrjcvShMmwbx8qUguGKtKdxSC9nbFmKACy8DUlYMs8MNJeDrLGGKqIPKTAkrdgdBhULiFyNrngLlCreUgoIY3XJSKakd2ZY0mJejuFYvaX8qVNlZWitSgCRVpqq5zlOZai51L9zwvuTeM8TzW4MtPminRnyWlfzab8iewip4WNBSXc1hTo1UthVfbeFTJH0rdcc9NrLvXfJzb/ZqQqXFZKruLGRJ9yUVrwM1atSbXXe2jKij10TdEf2bYk3+o0/Sog1h5Wg7bjgit9JacwC0tisnZJyHk6Sk5DPjBKJMmYexphVRewC00YCGmNPWMUCY/RXrlDesAcBHSQNdKwd0cMyCPo3We7sb6QxhlVlq2M67n2bvPW+xUcGVTqufJq7Vqy9UbPnZKR1nbozHJ7UgXJ/bnxYeRI6l2T4ZzVxHY/BtXrp2tNnQI29965qAZg8B609hw3RmjJC/JN58HEZACx2apBaEJp9rW7247/aTszeyltAjUbwDMgAA02gAEmAOYkEamePrnJWWmFNrnwqbWtWs+NGfF0anV8xj2KdmfshiYGGHovTQdPf6RD3Gi3TjnDOXJZaDpJuExDb90Nf2w09JwijN5HnWbTRO9FbKfUcuU3jNGqwNO0G07p/TfmTZziCwJxAJmyH7nM+RxuM5EXPPbpdWzCm0tKb4FywWRFhZolzknV9SHCuVJrRSyuVHLn7na0LXzTrb6aWkw1prGKWtMb4MrcMkZIPsa831qbnb1xzgtaVobwnVsQZjBUkLc2TYLdSzOxzVXstaZ0yIjIenw3rkugd85ZWxt4Cq+d/BiXGvJYzYt27fqJudfsN1xO+dkzdHDQzR5ZbRuxttWKjrigptxartR+rNngeNoY8+F+wQaTfj6MNRqEF44wUSvxPNFVOJ4TkDzfFJUIEUUATReaIN3IM44lVLi/VedU4EkJIJLUKpSVZ3JUXpTVLqS0mmOn+kbnAqXbLxW/qpDSv/NuoqWvcVuVF55NqPkOpBRCmQcKMBeoxW1rrQalOtd2tDQ6jXDUtf/N6YtUX/PKrVSXjLg3yM22tVxRbrqPUorB9lkNQCI0OPjR95r5GonjQe8JEtTLqn2KbT2gXw6x0zoXWundB6T0XpvQ+l9H6f0AbC/ljrbWU0P1fqhm5/9pBM/PGzytXPrVMbY1xvjQmMASZkwplTGmdMGZMxZhpNmHMuax976LiHmORZiwllLB3LfRcnfWzGHvmwtYg0d3H/WCOxYEcqT9kjZOGCSfNZdyp12m1MDYJwHg/BHxBubB4MYCoFEBoFoEGu4EYF4Ntg4M4KKBAa2MAXDiqIECEGEBECATEGAbUMkKkM9s0K0O0NAdUNgfULgQWvgQUMUNAb0D7q7sanyj3oKvmsKkGr8NcG7kCE3t7qKGweKoqtpNAVWKRiiGiJiHuOGLiPiCDEwYMp5mNAyCDDumyByNyNBD1sKHIS+kgdmOfoIZelqPrsMOnmxpobBiBkGE3uFh3lFu5gBqYZxh2KmE3ofmrJtvIdoU4eqF2Fxp4SMBWEWCWGWGfoBDWHWCKnoI2AAZAW2B4d4Y4b2P2IOMOEGgjmSrfgwsJoeNNk+C/smswlXDOCCEcOeNAK/AOEOFOGsL/oIKKDrNWJHJEAAOREDsAwByCNGDCDB0AVFShfhSgOxgB/jVCMg06HzAh5qNEB6LACiNEUDjEc5QI0K2SCJlSTGcSzFi6mKrCTFSQbHy49KaQ6xzEbBq5jJLre7AC8BG4eSNER6IABSW6hQ269SNFHBHHAh3jAh0HpRmQLQXErHbFTHdRLwbFh63HtT3GdSC7AlgAvHvEbCfEbDCG/E6jGHiYe73a8CNH54F67RF6nTnRXS3T3SPTPSvTvSfTfS/T/SzFpjHGbBWGuY2Fd4Yk55rTbFD44x4wEwaREykwwDkwHSUzUy0z0yMzMwziszsw3SczMC0mFQb7CzqTb6SwnSbh0k6guGQasn97slYmbSRiSmjCwAnjrivQnSjDRiXR4aiwnQngHQaQaQMxCgHTMC1Y5InSXSGkzjymEiKn2DqRzjRiGaXQnhjGASImyzHFghcCk4fpSjQzhhwC2DwApFUBoTbhICgDqB6irJ4AHIggghAA==="}
import { type Chain } from 'viem'

export const mainnet = {
  id: 1,
  name: 'Ethereum',
  nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
  rpcUrls: {
    default: { http: ['https://eth.merkle.io'] },
  },
  blockExplorers: {
    default: { name: 'Etherscan', url: 'https://etherscan.io' },
  },
  contracts: {
    ensRegistry: {
      address: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
    },
    ensUniversalResolver: {
      address: '0xE4Acdd618deED4e6d2f03b9bf62dc6118FC9A4da',
      blockCreated: 16773775,
    },
    multicall3: {
      address: '0xca11bde05977b3631167028862be2a173976ca11',
      blockCreated: 14353601,
    },
  },
} as const satisfies Chain
```

```ts twoslash [defineChain]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/create-chain.md","from":8957,"to":13795}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"9dd120cd705dc697124cfe3fa80116ed4046ca81c57ffb5daa2cfd0b2775f253","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvWP3ZgYAYXzM5AHn4RSAW2ZoapOLzo0wUQ0pVgAYpp16ycCrxGS4aZ8rlH6MU+c9g6ra6+nAAfGGMIgGIHpbcsQAKpDB67PwYqgCCcHDsAOaBFmrCMnIwUGFO0ZYRADpg7FpYmu5l8sVglCBuzKQMiACcVKy++Wj4SACMU1RoffmpeO2KAd0c8kgADFQ1pMxiZEiDAL4U6Ni4iATER3PGeC5gbrw6cvJoscANvL+8AEasCAiADWAFFaFggSkDF8fn8ESlmFBJKwMNIYPxmIJWJ9eN8pAiib8kSiwGjeGBmFoYLE6iAwRMHCJmGB6QBueHExEwZGo9GCUisOkEPRYOCIAD0ktS+GZrIAdBIOVyiSdOYTfurVU80PsxBL8aqeXzyejfHAAEowfLsNykDBwzXckm8skU5FQFK5EVbWhbAOBoNbBQAJjBWwA7AAWRQANkGWS2UCs/1Dg0GkYAQlk4wpI1BQzApjAVc6Edry39SfyjM8AKqNEgGNjWuAQVjNp0uk3u9Ge72G+l+sHRrIiKBQONTAAcsDBABFY3HC/wtgBmf6Df78OOhqAiaezqwKRPRqDMMs96tu2uA4EghRImhQWJTOORyPrz8AVg1LsrF0azNV4cXEFlWFYddu2vXhgI9SdB19WgWRmf5YC2H9M0jf51zjdcZg/LZQxnGc93+GBQ2YKYv0zONUKmK9YPg9F71BJ9eRfN9o3XH88K2KZ/25QC/hE352FfXhBNVKkaRFRk5RSQQtCY34qXEEgFEFFJREdI0q1dU0KVk2leHpBSyFUokWN4OAMC0f4O3kgAVAAJKze1rWARCaNhDVnIStUC3gFVC3g41eTQYBC0Lgv4GB4AAfliTorASuBVFChUwl4AAfXhSkxcooA1E5ul6fokGjYYQFGMBxkmRBIzmBYlmuN4wA+dZyiQUNdmUfV9GmdczguHA8EIZtuhoegmDYTgeAxWQOgCVRUuCewDCcAlPJAiS32CmyTPkpklJUkBDtvED1PYTTtN8EQ9J27kjupUzzNOjybyM9E7IcpyzIZNyvsMvsMR8nRWH8mdgrEuCropUgsBEeshUNZ7iRsmRsVxGDrxs/AxViGzkHpQm0HFKUZQmBUaVIEFRiVCB6QAXWCitYcun6ASBUEIShKLYX0oCEfRbGwLxntXrkwGLIMFk2Qu40XtFgqhRFcnKelWV5TAJmQd4OG4Zs3VBvR5XQdrC1rVte0not6zVYHeAhxAP1gw9sMIxjeNE2TVN00zHM8wLIsSwNuHdopC1G1uhxW3gDsu2F5incQl3kNHcdJ2nOcYEXZdVw3Lcdz3A8jxnE8zwvA2o9Y3nH2fCo3w/L9f3Z0SO8tkCtDA9gIKgyWXSyrvDc5hoTkiGo5Elmz9qkrmweO2XTpgZSrNejTFHu3Sh++pe3pOxSDZsv7HOFWXgaVgz4e57zfKht8YdVY3VaRlG0b37uKXF3GU/x1Wmtiaq1JqKCmEptY0zpgzGA+sQBswdkbRed4G782hA4L+t8wa/zxBjKWqtl4fUUnABWtd961kFBfMmYoIHU2IQrOBo8kGqhNpIPUBw0DmxvjZa2No7R6ntjfOuvBnY+kBu7D2QYvZRljAoBMSYUxpgzNmXM+ZCzFlLNfACo8eENibPHVgbYk5kEwcI0RrsRxjgnFOWc84lwwBXKGNcm5ty7n3IeGYldTxZHPJeLRqduZsUbpxZuUlW7fkjH+RBOjVa91xP3Ngg9/49hHtEl+pUEjJNSWAE4DQmgtH6EtconRyrzEqogLCIwxgTGmLMagrUBggBWCUkYPVEB9RAHsDhRx2kjXONQS4E1bjkHuLNa4jAsCkAgDgfoGA+DzymKUvoAxIlVPqjU9pLVSCLEaRJbqmxEDrn6n0bp5B2mjQGeNa4k07jUAeOMyZ0yyCYD4IQhkq914gCWeUmc0Y1kNSqlsnZeATL7KuH8zpA1Tm9QuZgK5NwpqjMaRMqZMyXmUl0HHLSpAdKPVngQw+K9j7+O/r9ey58XLuRJVgryMAIZ+SfqVb5AwphbAhXVAFiApgQrKcC64N07o4oehgMFSAfzHMGj00MsLBnXOGdNe5IAUVPNma8wlRDLJfKoBVFloYOkco2TyhpIK3qioqRK6F7StgyvhTckZdyxlKseWiuZtlyUA3MlfZlw1mq1WqY1OMQK2o9HdawM14rIUnMOGc3iNqrgItuTNZFzrnmuvvpDaG3quU/n1f6pAM4g2NPTX5cNFro1iutf0uF8a7UKsdcql1fB36o0fskrGmIca4IdgTImNKQKgM1rQ2UtMyAwLgQg50lYyrarKSyyMOw/XrMar63lwbm1ozNYGyNkqznSqrbKhN9qk1MBTaqpanb8XcyAX2ikA6aFU2HdAxmyp4FMpncs6YM4I0GuXYW5YHawJmt9V08tiBoxxqGYih1ybUWpr4Nekm1DwEPqgaO59zN4FZqmIMLdP7AX1O2cGzWQGy1DWzRBuVUHj0PNg2eoJaDBZcOETgzB0t3rvPoayE+qtKEa3vZAzjesX3jxyVm0M64C2Ls5dyv91x6OQnQQYM1NUQNkb3WNGt8qkUnto+iljbaCUyw1fLLj1KbK8cBoOlDgnGETzE3GBdeGmqyaaQB3EZrWWkZ6eB/dtqtPQZ0yq9Fby5YkNM2JyMdSnNGsI400FrSDmee3ZaqYP4KOHrrTBoLrqLNIa1nQ3WcCxODEc3mw5LnKEeYXapnp64fMacg4mxVDa4PODYWbS9YNeG2wEaxtOXoM7iP9JIwM0ifZyL9oowOKiQ7qPDtS1+3MY76JbIYxOnYTHJLMenMRw5aBZ2sbnOxhcnHF1cWXDxx5vG+O44EhuHFdChPfJ+CJUTJ3IJ7n3Ae0EtvkJAuY5CDF0IwEwthXC+FCLzpImRUMFEqI0XXHRBit2wZBIe1xKSPE+IOeku9uz77ynrhIv8jZNVV2NNNhwhACWrhTA6TV3d6Xa3aZo9lvg3X+EOk67WAHQ2RujfDDI32CiA7KODmosOmi309FnUgOr36yszBcxzu2HmjnJdA/Vy5mmqPNdPei3ne3+cBjG7I+R/slFB1UaHDR9Is14Vw2VldxrrjmI8xChnSA4xM/89Rp1unXXLbjqtoxG3SDc/+ztix+2rE51sfnexjjnElzceXTxVcfE1zM6rNHTdJLPbbpE6XOqqpE5J41UMC7yd4CD82OACd2xh481uz3YGfe6/rfr11hu3Yx+zjYvOBcHFFxcaXdxFcM83a1TLj9YG9zl6QM72LeA3c0+mMBqFoHve+Z101zvAe+C55Cfn8Jv4s05vV05unLmj+PagB5yTrft8Nco3vrLjbQLxO+xHhCA3du96Bwwiwk/HBwIme2IlInIkomolokjHomokYmzzuwfHRyeyx34lx2nRn3KR/B/EkyvyrxdxADiXAkSXXDNUry8zOS12rUayPT1wPxESj0BwQOB1BxALwjAKImhygPh1gPgJmDtwJwGB/EjHwKdxc1X1qjaVDDqSf3bzf0Cw/1vwx25V4gwKzXwhqivw6Wrzk3uzzwoPp03zI29xZl2GgHjXyVaHxCKRWksENgECmS0F4AAHIiB2AYAtBXCGgGg6ACl3AngXgOoPheAABeOw1YSwRgZ6BZCgeEZeVwuWNebw+IwkAVbeIVXeWwxIuWVwpwM+AGJItyfI8GB+aGQ2NIkkZGFtJjP4fTYAXga9ZAVwqzATEdemdDVwlmSo+EM4eEeTAWGEOo34BojFGWJI06MLMAUoizVo/jArEzITCAVw3owkfowkSnA0SWFXXrX7XnVwiRfnU3YXC3abcXG3EsfIl+Kov4WvAxUPZOPBX4A4yxfvI7BPE7ZPc7cfdPa7C8a4qsFQp7U/VZG41UEghJSCH7Z4pgv/Q0Q4lCVgoAsHTgyHCAmHOHGAxHOAhiQE4kYE/PdAnHW4rUW4jYk4bgboGkeYJAUAYwC0CQLoa4ThEAE4E4IAA="}
import { defineChain } from 'viem'

export const mainnet = defineChain({
  id: 1,
  name: 'Ethereum',
  nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
  rpcUrls: {
    default: { http: ['https://eth.merkle.io'] },
  },
  blockExplorers: {
    default: { name: 'Etherscan', url: 'https://etherscan.io' },
  },
  contracts: {
    ensRegistry: {
      address: '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e',
    },
    ensUniversalResolver: {
      address: '0xE4Acdd618deED4e6d2f03b9bf62dc6118FC9A4da',
      blockCreated: 16773775,
    },
    multicall3: {
      address: '0xca11bde05977b3631167028862be2a173976ca11',
      blockCreated: 14353601,
    },
  },
})
```

:::

The more properties you add, the better the chain will be to use with Wagmi. Most of these attributes exist within the [`ethereum-lists/chains` repository](https://github.com/ethereum-lists/chains/tree/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains).

* `id`: The chain ID for the network. This can be found by typing the network name into [ChainList](https://chainlist.org). Example: "Ethereum Mainnet" has a Chain ID of `1`.
* `name`: Human-readable name for the chain. Example: "Ethereum Mainnet"
* `nativeCurrency`: The native currency of the chain. Found from [`ethereum-lists/chains`](https://github.com/ethereum-lists/chains/blob/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains/eip155-56.json#L20-L24).
* `rpcUrls`: At least one public, credible RPC URL. Found from [`ethereum-lists/chains`](https://github.com/ethereum-lists/chains/blob/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains/eip155-56.json#L4-L18).
* `blockExplorers`: A set of block explorers for the chain. Found from [`ethereum-lists/chains`](https://github.com/ethereum-lists/chains/blob/3fbd4eeac7ce116579634bd042b84e2b1d89886a/_data/chains/eip155-56.json#L30-L36).
* `contracts`: A set of deployed contracts for the chain. If you are deploying one of the following contracts yourself, make sure it is verified.
  * `multicall3` is optional, but it's address is most likely `0xca11bde05977b3631167028862be2a173976ca11` – you can find the deployed block number on the block explorer. Check out [`mds1/multicall`](https://github.com/mds1/multicall#multicall3-contract-addresses) for more info.
  * `ensRegistry` is optional – not all Chains have a ENS Registry. See [ENS Deployments](https://docs.ens.domains/ens-deployments) for more info.
  * `ensUniversalResolver` is optional – not all Chains have a ENS Universal Resolver.
* `sourceId`: Source Chain ID (e.g. the L1 chain).
* `testnet`: Whether or not the chain is a testnet.

---

---
url: /shared/errors.md
---
## BaseError

Error class extended by all errors.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/errors.md","from":149,"to":193}<fsm-vh3gqscxm4e>
import { BaseError } from '{{packageName}}'
```

## Config

### ConnectorAccountNotFoundError

When an account does not exist on the connector or is unable to be used.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/errors.md","from":328,"to":392}<fsm-vh3gqscxm4e>
import { ConnectorAccountNotFoundError } from '{{packageName}}'
```

### ConnectorAlreadyConnectedError

When a connector is already connected.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/errors.md","from":483,"to":548}<fsm-vh3gqscxm4e>
import { ConnectorAlreadyConnectedError } from '{{packageName}}'
```

### ConnectorChainMismatchError

When the Wagmi Config is out-of-sync with the connector's active chain ID. This is rare and likely an upstream wallet issue.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/errors.md","from":722,"to":784}<fsm-vh3gqscxm4e>
import { ConnectorChainMismatchError } from '{{packageName}}'
```

### ChainNotConfiguredError

When a chain is not configured. You likely need to add the chain to `Config['chains']`.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/errors.md","from":971,"to":1029}<fsm-vh3gqscxm4e>
import { ChainNotConfiguredError } from '{{packageName}}'
```

### ConnectorNotConnectedError

When a connector is not connected.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/errors.md","from":1112,"to":1173}<fsm-vh3gqscxm4e>
import { ConnectorNotConnectedError } from '{{packageName}}'
```

### ConnectorNotFoundError

When a connector is not found or able to be used.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/errors.md","from":1267,"to":1324}<fsm-vh3gqscxm4e>
import { ConnectorNotFoundError } from '{{packageName}}'
```

### ConnectorUnavailableReconnectingError

During the reconnection step, the only connector methods guaranteed to be available are: `id`, `name`, `type`, `uuid`. All other methods are not guaranteed to be available until reconnection completes and connectors are fully restored. This error commonly occurs for connectors that asynchronously inject after reconnection has already started.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/errors.md","from":1728,"to":1800}<fsm-vh3gqscxm4e>
import { ConnectorUnavailableReconnectingError } from '{{packageName}}'
```

## Connector

### ProviderNotFoundError

When a connector's provider is not found or able to be used.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/errors.md","from":1918,"to":1974}<fsm-vh3gqscxm4e>
import { ProviderNotFoundError } from '{{packageName}}'
```

### SwitchChainNotSupportedError

When switching chains is not supported by connectors.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/errors.md","from":2078,"to":2141}<fsm-vh3gqscxm4e>
import { SwitchChainNotSupportedError } from '{{packageName}}'
```

---

---
url: /shared/faq.md
---
## How do I support the project?

Wagmi is an open source software project and free to use. If you enjoy using Wagmi or would like to support Wagmi development, you can:

* [Become a sponsor on GitHub](https://github.com/sponsors/wevm)
* Send us crypto
  * Mainnet: 0x4557B18E779944BFE9d78A672452331C186a9f48
  * Multichain: 0xd2135CfB216b74109775236E36d4b433F1DF507B
* [Become a supporter on Drips](https://www.drips.network/app/projects/github/wevm/wagmi)

If you use Wagmi at work, **consider asking your company to sponsor Wagmi**. This may not be easy, but **business sponsorships typically make a much larger impact on the sustainability of OSS projects** than individual donations, so you will help us much more if you succeed.

## Type inference doesn't work

* Check that you set up TypeScript correctly with `"strict": true` in your `tsconfig.json` (TypeScript docs)
* Check that you const-asserted any ABIs or Typed Data you are using.
* Restart your language server or IDE, and check for type errors in your code.

## My wallet doesn't work

If you run into issues with a specific wallet, try another before opening up an issue. There are many different wallets and it's likely that the issue is with the wallet itself, not Wagmi. For example, if you are using Wallet X and sending a transaction doesn't work, try Wallet Y and see if it works.

## `BigInt` Serialization

Using native `BigInt` with `JSON.stringify` will raise a `TypeError` as
[`BigInt` values are not serializable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt#use_within_json). There are two techniques to mitigate this:

#### Lossless serialization

Lossless serialization means that `BigInt` will be converted to a format that can be deserialized later (e.g. `69420n` → `"#bigint.69420"`). The trade-off is that these values are not human-readable and are not intended to be displayed to the user.

Lossless serialization can be achieved with wagmi's `serialize` and `deserialize` utilities.

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/faq.md","from":2319,"to":2513}<fsm-vh3gqscxm4e>
import { serialize, deserialize } from 'wagmi'

const serialized = serialize({ value: 69420n })
// '{"value":"#bigint.69420"}'

const deserialized = deserialize(serialized)
// { value: 69420n }
```

#### Lossy serialization

Lossy serialization means that the `BigInt` will be converted to a normal display string (e.g. `69420n` → `'69420'`).
The trade-off is that you will not be able to deserialize the `BigInt` with `JSON.parse` as it can not distinguish between a normal string and a `BigInt`.

This method can be achieved by modifying `JSON.stringify` to include a BigInt `replacer`:

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/faq.md","from":2916,"to":3072}<fsm-vh3gqscxm4e>
const replacer = (key, value) =>
  typeof value === 'bigint' ? value.toString() : value

JSON.stringify({ value: 69420n }, replacer)
// '{"value":"69420"}'
```

## Is Wagmi production ready?

Yes. Wagmi is very stable and is used in production by thousands of organizations, like [Stripe](https://stripe.com), [Shopify](https://shopify.com), [Coinbase](https://coinbase.com), [Uniswap](https://uniswap.org), [ENS](https://ens.domains), [Optimism](https://optimism.com).

## Is Wagmi strict with semver?

Yes, Wagmi is very strict with [semantic versioning](https://semver.org) and we will never introduce breaking changes to the runtime API in a minor version bump.

For exported types, we try our best to not introduce breaking changes in non-major versions, however, [TypeScript doesn't follow semver](https://www.learningtypescript.com/articles/why-typescript-doesnt-follow-strict-semantic-versioning) and often introduces breaking changes in minor releases that can cause Wagmi type issues. See the TypeScript docs for more information.

## How can I contribute to Wagmi?

The Wagmi team accepts all sorts of contributions. Check out the [Contributing](/dev/contributing) guide to get started. If you are interested in adding a new connector to Wagmi, check out the [Creating Connectors](/dev/creating-connectors) guide.

## Anything else you want to know?

Please create a new [GitHub Discussion thread](https://github.com/wevm/wagmi). You're also free to suggest changes to this or any other page on the site using the "Suggest changes to this page" button at the bottom of the page.

---

---
url: /shared/getConnection-return-type.md
---
### address

`Address | undefined`

* Connected address from connector.
* Defaults to first address in [`addresses`](#addresses).

### addresses

`readonly Address[] | undefined`

Connected addresses from connector.

### chain

`Chain | undefined`

Connected chain from connector. If chain is not configured by config, it will be `undefined`.

### chainId

`number | undefined`

Connected chain id from connector.

### connector

`Connector | undefined`

Connected connector.

### isConnecting / isReconnecting / isConnected / isDisconnected

`boolean`

Boolean variables derived from [`status`](#status).

### status

`'connecting' | 'reconnecting' | 'connected' | 'disconnected'`

* `'connecting'` attempting to establish connection.
* `'reconnecting'` attempting to re-establish connection to one or more connectors.
* `'connected'` at least one connector is connected.
* `'disconnected'` no connection to any connector.

::: info You can use `status` to narrow the return type.
For example, when `status` is `'connected'` properties like `address` are guaranteed to be defined.

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/getConnection-return-type.md","from":1166,"to":2330}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"70621ff7ba048810d10cff60e35c82126a2beb12177fb38b972d09b620d6367c","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BjCMONAAmbDBkbQEsWidgHEYaAMIsefQWABK4gK6kwAFWy4qbAIakGiACxUANjDABzNPiQBGAAxU0ei+KbTeAlpRAn+PJEcQRnw9HT4yJEMAXwp0TTxCEnInOgMQAAosUggcfQwASnZdNCU4YQAdECh+OC4ZGigq9gAfdir6zxgmkFb2kFJeD1lLZraO4YFRkB9dfTsAVlNzKxtEADYnFzdEEBKynz8AxCCQsIjyRFsF2PicROJI1Pp3Vg5O2SF2YAqwdn/2DooFBBnByuwAILA0FwADcvwBgOh8Dg8GEgyBLBMGHYyChIJRFHYADpSfiYcgALqU+F/AFnfzCCShfx9JRgWAAM383VpiIZYAAklBhGAlABbABGZD59MmEFITPlpFl/1qUm4XRF7DQpCUMFV7HVk38FmEnJ0JlRhtqABFah9GubLdaEQDaopHabnVaDW7/vtwRNNREerTorNnPMjABmZaWax2IJR1zpL3eUw8uxUM6kcI0S4AJlu1ASuwAjvrSBgfDQXrsuGxOCavj86f8gQSwcJySjDZ2YWj2BioFicXjkWCiaTib2wVSaf7OCywEyV2yOTBuTwoIaBcLRRLpSql46FUqQ2gFTa4BqGt1hLr9Te755vewLb6b/a6pMHx+XT9dsjTgT0TUsH1XWAwNKmCP8w1+CNtCjAxDDjXwVkTK5k22NMWzAQ4syuHNQjzC4kGLSkc2gXBdn4Tl2AydMwGJQN2AAXk49gAHJHW6biijbf5mN+USwDEiTxKkyTJKQkBxXEHQkFANJzDgOQ8DQBBomiIA==="}
import { type GetConnectionReturnType } from '@wagmi/core'
const connection = {} as GetConnectionReturnType
// ---cut---
if (connection.status === 'connected') {
  connection
  // ^?















}
```

Or when status is `'disconnected'` properties like `address` are guaranteed to be `undefined`:

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/getConnection-return-type.md","from":2446,"to":3549}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"03f1cafa2983888b08080373baa176953254622dd97feb972d42875fedc5dd86","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BjCMONAAmbDBkbQEsWidgHEYaAMIsefQWABK4gK6kwAFWy4qbAIakGiACxUANjDABzNPiQBGAAxU0ei+KbTeAlpRAn+PJEcQRnw9HT4yJEMAXwp0TTxCEnInOgMQAAosUggcfQwASnZdNCU4YQAdECh+OC4ZGigq9gAfdir6zxgmkFb2kFJeD1lLZraO4YFRkB9dfTsAVlNzKxtEADYnFzdEEBKynz8AxCCQsIjyRFsF2PicROJI1Pp3Vg5O2SF2YAqwdn/2DooFBBnByuwlGBYAAzfzdADcvwBgOBoLg8GEkJhcKgiL+ALO/kxUJgsJ4uKRBNC/gAklBidjyXjkR80BBSAzSTjmQDalJuF16exoToTOief9aopWf4LMIRWKYBL2HzJrL5aLxZTJXAACK1VndYRoUhKJXa4rOUrgqo1OqTbpVPHRWbOeZGTa+FbWOxBN2udIy7ymOF2KhnUjhGiXABMt2oCV2AEczaQMD4aC9dlw2Jw1V8fvj/kCQfBwViuUyLSW0RiISSyQiLYSwJzGxSi5xqWA6W3uc3Juy+1XO6qBREhQqtaO4NK1ZYNYrlWOGurhZrzTP9fbx41jabN8j9jbqgaHT1na69AZDJ6zJYfVc/dtA/mwIdQ1dw6FIxckHGAF1w2gXBdn4aF2AyIMwAAOmPdgAF4kPYAByO1DSgFCikLf5oN+fCwAIojCJI4jiJdKgAFtxB0JBQDScw4DkPA0AQaJoiAA"}
import { type GetConnectionReturnType } from '@wagmi/core'
const connection = {} as GetConnectionReturnType
// ---cut---
if (connection.status === 'disconnected') {
  connection
  // ^?















}
```

:::

---

---
url: /shared/installation.md
---
## Requirements

Wagmi is optimized for modern browsers. It is compatible with the latest versions of the following browsers.

::: tip
Depending on your environment, you might need to add polyfills. See [Viem Platform Compatibility](https://viem.sh/docs/compatibility) for more info.
:::

## Using Unreleased Commits

If you can't wait for a new release to test the latest features, you can either install from the `canary` tag (tracks the [`main`](https://github.com/wevm/wagmi/tree/main) branch).

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/installation.md","from":713,"to":745}<fsm-vh3gqscxm4e>
pnpm add {{packageName}}@canary
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/installation.md","from":768,"to":803}<fsm-vh3gqscxm4e>
npm install {{packageName}}@canary
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/installation.md","from":827,"to":859}<fsm-vh3gqscxm4e>
yarn add {{packageName}}@canary
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/installation.md","from":882,"to":913}<fsm-vh3gqscxm4e>
bun add {{packageName}}@canary
```

:::

Or clone the [Wagmi repo](https://github.com/wevm/wagmi) to your local machine, build, and link it yourself.

```bash-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/installation.md","from":1044,"to":1148}<fsm-vh3gqscxm4e>
gh repo clone wevm/wagmi
cd wagmi
pnpm install
pnpm build
cd packages/{{packageDir}}
pnpm link --global
```

Then go to the project where you are using Wagmi and run `pnpm link --global {{packageName}}` (or the package manager that you used to link Wagmi globally). Make sure you installed any [required peer dependencies](#package-manager) and their versions are correct.

Finally, pull requests are continuously released via [pkg.pr.new](https://pkg.pr.new) and can be installed using the pull request number or short commit ID.

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/installation.md","from":1610,"to":1658}<fsm-vh3gqscxm4e>
pnpm add https://pkg.pr.new/{{packageName}}@123
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/installation.md","from":1681,"to":1732}<fsm-vh3gqscxm4e>
npm install https://pkg.pr.new/{{packageName}}@123
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/installation.md","from":1756,"to":1804}<fsm-vh3gqscxm4e>
yarn add https://pkg.pr.new/{{packageName}}@123
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/installation.md","from":1827,"to":1874}<fsm-vh3gqscxm4e>
bun add https://pkg.pr.new/{{packageName}}@123
```

:::

## Security

Ethereum-related projects are often targeted in attacks to steal users' assets. Make sure you follow security best-practices for your project. Some quick things to get started.

* Pin package versions, upgrade mindfully, and inspect lockfile changes to minimize the risk of [supply-chain attacks](https://nodejs.org/en/guides/security/#supply-chain-attacks).
* Use [npm](https://docs.npmjs.com)'s [`min-release-age`](https://docs.npmjs.com/cli/v11/using-npm/config#min-release-age) or [pnpm](https://pnpm.io)'s [`minimumReleaseAge`](https://pnpm.io/settings#minimumreleaseage) and [`trustPolicy`](https://pnpm.io/settings#trustpolicy) to mitigate against supply-chain attacks.
* Install the [Socket](https://socket.dev) [GitHub App](https://github.com/apps/socket-security) to help detect and block supply-chain attacks.
* Add a [Content Security Policy](https://cheatsheetseries.owasp.org/cheatsheets/Content_Security_Policy_Cheat_Sheet.html) to defend against external scripts running in your app.
* Pin [GitHub Action](https://x.com/paulmillr/status/1900948425325031448) versions to commits instead of tags. [Actions Up](https://github.com/azat-io/actions-up) is a good tool for using commits instead of tags.

---

---
url: /shared/migrate-from-v2-to-v3.md
---
## Install Connector Dependencies

All connector dependencies are now optional peer dependencies. This means that if you want to use a specific connector, you need to install its required dependencies.

For example, if you are using the `porto` connector, you also need to install the `porto` npm package. Required connector dependencies are listed below (along with links to npm, GitHub, [Socket](https://socket.dev), and licenses) and on docs pages under the "Install" section.

:::tip Secure your supply-chain
Since you are now responsible for managing connector dependencies, take a look at Wagmi's Security Getting Started section to brush up on some best practices.
:::

:::tip Building a developer tool on top of Wagmi?
If you are developing a library with Wagmi, you should decide if you want to install connector dependencies as part of your library ("batteries-included" approach) or pass the responsibility onto your users (more flexibility and control).
:::

### baseAccount

`baseAccount` requires `@base-org/account`

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":1598,"to":1682}<fsm-vh3gqscxm4e>
pnpm add @base-org/account@{{packageJson?.peerDependencies?.['@base-org/account']}}
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":1705,"to":1792}<fsm-vh3gqscxm4e>
npm install @base-org/account@{{packageJson?.peerDependencies?.['@base-org/account']}}
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":1816,"to":1900}<fsm-vh3gqscxm4e>
yarn add @base-org/account@{{packageJson?.peerDependencies?.['@base-org/account']}}
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":1923,"to":2006}<fsm-vh3gqscxm4e>
bun add @base-org/account@{{packageJson?.peerDependencies?.['@base-org/account']}}
```

:::

### coinbaseWallet

`coinbaseWallet` requires `@coinbase/wallet-sdk`

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":2381,"to":2471}<fsm-vh3gqscxm4e>
pnpm add @coinbase/wallet-sdk@{{packageJson?.peerDependencies?.['@coinbase/wallet-sdk']}}
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":2494,"to":2587}<fsm-vh3gqscxm4e>
npm install @coinbase/wallet-sdk@{{packageJson?.peerDependencies?.['@coinbase/wallet-sdk']}}
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":2611,"to":2701}<fsm-vh3gqscxm4e>
yarn add @coinbase/wallet-sdk@{{packageJson?.peerDependencies?.['@coinbase/wallet-sdk']}}
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":2724,"to":2813}<fsm-vh3gqscxm4e>
bun add @coinbase/wallet-sdk@{{packageJson?.peerDependencies?.['@coinbase/wallet-sdk']}}
```

:::

### metaMask

`metaMask` requires `@metamask/connect-evm`

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":3165,"to":3257}<fsm-vh3gqscxm4e>
pnpm add @metamask/connect-evm@{{packageJson?.peerDependencies?.['@metamask/connect-evm']}}
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":3280,"to":3375}<fsm-vh3gqscxm4e>
npm install @metamask/connect-evm@{{packageJson?.peerDependencies?.['@metamask/connect-evm']}}
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":3399,"to":3491}<fsm-vh3gqscxm4e>
yarn add @metamask/connect-evm@{{packageJson?.peerDependencies?.['@metamask/connect-evm']}}
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":3514,"to":3605}<fsm-vh3gqscxm4e>
bun add @metamask/connect-evm@{{packageJson?.peerDependencies?.['@metamask/connect-evm']}}
```

:::

### porto

`porto` requires `porto`

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":3879,"to":3939}<fsm-vh3gqscxm4e>
pnpm add porto@{{packageJson?.peerDependencies?.['porto']}}
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":3962,"to":4025}<fsm-vh3gqscxm4e>
npm install porto@{{packageJson?.peerDependencies?.['porto']}}
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":4049,"to":4109}<fsm-vh3gqscxm4e>
yarn add porto@{{packageJson?.peerDependencies?.['porto']}}
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":4132,"to":4191}<fsm-vh3gqscxm4e>
bun add porto@{{packageJson?.peerDependencies?.['porto']}}
```

:::

### safe

`safe` requires `@safe-global/safe-apps-provider` and `@safe-global/safe-apps-sdk`

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":4837,"to":5043}<fsm-vh3gqscxm4e>
pnpm add @safe-global/safe-apps-provider@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-provider']}} @safe-global/safe-apps-sdk@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-sdk']}} 
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":5066,"to":5275}<fsm-vh3gqscxm4e>
npm install @safe-global/safe-apps-provider@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-provider']}} @safe-global/safe-apps-sdk@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-sdk']}} 
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":5299,"to":5505}<fsm-vh3gqscxm4e>
yarn add @safe-global/safe-apps-provider@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-provider']}} @safe-global/safe-apps-sdk@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-sdk']}} 
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":5528,"to":5733}<fsm-vh3gqscxm4e>
bun add @safe-global/safe-apps-provider@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-provider']}} @safe-global/safe-apps-sdk@{{packageJson?.peerDependencies?.['@safe-global/safe-apps-sdk']}} 
```

:::

### walletConnect

`walletConnect` requires `@walletconnect/ethereum-provider`

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":6141,"to":6255}<fsm-vh3gqscxm4e>
pnpm add @walletconnect/ethereum-provider@{{packageJson?.peerDependencies?.['@walletconnect/ethereum-provider']}}
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":6278,"to":6395}<fsm-vh3gqscxm4e>
npm install @walletconnect/ethereum-provider@{{packageJson?.peerDependencies?.['@walletconnect/ethereum-provider']}}
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":6419,"to":6533}<fsm-vh3gqscxm4e>
yarn add @walletconnect/ethereum-provider@{{packageJson?.peerDependencies?.['@walletconnect/ethereum-provider']}}
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/migrate-from-v2-to-v3.md","from":6556,"to":6669}<fsm-vh3gqscxm4e>
bun add @walletconnect/ethereum-provider@{{packageJson?.peerDependencies?.['@walletconnect/ethereum-provider']}}
```

:::

## Bumped Minimum TypeScript Version

The minimum supported TypeScript version is now `5.7.3` instead of `5.0.4`. Older versions of TypeScript should continue to work, but since [TypeScript doesn't follow semver](https://www.learningtypescript.com/articles/why-typescript-doesnt-follow-strict-semantic-versioning) we recommend you update to at least `5.7.3`. This should be relatively simple as there haven't been any breaking changes since `5.0.4`.

## Migrate v2 Deprecations

v2 deprecations Review the v2 migration guide for more information.

---

---
url: /shared/mutation-imports.md
---
## TanStack Query

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/mutation-imports.md","from":148,"to":335}<fsm-vh3gqscxm4e>
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

---

---
url: /shared/mutation-options.md
---
***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

---

---
url: /shared/mutation-result.md
---
***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

---

---
url: /shared/query-imports.md
---
## TanStack Query

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/query-imports.md","from":154,"to":364}<fsm-vh3gqscxm4e>
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

---

---
url: /shared/query-options.md
---
***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

---

---
url: /shared/query-result.md
---
***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

---

---
url: /shared/tempo-write-parameters.md
---
### account (optional)

* **Type:** `Account | Address`

Account that will be used to send the transaction. Defaults to connected Wagmi account.

### feeToken (optional)

* **Type:** `Address | bigint`

Fee token for the transaction.

Can be a TIP-20 token address or ID.

### feePayer (optional)

* **Type:** `Account | true`

Fee payer for the transaction.

Can be a [Viem Account](https://viem.sh/docs/accounts/local/privateKeyToAccount), or `true` if a [Fee Payer Service](https://docs.tempo.xyz/sdk/typescript/server/handler.feePayer) will be used.

### gas (optional)

* **Type:** `bigint`

Gas limit for the transaction.

### maxFeePerGas (optional)

* **Type:** `bigint`

Max fee per gas for the transaction.

### maxPriorityFeePerGas (optional)

* **Type:** `bigint`

Max priority fee per gas for the transaction.

### nonce (optional)

* **Type:** `number`

Nonce for the transaction.

### nonceKey (optional)

* **Type:** `'expiring' | bigint`

Nonce key for the transaction.

### validBefore (optional)

* **Type:** `number`

Unix timestamp before which the transaction must be included.

### validAfter (optional)

* **Type:** `number`

Unix timestamp after which the transaction can be included.

### throwOnReceiptRevert (optional)

* **Type:** `boolean`
* **Default:** `true`

Whether to throw an error if the transaction receipt indicates a revert. Only applicable to `*Sync` actions.

---

---
url: /react/api/hooks/useBalance.md
description: Hook for fetching native currency balance.
---

# useBalance

Hook for fetching native currency balance.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBalance.md","from":380,"to":415}<fsm-vh3gqscxm4e>
import { useBalance } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBalance.md","from":464,"to":613}<fsm-vh3gqscxm4e>
import { useBalance } from 'wagmi'

function App() {
  const result = useBalance({
    address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBalance.md","from":685,"to":735}<fsm-vh3gqscxm4e>
import { type UseBalanceParameters } from 'wagmi'
```

### address

`Address | undefined`

Address to get balance for. [`enabled`](#enabled) set to `false` if `address` is `undefined`.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBalance.md","from":905,"to":1110}<fsm-vh3gqscxm4e>
import { useBalance } from 'wagmi'
import { mainnet } from 'wagmi/chains'

function App() {
  const result = useBalance({
    address: '0x4557B18E779944BFE9d78A672452331C186a9f48', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### blockNumber

`bigint | undefined`

Block number to get balance at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBalance.md","from":1270,"to":1464}<fsm-vh3gqscxm4e>
import { useBalance } from 'wagmi'

function App() {
  const result = useBalance({
    address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
    blockNumber: 17829139n, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get balance at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBalance.md","from":1663,"to":1853}<fsm-vh3gqscxm4e>
import { useBalance } from 'wagmi'

function App() {
  const result = useBalance({
    address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
    blockTag: 'latest', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBalance.md","from":2042,"to":2289}<fsm-vh3gqscxm4e>
import { useBalance } from 'wagmi'
import { mainnet } from 'wagmi/chains' // [!code focus]

function App() {
  const result = useBalance({
    address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
    chainId: mainnet.id, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBalance.md","from":2543,"to":2772}<fsm-vh3gqscxm4e>
import { useBalance } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useBalance({
    address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBalance.md","from":2992,"to":3179}<fsm-vh3gqscxm4e>
import { useBalance } from 'wagmi'

function App() {
  const result = useBalance({
    address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
    scopeKey: 'foo', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBalance.md","from":3295,"to":3345}<fsm-vh3gqscxm4e>
import { type UseBalanceReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getBalance`](/core/api/actions/getBalance)

---

---
url: /solid/api/primitives/useBalance.md
description: Primitive for fetching native currency balance.
---

# useBalance

Primitive for fetching native currency balance.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useBalance.md","from":397,"to":439}<fsm-vh3gqscxm4e>
import { useBalance } from '@wagmi/solid'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useBalance.md","from":488,"to":653}<fsm-vh3gqscxm4e>
import { useBalance } from '@wagmi/solid'

function App() {
  const balance = useBalance(() => ({
    address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
  }))
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useBalance.md","from":725,"to":817}<fsm-vh3gqscxm4e>
import { useBalance } from '@wagmi/solid'

useBalance.Parameters
useBalance.SolidParameters
```

Parameters are passed as a getter function to maintain Solid reactivity.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useBalance.md","from":902,"to":971}<fsm-vh3gqscxm4e>
useBalance(() => ({
  address: '0x...',
  // other parameters...
}))
```

### address

`Address | undefined`

Address to get balance for. [`enabled`](#enabled) set to `false` if `address` is `undefined`.

### blockNumber

`bigint | undefined`

Block number to get balance at.

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get balance at.

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

### config

`Config | undefined`

[`Config`](/solid/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/solid/api/WagmiProvider).

### scopeKey

`string | undefined`

Scopes the cache to a given context. Primitives that have identical context will share the same cache.

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useBalance.md","from":1768,"to":1833}<fsm-vh3gqscxm4e>
import { useBalance } from '@wagmi/solid'

useBalance.ReturnType
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getBalance`](/core/api/actions/getBalance)

---

---
url: /vue/api/composables/useBalance.md
description: Composable for fetching native currency balance.
---

# useBalance

Composable for fetching native currency balance.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBalance.md","from":397,"to":437}<fsm-vh3gqscxm4e>
import { useBalance } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBalance.md","from":486,"to":650}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBalance } from '@wagmi/vue'

const result = useBalance({
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBalance.md","from":720,"to":775}<fsm-vh3gqscxm4e>
import { type UseBalanceParameters } from '@wagmi/vue'
```

### address

`Address | undefined`

Address to get balance for. [`enabled`](#enabled) set to `false` if `address` is `undefined`.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBalance.md","from":945,"to":1170}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBalance } from '@wagmi/vue'
import { mainnet } from '@wagmi/vue/chains'

const result = useBalance({
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### blockNumber

`bigint | undefined`

Block number to get balance at.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBalance.md","from":1330,"to":1537}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBalance } from '@wagmi/vue'

const result = useBalance({
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
  blockNumber: 17829139n, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get balance at.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBalance.md","from":1736,"to":1939}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBalance } from '@wagmi/vue'

const result = useBalance({
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
  blockTag: 'latest', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBalance.md","from":2126,"to":2391}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBalance } from '@wagmi/vue'
import { mainnet } from '@wagmi/vue/chains' // [!code focus]

const result = useBalance({
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
  chainId: mainnet.id, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBalance.md","from":2627,"to":2869}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBalance } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const result = useBalance({
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBalance.md","from":3087,"to":3287}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBalance } from '@wagmi/vue'

const result = useBalance({
  address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
  scopeKey: 'foo', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBalance.md","from":3401,"to":3456}<fsm-vh3gqscxm4e>
import { type UseBalanceReturnType } from '@wagmi/vue'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getBalance`](/core/api/actions/getBalance)

---

---
url: /react/api/hooks/useBlobBaseFee.md
description: Hook for fetching the current blob base fee (in wei).
---

# useBlobBaseFee

Hook for fetching the current blob base fee (in wei).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlobBaseFee.md","from":376,"to":415}<fsm-vh3gqscxm4e>
import { useBlobBaseFee } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlobBaseFee.md","from":464,"to":557}<fsm-vh3gqscxm4e>
import { useBlobBaseFee } from 'wagmi'

function App() {
  const result = useBlobBaseFee()
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlobBaseFee.md","from":629,"to":683}<fsm-vh3gqscxm4e>
import { type UseBlobBaseFeeParameters } from 'wagmi'
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlobBaseFee.md","from":821,"to":1017}<fsm-vh3gqscxm4e>
import { useBlobBaseFee } from 'wagmi'
import { mainnet } from 'wagmi/chains' // [!code focus]

function App() {
  const result = useBlobBaseFee({
    chainId: mainnet.id, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlobBaseFee.md","from":1271,"to":1449}<fsm-vh3gqscxm4e>
import { useBlobBaseFee } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useBlobBaseFee({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlobBaseFee.md","from":1669,"to":1856}<fsm-vh3gqscxm4e>
import { useBlobBaseFee } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useBlobBaseFee({
    scopeKey: 'foo', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlobBaseFee.md","from":1972,"to":2026}<fsm-vh3gqscxm4e>
import { type UseBlobBaseFeeReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getBlobBaseFee`](/core/api/actions/getBlobBaseFee)

---

---
url: /react/api/hooks/useBlock.md
description: 'Hook for fetching information about a block at a block number, hash or tag.'
---

# useBlock

Hook for fetching information about a block at a block number, hash or tag.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlock.md","from":396,"to":429}<fsm-vh3gqscxm4e>
import { useBlock } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlock.md","from":478,"to":559}<fsm-vh3gqscxm4e>
import { useBlock } from 'wagmi'

function App() {
  const result = useBlock()
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlock.md","from":631,"to":679}<fsm-vh3gqscxm4e>
import { type UseBlockParameters } from 'wagmi'
```

### blockHash

`` `0x${string}` ``

Information at a given block hash.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlock.md","from":790,"to":977}<fsm-vh3gqscxm4e>
import { useBlock } from 'wagmi'

function App() {
  const result = useBlock({
    blockHash: '0x89644bbd5c8d682a2e9611170e6c1f02573d866d286f006cbf517eec7254ec2d' // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`bigint`

Information at a given block number.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlock.md","from":1131,"to":1258}<fsm-vh3gqscxm4e>
import { useBlock } from 'wagmi'

function App() {
  const result = useBlock({
    blockNumber: 42069n // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized'`

Information at a given block tag. Defaults to `'latest'`.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlock.md","from":1480,"to":1607}<fsm-vh3gqscxm4e>
import { useBlock } from 'wagmi'

function App() {
  const result = useBlock({
    blockTag: 'pending' // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlock.md","from":1791,"to":1975}<fsm-vh3gqscxm4e>
import { useBlock } from 'wagmi'
import { mainnet } from 'wagmi/chains' // [!code focus]

function App() {
  const result = useBlock({
    chainId: mainnet.id, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlock.md","from":2229,"to":2395}<fsm-vh3gqscxm4e>
import { useBlock } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useBlock({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### includeTransactions

`boolean`

Whether or not to include transactions as objects.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlock.md","from":2568,"to":2735}<fsm-vh3gqscxm4e>
import { useBlock } from 'wagmi'
import { config } from './config'

function App() {
  const result = useBlock({
    includeTransactions: true // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlock.md","from":2955,"to":3112}<fsm-vh3gqscxm4e>
import { useBlock } from 'wagmi'
import { config } from './config'

function App() {
  const result = useBlock({
    scopeKey: 'foo' // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### watch

`boolean | UseWatchBlockParameters | undefined`

* Enables/disables listening for block changes.
* Can pass a subset of [`UseWatchBlocksParameters`](/react/api/hooks/useWatchBlocks#parameters) directly to [`useWatchBlocks`](/react/api/hooks/useWatchBlocks).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlock.md","from":3467,"to":3587}<fsm-vh3gqscxm4e>
import { useBlock } from 'wagmi'

function App() {
  const result = useBlock({
    watch: true, // [!code focus]
  })
}
```

```tsx [index-2.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlock.md","from":3613,"to":3800}<fsm-vh3gqscxm4e>
import { useBlock } from 'wagmi'

function App() {
  const result = useBlock({
    watch: { // [!code focus]
      pollingInterval: 4_000, // [!code focus]
    }, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlock.md","from":3916,"to":3964}<fsm-vh3gqscxm4e>
import { type UseBlockReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getBlock`](/core/api/actions/getBlock)
* [`watchBlockNumber`](/core/api/actions/watchBlockNumber)

---

---
url: /react/api/hooks/useBlockNumber.md
description: Hook for fetching the number of the most recent block seen.
---

# useBlockNumber

Hook for fetching the number of the most recent block seen.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockNumber.md","from":388,"to":427}<fsm-vh3gqscxm4e>
import { useBlockNumber } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockNumber.md","from":476,"to":569}<fsm-vh3gqscxm4e>
import { useBlockNumber } from 'wagmi'

function App() {
  const result = useBlockNumber()
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockNumber.md","from":641,"to":695}<fsm-vh3gqscxm4e>
import { type UseBlockNumberParameters } from 'wagmi'
```

### cacheTime

`number | undefined`

Time in milliseconds that cached block number will remain in memory.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockNumber.md","from":841,"to":978}<fsm-vh3gqscxm4e>
import { useBlockNumber } from 'wagmi'

function App() {
  const result = useBlockNumber({
    cacheTime: 4_000, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockNumber.md","from":1162,"to":1358}<fsm-vh3gqscxm4e>
import { useBlockNumber } from 'wagmi'
import { mainnet } from 'wagmi/chains' // [!code focus]

function App() {
  const result = useBlockNumber({
    chainId: mainnet.id, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockNumber.md","from":1612,"to":1790}<fsm-vh3gqscxm4e>
import { useBlockNumber } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useBlockNumber({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockNumber.md","from":2010,"to":2197}<fsm-vh3gqscxm4e>
import { useBlockNumber } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useBlockNumber({
    scopeKey: 'foo', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### watch

`boolean | UseWatchBlockNumberParameters | undefined`

* Enables/disables listening for block number changes.
* Can pass a subset of [`UseWatchBlockNumberParameters`](/react/api/hooks/useWatchBlockNumber#parameters)directly to [`useWatchBlockNumber`](/react/api/hooks/useWatchBlockNumber).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockNumber.md","from":2584,"to":2716}<fsm-vh3gqscxm4e>
import { useBlockNumber } from 'wagmi'

function App() {
  const result = useBlockNumber({
    watch: true, // [!code focus]
  })
}
```

```tsx [index-2.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockNumber.md","from":2742,"to":2941}<fsm-vh3gqscxm4e>
import { useBlockNumber } from 'wagmi'

function App() {
  const result = useBlockNumber({
    watch: { // [!code focus]
      pollingInterval: 4_000, // [!code focus]
    }, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockNumber.md","from":3057,"to":3111}<fsm-vh3gqscxm4e>
import { type UseBlockNumberReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getBlockNumber`](/core/api/actions/getBlockNumber)
* [`watchBlockNumber`](/core/api/actions/watchBlockNumber)

---

---
url: /solid/api/primitives/useBlockNumber.md
description: Primitive for fetching the current block number.
---

# useBlockNumber

Primitive for fetching the current block number.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useBlockNumber.md","from":178,"to":224}<fsm-vh3gqscxm4e>
import { useBlockNumber } from '@wagmi/solid'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useBlockNumber.md","from":273,"to":378}<fsm-vh3gqscxm4e>
import { useBlockNumber } from '@wagmi/solid'

function App() {
  const blockNumber = useBlockNumber()
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useBlockNumber.md","from":450,"to":554}<fsm-vh3gqscxm4e>
import { useBlockNumber } from '@wagmi/solid'

useBlockNumber.Parameters
useBlockNumber.SolidParameters
```

Parameters are passed as a getter function to maintain Solid reactivity.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useBlockNumber.md","from":639,"to":706}<fsm-vh3gqscxm4e>
useBlockNumber(() => ({
  chainId: 1,
  // other parameters...
}))
```

### cacheTime

`number | undefined`

Time in milliseconds that cached block number will remain in memory.

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

### config

`Config | undefined`

[`Config`](/solid/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/solid/api/WagmiProvider).

### scopeKey

`string | undefined`

Scopes the cache to a given context. Primitives that have identical context will share the same cache.

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useBlockNumber.md","from":1291,"to":1364}<fsm-vh3gqscxm4e>
import { useBlockNumber } from '@wagmi/solid'

useBlockNumber.ReturnType
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getBlockNumber`](/core/api/actions/getBlockNumber)

---

---
url: /vue/api/composables/useBlockNumber.md
description: Composable for fetching the number of the most recent block seen.
---

# useBlockNumber

Composable for fetching the number of the most recent block seen.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBlockNumber.md","from":405,"to":449}<fsm-vh3gqscxm4e>
import { useBlockNumber } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBlockNumber.md","from":498,"to":683}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBlockNumber } from '@wagmi/vue'

const { data: blockNumber } = useBlockNumber()
</script>

<template>
  Block Number: {{ blockNumber }}
</template>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBlockNumber.md","from":753,"to":812}<fsm-vh3gqscxm4e>
import { type UseBlockNumberParameters } from '@wagmi/vue'
```

### cacheTime

`MaybeRef<number> | undefined`

Time in milliseconds that cached block number will remain in memory.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBlockNumber.md","from":968,"to":1134}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBlockNumber } from '@wagmi/vue'

const { data: blockNumber } = useBlockNumber({
  cacheTime: 4_000 // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`MaybeRef<config['chains'][number]['id']> | undefined`

ID of chain to use when fetching data.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBlockNumber.md","from":1326,"to":1557}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBlockNumber } from '@wagmi/vue'
import { mainnet } from '@wagmi/vue/chains' // [!code focus]

const { data: blockNumber } = useBlockNumber({
  chainId: mainnet.id, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBlockNumber.md","from":1793,"to":2001}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBlockNumber } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const { data: blockNumber } = useBlockNumber({
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`MaybeRef<string> | undefined`

Scopes the cache to a given context. Composables that have identical context will share the same cache.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBlockNumber.md","from":2235,"to":2401}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBlockNumber } from '@wagmi/vue'

const { data: blockNumber } = useBlockNumber({
  scopeKey: 'foo', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### watch

`MaybeRef<boolean | UseWatchBlockNumberParameters> | undefined`

* Enables/disables listening for block number changes.
* Can pass a subset of [`UseWatchBlockNumberParameters`](/vue/api/composables/useWatchBlockNumber#parameters) directly to [`useWatchBlockNumber`](/vue/api/composables/useWatchBlockNumber).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBlockNumber.md","from":2805,"to":2967}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBlockNumber } from '@wagmi/vue'

const { data: blockNumber } = useBlockNumber({
  watch: true, // [!code focus]
})
</script>
```

```vue [index-2.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBlockNumber.md","from":2993,"to":3217}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBlockNumber } from '@wagmi/vue'

const { data: blockNumber } = useBlockNumber({
  watch: { // [!code focus]
    pollingInterval: 4_000 // [!code focus]
  }, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBlockNumber.md","from":3331,"to":3390}<fsm-vh3gqscxm4e>
import { type UseBlockNumberReturnType } from '@wagmi/vue'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getBlockNumber`](/core/api/actions/getBlockNumber)
* [`watchBlockNumber`](/core/api/actions/watchBlockNumber)

---

---
url: /react/api/hooks/useBlockTransactionCount.md
description: 'Hook for fetching the number of Transactions at a block number, hash or tag.'
---

# useBlockTransactionCount

Hook for fetching the number of Transactions at a block number, hash or tag.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockTransactionCount.md","from":472,"to":521}<fsm-vh3gqscxm4e>
import { useBlockTransactionCount } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockTransactionCount.md","from":570,"to":683}<fsm-vh3gqscxm4e>
import { useBlockTransactionCount } from 'wagmi'

function App() {
  const result = useBlockTransactionCount()
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockTransactionCount.md","from":755,"to":819}<fsm-vh3gqscxm4e>
import { type UseBlockTransactionCountParameters } from 'wagmi'
```

### blockHash

`` `0x${string}` ``

Transaction count at a given block hash.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockTransactionCount.md","from":936,"to":1123}<fsm-vh3gqscxm4e>
import { useBlock } from 'wagmi'

function App() {
  const result = useBlock({
    blockHash: '0x89644bbd5c8d682a2e9611170e6c1f02573d866d286f006cbf517eec7254ec2d' // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`bigint`

Transaction count at a given block number.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockTransactionCount.md","from":1283,"to":1410}<fsm-vh3gqscxm4e>
import { useBlock } from 'wagmi'

function App() {
  const result = useBlock({
    blockNumber: 42069n // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized'`

Transaction count at a given block tag. Defaults to `'latest'`.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockTransactionCount.md","from":1638,"to":1765}<fsm-vh3gqscxm4e>
import { useBlock } from 'wagmi'

function App() {
  const result = useBlock({
    blockTag: 'pending' // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockTransactionCount.md","from":1949,"to":2133}<fsm-vh3gqscxm4e>
import { useBlock } from 'wagmi'
import { mainnet } from 'wagmi/chains' // [!code focus]

function App() {
  const result = useBlock({
    chainId: mainnet.id, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockTransactionCount.md","from":2387,"to":2585}<fsm-vh3gqscxm4e>
import { useBlockTransactionCount } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useBlockTransactionCount({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockTransactionCount.md","from":2805,"to":3012}<fsm-vh3gqscxm4e>
import { useBlockTransactionCount } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useBlockTransactionCount({
    scopeKey: 'foo', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBlockTransactionCount.md","from":3129,"to":3193}<fsm-vh3gqscxm4e>
import { type UseBlockTransactionCountReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getBlockTransactionCount`](/core/api/actions/getBlockTransactionCount)

---

---
url: /react/api/hooks/useBytecode.md
description: Hook for retrieving the bytecode at an address.
---

# useBytecode

Hook for retrieving the bytecode at an address.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBytecode.md","from":358,"to":394}<fsm-vh3gqscxm4e>
import { useBytecode } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBytecode.md","from":443,"to":594}<fsm-vh3gqscxm4e>
import { useBytecode } from 'wagmi'

function App() {
  const result = useBytecode({
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBytecode.md","from":666,"to":717}<fsm-vh3gqscxm4e>
import { type UseBytecodeParameters } from 'wagmi'
```

### address

`Address | undefined`

The contract address.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBytecode.md","from":815,"to":983}<fsm-vh3gqscxm4e>
import { useBytecode } from 'wagmi'

function App() {
  const result = useBytecode({
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`bigint | undefined`

The block number to check the bytecode at.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBytecode.md","from":1151,"to":1347}<fsm-vh3gqscxm4e>
import { useBytecode } from 'wagmi'

function App() {
  const result = useBytecode({
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
    blockNumber: 16280770n, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

The block tag to check the bytecode at.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBytecode.md","from":1559,"to":1749}<fsm-vh3gqscxm4e>
import { useBytecode } from 'wagmi'

function App() {
  const result = useBytecode({
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
    blockTag: 'safe', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

The chain ID to check the bytecode at.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBytecode.md","from":1933,"to":2165}<fsm-vh3gqscxm4e>
import { useBytecode } from 'wagmi'
import { mainnet } from 'wagmi/chains'

function App() {
  const result = useBytecode({
    chainId: mainnet.id, // [!code focus]
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBytecode.md","from":2419,"to":2650}<fsm-vh3gqscxm4e>
import { useBytecode } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useBytecode({
    config, // [!code focus]
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBytecode.md","from":2870,"to":3092}<fsm-vh3gqscxm4e>
import { useBytecode } from 'wagmi'
import { config } from './config'

function App() {
  const result = useBytecode({
    scopeKey: 'foo' // [!code focus]
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useBytecode.md","from":3208,"to":3259}<fsm-vh3gqscxm4e>
import { type UseBytecodeReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getBytecode`](/core/api/actions/getBytecode)

---

---
url: /vue/api/composables/useBytecode.md
description: Composable for retrieving the bytecode at an address.
---

# useBytecode

Composable for retrieving the bytecode at an address.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBytecode.md","from":375,"to":416}<fsm-vh3gqscxm4e>
import { useBytecode } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBytecode.md","from":465,"to":695}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBytecode } from '@wagmi/vue'

const { data: byteCode } = useBytecode({
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
})
</script>

<template>
  Byte Code: {{ byteCode }}
</template>
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBytecode.md","from":767,"to":823}<fsm-vh3gqscxm4e>
import { type UseBytecodeParameters } from '@wagmi/vue'
```

### address

`Address | undefined`

The contract address.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBytecode.md","from":921,"to":1168}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBytecode } from '@wagmi/vue'

const { data: byteCode } = useBytecode({
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', // [!code focus]
})
</script>

<template>
  Byte Code: {{ byteCode }}
</template>
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`bigint | undefined`

The block number to check the bytecode at.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBytecode.md","from":1336,"to":1609}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBytecode } from '@wagmi/vue'

const { data: byteCode } = useBytecode({
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  blockNumber: 16280770n, // [!code focus]
})
</script>

<template>
  Byte Code: {{ byteCode }}
</template>
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

The block tag to check the bytecode at.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBytecode.md","from":1821,"to":2088}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBytecode } from '@wagmi/vue'

const { data: byteCode } = useBytecode({
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  blockTag: 'safe', // [!code focus]
})
</script>

<template>
  Byte Code: {{ byteCode }}
</template>
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

The chain ID to check the bytecode at.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBytecode.md","from":2272,"to":2586}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBytecode } from '@wagmi/vue'
import { mainnet } from '@wagmi/vue/chains'

const { data: byteCode } = useBytecode({
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  chainId: mainnet.id, // [!code focus]
})
</script>

<template>
  Byte Code: {{ byteCode }}
</template>
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBytecode.md","from":2840,"to":3148}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBytecode } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const { data: byteCode } = useBytecode({
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  config, // [!code focus]
})
</script>

<template>
  Byte Code: {{ byteCode }}
</template>
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBytecode.md","from":3368,"to":3685}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useBytecode } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const { data: byteCode } = useBytecode({
  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
  scopeKey: 'foo', // [!code focus]
})
</script>

<template>
  Byte Code: {{ byteCode }}
</template>
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useBytecode.md","from":3801,"to":3857}<fsm-vh3gqscxm4e>
import { type UseBytecodeReturnType } from '@wagmi/vue'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getBytecode`](/core/api/actions/getBytecode)

---

---
url: /react/api/hooks/useCall.md
description: >-
  Hook for executing a new message call immediately without submitting a
  transaction to the network.
---

# useCall

Hook for executing a new message call immediately without submitting a transaction to the network.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCall.md","from":424,"to":456}<fsm-vh3gqscxm4e>
import { useCall } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCall.md","from":505,"to":758}<fsm-vh3gqscxm4e>
import { useCall } from 'wagmi'

function App() {
  const result = useCall({
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCall.md","from":830,"to":877}<fsm-vh3gqscxm4e>
import { type UseCallParameters } from 'wagmi'
```

### account

`Account | Address | undefined`

The Account to call from.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCall.md","from":989,"to":1259}<fsm-vh3gqscxm4e>
import { useCall } from 'wagmi'

function App() {
  const result = useCall({
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', // [!code focus]
    data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### data

`0x${string} | undefined`

A contract hashed method call with encoded args.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCall.md","from":1431,"to":1701}<fsm-vh3gqscxm4e>
import { useCall } from 'wagmi'

function App() {
  const result = useCall({
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', // [!code focus]
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### to

`Address | undefined`

The contract address or recipient.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCall.md","from":1853,"to":2123}<fsm-vh3gqscxm4e>
import { useCall } from 'wagmi'

function App() {
  const result = useCall({
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### accessList

`AccessList | undefined`

The access list.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCall.md","from":2268,"to":2637}<fsm-vh3gqscxm4e>
import { useCall } from 'wagmi'

function App() {
  const result = useCall({
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    accessList: [ // [!code focus:6] 
      {
        address: '0x1',
        storageKeys: ['0x1'],
      },
    ],
    data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### gas

`bigint | undefined`

The gas provided for transaction execution.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCall.md","from":2798,"to":3089}<fsm-vh3gqscxm4e>
import { useCall } from 'wagmi'

function App() {
  const result = useCall({
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
    gas: 1_000_000n, // [!code focus]
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### gasPrice

`bigint | undefined`

The price (in wei) to pay per gas. Only applies to [Legacy Transactions](https://viem.sh/docs/glossary/terms#legacy-transaction).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCall.md","from":3341,"to":3642}<fsm-vh3gqscxm4e>
import { useCall } from 'wagmi'

function App() {
  const result = useCall({
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
    gasPrice: parseGwei('20'), // [!code focus]
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxFeePerGas

`bigint | undefined`

Total fee per gas (in wei), inclusive of `maxPriorityFeePerGas`. Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCall.md","from":3932,"to":4237}<fsm-vh3gqscxm4e>
import { useCall } from 'wagmi'

function App() {
  const result = useCall({
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
    maxFeePerGas: parseGwei('20'), // [!code focus]
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxPriorityFeePerGas

`bigint | undefined`

Max priority fee per gas (in wei). Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCall.md","from":4505,"to":4852}<fsm-vh3gqscxm4e>
import { useCall } from 'wagmi'

function App() {
  const result = useCall({
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
    maxFeePerGas: parseGwei('20'),
    maxPriorityFeePerGas: parseGwei('2'), // [!code focus]
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### nonce

`number | undefined`

Unique number identifying this transaction.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCall.md","from":5015,"to":5301}<fsm-vh3gqscxm4e>
import { useCall } from 'wagmi'

function App() {
  const result = useCall({
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
    nonce: 420, // [!code focus]
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### value

`bigint | undefined`

Value (in wei) sent with this transaction.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCall.md","from":5463,"to":5761}<fsm-vh3gqscxm4e>
import { useCall } from 'wagmi'

function App() {
  const result = useCall({
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    value: parseEther('1'), // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`number | undefined`

The block number to perform the call against.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCall.md","from":5932,"to":6230}<fsm-vh3gqscxm4e>
import { useCall } from 'wagmi'

function App() {
  const result = useCall({
    blockNumber: 15121123n, // [!code focus]
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

The block tag to perform the call against.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCall.md","from":6445,"to":6737}<fsm-vh3gqscxm4e>
import { useCall } from 'wagmi'

function App() {
  const result = useCall({
    blockTag: 'safe', // [!code focus]
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

The block tag to perform the call against.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCall.md","from":6925,"to":7265}<fsm-vh3gqscxm4e>
import { useCall } from 'wagmi'
import { mainnet } from '@wagmi/core/chains'

function App() {
  const result = useCall({
    chainId: mainnet.id, // [!code focus]
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCall.md","from":7519,"to":7852}<fsm-vh3gqscxm4e>
import { useCall } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useCall({
    config, // [!code focus]
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCall.md","from":8072,"to":8396}<fsm-vh3gqscxm4e>
import { useCall } from 'wagmi'
import { config } from './config'

function App() {
  const result = useCall({
    scopeKey: 'foo' // [!code focus]
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCall.md","from":8512,"to":8559}<fsm-vh3gqscxm4e>
import { type UseCallReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`call`](/core/api/actions/call)

---

---
url: /react/api/hooks/useCallsStatus.md
description: Hook for fetching the number of the most recent block seen.
---

# useCallsStatus

Hook to fetch the status and receipts of a call batch that was sent via [`useSendCalls`](/react/api/hooks/useSendCalls).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCallsStatus.md","from":470,"to":509}<fsm-vh3gqscxm4e>
import { useCallsStatus } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCallsStatus.md","from":558,"to":690}<fsm-vh3gqscxm4e>
import { useCallsStatus } from 'wagmi'

function App() {
  const result = useCallsStatus({
    id: '0x...', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCallsStatus.md","from":762,"to":816}<fsm-vh3gqscxm4e>
import { type UseCallsStatusParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCallsStatus.md","from":1024,"to":1219}<fsm-vh3gqscxm4e>
import { useCallsStatus } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useCallsStatus({
    config, // [!code focus]
    id: '0x...',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

Connector to get call statuses with.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCallsStatus.md","from":1382,"to":1662}<fsm-vh3gqscxm4e>
import { useCallsStatus, useConnections } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const connections = useConnections()
  const result = useCallsStatus({
    connector: connections[0]?.connector, // [!code focus]
    id: '0x...',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### id

`string`

Identifier of the call batch.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCallsStatus.md","from":1794,"to":1960}<fsm-vh3gqscxm4e>
import { useCallsStatus } from '@wagmi/core'
import { config } from './config'

const status = await useCallsStatus({
  id: '0x1234567890abcdef', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCallsStatus.md","from":2180,"to":2384}<fsm-vh3gqscxm4e>
import { useCallsStatus } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useCallsStatus({
    id: '0x...',
    scopeKey: 'foo', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCallsStatus.md","from":2500,"to":2554}<fsm-vh3gqscxm4e>
import { type UseCallsStatusReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getCallsStatus`](https://viem.sh/docs/actions/wallet/getCallsStatus)

---

---
url: /react/api/hooks/useCapabilities.md
description: Hook for fetching the number of the most recent block seen.
---

# useCapabilities

Hook to extract capabilities (grouped by chain ID) that a connected wallet supports (e.g. paymasters, session keys, etc).

[Read more.](https://github.com/ethereum/EIPs/blob/815028dc634463e1716fc5ce44c019a6040f0bef/EIPS/eip-5792.md#wallet_getcapabilities)

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCapabilities.md","from":608,"to":648}<fsm-vh3gqscxm4e>
import { useCapabilities } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCapabilities.md","from":697,"to":792}<fsm-vh3gqscxm4e>
import { useCapabilities } from 'wagmi'

function App() {
  const result = useCapabilities()
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCapabilities.md","from":864,"to":919}<fsm-vh3gqscxm4e>
import { type UseCapabilitiesParameters } from 'wagmi'
```

### account

`Account | Address | undefined`

Fetch capabilities for the provided account.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCapabilities.md","from":1048,"to":1245}<fsm-vh3gqscxm4e>
import { useCapabilities } from '@wagmi/core'
import { config } from './config'

const status = await useCapabilities({
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCapabilities.md","from":1499,"to":1679}<fsm-vh3gqscxm4e>
import { useCapabilities } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useCapabilities({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

Connector to get call statuses with.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCapabilities.md","from":1842,"to":2107}<fsm-vh3gqscxm4e>
import { useCapabilities, useConnections } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const connections = useConnections()
  const result = useCapabilities({
    connector: connections[0]?.connector, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCapabilities.md","from":2327,"to":2516}<fsm-vh3gqscxm4e>
import { useCapabilities } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useCapabilities({
    scopeKey: 'foo', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useCapabilities.md","from":2632,"to":2687}<fsm-vh3gqscxm4e>
import { type UseCapabilitiesReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getCapabilities`](https://viem.sh/docs/actions/wallet/getCapabilities)

---

---
url: /react/api/hooks/useChainId.md
description: Hook for getting current chain ID.
---

# useChainId

Hook for getting current chain ID.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useChainId.md","from":142,"to":177}<fsm-vh3gqscxm4e>
import { useChainId } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useChainId.md","from":226,"to":312}<fsm-vh3gqscxm4e>
import { useChainId } from 'wagmi'

function App() {
  const chainId = useChainId()
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useChainId.md","from":384,"to":434}<fsm-vh3gqscxm4e>
import { type UseChainIdParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useChainId.md","from":642,"to":813}<fsm-vh3gqscxm4e>
import { useChainId } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const chainId = useChainId({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useChainId.md","from":886,"to":936}<fsm-vh3gqscxm4e>
import { type UseChainIdReturnType } from 'wagmi'
```

`number`

Current chain ID from [`config.state.chainId`](/react/api/createConfig#chainid).

::: info
Only returns chain IDs for chains configured via `createConfig`'s [`chains`](/react/api/createConfig#chains) parameter.

If the active [connection](/react/api/createConfig#connection) [`chainId`](/react/api/createConfig#chainid-1) is not from a chain included in your Wagmi `Config`, `useChainId` will return the last configured chain ID.
:::

## Action

* [`getChainId`](/core/api/actions/getChainId)
* [`watchChainId`](/core/api/actions/watchChainId)

---

---
url: /solid/api/primitives/useChainId.md
description: Primitive for getting current chain ID.
---

# useChainId

Primitive for getting current chain ID.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useChainId.md","from":152,"to":194}<fsm-vh3gqscxm4e>
import { useChainId } from '@wagmi/solid'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useChainId.md","from":243,"to":377}<fsm-vh3gqscxm4e>
import { useChainId } from '@wagmi/solid'

function App() {
  const chainId = useChainId()
  
  return <p>Chain ID: {chainId()}</p>
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useChainId.md","from":449,"to":541}<fsm-vh3gqscxm4e>
import { useChainId } from '@wagmi/solid'

useChainId.Parameters
useChainId.SolidParameters
```

Parameters are passed as a getter function to maintain Solid reactivity.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useChainId.md","from":626,"to":660}<fsm-vh3gqscxm4e>
useChainId(() => ({
  config,
}))
```

### config

`Config | undefined`

[`Config`](/solid/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/solid/api/WagmiProvider).

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useChainId.md","from":856,"to":921}<fsm-vh3gqscxm4e>
import { useChainId } from '@wagmi/solid'

useChainId.ReturnType
```

`Accessor<number>`

Returns an accessor containing the current chain ID from the config state.

::: info
Only returns chain IDs for chains configured via `createConfig`'s [`chains`](/solid/api/createConfig#chains) parameter.

If the active [connection](/solid/api/createConfig#connection) [`chainId`](/solid/api/createConfig#chainid-1) is not from a chain included in your Wagmi `Config`, `useChainId` will return the last configured chain ID.
:::

## Action

* [`getChainId`](/core/api/actions/getChainId)
* [`watchChainId`](/core/api/actions/watchChainId)

---

---
url: /vue/api/composables/useChainId.md
description: Composable for getting current chain ID.
---

# useChainId

Composable for getting current chain ID.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useChainId.md","from":154,"to":194}<fsm-vh3gqscxm4e>
import { useChainId } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useChainId.md","from":243,"to":348}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useChainId } from '@wagmi/vue'

const chainId = useChainId()
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useChainId.md","from":418,"to":473}<fsm-vh3gqscxm4e>
import { type UseChainIdParameters } from '@wagmi/vue'
```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useChainId.md","from":665,"to":851}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useChainId } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const chainId = useChainId({
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useChainId.md","from":922,"to":977}<fsm-vh3gqscxm4e>
import { type UseChainIdReturnType } from '@wagmi/vue'
```

`number`

Current chain ID from [`config.state.chainId`](/vue/api/createConfig#chainid).

::: info
Only returns chain IDs for chains configured via `createConfig`'s [`chains`](/vue/api/createConfig#chains) parameter.

If the active [connection](/vue/api/createConfig#connection) [`chainId`](/vue/api/createConfig#chainid-1) is not from a chain included in your Wagmi `Config`, `useChainId` will return the last configured chain ID.
:::

## Action

* [`getChainId`](/core/api/actions/getChainId)
* [`watchChainId`](/core/api/actions/watchChainId)

---

---
url: /react/api/hooks/useChains.md
description: Hook for getting configured chains
---

# useChains

Hook for getting configured chains

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useChains.md","from":140,"to":174}<fsm-vh3gqscxm4e>
import { useChains } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useChains.md","from":223,"to":306}<fsm-vh3gqscxm4e>
import { useChains } from 'wagmi'

function App() {
  const chains = useChains()
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useChains.md","from":378,"to":427}<fsm-vh3gqscxm4e>
import { type UseChainsParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useChains.md","from":635,"to":803}<fsm-vh3gqscxm4e>
import { useChains } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const chains = useChains({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useChains.md","from":876,"to":925}<fsm-vh3gqscxm4e>
import { type UseChainsReturnType } from 'wagmi'
```

`readonly [Chain, ...Chain[]]`

Chains from [`config.chains`](/react/api/createConfig#chains).

## Action

* [`getChains`](/core/api/actions/getChains)

---

---
url: /solid/api/primitives/useChains.md
description: Primitive for getting configured chains.
---

# useChains

Primitive for getting configured chains.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useChains.md","from":152,"to":193}<fsm-vh3gqscxm4e>
import { useChains } from '@wagmi/solid'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useChains.md","from":242,"to":484}<fsm-vh3gqscxm4e>
import { useChains } from '@wagmi/solid'
import { For } from 'solid-js'

function App() {
  const chains = useChains()
  
  return (
    <ul>
      <For each={chains()}>
        {(chain) => <li>{chain.name}</li>}
      </For>
    </ul>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useChains.md","from":556,"to":645}<fsm-vh3gqscxm4e>
import { useChains } from '@wagmi/solid'

useChains.Parameters
useChains.SolidParameters
```

Parameters are passed as a getter function to maintain Solid reactivity.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useChains.md","from":730,"to":763}<fsm-vh3gqscxm4e>
useChains(() => ({
  config,
}))
```

### config

`Config | undefined`

[`Config`](/solid/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/solid/api/WagmiProvider).

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useChains.md","from":959,"to":1022}<fsm-vh3gqscxm4e>
import { useChains } from '@wagmi/solid'

useChains.ReturnType
```

`Accessor<readonly Chain[]>`

Returns an accessor containing the configured chains.

## Action

* [`getChains`](/core/api/actions/getChains)

---

---
url: /vue/api/composables/useChains.md
description: Composable for getting configured chains
---

# useChains

Composable for getting configured chains

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useChains.md","from":152,"to":191}<fsm-vh3gqscxm4e>
import { useChains } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useChains.md","from":240,"to":342}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useChains } from '@wagmi/vue'

const chains = useChains()
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useChains.md","from":412,"to":466}<fsm-vh3gqscxm4e>
import { type UseChainsParameters } from '@wagmi/vue'
```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useChains.md","from":658,"to":841}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useChains } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const chains = useChains({
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useChains.md","from":912,"to":966}<fsm-vh3gqscxm4e>
import { type UseChainsReturnType } from '@wagmi/vue'
```

`readonly [Chain, ...Chain[]]`

Chains from [`config.chains`](/vue/api/createConfig#chains).

## Action

* [`getChains`](/core/api/actions/getChains)

---

---
url: /react/api/hooks/useClient.md
description: Hook for getting Viem `Client` instance.
---

# useClient

Hook for getting Viem [`Client`](https://viem.sh/docs/clients/custom) instance.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useClient.md","from":191,"to":225}<fsm-vh3gqscxm4e>
import { useClient } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useClient.md","from":274,"to":357}<fsm-vh3gqscxm4e>
import { useClient } from 'wagmi'

function App() {
  const client = useClient()
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useClient.md","from":429,"to":478}<fsm-vh3gqscxm4e>
import { type UseClientParameters } from 'wagmi'
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when getting Viem Client.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useClient.md","from":620,"to":840}<fsm-vh3gqscxm4e>
import { useClient } from 'wagmi'
import { mainnet } from 'wagmi/chains' // [!code focus]
import { config } from './config'

function App() {
  const client = useClient({
    chainId: mainnet.id, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useClient.md","from":1093,"to":1261}<fsm-vh3gqscxm4e>
import { useClient } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const client = useClient({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useClient.md","from":1334,"to":1383}<fsm-vh3gqscxm4e>
import { type UseClientReturnType } from 'wagmi'
```

`Client | undefined`

Viem [`Client`](https://viem.sh/docs/clients/custom) instance.

## Action

* [`getClient`](/core/api/actions/getClient)
* [`watchClient`](/core/api/actions/watchClient)

---

---
url: /solid/api/primitives/useClient.md
description: Primitive for getting Viem Client.
---

# useClient

Primitive for getting [Viem Client](https://viem.sh/docs/clients/intro) instance.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useClient.md","from":187,"to":228}<fsm-vh3gqscxm4e>
import { useClient } from '@wagmi/solid'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useClient.md","from":277,"to":367}<fsm-vh3gqscxm4e>
import { useClient } from '@wagmi/solid'

function App() {
  const client = useClient()
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useClient.md","from":439,"to":528}<fsm-vh3gqscxm4e>
import { useClient } from '@wagmi/solid'

useClient.Parameters
useClient.SolidParameters
```

Parameters are passed as a getter function to maintain Solid reactivity.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useClient.md","from":613,"to":650}<fsm-vh3gqscxm4e>
useClient(() => ({
  chainId: 1,
}))
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when getting the client.

### config

`Config | undefined`

[`Config`](/solid/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/solid/api/WagmiProvider).

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useClient.md","from":950,"to":1013}<fsm-vh3gqscxm4e>
import { useClient } from '@wagmi/solid'

useClient.ReturnType
```

`Accessor<Client | undefined>`

Returns an accessor containing the Viem Client instance, or `undefined` if not available.

## Action

* [`getClient`](/core/api/actions/getClient)

---

---
url: /vue/api/composables/useClient.md
description: Composable for getting Viem `Client` instance.
---

# useClient

Composable for getting Viem [`Client`](https://viem.sh/docs/clients/custom) instance.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useClient.md","from":203,"to":242}<fsm-vh3gqscxm4e>
import { useClient } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useClient.md","from":291,"to":393}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useClient } from '@wagmi/vue'

const client = useClient()
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useClient.md","from":463,"to":517}<fsm-vh3gqscxm4e>
import { type UseClientParameters } from '@wagmi/vue'
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when getting Viem Client.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useClient.md","from":661,"to":901}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useClient } from '@wagmi/vue'
import { mainnet } from '@wagmi/vue/chains' // [!code focus]
import { config } from './config'

const client = useClient({
  chainId: mainnet.id, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useClient.md","from":1137,"to":1320}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useClient } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const client = useClient({
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useClient.md","from":1391,"to":1445}<fsm-vh3gqscxm4e>
import { type UseClientReturnType } from '@wagmi/vue'
```

`Client | undefined`

Viem [`Client`](https://viem.sh/docs/clients/custom) instance.

## Action

* [`getClient`](/core/api/actions/getClient)
* [`watchClient`](/core/api/actions/watchClient)

---

---
url: /react/api/hooks/useConfig.md
description: Hook for getting `Config` from nearest `WagmiProvider`.
---

# useConfig

Hook for getting [`Config`](/react/api/createConfig#config) from nearest [`WagmiProvider`](/react/api/WagmiProvider).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConfig.md","from":244,"to":278}<fsm-vh3gqscxm4e>
import { useConfig } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConfig.md","from":327,"to":410}<fsm-vh3gqscxm4e>
import { useConfig } from 'wagmi'

function App() {
  const config = useConfig()
}
```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConfig.md","from":442,"to":491}<fsm-vh3gqscxm4e>
import { type UseConfigReturnType } from 'wagmi'
```

If you use TypeScript and [register your `Config`](/react/typescript#register-config), the return type will be inferred.

::: code-group

```ts twoslash [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConfig.md","from":660,"to":3560}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"914af31f2d67af9b6a0eb3594b780105455023fedc851e1b259e6312534bc63b","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgBhSf3YBzADwjFK3nRpgocXgrBLlvALyHNa0jGZRJrDL1QAdKbw8AjVhBEBrAFFaLB8bUjhEXmA3D1jYmzsHJ1h+ZkFWNEjo9zjc3gT7MEdeMGYAWxhIlxAAtHwyOBFmMGqAbhi83IKk6VJWKoI0NCwIgHpRmDqGprAAOgk2js7420Li5ix2AFU+gfwhkcRxjfZZyfrwmfmIUZPFnNyAX3aH56Xeb18/ABV2CsiAIwAJgADGCXnENGA0KRmGIIlF3nFukUnDAwHAtmB2CRwmwAErwCCsXFZJGdFHrKBQGxwBHVEG0GDMlnMgEAFigAHYAQAOERAzzsrlQACcoqBAGZYMxPADJZKAKwwDns1n3ZbI1Y9T7+OQJGhQSJSkG8xXm3kQzpvB5axKo3hldLiJqsViSsm2inah12GnwekgRlNAEAzywEGK0VcrmeSUANklofjXJBQN5vPjgpgQOYAK5kuj8ZDAI1mo8lKcur8+tshsB7KVCZBAKteRtcQ7sVmPd4HMdEBsvB7szbvFx7H4GAAElx8AB+SKMRgiDjozKGNfQ1QjgB8FF4WGYsIqNHCkQAamRJzO5wAFY/lSYNPhmXe8O+kCBldiyVSeCBiVsMBdz4AAfaQ9BgJQwBgKAXkeA9sjiEcEIAXV3XdGCPE9n3CRdeC2WQjBMB9cLPOB1CsUDIiI+QrEJNBBFIMBvmwGAqOMFRdzcP4sEHNBpGIqxKBAewRAQRBBmGMZRgAd2YZQf1mOB8FGBIxFuTZRkICA/DgUYZHorjlFEuA0GPBhEFFKhWHRZQ6iQGzqGPZRJjwIySJUUSOFgpAQSoER8EfMQyCcxD0HYvBCFxUSaHoPAhFEcRJF4ABBLAsEYbhIiICB2CgMyLNIKz2XZWz7McxBJSoYq3KskAMqwHz2D8xAgUC4LYVC8hrIi6goqkmKwtqnQ8ChczeChExIi86wfWKVwHmrIIQkHBpPWWSteBSNIMk28t8gWpxSn+XhqlqC5GmaMty225j+nO6TDnGc5pmaa5bs1baTh2R7qn2GSji0043suD6JBBr7OzHLsvB8fxfjO4EwRBMcoRhOE0ARZDvXtYp0UxbFcTgAkiRJMgDru47eD9WlA0ZVlWQ5bk+QFIURXFKUZTlBVlVVdUQDHLaaerWtmHrXgTTNC1hdiOGuhpp0MnYV13Sp76abpgMBmDPMwwjKMYzjRNk1TdNM2zXN80LLli316G8bWKsEZrA04IbJt4xbOWPAVhWRz7dkByHVD3gnKdZ1Ugjl1Xdh11mrc0B3Ht90PR9Tw23gr1IG8o/wMinwo1930/b9fw4gCgOaUDeAg4QUlauCEKQ94w7AR4MKKyykG9iqwAc/Be9q1z3Kk6bvNspukBqkAgpCs8kF5frMBwPAAEdBDIDA4rG8fJEmiflFmqxVG2pa4hW4JQiz3G8m23bnQ1kX8ZOp8Bku96WiF8l75ph69gHFkmDa6cwFg/y9H/V+tNNh/UAUDY4mwzhTHBmAm4dwIHLH9mOasSNKh9lBOCd4GNurY2fisaBhMsQ4gaGTOAxJSSIkgYraB2s6S6yZEzNknIeT8kFMKMUEppS2F5kqFUZVBa+xYc7D4rtxaS2luaRUlpf68AVnaGRysXRsHVkww6R1WHUnphwks4YYCRmjLGBMSYAQpjTBmLMngcx5gLEWEsjsoEyLFu7I0QcvY+1UdgtuvZ+xlHWsOHsY4I63mjkuFcSdE7x23HuA8OEi5Zxznne8Gc8I8HMKXL8P4/xVzsjXcCkFG6wXgm4RCejuyRJqV3Kg5ke6ID7iAOyA8qrxhHqQeq40RJTzarPeepCwqIGXhQSKa8hrEBGtQPeIAWAcC4HwTyp85pnxphfWIV81phBxqoh+0E9objvpraBp18EXRQaAjx0iegAKeoDF6ExblXHAVIjRPRfq7GeUA4GJxkFXQ+egzY9ygnLVdngwEhC0bEMkJjeE5CKw0yocTWhrBCT0IpqQFFDzfRGJ1k9RmXDxGsz4RzQR3MRHyjEQLFk9zvkOm8XWD2UtJSmiUSo5h6iKGaOdKrHRHo6nU0Mf6dhJLaCmMNpYk2Ni7EW0cc4m2biHaYMOttVlEt2Ucn8a2QJsMxyB1CeE9ucRon5xjvEpJG45BJxTrMNOaTM7nmzteSO2TyIvnyR+QpFd/yAVKSBcpDdoJN2qR3VuDx26d0wthHJFECJ0TmoXV1lE9w5UsCZR1PFsRlH4iVISxkTCiXEpJZ6skFJKVOKpdSthNInB0oBfShlhImW7iVXuzlOmDycr0/pUl1kdqGbgaqnUF7jPzJ3QK0Ax0gD4gJKIxa5pqIEIU3gAByatP5N1uDcElMQEgpBNWynUiagkj7mBXVYbKNTRKnmYEgUAOhCbHrwNjEAjxHhAA=="}
import { type Config } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

declare module 'wagmi' {
  interface Register {
    config: Config<readonly [typeof mainnet, typeof sepolia]>
  }
}
// ---cut---
import { useConfig } from 'wagmi'

function App() {
  const config = useConfig()
  //    ^?
}
```

```ts [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConfig.md","from":3583,"to":3899}<fsm-vh3gqscxm4e>
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

declare module 'wagmi' {
  interface Register {
    config: typeof config
  }
}

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

:::

---

---
url: /solid/api/primitives/useConfig.md
description: Primitive for getting Wagmi Config.
---

# useConfig

Primitive for getting the current Wagmi [`Config`](/solid/api/createConfig#config).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConfig.md","from":190,"to":231}<fsm-vh3gqscxm4e>
import { useConfig } from '@wagmi/solid'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConfig.md","from":280,"to":370}<fsm-vh3gqscxm4e>
import { useConfig } from '@wagmi/solid'

function App() {
  const config = useConfig()
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConfig.md","from":442,"to":531}<fsm-vh3gqscxm4e>
import { useConfig } from '@wagmi/solid'

useConfig.Parameters
useConfig.SolidParameters
```

Parameters are passed as a getter function to maintain Solid reactivity.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConfig.md","from":616,"to":663}<fsm-vh3gqscxm4e>
useConfig(() => ({
  config: customConfig,
}))
```

### config

`Config | undefined`

[`Config`](/solid/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/solid/api/WagmiProvider).

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConfig.md","from":859,"to":922}<fsm-vh3gqscxm4e>
import { useConfig } from '@wagmi/solid'

useConfig.ReturnType
```

`Accessor<Config>`

Returns an accessor containing the Wagmi Config.

---

---
url: /vue/api/composables/useConfig.md
description: Composable for getting `Config` from the `WagmiPlugin`.
---

# useConfig

Composable for getting [`Config`](/vue/api/createConfig#config) from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConfig.md","from":238,"to":272}<fsm-vh3gqscxm4e>
import { useConfig } from 'wagmi'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConfig.md","from":321,"to":418}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConfig } from 'wagmi'

const config = useConfig()
</script>
```

:::

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConfig.md","from":450,"to":499}<fsm-vh3gqscxm4e>
import { type UseConfigReturnType } from 'wagmi'
```

---

---
url: /react/api/hooks/useConnect.md
description: Hook for connecting accounts with connectors.
---

# useConnect

Hook for connecting accounts with [connectors](/react/api/connectors).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnect.md","from":588,"to":623}<fsm-vh3gqscxm4e>
import { useConnect } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnect.md","from":672,"to":916}<fsm-vh3gqscxm4e>
import { useConnect } from 'wagmi'
import { injected } from 'wagmi/connectors'

function App() {
  const connect = useConnect()
  return (
    <button onClick={() => connect.mutate({ connector: injected() })}>
      Connect
    </button>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnect.md","from":988,"to":1038}<fsm-vh3gqscxm4e>
import { type UseConnectParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnect.md","from":1246,"to":1417}<fsm-vh3gqscxm4e>
import { useConnect } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const connect = useConnect({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnect.md","from":1536,"to":1586}<fsm-vh3gqscxm4e>
import { type UseConnectReturnType } from 'wagmi'
```

### connectors [deprecated](/react/guides/migrate-from-v2-to-v3#removed-useconnect-connectors-usereconnect-connectors)

`readonly Connector[]`

Globally configured connectors via [`createConfig`](/react/api/createConfig#connectors). Useful for rendering a list of available connectors.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnect.md","from":1942,"to":2249}<fsm-vh3gqscxm4e>
import { useConnect } from 'wagmi'

function App() {
  const connect = useConnect()

  return (
    <div>
      {connect.connectors.map((connector) => (
        <button key={connector.id} onClick={() => connect.mutate({ connector })}>
          {connector.name}
        </button>
      ))}
    </div>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

::: tip
Not all connectors support connecting directly to a `chainId` (e.g. they don't support programmatic chain switching). In those cases, the connector will connect to whatever chain the connector's provider (e.g. wallet) is connected to.
:::

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`connect`](/core/api/actions/connect)

---

---
url: /solid/api/primitives/useConnect.md
description: Primitive for connecting accounts with connectors.
---

# useConnect

Primitive for connecting accounts with [connectors](/solid/api/connectors).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnect.md","from":541,"to":583}<fsm-vh3gqscxm4e>
import { useConnect } from '@wagmi/solid'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnect.md","from":632,"to":893}<fsm-vh3gqscxm4e>
import { useConnect } from '@wagmi/solid'
import { injected } from '@wagmi/solid/connectors'

function App() {
  const connect = useConnect()
  
  return (
    <button onClick={() => connect.mutate({ connector: injected() })}>
      Connect
    </button>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnect.md","from":965,"to":1057}<fsm-vh3gqscxm4e>
import { useConnect } from '@wagmi/solid'

useConnect.Parameters
useConnect.SolidParameters
```

Parameters are passed as a getter function to maintain Solid reactivity.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnect.md","from":1142,"to":1201}<fsm-vh3gqscxm4e>
useConnect(() => ({
  config,
  // mutation options...
}))
```

### config

`Config | undefined`

[`Config`](/solid/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/solid/api/WagmiProvider).

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnect.md","from":1443,"to":1508}<fsm-vh3gqscxm4e>
import { useConnect } from '@wagmi/solid'

useConnect.ReturnType
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

::: tip
Not all connectors support connecting directly to a `chainId` (e.g. they don't support programmatic chain switching). In those cases, the connector will connect to whatever chain the connector's provider (e.g. wallet) is connected to.
:::

## Action

* [`connect`](/core/api/actions/connect)

---

---
url: /vue/api/composables/useConnect.md
description: Composable for connecting accounts with connectors.
---

# useConnect

Composable for connecting accounts with [connectors](/vue/api/connectors).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnect.md","from":603,"to":643}<fsm-vh3gqscxm4e>
import { useConnect } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnect.md","from":692,"to":952}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnect } from '@wagmi/vue'
import { injected } from '@wagmi/connectors'

const connect = useConnect()
</script>

<template>
  <button @click="connect.mutate({ connector: injected() })">
    Connect
  </button>
</template>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnect.md","from":1022,"to":1077}<fsm-vh3gqscxm4e>
import { type UseConnectParameters } from '@wagmi/vue'
```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnect.md","from":1269,"to":1455}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnect } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const connect = useConnect({
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnect.md","from":1572,"to":1627}<fsm-vh3gqscxm4e>
import { type UseConnectReturnType } from '@wagmi/vue'
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

::: tip
Not all connectors support connecting directly to a `chainId` (e.g. they don't support programmatic chain switching). In those cases, the connector will connect to whatever chain the connector's provider (e.g. wallet) is connected to.
:::

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`connect`](/core/api/actions/connect)

---

---
url: /react/api/hooks/useConnection.md
description: Hook for getting current connection.
---

# useConnection

Hook for getting current connection.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnection.md","from":152,"to":190}<fsm-vh3gqscxm4e>
import { useConnection } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnection.md","from":239,"to":334}<fsm-vh3gqscxm4e>
import { useConnection } from 'wagmi'

function App() {
  const connection = useConnection()
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnection.md","from":406,"to":459}<fsm-vh3gqscxm4e>
import { type UseConnectionParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnection.md","from":667,"to":847}<fsm-vh3gqscxm4e>
import { useConnection } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const connection = useConnection({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnection.md","from":920,"to":973}<fsm-vh3gqscxm4e>
import { type UseConnectionReturnType } from 'wagmi'
```

### address

`Address | undefined`

* Connected address from connector.
* Defaults to first address in [`addresses`](#addresses).

### addresses

`readonly Address[] | undefined`

Connected addresses from connector.

### chain

`Chain | undefined`

Connected chain from connector. If chain is not configured by config, it will be `undefined`.

### chainId

`number | undefined`

Connected chain id from connector.

### connector

`Connector | undefined`

Connected connector.

### isConnecting / isReconnecting / isConnected / isDisconnected

`boolean`

Boolean variables derived from [`status`](#status).

### status

`'connecting' | 'reconnecting' | 'connected' | 'disconnected'`

* `'connecting'` attempting to establish connection.
* `'reconnecting'` attempting to re-establish connection to one or more connectors.
* `'connected'` at least one connector is connected.
* `'disconnected'` no connection to any connector.

::: info You can use `status` to narrow the return type.
For example, when `status` is `'connected'` properties like `address` are guaranteed to be defined.

```ts twoslash
// @twoslash-cache: {"v":1,"hash":"70621ff7ba048810d10cff60e35c82126a2beb12177fb38b972d09b620d6367c","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BjCMONAAmbDBkbQEsWidgHEYaAMIsefQWABK4gK6kwAFWy4qbAIakGiACxUANjDABzNPiQBGAAxU0ei+KbTeAlpRAn+PJEcQRnw9HT4yJEMAXwp0TTxCEnInOgMQAAosUggcfQwASnZdNCU4YQAdECh+OC4ZGigq9gAfdir6zxgmkFb2kFJeD1lLZraO4YFRkB9dfTsAVlNzKxtEADYnFzdEEBKynz8AxCCQsIjyRFsF2PicROJI1Pp3Vg5O2SF2YAqwdn/2DooFBBnByuwAILA0FwADcvwBgOh8Dg8GEgyBLBMGHYyChIJRFHYADpSfiYcgALqU+F/AFnfzCCShfx9JRgWAAM383VpiIZYAAklBhGAlABbABGZD59MmEFITPlpFl/1qUm4XRF7DQpCUMFV7HVk38FmEnJ0JlRhtqABFah9GubLdaEQDaopHabnVaDW7/vtwRNNREerTorNnPMjABmZaWax2IJR1zpL3eUw8uxUM6kcI0S4AJlu1ASuwAjvrSBgfDQXrsuGxOCavj86f8gQSwcJySjDZ2YWj2BioFicXjkWCiaTib2wVSaf7OCywEyV2yOTBuTwoIaBcLRRLpSql46FUqQ2gFTa4BqGt1hLr9Te755vewLb6b/a6pMHx+XT9dsjTgT0TUsH1XWAwNKmCP8w1+CNtCjAxDDjXwVkTK5k22NMWzAQ4syuHNQjzC4kGLSkc2gXBdn4Tl2AydMwGJQN2AAXk49gAHJHW6biijbf5mN+USwDEiTxKkyTJKQkBxXEHQkFANJzDgOQ8DQBBomiIA==="}
import { type GetConnectionReturnType } from '@wagmi/core'
const connection = {} as GetConnectionReturnType
// ---cut---
if (connection.status === 'connected') {
  connection
  // ^?















}
```

Or when status is `'disconnected'` properties like `address` are guaranteed to be `undefined`:

```ts twoslash
// @twoslash-cache: {"v":1,"hash":"03f1cafa2983888b08080373baa176953254622dd97feb972d42875fedc5dd86","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BjCMONAAmbDBkbQEsWidgHEYaAMIsefQWABK4gK6kwAFWy4qbAIakGiACxUANjDABzNPiQBGAAxU0ei+KbTeAlpRAn+PJEcQRnw9HT4yJEMAXwp0TTxCEnInOgMQAAosUggcfQwASnZdNCU4YQAdECh+OC4ZGigq9gAfdir6zxgmkFb2kFJeD1lLZraO4YFRkB9dfTsAVlNzKxtEADYnFzdEEBKynz8AxCCQsIjyRFsF2PicROJI1Pp3Vg5O2SF2YAqwdn/2DooFBBnByuwlGBYAAzfzdADcvwBgOBoLg8GEkJhcKgiL+ALO/kxUJgsJ4uKRBNC/gAklBidjyXjkR80BBSAzSTjmQDalJuF16exoToTOief9aopWf4LMIRWKYBL2HzJrL5aLxZTJXAACK1VndYRoUhKJXa4rOUrgqo1OqTbpVPHRWbOeZGTa+FbWOxBN2udIy7ymOF2KhnUjhGiXABMt2oCV2AEczaQMD4aC9dlw2Jw1V8fvj/kCQfBwViuUyLSW0RiISSyQiLYSwJzGxSi5xqWA6W3uc3Juy+1XO6qBREhQqtaO4NK1ZYNYrlWOGurhZrzTP9fbx41jabN8j9jbqgaHT1na69AZDJ6zJYfVc/dtA/mwIdQ1dw6FIxckHGAF1w2gXBdn4aF2AyIMwAAOmPdgAF4kPYAByO1DSgFCikLf5oN+fCwAIojCJI4jiJdKgAFtxB0JBQDScw4DkPA0AQaJoiAA"}
import { type GetConnectionReturnType } from '@wagmi/core'
const connection = {} as GetConnectionReturnType
// ---cut---
if (connection.status === 'disconnected') {
  connection
  // ^?















}
```

:::

## Action

* [`getConnection`](/core/api/actions/getConnection)

---

---
url: /solid/api/primitives/useConnection.md
description: Primitive for getting current connection.
---

# useConnection

Primitive for getting current connection.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnection.md","from":162,"to":207}<fsm-vh3gqscxm4e>
import { useConnection } from '@wagmi/solid'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnection.md","from":256,"to":580}<fsm-vh3gqscxm4e>
import { useConnection } from '@wagmi/solid'
import { Show } from 'solid-js'

function App() {
  const connection = useConnection()
  
  return (
    <Show when={connection.isConnected} fallback={<p>Not connected</p>}>
      <p>Address: {connection.address}</p>
      <p>Chain ID: {connection.chainId}</p>
    </Show>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnection.md","from":652,"to":753}<fsm-vh3gqscxm4e>
import { useConnection } from '@wagmi/solid'

useConnection.Parameters
useConnection.SolidParameters
```

Parameters are passed as a getter function to maintain Solid reactivity.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnection.md","from":838,"to":875}<fsm-vh3gqscxm4e>
useConnection(() => ({
  config,
}))
```

### config

`Config | undefined`

[`Config`](/solid/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/solid/api/WagmiProvider).

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnection.md","from":1071,"to":1142}<fsm-vh3gqscxm4e>
import { useConnection } from '@wagmi/solid'

useConnection.ReturnType
```

### address

`Address | undefined`

The connected account address.

### addresses

`readonly Address[] | undefined`

All connected account addresses.

### chain

`Chain | undefined`

The connected chain.

### chainId

`number | undefined`

The connected chain ID.

### connector

`Connector | undefined`

The active connector.

### isConnected

`boolean`

Whether an account is connected.

### isConnecting

`boolean`

Whether a connection is in progress.

### isDisconnected

`boolean`

Whether the account is disconnected.

### isReconnecting

`boolean`

Whether a reconnection is in progress.

### status

`'connected' | 'connecting' | 'disconnected' | 'reconnecting'`

The current connection status.

## Action

* [`getConnection`](/core/api/actions/getConnection)

---

---
url: /vue/api/composables/useConnection.md
description: Composable for getting current connection.
---

# useConnection

Composable for getting current connection.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnection.md","from":164,"to":207}<fsm-vh3gqscxm4e>
import { useConnection } from '@wagmi/vue'
```

## Usage

::: code-group

```vue twoslash [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnection.md","from":265,"to":3520}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"13c71d856a5988592573d4377882b1c1fa1e1a07a6da8a54925e9753a897fb69","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAIAzAK5gAxmnYQwvQXBgBhSWBhiJYADwjJ/dgHNedGmChxeCsNr0BeU1t1rSMZlEmsMvVAB0pvHwCNWECIA1gCitFgBDqRwiLzAXj6JiQ5OLm6w/MyCrGix8d5JhbwpzmCuvGDMALYwsR4gIWj4ZHAizGD1ANwJRYUladKkrHUEaGhYMQD0kzBNLW1gAHQSXT29yY6l5cxY7ACqQyP4YxOI0zvsi7PN0QvLEJMXqwWFAL7dL+9rvP6BQQAq7BqsQAjAAmAAMUI+SU0YDQpGYYhicW+SX6ZTcMDAcD2YHYJGibAASvAIKxCXk0b0MdsoFAHHAUfUIbQYOyOeyQQAWKAAdhBAA4RGDfNy+VAAJySsEAZlgzF8INlsoArDAedzOc91ujNgNfsE5CkaFBYnKIYLVdbBTDel8XnrUpjeFVsuI2qxWLKqY6afqXU4GfBmSBWW0QSDfLAIarJXy+b5ZQA2WWR5N8iFgwWC5OimBg5ggvmy+PJiMgnW6ny0tyGoLGxym0HctUpiEgu1FB1JHuJRYD3g810QBy8AeLLu8QnsfgYAASXHwAH5YoxGCIONjcqYt/C1BOAHwUXhYZiImo0aKxABqZFnC6XAAVz9VZi0+JZD7wn6QIFV2FkNRfAgclHDAQ8+AAH2kIwYG0JQoA+V4T3yJIJ2QgBdQ9D0YM8L3faJV14PZZDMJQVEkF8CKvOANFsHRINiUj5EUZRxEkUk0EEUgwH+bAYHo8xdEPLwgSwUc0GkMi2MosBKBAZwRAQRBRnGKZJgAd2YHQAMWOB8EmIhBBgR5dkmTQqgkuBFVYeBJhkViwAojj5KoOA0HPBhEFlbkqDssAdCaJBlSoTzSB0WY8Ec8j2NUBSOCUEKqBEfBXzEMgkElFD0AEvBCEJBSaHoPA4Q83g4Rc1RmJk5y4s42YeL4gS1DMCx7ADcpPBeeswgiUcWl9dZa14DIshyIbq2KTq3EqYFeHqRobladoq2rEaeOGBa1NOaZrnmdp7jW3URouA4tvqY51LOMzLn225DokW7jt7Kc+z8AJgkBebwShCEpzhBEkTQFE0P9Z1ymxXF8UJGzWFJOByUpVE/SKU76UZUNWU5TkeX5IURTFCVpTlBUlRVdVNW1EAp2Gmafk+hsTRgM1eAtK0bVpxJ3r6em3RydhPW9Sb1vpoNMZGcMiyjGM4wTJNU3TTNs1zfNC2LUs+XLaWXvBrY60ZxtmGbIdW1VdtO2pHweZ5idTZHMcMO+Gc50XAziPXTd2G3WI5D3NADwHY9T1fS9Bt4O9SAfN38Got9aM/b9f3/QDBJAsD2kg3gYOEDJ2EQ5DUO+J2wFebDDwUjyvKQPlVX87EgvwEKITC89Iu8kBKvqtyQES3AfJStLEQy8hEGTHLqDy1SCsysKDCYNhOB4aSnKqyRWoYjqIbcbqkl68JInDsG0fpsb3RFk76bm2ptqWg6Ohpq3ee3wYLp2jT7pWpYVkf1Hn/13gZ1DjbSurtW6Vw5gPW/g8J4v91g2ynPWb6N9frQm+IDYeIML5OgAVDPEBIWgkjJBSMg2C9YDHFiGSWbIcZcl5AKYUopxRShlPKRw5M1Qam5FqDkusT4v3rEbE27NrSqltE/HmOCBj8w9GwYWKMprTRfpQpk1CKzRhgLGeMiYUxphBBmLMOY8y+ALEWEsZYKx8P/gaQ2zNWY8jbMmDsXNrZvSnHbYcVQBrjgHFOF2j53Zrg3P7X2/tA6LGDvheO4dI7R2fKHQiy8vw/j/ABIC6c7KZ2grBPOBcvAoQUf2Xx+Ty54QSbRYiLFYpyTjmHaI4SmIkVqmvMAXEmr8RwA0sSVlJIr2qa5BSSkVLvxutpXSlwDJGRMrdCy/5rK2XsjFWSAz3LhW8jmeugVgqIFCtQNuUVVJLLqnJBK+d+6ykHulK8IVsoUFyjgfKxBZ7UHnqpMqUku5yRqqvbubTeIdMEm1OwI1d6JH3v1KIoMn4jTPhNQposX7XxGHfKBVipEuk2kcE4H9IFfyOnAqap1djnSxddc4uwIHLTuE9WBLjeAIO+EgoEKDIRoJeBg4GUK/4jTwTDQh8NiHI2PpfZRGMqHbWxrQrh+NGFExYaTdhypOFU14QShFADBF2PNLKS0ojxF/0kRsF+MjBZyJ9PCkVACVFY1oOo2W2iFZ6IMSrYxpiNYWJ1mqy1Ni/hCJZi2RxziJFuOLoOTx3iS5JH8THD2wTvbwlCfGgOR4TxRLqSiWJrt4k0Q/LwZJyc0lp1ApkiC2Tc7wTOUhfJRcXglzLjhSuayQrchbr3Bu2yQStvCu3Uqyz4r+TOTXS5mDMo7O5BPTADzp5PPIHPEqqk8J/hwKQTAfBrWxFJPwNQ5aEIs2/DBTdagAAGrIAAkwAPJR0Cq8I9+7eCHpPbQc9l7846BvdnHJFbEIV1WdXHZqoQSbMbkOvZEUDkgGtacpKiA+TDuBqOsEqoy4pWgP3EAahWhRywFJWQ3EsC8FYO0HQlh6gg3qKJfEPSV1xD6X2yQ9KBCpN4AAcgAAJjIAlMmAzGvBeHeRVOjUhrBHJaYwbgXg1CTEw+wbDFGJM0CsoRmgFGfAAEExWqLiMAATxzXKLGtfS14EnJgKYiMbGAP6QCXmYEgUABgobxVUsZXArxXhAA"}
<script setup lang="ts">
// ---cut-start---
// @errors: 2322
import { type Config } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

declare module '@wagmi/vue' {
  interface Register {
    config: Config<readonly [typeof mainnet, typeof sepolia]>
  }
}
// ---cut-end---
import { useConnection } from '@wagmi/vue'

const connection = useConnection()
</script>

<template>
  Address: {{ connection.address }}
</template>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnection.md","from":3599,"to":4137}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"7e300c04b97782c39df43713d56b7a3f066187bfbb69ba67cfe1b4d60e143b11","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAJMcvAKpwYAYQhgwMAMZp2kgArNSzALYwapOAB4ZkgGbsA5rzo0wUOLwlgjpgLw3DJgHy8nwADphef3vp2JgD8iAEupgA+zkFRvACuljBG0lAA3D4Avj7salgQpGjCorbScgpgyqoaWghUcGgqDIgAjAAsVKwwYMZo+EgATADMVI2kxpp4IuKSZfJKKuqaZHUgHNJIAAxUMviLcmRI7ZkAujvQuIggufmFvMD82DDFM1Ky85WLNSu8mbwGpAgal4AHIAAIAd2YxjU7AA9ER4jAQZQQDVmEhQOZunAKng0AhMpkgA=="}
import { type UseConnectionParameters } from '@wagmi/vue'
```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnection.md","from":4337,"to":4532}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnection } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const connection = useConnection({
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts twoslash
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnection.md","from":4612,"to":5542}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"b6f1971287fb7adb77e1a5d5dc952329e6dd516b560ac655f5064dcb9d4b925c","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808AKAQwBsBLZuASgAJMcvAKpwYAYQhgwMAMZp2kgEow0AV1JgAKthgAeGZIBm7AOa86NMFDi8JYY2YC8to6YB8vZ5ojLDcXcAAOmC8obzMUFCk8HCIvKpWMMbSUADcwWHhkdFworHxickwaRlhMvjM7GBxCbBFJSFlFVUAklA1hVXF6Y2hBlKyaBCkHXVdDZnscHbScsVxhmyiPZNwyv2z8mAmC0swK2FTM4NVO7yLrMuloVMAIlMbg/P8pKr717xwaMxq+YEgUAekk2xX+PQAvh4AD68by+fxBXpZKIxOIAQWyMQOoQiKNy8Di0QiklYGF4yAxeLgFF4ADp6ZScnBkABdFnY3jlSrVXiMOwOcz0GBWGz9AUAflszRCcTFpmQ/y5VTg/xZyDAqgAtgAjMgsvgw2pJcYcpVgNpxDU6sim4GDYZxY5yYYco52ubtF5vV3Td1bM4XK5Iu5AgYe3aXd7BtayP2nCNBzJfH6qP4gR4esHBSG8GFwpL+em06GwnwF3RFtzBdiarDDNDCURO+RKFTqLQ6SggZOkBiIACMABYqKxhSY0PgkAAmADMVG+pBMKjwInEcdbag02hwXY40iQAAYqFzSMw5uQB4PwSzj9BcIgQDW673eMB+DpG2uwy2wMpNx3BHBc5SAgTVeAAcgAAQAd2YExNXYAB6Ig3nArtNRUZgkFACxhTgBQwDwNAEHBcEgA=="}
import { type UseConnectionReturnType } from '@wagmi/vue'
```

### address

`Address | undefined`

* Connected address from connector.
* Defaults to first address in [`addresses`](#addresses).

### addresses

`readonly Address[] | undefined`

Connected addresses from connector.

### chain

`Chain | undefined`

Connected chain from connector. If chain is not configured by config, it will be `undefined`.

### chainId

`number | undefined`

Connected chain id from connector.

### connector

`Connector | undefined`

Connected connector.

### isConnecting / isReconnecting / isConnected / isDisconnected

`boolean`

Boolean variables derived from [`status`](#status).

### status

`'connecting' | 'reconnecting' | 'connected' | 'disconnected'`

* `'connecting'` attempting to establish connection.
* `'reconnecting'` attempting to re-establish connection to one or more connectors.
* `'connected'` at least one connector is connected.
* `'disconnected'` no connection to any connector.

::: info You can use `status` to narrow the return type.
For example, when `status` is `'connected'` properties like `address` are guaranteed to be defined.

```ts twoslash
// @twoslash-cache: {"v":1,"hash":"70621ff7ba048810d10cff60e35c82126a2beb12177fb38b972d09b620d6367c","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BjCMONAAmbDBkbQEsWidgHEYaAMIsefQWABK4gK6kwAFWy4qbAIakGiACxUANjDABzNPiQBGAAxU0ei+KbTeAlpRAn+PJEcQRnw9HT4yJEMAXwp0TTxCEnInOgMQAAosUggcfQwASnZdNCU4YQAdECh+OC4ZGigq9gAfdir6zxgmkFb2kFJeD1lLZraO4YFRkB9dfTsAVlNzKxtEADYnFzdEEBKynz8AxCCQsIjyRFsF2PicROJI1Pp3Vg5O2SF2YAqwdn/2DooFBBnByuwAILA0FwADcvwBgOh8Dg8GEgyBLBMGHYyChIJRFHYADpSfiYcgALqU+F/AFnfzCCShfx9JRgWAAM383VpiIZYAAklBhGAlABbABGZD59MmEFITPlpFl/1qUm4XRF7DQpCUMFV7HVk38FmEnJ0JlRhtqABFah9GubLdaEQDaopHabnVaDW7/vtwRNNREerTorNnPMjABmZaWax2IJR1zpL3eUw8uxUM6kcI0S4AJlu1ASuwAjvrSBgfDQXrsuGxOCavj86f8gQSwcJySjDZ2YWj2BioFicXjkWCiaTib2wVSaf7OCywEyV2yOTBuTwoIaBcLRRLpSql46FUqQ2gFTa4BqGt1hLr9Te755vewLb6b/a6pMHx+XT9dsjTgT0TUsH1XWAwNKmCP8w1+CNtCjAxDDjXwVkTK5k22NMWzAQ4syuHNQjzC4kGLSkc2gXBdn4Tl2AydMwGJQN2AAXk49gAHJHW6biijbf5mN+USwDEiTxKkyTJKQkBxXEHQkFANJzDgOQ8DQBBomiIA==="}
import { type GetConnectionReturnType } from '@wagmi/core'
const connection = {} as GetConnectionReturnType
// ---cut---
if (connection.status === 'connected') {
  connection
  // ^?















}
```

Or when status is `'disconnected'` properties like `address` are guaranteed to be `undefined`:

```ts twoslash
// @twoslash-cache: {"v":1,"hash":"03f1cafa2983888b08080373baa176953254622dd97feb972d42875fedc5dd86","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BjCMONAAmbDBkbQEsWidgHEYaAMIsefQWABK4gK6kwAFWy4qbAIakGiACxUANjDABzNPiQBGAAxU0ei+KbTeAlpRAn+PJEcQRnw9HT4yJEMAXwp0TTxCEnInOgMQAAosUggcfQwASnZdNCU4YQAdECh+OC4ZGigq9gAfdir6zxgmkFb2kFJeD1lLZraO4YFRkB9dfTsAVlNzKxtEADYnFzdEEBKynz8AxCCQsIjyRFsF2PicROJI1Pp3Vg5O2SF2YAqwdn/2DooFBBnByuwlGBYAAzfzdADcvwBgOBoLg8GEkJhcKgiL+ALO/kxUJgsJ4uKRBNC/gAklBidjyXjkR80BBSAzSTjmQDalJuF16exoToTOief9aopWf4LMIRWKYBL2HzJrL5aLxZTJXAACK1VndYRoUhKJXa4rOUrgqo1OqTbpVPHRWbOeZGTa+FbWOxBN2udIy7ymOF2KhnUjhGiXABMt2oCV2AEczaQMD4aC9dlw2Jw1V8fvj/kCQfBwViuUyLSW0RiISSyQiLYSwJzGxSi5xqWA6W3uc3Juy+1XO6qBREhQqtaO4NK1ZYNYrlWOGurhZrzTP9fbx41jabN8j9jbqgaHT1na69AZDJ6zJYfVc/dtA/mwIdQ1dw6FIxckHGAF1w2gXBdn4aF2AyIMwAAOmPdgAF4kPYAByO1DSgFCikLf5oN+fCwAIojCJI4jiJdKgAFtxB0JBQDScw4DkPA0AQaJoiAA"}
import { type GetConnectionReturnType } from '@wagmi/core'
const connection = {} as GetConnectionReturnType
// ---cut---
if (connection.status === 'disconnected') {
  connection
  // ^?















}
```

:::

## Action

* [`getConnection`](/core/api/actions/getConnection)

---

---
url: /react/api/hooks/useConnectionEffect.md
description: Hook for listening to connection lifecycle events.
---

# useConnectionEffect

Hook for listening to connection lifecycle events.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnectionEffect.md","from":192,"to":236}<fsm-vh3gqscxm4e>
import { useConnectionEffect } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnectionEffect.md","from":285,"to":508}<fsm-vh3gqscxm4e>
import { useConnectionEffect } from 'wagmi'

function App() {
  useConnectionEffect({
    onConnect(data) {
      console.log('Connected!', data)
    },
    onDisconnect() {
      console.log('Disconnected!')
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnectionEffect.md","from":580,"to":639}<fsm-vh3gqscxm4e>
import { type UseConnectionEffectParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnectionEffect.md","from":847,"to":1150}<fsm-vh3gqscxm4e>
import { useConnectionEffect } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  useConnectionEffect({
    config, // [!code focus]
    onConnect(data) {
      console.log('Connected!', data)
    },
    onDisconnect() {
      console.log('Disconnected!')
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onConnect

``((data: { address: `0x${string}`; addresses: readonly [`0x${string}`, ...`0x${string}`[]]; chain: Chain | undefined chainId: number; connector: Connector; isReconnected: boolean }) => void) | undefined``

Callback that is called when connection is made.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnectionEffect.md","from":1509,"to":1720}<fsm-vh3gqscxm4e>
import { useConnectionEffect } from 'wagmi'

function App() {
  useConnectionEffect({
    onConnect(data) { // [!code focus]
      console.log('Connected!', data) // [!code focus]
    }, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onDisconnect

`(() => void) | undefined`

Callback that is called when there no more connections.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnectionEffect.md","from":1908,"to":2115}<fsm-vh3gqscxm4e>
import { useConnectionEffect } from 'wagmi'

function App() {
  useConnectionEffect({
    onDisconnect() { // [!code focus]
      console.log('Disconnected!') // [!code focus]
    }, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Action

* [`getConnection`](/core/api/actions/getConnection)
* [`watchConnection`](/core/api/actions/watchConnection)

---

---
url: /solid/api/primitives/useConnectionEffect.md
description: Primitive for reacting to connection state changes.
---

# useConnectionEffect

Primitive for reacting to connection state changes.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnectionEffect.md","from":194,"to":245}<fsm-vh3gqscxm4e>
import { useConnectionEffect } from '@wagmi/solid'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnectionEffect.md","from":294,"to":557}<fsm-vh3gqscxm4e>
import { useConnectionEffect } from '@wagmi/solid'

function App() {
  useConnectionEffect(() => ({
    onConnect(data) {
      console.log('Connected!', data)
    },
    onDisconnect() {
      console.log('Disconnected!')
    },
  }))

  return <div>...</div>
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnectionEffect.md","from":629,"to":748}<fsm-vh3gqscxm4e>
import { useConnectionEffect } from '@wagmi/solid'

useConnectionEffect.Parameters
useConnectionEffect.SolidParameters
```

Parameters are passed as a getter function to maintain Solid reactivity.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnectionEffect.md","from":833,"to":931}<fsm-vh3gqscxm4e>
useConnectionEffect(() => ({
  onConnect(data) { /* ... */ },
  onDisconnect() { /* ... */ },
}))
```

### onConnect

`((data: { address: Address; addresses: readonly Address[]; chain: Chain | undefined; chainId: number; connector: Connector; isReconnected: boolean }) => void) | undefined`

Callback that is called when accounts are connected.

### onDisconnect

`(() => void) | undefined`

Callback that is called when no more accounts are connected.

### config

`Config | undefined`

[`Config`](/solid/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/solid/api/WagmiProvider).

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnectionEffect.md","from":1478,"to":1561}<fsm-vh3gqscxm4e>
import { useConnectionEffect } from '@wagmi/solid'

useConnectionEffect.ReturnType
```

`void`

## Action

* [`watchConnection`](/core/api/actions/watchConnection)

---

---
url: /vue/api/composables/useConnectionEffect.md
description: Composable for listening to connection lifecycle events.
---

# useConnectionEffect

Composable for listening to connection lifecycle events.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnectionEffect.md","from":204,"to":253}<fsm-vh3gqscxm4e>
import { useConnectionEffect } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnectionEffect.md","from":302,"to":530}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnectionEffect } from '@wagmi/vue'

useConnectionEffect({
  onConnect(data) {
    console.log('Connected!', data)
  },
  onDisconnect() {
    console.log('Disconnected!')
  },
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnectionEffect.md","from":600,"to":664}<fsm-vh3gqscxm4e>
import { type useConnectionEffectParameters } from '@wagmi/vue'
```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnectionEffect.md","from":856,"to":1162}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnectionEffect } from '@wagmi/vue'
import { config } from './config' // [!code focus]

useConnectionEffect({
  config, // [!code focus]
  onConnect(data) {
    console.log('Connected!', data)
  },
  onDisconnect() {
    console.log('Disconnected!')
  },
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onConnect

``MaybeRef<((data: { address: `0x${string}`; addresses: readonly [`0x${string}`, ...`0x${string}`[]]; chain: Chain | undefined chainId: number; connector: Connector; isReconnected: boolean }) => void)> | undefined``

Callback that is called when connection is made.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnectionEffect.md","from":1529,"to":1745}<fsm-vh3gqscxm4e>
import { useConnectionEffect } from '@wagmi/vue'

function App() {
  useConnectionEffect({
    onConnect(data) { // [!code focus]
      console.log('Connected!', data) // [!code focus]
    }, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onDisconnect

`MaybeRef<(() => void)> | undefined`

Callback that is called when there no more connections.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnectionEffect.md","from":1941,"to":2153}<fsm-vh3gqscxm4e>
import { useConnectionEffect } from '@wagmi/vue'

function App() {
  useConnectionEffect({
    onDisconnect() { // [!code focus]
      console.log('Disconnected!') // [!code focus]
    }, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Action

* [`getConnection`](/core/api/actions/getConnection)
* [`watchConnection`](/core/api/actions/watchConnection)

---

---
url: /react/api/hooks/useConnections.md
description: Hook for getting active connections.
---

# useConnections

Hook for getting active connections.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnections.md","from":154,"to":193}<fsm-vh3gqscxm4e>
import { useConnections } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnections.md","from":242,"to":340}<fsm-vh3gqscxm4e>
import { useConnections } from 'wagmi'

function App() {
  const connections = useConnections()
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnections.md","from":412,"to":466}<fsm-vh3gqscxm4e>
import { type UseConnectionsParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnections.md","from":674,"to":857}<fsm-vh3gqscxm4e>
import { useConnections } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const connections = useConnections({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnections.md","from":930,"to":984}<fsm-vh3gqscxm4e>
import { type UseConnectionsReturnType } from 'wagmi'
```

## Action

* [`getConnections`](/core/api/actions/getConnections)
* [`watchConnections`](/core/api/actions/watchConnections)

---

---
url: /solid/api/primitives/useConnections.md
description: Primitive for getting all active connections.
---

# useConnections

Primitive for getting all active connections.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnections.md","from":172,"to":218}<fsm-vh3gqscxm4e>
import { useConnections } from '@wagmi/solid'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnections.md","from":267,"to":621}<fsm-vh3gqscxm4e>
import { useConnections } from '@wagmi/solid'
import { For } from 'solid-js'

function App() {
  const connections = useConnections()
  
  return (
    <ul>
      <For each={connections()}>
        {(connection) => (
          <li>
            {connection.connector.name}: {connection.accounts[0]}
          </li>
        )}
      </For>
    </ul>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnections.md","from":693,"to":797}<fsm-vh3gqscxm4e>
import { useConnections } from '@wagmi/solid'

useConnections.Parameters
useConnections.SolidParameters
```

Parameters are passed as a getter function to maintain Solid reactivity.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnections.md","from":882,"to":920}<fsm-vh3gqscxm4e>
useConnections(() => ({
  config,
}))
```

### config

`Config | undefined`

[`Config`](/solid/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/solid/api/WagmiProvider).

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnections.md","from":1116,"to":1189}<fsm-vh3gqscxm4e>
import { useConnections } from '@wagmi/solid'

useConnections.ReturnType
```

`Accessor<readonly Connection[]>`

Returns an accessor containing all active connections. Each connection includes:

* `accounts`: Connected account addresses
* `chainId`: Connected chain ID
* `connector`: The connector instance

## Action

* [`getConnections`](/core/api/actions/getConnections)

---

---
url: /vue/api/composables/useConnections.md
description: Composable for getting active connections.
---

# useConnections

Composable for getting active connections.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnections.md","from":166,"to":205}<fsm-vh3gqscxm4e>
import { useConnections } from 'wagmi'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnections.md","from":254,"to":366}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnections } from 'wagmi'

const connections = useConnections()
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnections.md","from":436,"to":490}<fsm-vh3gqscxm4e>
import { type UseConnectionsParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnections.md","from":682,"to":875}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnections } from 'wagmi'
import { config } from './config' // [!code focus]

const connections = useConnections({
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnections.md","from":946,"to":1000}<fsm-vh3gqscxm4e>
import { type UseConnectionsReturnType } from 'wagmi'
```

## Action

* [`getConnections`](/core/api/actions/getConnections)
* [`watchConnections`](/core/api/actions/watchConnections)

---

---
url: /react/api/hooks/useConnectorClient.md
description: Hook for getting a Viem `Client` object for the current or provided connector.
---

# useConnectorClient

Hook for getting a Viem [`Client`](https://viem.sh/docs/clients/custom) object for the current or provided connector.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnectorClient.md","from":534,"to":577}<fsm-vh3gqscxm4e>
import { useConnectorClient } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnectorClient.md","from":626,"to":727}<fsm-vh3gqscxm4e>
import { useConnectorClient } from 'wagmi'

function App() {
  const result = useConnectorClient()
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnectorClient.md","from":799,"to":857}<fsm-vh3gqscxm4e>
import { type UseConnectorClientParameters } from 'wagmi'
```

### account

`Address | Account | undefined`

Account to use with client. Throws if account is not found on [`connector`](#connector).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnectorClient.md","from":1004,"to":1186}<fsm-vh3gqscxm4e>
import { useConnectorClient } from 'wagmi'

function App() {
  const result = useConnectorClient({
    account: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
  })
}
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use with client.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnectorClient.md","from":1289,"to":1437}<fsm-vh3gqscxm4e>
import { useConnectorClient } from 'wagmi'

function App() {
  const result = useConnectorClient({
    chainId: mainnet.id, // [!code focus]
  })
}
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnectorClient.md","from":1645,"to":1831}<fsm-vh3gqscxm4e>
import { useConnectorClient } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useConnectorClient({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

* Connector to get client for.
* Defaults to current connector.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnectorClient.md","from":1993,"to":2219}<fsm-vh3gqscxm4e>
import { useConnections, useConnectorClient } from 'wagmi'

function App() {
  const connections = useConnections(config)
  const result = useConnectorClient({
    connector: connections[0]?.connector, // [!code focus]
  })
}
```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnectorClient.md","from":2289,"to":2347}<fsm-vh3gqscxm4e>
import { type UseConnectorClientReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getConnectorClient`](/core/api/actions/getConnectorClient)

---

---
url: /solid/api/primitives/useConnectorClient.md
description: Primitive for getting Viem Wallet Client from the active connector.
---

# useConnectorClient

Primitive for getting a [Viem Wallet Client](https://viem.sh/docs/clients/wallet) from the active connector.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnectorClient.md","from":265,"to":315}<fsm-vh3gqscxm4e>
import { useConnectorClient } from '@wagmi/solid'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnectorClient.md","from":364,"to":530}<fsm-vh3gqscxm4e>
import { useConnectorClient } from '@wagmi/solid'

function App() {
  const client = useConnectorClient()
  
  // client() returns the Wallet Client when connected
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnectorClient.md","from":602,"to":718}<fsm-vh3gqscxm4e>
import { useConnectorClient } from '@wagmi/solid'

useConnectorClient.Parameters
useConnectorClient.SolidParameters
```

Parameters are passed as a getter function to maintain Solid reactivity.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnectorClient.md","from":803,"to":875}<fsm-vh3gqscxm4e>
useConnectorClient(() => ({
  chainId: 1,
  connector: myConnector,
}))
```

### account

`Address | undefined`

Account to use for the client.

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use for the client.

### config

`Config | undefined`

[`Config`](/solid/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/solid/api/WagmiProvider).

### connector

`Connector | undefined`

Connector to get the client for. Defaults to the active connector.

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnectorClient.md","from":1385,"to":1466}<fsm-vh3gqscxm4e>
import { useConnectorClient } from '@wagmi/solid'

useConnectorClient.ReturnType
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getConnectorClient`](/core/api/actions/getConnectorClient)

---

---
url: /vue/api/composables/useConnectorClient.md
description: >-
  Composable for getting a Viem `Client` object for the current or provided
  connector.
---

# useConnectorClient

Composable for getting a Viem [`Client`](https://viem.sh/docs/clients/custom) object for the current or provided connector.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnectorClient.md","from":551,"to":599}<fsm-vh3gqscxm4e>
import { useConnectorClient } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnectorClient.md","from":648,"to":768}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnectorClient } from '@wagmi/vue'

const result = useConnectorClient()
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnectorClient.md","from":838,"to":901}<fsm-vh3gqscxm4e>
import { type UseConnectorClientParameters } from '@wagmi/vue'
```

### account

`Address | Account | undefined`

Account to use with client. Throws if account is not found on [`connector`](#connector).

```vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnectorClient.md","from":1049,"to":1246}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnectorClient } from '@wagmi/vue'

const result = useConnectorClient({
  account: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
})
</script>
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use with client.

```vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnectorClient.md","from":1350,"to":1513}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnectorClient } from '@wagmi/vue'

const result = useConnectorClient({
  chainId: mainnet.id, // [!code focus]
})
</script>
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnectorClient.md","from":1721,"to":1922}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnectorClient } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const result = useConnectorClient({
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

* Connector to get client for.
* Defaults to current connector.

```vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnectorClient.md","from":2083,"to":2322}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnections, useConnectorClient } from '@wagmi/vue'

const connections = useConnections(config)
const result = useConnectorClient({
  connector: connections[0]?.connector, // [!code focus]
})
</script>
```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnectorClient.md","from":2392,"to":2455}<fsm-vh3gqscxm4e>
import { type UseConnectorClientReturnType } from '@wagmi/vue'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getConnectorClient`](/core/api/actions/getConnectorClient)

---

---
url: /react/api/hooks/useConnectors.md
description: Hook for getting configured connectors.
---

# useConnectors

Hook for getting configured connectors.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnectors.md","from":158,"to":196}<fsm-vh3gqscxm4e>
import { useConnectors } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnectors.md","from":245,"to":340}<fsm-vh3gqscxm4e>
import { useConnectors } from 'wagmi'

function App() {
  const connectors = useConnectors()
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useConnectors.md","from":413,"to":466}<fsm-vh3gqscxm4e>
import { type UseConnectorsReturnType } from 'wagmi'
```

`readonly Connector[]`

Connectors from [`config.connectors`](/react/api/createConfig#connectors-1).

## Action

* [`getConnectors`](/core/api/actions/getConnectors)

---

---
url: /solid/api/primitives/useConnectors.md
description: Primitive for getting configured connectors.
---

# useConnectors

Primitive for getting configured connectors.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnectors.md","from":168,"to":213}<fsm-vh3gqscxm4e>
import { useConnectors } from '@wagmi/solid'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnectors.md","from":262,"to":708}<fsm-vh3gqscxm4e>
import { useConnect, useConnectors } from '@wagmi/solid'
import { For } from 'solid-js'

function App() {
  const connectors = useConnectors()
  const connect = useConnect()
  
  return (
    <ul>
      <For each={connectors()}>
        {(connector) => (
          <li>
            <button onClick={() => connect.mutate({ connector })}>
              {connector.name}
            </button>
          </li>
        )}
      </For>
    </ul>
  )
}
```

```ts [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnectors.md","from":730,"to":1110}<fsm-vh3gqscxm4e>
import { http, createConfig } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'
import { injected, walletConnect } from '@wagmi/solid/connectors'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected(), walletConnect({ projectId: '...' })],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnectors.md","from":1140,"to":1241}<fsm-vh3gqscxm4e>
import { useConnectors } from '@wagmi/solid'

useConnectors.Parameters
useConnectors.SolidParameters
```

Parameters are passed as a getter function to maintain Solid reactivity.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnectors.md","from":1326,"to":1363}<fsm-vh3gqscxm4e>
useConnectors(() => ({
  config,
}))
```

### config

`Config | undefined`

[`Config`](/solid/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/solid/api/WagmiProvider).

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useConnectors.md","from":1559,"to":1630}<fsm-vh3gqscxm4e>
import { useConnectors } from '@wagmi/solid'

useConnectors.ReturnType
```

`Accessor<readonly Connector[]>`

Returns an accessor containing all configured connectors.

## Action

* [`getConnectors`](/core/api/actions/getConnectors)

---

---
url: /vue/api/composables/useConnectors.md
description: Composable for getting configured connectors.
---

# useConnectors

Composable for getting configured connectors.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnectors.md","from":170,"to":213}<fsm-vh3gqscxm4e>
import { useConnectors } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnectors.md","from":262,"to":376}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnectors } from '@wagmi/vue'

const connectors = useConnectors()
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useConnectors.md","from":447,"to":505}<fsm-vh3gqscxm4e>
import { type UseConnectorsReturnType } from '@wagmi/vue'
```

`readonly Connector[]`

Connectors from [`config.connectors`](/vue/api/createConfig#connectors-1).

## Action

* [`getConnectors`](/core/api/actions/getConnectors)

---

---
url: /react/api/hooks/useContractEvents.md
description: >-
  Hook that fetches a list of contract event logs matching the provided
  parameters.
---

# useContractEvents

Hook that fetches a list of contract event logs matching the provided parameters.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useContractEvents.md","from":250,"to":292}<fsm-vh3gqscxm4e>
import { useContractEvents } from 'wagmi'
```

## Usage

By default, `useContractEvents` returns all matched events on the ABI. In practice, you must use scoping to filter for specific events.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useContractEvents.md","from":478,"to":677}<fsm-vh3gqscxm4e>
import { useContractEvents } from 'wagmi'
import { abi } from './abi'

function App() {
  // Fetch event logs for every event on every ERC-20 contract. 
  const result = useContractEvents({ abi })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useContractEvents.md","from":785,"to":842}<fsm-vh3gqscxm4e>
import { type UseContractEventsParameters } from 'wagmi'
```

### abi

`Abi`

The contract's ABI. Check out the [TypeScript docs](/react/typescript#const-assert-abis-typed-data) for how to set up ABIs for maximum type inference and safety.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useContractEvents.md","from":1060,"to":1217}<fsm-vh3gqscxm4e>
import { useContractEvents } from 'wagmi'
import { abi } from './abi'

function App() {
 const result = useContractEvents({
    abi, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### address

`Address | undefined`

The contract's address.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useContractEvents.md","from":1399,"to":1616}<fsm-vh3gqscxm4e>
import { useContractEvents } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useContractEvents({
    address: '0x6b175474e89094c44da98b954eedeac495271d0f', // [!code focus]
    abi,
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### args

`object | readonly unknown[] | undefined`

* Logs can be scoped to given indexed arguments.
* Inferred from [`abi`](#abi) and [`eventName`](#eventname).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useContractEvents.md","from":1901,"to":2268}<fsm-vh3gqscxm4e>
import { useContractEvents } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useContractEvents({
    abi,
    eventName: 'Transfer',
    args: { // [!code focus]
      from: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045', // [!code focus]
      to: '0xd2135CfB216b74109775236E36d4b433F1DF507B' // [!code focus]
    } // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

Only indexed arguments in `event` are candidates for `args`.

An argument can also be an array to indicate that other values can exist in the position:

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useContractEvents.md","from":2542,"to":3054}<fsm-vh3gqscxm4e>
import { useContractEvents } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useContractEvents({
    abi,
    eventName: 'Transfer',
    args: { 
      from: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045', 
      to: [ // [!code focus]
        '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
        '0xa5cc3c03994db5b0d9a5eedd10cabab0813678ac', // [!code focus]
        '0xa152f8bb749c55e9943a3a0a3111d18ee2b3f94e', // [!code focus]
    ], // [!code focus]
    }
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockHash

`` `0x${string}` | undefined ``

* Block hash to include logs from. Mutually exclusive with `fromBlock`/`toBlock`.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useContractEvents.md","from":3307,"to":3550}<fsm-vh3gqscxm4e>
import { useContractEvents } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useContractEvents({
    abi,
    blockHash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useContractEvents.md","from":3770,"to":3998}<fsm-vh3gqscxm4e>
import { useContractEvents } from 'wagmi'
import { mainnet } from '@wagmi/core/chains'
import { abi } from './abi'

function App() {
  const result = useContractEvents({
    abi,
    chainId: mainnet.id, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useContractEvents.md","from":4288,"to":4492}<fsm-vh3gqscxm4e>
import { useContractEvents } from 'wagmi'
import { abi } from './abi'
import { config } from './config'

function App() {
  const result = useContractEvents({
    abi,
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### eventName

`string | undefined`

* Event to filter for the contract.
* Inferred from [`abi`](#abi).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useContractEvents.md","from":4718,"to":4937}<fsm-vh3gqscxm4e>
import { useContractEvents } from 'wagmi'
import { abi } from './abi'
import { config } from './config'

function App() {
  const result = useContractEvents({
    abi,
    eventName: 'Transfer', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### fromBlock

`bigint | 'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

* Block to start including logs from. Mutually exclusive with `blockHash`.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useContractEvents.md","from":5230,"to":5445}<fsm-vh3gqscxm4e>
import { useContractEvents } from 'wagmi'
import { abi } from './abi'
import { config } from './config'

function App() {
  const result = useContractEvents({
    abi,
    fromBlock: 69420n, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### strict

`boolean | undefined`

* Flag to only return logs that conform to the indexed & non-indexed arguments on the `event`, meaning that `args` will always be defined. Defaults to `false`.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useContractEvents.md","from":5762,"to":5972}<fsm-vh3gqscxm4e>
import { useContractEvents } from 'wagmi'
import { abi } from './abi'
import { config } from './config'

function App() {
  const result = useContractEvents({
    abi,
    strict: true, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### toBlock

`bigint | 'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

* Block to stop including logs from. Mutually exclusive with `blockHash`.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useContractEvents.md","from":6262,"to":6475}<fsm-vh3gqscxm4e>
import { useContractEvents } from 'wagmi'
import { abi } from './abi'
import { config } from './config'

function App() {
  const result = useContractEvents({
    abi,
    toBlock: 70120n, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useContractEvents.md","from":6584,"to":6641}<fsm-vh3gqscxm4e>
import { type UseContractEventsReturnType } from 'wagmi'
```

A list of event logs.

## Action

* [`getContractEvents`](/core/api/actions/getContractEvents)

---

---
url: /react/api/hooks/useDeployContract.md
description: >-
  Hook for deploying a contract to the network, given bytecode & constructor
  arguments.
---

# useDeployContract&#x20;

Hook for deploying a contract to the network, given bytecode, and constructor arguments.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useDeployContract.md","from":561,"to":603}<fsm-vh3gqscxm4e>
import { useDeployContract } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useDeployContract.md","from":652,"to":1077}<fsm-vh3gqscxm4e>
import { useDeployContract } from 'wagmi'
import { parseEther } from 'viem'
import { wagmiAbi } from './abi'

function App() {
  const deployContract = useDeployContract()

  return (
    <button
      onClick={() =>
        deployContract.mutate({
          abi: wagmiAbi,
          bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
        })
      }
    >
      Deploy Contract
    </button>
  )
}
```

```ts [abi.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useDeployContract.md","from":1096,"to":1230}<fsm-vh3gqscxm4e>
export const wagmiAbi = [
  ...
  {
    inputs: [],
    stateMutability: "nonpayable",
    type: "constructor",
  },
  ...
] as const
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Deploying with Constructor Args

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useDeployContract.md","from":1351,"to":1801}<fsm-vh3gqscxm4e>
import { useDeployContract } from 'wagmi'
import { parseEther } from 'viem'
import { wagmiAbi } from './abi'

function App() {
  const deployContract = useDeployContract()

  return (
    <button
      onClick={() =>
        deployContract.mutate({
          abi: wagmiAbi,
          args: [69420],
          bytecode: '0x608060405260405161083e38038061083e833981016040819052610...',
        })
      }
    >
      Deploy Contract
    </button>
  )
}
```

```ts [abi.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useDeployContract.md","from":1820,"to":1984}<fsm-vh3gqscxm4e>
export const wagmiAbi = [
  ...
  {
    inputs: [{ name: "x", type: "uint32" }],
    stateMutability: "nonpayable",
    type: "constructor",
  },
  ...
] as const;
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useDeployContract.md","from":2056,"to":2113}<fsm-vh3gqscxm4e>
import { type useDeployContractParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useDeployContract.md","from":2321,"to":2513}<fsm-vh3gqscxm4e>
import { useDeployContract } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const deployContract = useDeployContract({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useDeployContract.md","from":2632,"to":2689}<fsm-vh3gqscxm4e>
import { type useDeployContractReturnType } from 'wagmi'
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`deployContract`](/core/api/actions/deployContract)

---

---
url: /react/api/hooks/useDisconnect.md
description: Hook for disconnecting connections.
---

# useDisconnect

Hook for disconnecting connections.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useDisconnect.md","from":412,"to":450}<fsm-vh3gqscxm4e>
import { useDisconnect } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useDisconnect.md","from":499,"to":689}<fsm-vh3gqscxm4e>
import { useDisconnect } from 'wagmi'

function App() {
  const disconnect = useDisconnect()
  return (
    <button onClick={() => disconnect.mutate()}>
      Disconnect
    </button>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useDisconnect.md","from":761,"to":814}<fsm-vh3gqscxm4e>
import { type UseDisconnectParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useDisconnect.md","from":1022,"to":1198}<fsm-vh3gqscxm4e>
import { useDisconnect } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useDisconnect({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useDisconnect.md","from":1317,"to":1370}<fsm-vh3gqscxm4e>
import { type UseDisconnectReturnType } from 'wagmi'
```

### connectors [deprecated](/react/guides/migrate-from-v2-to-v3#removed-usedisconnect-connectors-useswitchconnection-connectors)

`readonly Connector[]`

Connectors that are currently connected. Useful for rendering a list of connectors to disconnect.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useDisconnect.md","from":1692,"to":2094}<fsm-vh3gqscxm4e>
import { useConnectors, useDisconnect } from 'wagmi'
import { mainnet } from 'wagmi/chains'

function App() {
  const disconnect = useDisconnect()
  const connectors = useConnectors()

  return (
    <div>
      {connectors.map((connector) => (
        <button key={connector.id} onClick={() => disconnect.mutate({ connector })}>
          {connector.name}
        </button>
      ))}
    </div>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`disconnect`](/core/api/actions/disconnect)

---

---
url: /solid/api/primitives/useDisconnect.md
description: Primitive for disconnecting connections.
---

# useDisconnect

Primitive for disconnecting connections.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useDisconnect.md","from":401,"to":446}<fsm-vh3gqscxm4e>
import { useDisconnect } from '@wagmi/solid'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useDisconnect.md","from":495,"to":695}<fsm-vh3gqscxm4e>
import { useDisconnect } from '@wagmi/solid'

function App() {
  const disconnect = useDisconnect()
  
  return (
    <button onClick={() => disconnect.mutate()}>
      Disconnect
    </button>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useDisconnect.md","from":767,"to":868}<fsm-vh3gqscxm4e>
import { useDisconnect } from '@wagmi/solid'

useDisconnect.Parameters
useDisconnect.SolidParameters
```

Parameters are passed as a getter function to maintain Solid reactivity.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useDisconnect.md","from":953,"to":1015}<fsm-vh3gqscxm4e>
useDisconnect(() => ({
  config,
  // mutation options...
}))
```

### config

`Config | undefined`

[`Config`](/solid/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/solid/api/WagmiProvider).

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useDisconnect.md","from":1257,"to":1328}<fsm-vh3gqscxm4e>
import { useDisconnect } from '@wagmi/solid'

useDisconnect.ReturnType
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`disconnect`](/core/api/actions/disconnect)

---

---
url: /vue/api/composables/useDisconnect.md
description: Composable for disconnecting connections.
---

# useDisconnect

Composable for disconnecting connections.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useDisconnect.md","from":429,"to":472}<fsm-vh3gqscxm4e>
import { useDisconnect } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useDisconnect.md","from":521,"to":726}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useDisconnect } from '@wagmi/vue'

const disconnect = useDisconnect()
</script>

<template>
  <button @click="disconnect.mutate()">
    Disconnect
  </button>
</template>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useDisconnect.md","from":796,"to":854}<fsm-vh3gqscxm4e>
import { type UseDisconnectParameters } from '@wagmi/vue'
```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useDisconnect.md","from":1046,"to":1241}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useDisconnect } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const disconnect = useDisconnect({
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useDisconnect.md","from":1358,"to":1416}<fsm-vh3gqscxm4e>
import { type UseDisconnectReturnType } from '@wagmi/vue'
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`disconnect`](/core/api/actions/connect)

---

---
url: /react/api/hooks/useEnsAddress.md
description: Hook for fetching ENS address for name.
---

# useEnsAddress

Hook for fetching ENS address for name.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAddress.md","from":343,"to":381}<fsm-vh3gqscxm4e>
import { useEnsAddress } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAddress.md","from":430,"to":596}<fsm-vh3gqscxm4e>
import { useEnsAddress } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsAddress({
    name: normalize('wevm.eth'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: warning
Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `useEnsAddress`. You can use Viem's built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this.
:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAddress.md","from":1123,"to":1176}<fsm-vh3gqscxm4e>
import { type UseEnsAddressParameters } from 'wagmi'
```

***

### blockNumber

`bigint | undefined`

Block number to get ENS address at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAddress.md","from":1294,"to":1505}<fsm-vh3gqscxm4e>
import { useEnsAddress } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsAddress({
    blockNumber: 17829139n, // [!code focus]
    name: normalize('wevm.eth'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get ENS address at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAddress.md","from":1708,"to":1915}<fsm-vh3gqscxm4e>
import { useEnsAddress } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsAddress({
    name: normalize('wevm.eth'),
    blockTag: 'latest', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAddress.md","from":2104,"to":2368}<fsm-vh3gqscxm4e>
import { useEnsAddress } from 'wagmi'
import { mainnet } from 'wagmi/chains' // [!code focus]
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsAddress({
    chainId: mainnet.id, // [!code focus]
    name: normalize('wevm.eth'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### coinType

`number | undefined`

The [ENSIP-9](https://docs.ens.domains/ens-improvement-proposals/ensip-9-multichain-address-resolution) coin type to fetch the address for.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAddress.md","from":2628,"to":2829}<fsm-vh3gqscxm4e>
import { useEnsAddress } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsAddress({
    coinType: 60, // [!code focus]
    name: normalize('wevm.eth'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAddress.md","from":3083,"to":3329}<fsm-vh3gqscxm4e>
import { useEnsAddress } from 'wagmi'
import { normalize } from 'viem/ens'
import { config } from './config' // [!code focus]

function App() {
  const result = useEnsAddress({
    config, // [!code focus]
    name: normalize('wevm.eth'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### name

`string | undefined`

Name to get the address for. [`enabled`](#enabled) set to `false` if `name` is `undefined`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAddress.md","from":3537,"to":3720}<fsm-vh3gqscxm4e>
import { useEnsAddress } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsAddress({
    name: normalize('wevm.eth'), // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAddress.md","from":3938,"to":4142}<fsm-vh3gqscxm4e>
import { useEnsAddress } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsAddress({
    name: normalize('wevm.eth'),
    scopeKey: 'foo', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### universalResolverAddress

`Address | undefined`

* Address of ENS Universal Resolver Contract.
* Defaults to current chain's Universal Resolver Contract address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAddress.md","from":4392,"to":4651}<fsm-vh3gqscxm4e>
import { useEnsAddress } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsAddress({
    name: normalize('wevm.eth'),
    universalResolverAddress: '0x74E20Bd2A1fE0cdbe45b9A1d89cb7e0a45b36376', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAddress.md","from":4767,"to":4820}<fsm-vh3gqscxm4e>
import { type UseEnsAddressReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getEnsAddress`](/core/api/actions/getEnsAddress)

---

---
url: /vue/api/composables/useEnsAddress.md
description: Composable for fetching ENS address for name.
---

# useEnsAddress

Composable for fetching ENS address for name.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAddress.md","from":360,"to":403}<fsm-vh3gqscxm4e>
import { useEnsAddress } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAddress.md","from":452,"to":633}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsAddress } from '@wagmi/vue'
import { normalize } from 'viem/ens'

const result = useEnsAddress({
  name: normalize('wevm.eth'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: warning
Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `useEnsAddress`. You can use Viem's built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this.
:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAddress.md","from":1158,"to":1216}<fsm-vh3gqscxm4e>
import { type UseEnsAddressParameters } from '@wagmi/vue'
```

***

### blockNumber

`bigint | undefined`

Block number to get ENS address at.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAddress.md","from":1336,"to":1560}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsAddress } from '@wagmi/vue'
import { normalize } from 'viem/ens'

const result = useEnsAddress({
  blockNumber: 17829139n, // [!code focus]
  name: normalize('wevm.eth'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get ENS address at.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAddress.md","from":1763,"to":1983}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsAddress } from '@wagmi/vue'
import { normalize } from 'viem/ens'

const result = useEnsAddress({
  name: normalize('wevm.eth'),
  blockTag: 'latest', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAddress.md","from":2170,"to":2452}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsAddress } from '@wagmi/vue'
import { mainnet } from '@wagmi/vue/chains' // [!code focus]
import { normalize } from 'viem/ens'

const result = useEnsAddress({
  chainId: mainnet.id, // [!code focus]
  name: normalize('wevm.eth'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### coinType

`number | undefined`

The [ENSIP-9](https://docs.ens.domains/ens-improvement-proposals/ensip-9-multichain-address-resolution) coin type to fetch the address for.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAddress.md","from":2712,"to":2926}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsAddress } from '@wagmi/vue'
import { normalize } from 'viem/ens'

const result = useEnsAddress({
  coinType: 60, // [!code focus]
  name: normalize('wevm.eth'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAddress.md","from":3162,"to":3421}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsAddress } from '@wagmi/vue'
import { normalize } from 'viem/ens'
import { config } from './config' // [!code focus]

const result = useEnsAddress({
  config, // [!code focus]
  name: normalize('wevm.eth'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### name

`string | undefined`

Name to get the address for. [`enabled`](#enabled) set to `false` if `name` is `undefined`.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAddress.md","from":3629,"to":3827}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsAddress } from '@wagmi/vue'
import { normalize } from 'viem/ens'

const result = useEnsAddress({
  name: normalize('wevm.eth'), // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Composables that have identical context will share the same cache.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAddress.md","from":4051,"to":4268}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsAddress } from '@wagmi/vue'
import { normalize } from 'viem/ens'

const result = useEnsAddress({
  name: normalize('wevm.eth'),
  scopeKey: 'foo', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### universalResolverAddress

`Address | undefined`

* Address of ENS Universal Resolver Contract.
* Defaults to current chain's Universal Resolver Contract address.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAddress.md","from":4518,"to":4790}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsAddress } from '@wagmi/vue'
import { normalize } from 'viem/ens'

const result = useEnsAddress({
  name: normalize('wevm.eth'),
  universalResolverAddress: '0x74E20Bd2A1fE0cdbe45b9A1d89cb7e0a45b36376', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAddress.md","from":4904,"to":4962}<fsm-vh3gqscxm4e>
import { type UseEnsAddressReturnType } from '@wagmi/vue'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getEnsAddress`](/core/api/actions/getEnsAddress)

---

---
url: /react/api/hooks/useEnsAvatar.md
description: Hook for fetching ENS avatar for name.
---

# useEnsAvatar

Hook for fetching ENS avatar for name.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAvatar.md","from":343,"to":380}<fsm-vh3gqscxm4e>
import { useEnsAvatar } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAvatar.md","from":429,"to":593}<fsm-vh3gqscxm4e>
import { useEnsAvatar } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsAvatar({
    name: normalize('wevm.eth'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: warning
Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `useEnsAvatar`. You can use Viem's built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this.
:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAvatar.md","from":1119,"to":1171}<fsm-vh3gqscxm4e>
import { type UseEnsAvatarParameters } from 'wagmi'
```

***

### assetGatewayUrls&#x20;

`{ ipfs?: string | undefined; arweave?: string | undefined } | undefined`

Gateway urls to resolve IPFS and/or Arweave assets.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAvatar.md","from":1393,"to":1722}<fsm-vh3gqscxm4e>
import { getEnsAvatar } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

function App() {
  const result = useEnsAvatar({
    assetGatewayUrls: { // [!code focus]
      ipfs: 'https://cloudflare-ipfs.com', // [!code focus]
    }, // [!code focus]
    name: normalize('wevm.eth'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`bigint | undefined`

Block number to get ENS avatar at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAvatar.md","from":1880,"to":2089}<fsm-vh3gqscxm4e>
import { useEnsAvatar } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsAvatar({
    blockNumber: 17829139n, // [!code focus]
    name: normalize('wevm.eth'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get ENS avatar at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAvatar.md","from":2291,"to":2496}<fsm-vh3gqscxm4e>
import { useEnsAvatar } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsAvatar({
    name: normalize('wevm.eth'),
    blockTag: 'latest', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAvatar.md","from":2685,"to":2948}<fsm-vh3gqscxm4e>
import { useEnsAvatar } from 'wagmi'
import { mainnet } from 'wagmi/chains' // [!code focus]
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsAvatar({
    chainId: mainnet.id, // [!code focus],
    name: normalize('wevm.eth'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAvatar.md","from":3202,"to":3446}<fsm-vh3gqscxm4e>
import { useEnsAvatar } from 'wagmi'
import { normalize } from 'viem/ens'
import { config } from './config' // [!code focus]

function App() {
  const result = useEnsAvatar({
    config, // [!code focus]
    name: normalize('wevm.eth'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### gatewayUrls

`string[] | undefined`

A set of Universal Resolver gateways, used for resolving CCIP-Read requests made through the ENS Universal Resolver Contract.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAvatar.md","from":3697,"to":3929}<fsm-vh3gqscxm4e>
import { useEnsAvatar } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsAvatar({
    gatewayUrls: ['https://cloudflare-ipfs.com'] { // [!code focus]
    name: normalize('wevm.eth'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### name

`string | undefined`

Name to get the avatar for. [`enabled`](#enabled) set to `false` if `name` is `undefined`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAvatar.md","from":4136,"to":4317}<fsm-vh3gqscxm4e>
import { useEnsAvatar } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsAvatar({
    name: normalize('wevm.eth'), // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAvatar.md","from":4535,"to":4737}<fsm-vh3gqscxm4e>
import { useEnsAvatar } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsAvatar({
    name: normalize('wevm.eth'),
    scopeKey: 'foo', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### universalResolverAddress

`Address | undefined`

* Address of ENS Universal Resolver Contract.
* Defaults to current chain's Universal Resolver Contract address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAvatar.md","from":4987,"to":5244}<fsm-vh3gqscxm4e>
import { useEnsAvatar } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsAvatar({
    name: normalize('wevm.eth'),
    universalResolverAddress: '0x74E20Bd2A1fE0cdbe45b9A1d89cb7e0a45b36376', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsAvatar.md","from":5360,"to":5412}<fsm-vh3gqscxm4e>
import { type UseEnsAvatarReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getEnsAvatar`](/core/api/actions/getEnsAvatar)

---

---
url: /vue/api/composables/useEnsAvatar.md
description: Composable for fetching ENS avatar for name.
---

# useEnsAvatar

Composable for fetching ENS avatar for name.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAvatar.md","from":360,"to":402}<fsm-vh3gqscxm4e>
import { useEnsAvatar } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAvatar.md","from":451,"to":630}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsAvatar } from '@wagmi/vue'
import { normalize } from 'viem/ens'

const result = useEnsAvatar({
  name: normalize('wevm.eth'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: warning
Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `useEnsAvatar`. You can use Viem's built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this.
:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAvatar.md","from":1154,"to":1211}<fsm-vh3gqscxm4e>
import { type UseEnsAvatarParameters } from '@wagmi/vue'
```

***

### assetGatewayUrls&#x20;

`{ ipfs?: string | undefined; arweave?: string | undefined } | undefined`

Gateway urls to resolve IPFS and/or Arweave assets.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAvatar.md","from":1435,"to":1768}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { getEnsAvatar } from '@wagmi/core'
import { normalize } from 'viem/ens'
import { config } from './config'

const result = useEnsAvatar({
  assetGatewayUrls: { // [!code focus]
    ipfs: 'https://cloudflare-ipfs.com', // [!code focus]
  }, // [!code focus]
  name: normalize('wevm.eth'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`bigint | undefined`

Block number to get ENS avatar at.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAvatar.md","from":1926,"to":2148}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsAvatar } from '@wagmi/vue'
import { normalize } from 'viem/ens'

const result = useEnsAvatar({
  blockNumber: 17829139n, // [!code focus]
  name: normalize('wevm.eth'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get ENS avatar at.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAvatar.md","from":2350,"to":2568}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsAvatar } from '@wagmi/vue'
import { normalize } from 'viem/ens'

const result = useEnsAvatar({
  name: normalize('wevm.eth'),
  blockTag: 'latest', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAvatar.md","from":2755,"to":3031}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsAvatar } from '@wagmi/vue'
import { mainnet } from 'wagmi/chains' // [!code focus]
import { normalize } from 'viem/ens'

const result = useEnsAvatar({
  chainId: mainnet.id, // [!code focus],
  name: normalize('wevm.eth'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAvatar.md","from":3267,"to":3524}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsAvatar } from '@wagmi/vue'
import { normalize } from 'viem/ens'
import { config } from './config' // [!code focus]

const result = useEnsAvatar({
  config, // [!code focus]
  name: normalize('wevm.eth'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### gatewayUrls

`string[] | undefined`

A set of Universal Resolver gateways, used for resolving CCIP-Read requests made through the ENS Universal Resolver Contract.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAvatar.md","from":3775,"to":4019}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsAvatar } from '@wagmi/vue'
import { normalize } from 'viem/ens'

const result = useEnsAvatar({
  gatewayUrls: ['https://cloudflare-ipfs.com'], // [!code focus]
  name: normalize('wevm.eth'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### name

`string | undefined`

Name to get the avatar for. [`enabled`](#enabled) set to `false` if `name` is `undefined`.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAvatar.md","from":4226,"to":4422}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsAvatar } from '@wagmi/vue'
import { normalize } from 'viem/ens'

const result = useEnsAvatar({
  name: normalize('wevm.eth'), // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Composables that have identical context will share the same cache.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAvatar.md","from":4646,"to":4861}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsAvatar } from '@wagmi/vue'
import { normalize } from 'viem/ens'

const result = useEnsAvatar({
  name: normalize('wevm.eth'),
  scopeKey: 'foo', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### universalResolverAddress

`Address | undefined`

* Address of ENS Universal Resolver Contract.
* Defaults to current chain's Universal Resolver Contract address.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAvatar.md","from":5111,"to":5381}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsAvatar } from '@wagmi/vue'
import { normalize } from 'viem/ens'

const result = useEnsAvatar({
  name: normalize('wevm.eth'),
  universalResolverAddress: '0x74E20Bd2A1fE0cdbe45b9A1d89cb7e0a45b36376', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsAvatar.md","from":5495,"to":5552}<fsm-vh3gqscxm4e>
import { type UseEnsAvatarReturnType } from '@wagmi/vue'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getEnsAvatar`](/core/api/actions/getEnsAvatar)

---

---
url: /react/api/hooks/useEnsName.md
description: Hook for fetching primary ENS name for address.
---

# useEnsName

Hook for fetching primary ENS name for address.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsName.md","from":351,"to":386}<fsm-vh3gqscxm4e>
import { useEnsName } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsName.md","from":435,"to":584}<fsm-vh3gqscxm4e>
import { useEnsName } from 'wagmi'

function App() {
  const result = useEnsName({
    address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsName.md","from":656,"to":706}<fsm-vh3gqscxm4e>
import { type UseEnsNameParameters } from 'wagmi'
```

### address

`Address | undefined`

Name to get the resolver for. [`enabled`](#enabled) set to `false` if `address` is `undefined`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsName.md","from":876,"to":1042}<fsm-vh3gqscxm4e>
import { useEnsName } from 'wagmi'

function App() {
  const result = useEnsName({
    address: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### blockNumber

`bigint | undefined`

Block number to get ENS name at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsName.md","from":1203,"to":1397}<fsm-vh3gqscxm4e>
import { useEnsName } from 'wagmi'

function App() {
  const result = useEnsName({
    address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    blockNumber: 17829139n, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get ENS name at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsName.md","from":1597,"to":1787}<fsm-vh3gqscxm4e>
import { useEnsName } from 'wagmi'

function App() {
  const result = useEnsName({
    address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    blockTag: 'latest', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsName.md","from":1976,"to":2223}<fsm-vh3gqscxm4e>
import { useEnsName } from 'wagmi'
import { mainnet } from 'wagmi/chains' // [!code focus]

function App() {
  const result = useEnsName({
    address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    chainId: mainnet.id, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsName.md","from":2477,"to":2743}<fsm-vh3gqscxm4e>
import { useEnsName } from 'wagmi'
import { normalize } from 'viem/ens'
import { config } from './config' // [!code focus]

function App() {
  const result = useEnsName({
    address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsName.md","from":2961,"to":3148}<fsm-vh3gqscxm4e>
import { useEnsName } from 'wagmi'

function App() {
  const result = useEnsName({
    address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    scopeKey: 'foo', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### universalResolverAddress

`Address | undefined`

* Address of ENS Universal Resolver Contract.
* Defaults to current chain's Universal Resolver Contract address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsName.md","from":3398,"to":3640}<fsm-vh3gqscxm4e>
import { useEnsName } from 'wagmi'

function App() {
  const result = useEnsName({
    address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    universalResolverAddress: '0x74E20Bd2A1fE0cdbe45b9A1d89cb7e0a45b36376', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsName.md","from":3756,"to":3806}<fsm-vh3gqscxm4e>
import { type UseEnsNameReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getEnsName`](/core/api/actions/getEnsName)

---

---
url: /vue/api/composables/useEnsName.md
description: Composable for fetching primary ENS name for address.
---

# useEnsName

Composable for fetching primary ENS name for address.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsName.md","from":368,"to":408}<fsm-vh3gqscxm4e>
import { useEnsName } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsName.md","from":457,"to":621}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsName } from '@wagmi/vue'

const result = useEnsName({
  address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsName.md","from":691,"to":746}<fsm-vh3gqscxm4e>
import { type UseEnsNameParameters } from '@wagmi/vue'
```

### address

`Address | undefined`

Name to get the resolver for. [`enabled`](#enabled) set to `false` if `address` is `undefined`.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsName.md","from":918,"to":1099}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsName } from '@wagmi/vue'

const result = useEnsName({
  address: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### blockNumber

`bigint | undefined`

Block number to get ENS name at.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsName.md","from":1260,"to":1467}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsName } from '@wagmi/vue'

const result = useEnsName({
  address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  blockNumber: 17829139n, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get ENS name at.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsName.md","from":1667,"to":1870}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsName } from '@wagmi/vue'

const result = useEnsName({
  address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  blockTag: 'latest', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsName.md","from":2057,"to":2317}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsName } from '@wagmi/vue'
import { mainnet } from 'wagmi/chains' // [!code focus]

const result = useEnsName({
  address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  chainId: mainnet.id, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsName.md","from":2553,"to":2832}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsName } from '@wagmi/vue'
import { normalize } from 'viem/ens'
import { config } from './config' // [!code focus]

const result = useEnsName({
  address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Composables that have identical context will share the same cache.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsName.md","from":3056,"to":3256}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsName } from '@wagmi/vue'

const result = useEnsName({
  address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  scopeKey: 'foo', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### universalResolverAddress

`Address | undefined`

* Address of ENS Universal Resolver Contract.
* Defaults to current chain's Universal Resolver Contract address.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsName.md","from":3506,"to":3761}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEnsName } from '@wagmi/vue'

const result = useEnsName({
  address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  universalResolverAddress: '0x74E20Bd2A1fE0cdbe45b9A1d89cb7e0a45b36376', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEnsName.md","from":3875,"to":3930}<fsm-vh3gqscxm4e>
import { type UseEnsNameReturnType } from '@wagmi/vue'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getEnsName`](/core/api/actions/getEnsName)

---

---
url: /react/api/hooks/useEnsResolver.md
description: Hook for fetching ENS resolver for name.
---

# useEnsResolver

Hook for fetching ENS resolver for name.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsResolver.md","from":357,"to":396}<fsm-vh3gqscxm4e>
import { useEnsResolver } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsResolver.md","from":445,"to":613}<fsm-vh3gqscxm4e>
import { useEnsResolver } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsResolver({
    name: normalize('wevm.eth'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: warning
Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `useEnsResolver`. You can use Viem's built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this.
:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsResolver.md","from":1141,"to":1195}<fsm-vh3gqscxm4e>
import { type UseEnsResolverParameters } from 'wagmi'
```

***

### blockNumber

`bigint | undefined`

Block number to get ENS resolver at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsResolver.md","from":1314,"to":1527}<fsm-vh3gqscxm4e>
import { useEnsResolver } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsResolver({
    blockNumber: 17829139n, // [!code focus]
    name: normalize('wevm.eth'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get ENS resolver at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsResolver.md","from":1731,"to":1940}<fsm-vh3gqscxm4e>
import { useEnsResolver } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsResolver({
    name: normalize('wevm.eth'),
    blockTag: 'latest', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsResolver.md","from":2129,"to":2395}<fsm-vh3gqscxm4e>
import { useEnsResolver } from 'wagmi'
import { mainnet } from 'wagmi/chains' // [!code focus]
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsResolver({
    chainId: mainnet.id, // [!code focus]
    name: normalize('wevm.eth'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsResolver.md","from":2649,"to":2897}<fsm-vh3gqscxm4e>
import { useEnsResolver } from 'wagmi'
import { normalize } from 'viem/ens'
import { config } from './config' // [!code focus]

function App() {
  const result = useEnsResolver({
    config, // [!code focus]
    name: normalize('wevm.eth'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### name

`string | undefined`

Name to get the resolver for. [`enabled`](#enabled) set to `false` if `name` is `undefined`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsResolver.md","from":3106,"to":3291}<fsm-vh3gqscxm4e>
import { useEnsResolver } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsResolver({
    name: normalize('wevm.eth'), // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsResolver.md","from":3509,"to":3715}<fsm-vh3gqscxm4e>
import { useEnsResolver } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsResolver({
    name: normalize('wevm.eth'),
    scopeKey: 'foo', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### universalResolverAddress

`Address | undefined`

* Resolver of ENS Universal Resolver Contract.
* Defaults to current chain's Universal Resolver Contract address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsResolver.md","from":3966,"to":4227}<fsm-vh3gqscxm4e>
import { useEnsResolver } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsResolver({
    name: normalize('wevm.eth'),
    universalResolverAddress: '0x74E20Bd2A1fE0cdbe45b9A1d89cb7e0a45b36376', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsResolver.md","from":4343,"to":4397}<fsm-vh3gqscxm4e>
import { type UseEnsResolverReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getEnsResolver`](/core/api/actions/getEnsResolver)

---

---
url: /react/api/hooks/useEnsText.md
description: Hook for fetching a text record for a specified ENS name and key.
---

# useEnsText

Hook for fetching a text record for a specified ENS name and key.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsText.md","from":387,"to":422}<fsm-vh3gqscxm4e>
import { useEnsText } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsText.md","from":471,"to":655}<fsm-vh3gqscxm4e>
import { useEnsText } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsText({
    name: normalize('wevm.eth'),
    key: 'com.twitter',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: warning
Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `useEnsText`. You can use Viem's built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize) function for this.
:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsText.md","from":1179,"to":1229}<fsm-vh3gqscxm4e>
import { type UseEnsTextParameters } from 'wagmi'
```

***

### blockNumber

`bigint | undefined`

Block number to get the text at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsText.md","from":1344,"to":1573}<fsm-vh3gqscxm4e>
import { useEnsText } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsText({
    blockNumber: 17829139n, // [!code focus]
    name: normalize('wevm.eth'),
    key: 'com.twitter',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get the text at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsText.md","from":1773,"to":1998}<fsm-vh3gqscxm4e>
import { useEnsText } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsText({
    blockTag: 'latest', // [!code focus]
    name: normalize('wevm.eth'),
    key: 'com.twitter',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsText.md","from":2187,"to":2469}<fsm-vh3gqscxm4e>
import { useEnsText } from 'wagmi'
import { mainnet } from 'wagmi/chains' // [!code focus]
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsText({
    chainId: mainnet.id, // [!code focus]
    name: normalize('wevm.eth'),
    key: 'com.twitter',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### key

`string | undefined`

ENS key to get Text for.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsText.md","from":2609,"to":2810}<fsm-vh3gqscxm4e>
import { useEnsText } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsText({
    name: normalize('wevm.eth'),
    key: 'com.twitter', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### name

`string | undefined`

Name to get the text for. [`enabled`](#enabled) set to `false` if `name` is `undefined`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsText.md","from":3016,"to":3217}<fsm-vh3gqscxm4e>
import { useEnsText } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsText({
    name: normalize('wevm.eth'), // [!code focus]
    key: 'com.twitter',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsText.md","from":3471,"to":3735}<fsm-vh3gqscxm4e>
import { useEnsText } from 'wagmi'
import { normalize } from 'viem/ens'
import { config } from './config' // [!code focus]

function App() {
  const result = useEnsText({
    config, // [!code focus]
    name: normalize('wevm.eth'),
    key: 'com.twitter',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsText.md","from":3953,"to":4175}<fsm-vh3gqscxm4e>
import { useEnsText } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsText({
    scopeKey: 'foo', // [!code focus]
    name: normalize('wevm.eth'),
    key: 'com.twitter',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### universalResolverAddress

`Address | undefined`

* Resolver of ENS Universal Resolver Contract.
* Defaults to current chain's Universal Resolver Contract address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsText.md","from":4426,"to":4703}<fsm-vh3gqscxm4e>
import { useEnsText } from 'wagmi'
import { normalize } from 'viem/ens'

function App() {
  const result = useEnsText({
    name: normalize('wevm.eth'),
    key: 'com.twitter',
    universalResolverAddress: '0x74E20Bd2A1fE0cdbe45b9A1d89cb7e0a45b36376', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEnsText.md","from":4819,"to":4869}<fsm-vh3gqscxm4e>
import { type UseEnsTextReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getEnsText`](/core/api/actions/getEnsText)

---

---
url: /react/api/hooks/useEstimateFeesPerGas.md
description: >-
  Hook for fetching an estimate for the fees per gas (in wei) for a transaction
  to be likely included in the next block.
---

# useEstimateFeesPerGas

Hook for fetching an estimate for the fees per gas (in wei) for a transaction to be likely included in the next block.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateFeesPerGas.md","from":635,"to":681}<fsm-vh3gqscxm4e>
import { useEstimateFeesPerGas } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateFeesPerGas.md","from":730,"to":837}<fsm-vh3gqscxm4e>
import { useEstimateFeesPerGas } from 'wagmi'

function App() {
  const result = useEstimateFeesPerGas()
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateFeesPerGas.md","from":909,"to":960}<fsm-vh3gqscxm4e>
import { type UseEstimateFeesPerGas } from 'wagmi'
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateFeesPerGas.md","from":1098,"to":1308}<fsm-vh3gqscxm4e>
import { useEstimateFeesPerGas } from 'wagmi'
import { mainnet } from 'wagmi/chains' // [!code focus]

function App() {
  const result = useEstimateFeesPerGas({
    chainId: mainnet.id, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateFeesPerGas.md","from":1562,"to":1754}<fsm-vh3gqscxm4e>
import { useEstimateFeesPerGas } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useEstimateFeesPerGas({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateFeesPerGas.md","from":1972,"to":2122}<fsm-vh3gqscxm4e>
import { useEstimateFeesPerGas } from 'wagmi'

function App() {
  const result = useEstimateFeesPerGas({
    scopeKey: 'foo', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### type

`'legacy' | 'eip1559'`

* Defaults to `'eip1559'`

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateFeesPerGas.md","from":2266,"to":2415}<fsm-vh3gqscxm4e>
import { useEstimateFeesPerGas } from 'wagmi'

function App() {
  const result = useEstimateFeesPerGas({
    type: 'legacy', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateFeesPerGas.md","from":2531,"to":2592}<fsm-vh3gqscxm4e>
import { type UseEstimateFeesPerGasReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`estimateFeesPerGas`](/core/api/actions/estimateFeesPerGas)

---

---
url: /react/api/hooks/useEstimateGas.md
description: >-
  Hook for estimating the gas necessary to complete a transaction without
  submitting it to the network.
---

# useEstimateGas

Hook for estimating the gas necessary to complete a transaction without submitting it to the network.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateGas.md","from":463,"to":502}<fsm-vh3gqscxm4e>
import { useEstimateGas } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateGas.md","from":551,"to":644}<fsm-vh3gqscxm4e>
import { useEstimateGas } from 'wagmi'

function App() {
  const result = useEstimateGas()
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateGas.md","from":716,"to":770}<fsm-vh3gqscxm4e>
import { type UseEstimateGasParameters } from 'wagmi'
```

### accessList

`AccessList | undefined`

The access list.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateGas.md","from":867,"to":1263}<fsm-vh3gqscxm4e>
import { useEstimateGas } from 'wagmi'
import { parseEther } from 'viem'
import { config } from './config'

function App() {
  const result = useEstimateGas({
    accessList: [{ // [!code focus]
      address: '0x1', // [!code focus]
      storageKeys: ['0x1'], // [!code focus]
    }], // [!code focus]
    to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    value: parseEther('0.01'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### account

`Address | Account | undefined`

Account to use when estimating gas.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateGas.md","from":1429,"to":1756}<fsm-vh3gqscxm4e>
import { useEstimateGas } from 'wagmi'
import { parseEther } from 'viem'
import { config } from './config'

function App() {
  const result = useEstimateGas({
    account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', // [!code focus]
    to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    value: parseEther('0.01'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

Chain ID to target when estimating gas.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateGas.md","from":1939,"to":2277}<fsm-vh3gqscxm4e>
import { useEstimateGas } from 'wagmi'
import { mainnet } from '@wagmi/core/chains'
import { parseEther } from 'viem'
import { config } from './config'

function App() {
  const result = useEstimateGas({
    chainId: mainnet.id, // [!code focus]
    to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    value: parseEther('0.01'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

Connector to estimate with. If no [`account`](#account) is provided, will use default account from connector.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateGas.md","from":2511,"to":2885}<fsm-vh3gqscxm4e>
import { getConnections, estimateGas } from '@wagmi/core'
import { parseEther } from 'viem'
import { config } from './config'

function App() {
  const connections = getConnections(config)
  const result = useEstimateGas({
    connector: connections[0]?.connector, // [!code focus]
    to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    value: parseEther('0.01'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### data

`` `0x${string}` | undefined ``

A contract hashed method call with encoded function data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateGas.md","from":3070,"to":3394}<fsm-vh3gqscxm4e>
import { useEstimateGas } from 'wagmi'
import { parseEther } from 'viem'
import { config } from './config'

function App() {
  const result = useEstimateGas({
    data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', // [!code focus]
    to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    value: parseEther('0.01'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### gas

`bigint | undefined`

Gas provided for transaction execution.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateGas.md","from":3549,"to":3854}<fsm-vh3gqscxm4e>
import { useEstimateGas } from 'wagmi'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

function App() {
  const result = useEstimateGas({
    gas: parseGwei('20'), // [!code focus]
    to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    value: parseEther('0.01'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### gasPrice

`bigint | undefined`

The price in wei to pay per gas. Only applies to [Legacy Transactions](https://viem.sh/docs/glossary/terms#legacy-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateGas.md","from":4107,"to":4417}<fsm-vh3gqscxm4e>
import { useEstimateGas } from 'wagmi'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

function App() {
  const result = useEstimateGas({
    gasPrice: parseGwei('20'), // [!code focus]
    to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    value: parseEther('0.01'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxFeePerGas

`bigint | undefined`

Total fee per gas in wei, inclusive of [`maxPriorityFeePerGas`](#maxPriorityFeePerGas). Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateGas.md","from":4728,"to":5042}<fsm-vh3gqscxm4e>
import { useEstimateGas } from 'wagmi'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

function App() {
  const result = useEstimateGas({
    maxFeePerGas: parseGwei('20'), // [!code focus]
    to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    value: parseEther('0.01'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxPriorityFeePerGas

`bigint | undefined`

Max priority fee per gas in wei. Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateGas.md","from":5306,"to":5662}<fsm-vh3gqscxm4e>
import { useEstimateGas } from 'wagmi'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

function App() {
  const result = useEstimateGas({
    maxFeePerGas: parseGwei('20'),
    maxPriorityFeePerGas: parseGwei('2'), // [!code focus]
    to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    value: parseEther('0.01'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### nonce

`number`

Unique number identifying this transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateGas.md","from":5816,"to":6100}<fsm-vh3gqscxm4e>
import { useEstimateGas } from 'wagmi'
import { parseEther } from 'viem'
import { config } from './config'

function App() {
  const result = useEstimateGas({
    nonce: 123, // [!code focus]
    to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    value: parseEther('0.01'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateGas.md","from":6318,"to":6607}<fsm-vh3gqscxm4e>
import { useEstimateGas } from 'wagmi'
import { parseEther } from 'viem'
import { config } from './config'

function App() {
  const result = useEstimateGas({
    scopeKey: 'foo', // [!code focus]
    to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    value: parseEther('0.01'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### to

`Address | undefined`

The transaction recipient or contract address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateGas.md","from":6769,"to":7037}<fsm-vh3gqscxm4e>
import { useEstimateGas } from 'wagmi'
import { parseEther } from 'viem'
import { config } from './config'

function App() {
  const result = useEstimateGas({
    to: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
    value: parseEther('0.01'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### type

`'legacy' | 'eip1559' | 'eip2930' | undefined`

Optional transaction request type to narrow parameters.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateGas.md","from":7235,"to":7524}<fsm-vh3gqscxm4e>
import { useEstimateGas } from 'wagmi'
import { parseEther } from 'viem'
import { config } from './config'

function App() {
  const result = useEstimateGas({
    to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    type: 'eip1559', // [!code focus]
    value: parseEther('0.01'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### value

`bigint | undefined`

Value in wei sent with this transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateGas.md","from":7682,"to":7951}<fsm-vh3gqscxm4e>
import { useEstimateGas } from 'wagmi'
import { parseEther } from 'viem'
import { config } from './config'

function App() {
  const result = useEstimateGas({
    to: '0xd2135CfB216b74109775236E36d4b433F1DF507B', 
    value: parseEther('0.01'), // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateGas.md","from":8067,"to":8121}<fsm-vh3gqscxm4e>
import { type UseEstimateGasReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`estimateGas`](/core/api/actions/estimateGas)

---

---
url: /vue/api/composables/useEstimateGas.md
description: >-
  Composable for estimating the gas necessary to complete a transaction without
  submitting it to the network.
---

# useEstimateGas

Composable for estimating the gas necessary to complete a transaction without submitting it to the network.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEstimateGas.md","from":480,"to":524}<fsm-vh3gqscxm4e>
import { useEstimateGas } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEstimateGas.md","from":573,"to":685}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEstimateGas } from '@wagmi/vue'

const result = useEstimateGas()
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEstimateGas.md","from":755,"to":814}<fsm-vh3gqscxm4e>
import { type UseEstimateGasParameters } from '@wagmi/vue'
```

### accessList

`AccessList | undefined`

The access list.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEstimateGas.md","from":913,"to":1314}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEstimateGas } from '@wagmi/vue'
import { parseEther } from 'viem'
import { config } from './config'

const result = useEstimateGas({
  accessList: [{ // [!code focus]
    address: '0x1', // [!code focus]
    storageKeys: ['0x1'], // [!code focus]
  }], // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### account

`Address | Account | undefined`

Account to use when estimating gas.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEstimateGas.md","from":1480,"to":1818}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEstimateGas } from '@wagmi/vue'
import { parseEther } from 'viem'
import { config } from './config'

const result = useEstimateGas({
  account: '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

Chain ID to target when estimating gas.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEstimateGas.md","from":2001,"to":2349}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEstimateGas } from '@wagmi/vue'
import { mainnet } from '@wagmi/vue/chains'
import { parseEther } from 'viem'
import { config } from './config'

const result = useEstimateGas({
  chainId: mainnet.id, // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

Connector to estimate with. If no [`account`](#account) is provided, will use default account from connector.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEstimateGas.md","from":2583,"to":2957}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnections, useEstimateGas } from '@wagmi/vue'
import { parseEther } from 'viem'
import { config } from './config'

const connections = useConnections()
const result = useEstimateGas({
  connector: connections[0]?.connector, // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### data

`` `0x${string}` | undefined ``

A contract hashed method call with encoded function data.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEstimateGas.md","from":3142,"to":3477}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEstimateGas } from '@wagmi/vue'
import { parseEther } from 'viem'
import { config } from './config'

const result = useEstimateGas({
  data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### gas

`bigint | undefined`

Gas provided for transaction execution.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEstimateGas.md","from":3632,"to":3948}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEstimateGas } from '@wagmi/vue'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

const result = useEstimateGas({
  gas: parseGwei('20'), // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### gasPrice

`bigint | undefined`

The price in wei to pay per gas. Only applies to [Legacy Transactions](https://viem.sh/docs/glossary/terms#legacy-transaction).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEstimateGas.md","from":4201,"to":4522}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEstimateGas } from '@wagmi/vue'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

const result = useEstimateGas({
  gasPrice: parseGwei('20'), // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxFeePerGas

`bigint | undefined`

Total fee per gas in wei, inclusive of [`maxPriorityFeePerGas`](#maxPriorityFeePerGas). Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEstimateGas.md","from":4833,"to":5158}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEstimateGas } from '@wagmi/vue'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

const result = useEstimateGas({
  maxFeePerGas: parseGwei('20'), // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxPriorityFeePerGas

`bigint | undefined`

Max priority fee per gas in wei. Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEstimateGas.md","from":5422,"to":5787}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEstimateGas } from '@wagmi/vue'
import { parseEther, parseGwei } from 'viem'
import { config } from './config'

const result = useEstimateGas({
  maxFeePerGas: parseGwei('20'),
  maxPriorityFeePerGas: parseGwei('2'), // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### nonce

`number`

Unique number identifying this transaction.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEstimateGas.md","from":5941,"to":6236}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEstimateGas } from '@wagmi/vue'
import { parseEther } from 'viem'
import { config } from './config'

const result = useEstimateGas({
  nonce: 123, // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Composables that have identical context will share the same cache.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEstimateGas.md","from":6460,"to":6760}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEstimateGas } from '@wagmi/vue'
import { parseEther } from 'viem'
import { config } from './config'

const result = useEstimateGas({
  scopeKey: 'foo', // [!code focus]
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  value: parseEther('0.01'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### to

`Address | undefined`

The transaction recipient or contract address.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEstimateGas.md","from":6922,"to":7203}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEstimateGas } from '@wagmi/vue'
import { parseEther } from 'viem'
import { config } from './config'

const result = useEstimateGas({
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
  value: parseEther('0.01'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### type

`'legacy' | 'eip1559' | 'eip2930' | undefined`

Optional transaction request type to narrow parameters.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEstimateGas.md","from":7401,"to":7701}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEstimateGas } from '@wagmi/vue'
import { parseEther } from 'viem'
import { config } from './config'

const result = useEstimateGas({
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  type: 'eip1559', // [!code focus]
  value: parseEther('0.01'),
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### value

`bigint | undefined`

Value in wei sent with this transaction.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEstimateGas.md","from":7859,"to":8141}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useEstimateGas } from '@wagmi/vue'
import { parseEther } from 'viem'
import { config } from './config'

const result = useEstimateGas({
  to: '0xd2135CfB216b74109775236E36d4b433F1DF507B', 
  value: parseEther('0.01'), // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useEstimateGas.md","from":8255,"to":8314}<fsm-vh3gqscxm4e>
import { type UseEstimateGasReturnType } from '@wagmi/vue'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`estimateGas`](/core/api/actions/estimateGas)

---

---
url: /react/api/hooks/useEstimateMaxPriorityFeePerGas.md
description: >-
  Hook for fetching an estimate for the max priority fee per gas (in wei) for a
  transaction to be likely included in the next block.
---

# useEstimateMaxPriorityFeePerGas

Hook for fetching an estimate for the fees per gas (in wei) for a transaction to be likely included in the next block.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateMaxPriorityFeePerGas.md","from":594,"to":650}<fsm-vh3gqscxm4e>
import { useEstimateMaxPriorityFeePerGas } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateMaxPriorityFeePerGas.md","from":699,"to":826}<fsm-vh3gqscxm4e>
import { useEstimateMaxPriorityFeePerGas } from 'wagmi'

function App() {
  const result = useEstimateMaxPriorityFeePerGas()
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateMaxPriorityFeePerGas.md","from":898,"to":959}<fsm-vh3gqscxm4e>
import { type UseEstimateMaxPriorityFeePerGas } from 'wagmi'
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateMaxPriorityFeePerGas.md","from":1097,"to":1327}<fsm-vh3gqscxm4e>
import { useEstimateMaxPriorityFeePerGas } from 'wagmi'
import { mainnet } from 'wagmi/chains' // [!code focus]

function App() {
  const result = useEstimateMaxPriorityFeePerGas({
    chainId: mainnet.id, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateMaxPriorityFeePerGas.md","from":1581,"to":1793}<fsm-vh3gqscxm4e>
import { useEstimateMaxPriorityFeePerGas } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useEstimateMaxPriorityFeePerGas({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateMaxPriorityFeePerGas.md","from":2011,"to":2181}<fsm-vh3gqscxm4e>
import { useEstimateMaxPriorityFeePerGas } from 'wagmi'

function App() {
  const result = useEstimateMaxPriorityFeePerGas({
    scopeKey: 'foo', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useEstimateMaxPriorityFeePerGas.md","from":2297,"to":2368}<fsm-vh3gqscxm4e>
import { type UseEstimateMaxPriorityFeePerGasReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`estimateMaxPriorityFeePerGas`](/core/api/actions/estimateMaxPriorityFeePerGas)

---

---
url: /react/api/hooks/useFeeHistory.md
description: Hook for fetching a collection of historical gas information.
---

# useFeeHistory

Hook for fetching a collection of historical gas information.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useFeeHistory.md","from":387,"to":425}<fsm-vh3gqscxm4e>
import { useFeeHistory } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useFeeHistory.md","from":474,"to":619}<fsm-vh3gqscxm4e>
import { useFeeHistory } from 'wagmi'

function App() {
  const result = useFeeHistory({
    blockCount: 4,
    rewardPercentiles: [25, 75]
})
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useFeeHistory.md","from":691,"to":744}<fsm-vh3gqscxm4e>
import { type UseFeeHistoryParameters } from 'wagmi'
```

### blockCount

`number | undefined`

Number of blocks in the requested range. Between 1 and 1024 blocks can be requested in a single query. Less than requested may be returned if not all blocks are available.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useFeeHistory.md","from":994,"to":1158}<fsm-vh3gqscxm4e>
import { useFeeHistory } from 'wagmi'

function App() {
  const result = useFeeHistory({
    blockCount: 4, // [!code focus]
    rewardPercentiles: [25, 75]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### rewardPercentiles

`number[] | undefined`

A monotonically increasing list of percentile values to sample from each block's effective priority fees per gas in ascending order, weighted by gas used.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useFeeHistory.md","from":1446,"to":1610}<fsm-vh3gqscxm4e>
import { useFeeHistory } from 'wagmi'

function App() {
  const result = useFeeHistory({
    blockCount: 4,
    rewardPercentiles: [25, 75] // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`bigint | undefined`

Highest number block of the requested range.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useFeeHistory.md","from":1781,"to":1972}<fsm-vh3gqscxm4e>
import { useFeeHistory } from 'wagmi'

function App() {
  const result = useFeeHistory({
    blockCount: 4,
    blockNumber: 1551231n, // [!code focus]
    rewardPercentiles: [25, 75]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag of the highest number block of the requested range.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useFeeHistory.md","from":2206,"to":2392}<fsm-vh3gqscxm4e>
import { useFeeHistory } from 'wagmi'

function App() {
  const result = useFeeHistory({
    blockCount: 4,
    blockTag: 'safe', // [!code focus]
    rewardPercentiles: [25, 75]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useFeeHistory.md","from":2577,"to":2811}<fsm-vh3gqscxm4e>
import { useFeeHistory } from 'wagmi'
import { mainnet } from '@wagmi/core/chains'

function App() {
  const result = useFeeHistory({
    blockCount: 4,
    chainId: mainnet.id, // [!code focus]
    rewardPercentiles: [25, 75]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useFeeHistory.md","from":3065,"to":3292}<fsm-vh3gqscxm4e>
import { useFeeHistory } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useFeeHistory({
    blockCount: 4,
    rewardPercentiles: [25, 75]
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useFeeHistory.md","from":3512,"to":3748}<fsm-vh3gqscxm4e>
import { useFeeHistory } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useFeeHistory({
    blockCount: 4,
    rewardPercentiles: [25, 75]
    scopeKey: 'foo', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useFeeHistory.md","from":3864,"to":3917}<fsm-vh3gqscxm4e>
import { type UseFeeHistoryReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getFeeHistory`](/core/api/actions/getFeeHistory)

---

---
url: /react/api/hooks/useGasPrice.md
description: Hook for fetching the current price of gas (in wei).
---

# useGasPrice

Hook for fetching the current price of gas (in wei).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useGasPrice.md","from":359,"to":395}<fsm-vh3gqscxm4e>
import { useGasPrice } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useGasPrice.md","from":444,"to":531}<fsm-vh3gqscxm4e>
import { useGasPrice } from 'wagmi'

function App() {
  const result = useGasPrice()
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useGasPrice.md","from":603,"to":654}<fsm-vh3gqscxm4e>
import { type UseGasPriceParameters } from 'wagmi'
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useGasPrice.md","from":792,"to":982}<fsm-vh3gqscxm4e>
import { useGasPrice } from 'wagmi'
import { mainnet } from 'wagmi/chains' // [!code focus]

function App() {
  const result = useGasPrice({
    chainId: mainnet.id, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useGasPrice.md","from":1236,"to":1408}<fsm-vh3gqscxm4e>
import { useGasPrice } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useGasPrice({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useGasPrice.md","from":1628,"to":1809}<fsm-vh3gqscxm4e>
import { useGasPrice } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useGasPrice({
    scopeKey: 'foo', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useGasPrice.md","from":1925,"to":1976}<fsm-vh3gqscxm4e>
import { type UseGasPriceReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getGasPrice`](/core/api/actions/getGasPrice)

---

---
url: /react/api/hooks/useInfiniteReadContracts.md
description: >-
  Hook for calling multiple read methods on a contract with "infinite
  scroll"/"fetch more" support.
---

# useInfiniteReadContracts

Hook for calling multiple contract read-only methods with "infinite scrolling"/"fetch more" support.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useInfiniteReadContracts.md","from":505,"to":554}<fsm-vh3gqscxm4e>
import { useInfiniteReadContracts } from 'wagmi'
```

## Usage

The example below shows how to demonstrate how to fetch a set of [mloot](https://etherscan.io/address/0x1dfe7ca09e99d10835bf73044a23b73fc20623df) attributes (chestwear, footwear, and handwear) with "fetch more" support.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useInfiniteReadContracts.md","from":824,"to":1561}<fsm-vh3gqscxm4e>
import { useInfiniteReadContracts } from 'wagmi'
import { abi } from './abi'

const mlootContractConfig = {
  address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
  abi,
} as const

function App() {
  const result = useInfiniteReadContracts({
    cacheKey: 'mlootAttributes',
    contracts(pageParam) {
      const args = [pageParam] as const
      return [
        { ...mlootContractConfig, functionName: 'getChest', args },
        { ...mlootContractConfig, functionName: 'getFoot', args },
        { ...mlootContractConfig, functionName: 'getHand', args },
      ]
    }
    query: {
      initialPageParam: 0,
      getNextPageParam: (_lastPage, _allPages, lastPageParam) => {
        return lastPageParam + 1
      }
    }
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

In the above example, we are setting a few things:

* [`cacheKey`](#cachekey): A unique key to store the data in the cache.
* [`query.initialPageParam`](#initialpageparam): An initial page parameter to use when fetching the first set of contracts.
* [`query.getNextPageParam`](#getnextpageparam): A function that returns the next page parameter to use when fetching the next set of contracts.
* [`contracts`](#contracts): A function that provides `pageParam` (derived from the above) as an argument and expects to return an array of contracts.

### Paginated Parameters

We can also leverage properties like `getNextPageParam` with a custom `limit` variable to achieve "pagination" of parameters. For example, we can fetch the first 10 contract functions, then fetch the next 10 contract functions, and so on.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useInfiniteReadContracts.md","from":2501,"to":3177}<fsm-vh3gqscxm4e>
import { useInfiniteReadContracts } from 'wagmi'
import { abi } from './abi'

function Example({ limit = 10 }: { limit?: number } = {}) {
  const result = useInfiniteReadContracts({
    cacheKey: 'mlootAttributes',
    contracts(pageParam) {
      return [...new Array(limit)].map(
        (_, i) =>
          ({
            address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
            abi,
            functionName: 'getHand',
            args: [BigInt(pageParam + i)],
          }) as const,
      )
    },
    query: {
      initialPageParam: 1,
      getNextPageParam(_lastPage, _allPages, lastPageParam) {
        return lastPageParam + limit
      },
    }
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useInfiniteReadContracts.md","from":3294,"to":3358}<fsm-vh3gqscxm4e>
import { type UseInfiniteReadContractsParameters } from 'wagmi'
```

### cacheKey

`string`

A unique key to store the data in the cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useInfiniteReadContracts.md","from":3467,"to":3860}<fsm-vh3gqscxm4e>
import { useInfiniteReadContracts } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useInfiniteReadContracts({
    cacheKey: 'mlootAttributes', // [!code hl]
    contracts(pageParam) {
      // ...
    }
    query: {
      initialPageParam: 0,
      getNextPageParam: (_lastPage, _allPages, lastPageParam) => {
        return lastPageParam + 1
      }
    }
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### contracts

`(pageParam: {{TPageParam}}) => Contract[]`

A function that provides `pageParam` (derived from the above) as an argument and expects to return an array of contracts.

#### abi

`Abi | undefined`

The contract's ABI. Check out the [TypeScript docs](/react/typescript#const-assert-abis-typed-data) for how to set up ABIs for maximum type inference and safety.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useInfiniteReadContracts.md","from":4364,"to":4993}<fsm-vh3gqscxm4e>
import { useInfiniteReadContracts } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useInfiniteReadContracts({
    cacheKey: 'mlootAttributes',
    contracts(pageParam) {
      const args = [pageParam] as const
      return [
        // ...
        {  
          address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
          abi, // [!code hl]
          functionName: 'getChest', 
          args 
        },
        // ...
      ]
    }
    query: {
      initialPageParam: 0,
      getNextPageParam: (_lastPage, _allPages, lastPageParam) => {
        return lastPageParam + 1
      }
    }
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

#### address

`Address | undefined`

The contract's address.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useInfiniteReadContracts.md","from":5184,"to":5813}<fsm-vh3gqscxm4e>
import { useInfiniteReadContracts } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useInfiniteReadContracts({
    cacheKey: 'mlootAttributes',
    contracts(pageParam) {
      const args = [pageParam] as const
      return [
        // ...
        {  
          address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df', // [!code hl]
          abi,
          functionName: 'getChest', 
          args 
        },
        // ...
      ]
    }
    query: {
      initialPageParam: 0,
      getNextPageParam: (_lastPage, _allPages, lastPageParam) => {
        return lastPageParam + 1
      }
    }
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

#### functionName

`string | undefined`

* Function to call on the contract.
* Inferred from [`abi`](#abi).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useInfiniteReadContracts.md","from":6051,"to":6679}<fsm-vh3gqscxm4e>
import { useInfiniteReadContracts } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useInfiniteReadContracts({
    cacheKey: 'mlootAttributes',
    contracts(pageParam) {
      const args = [pageParam] as const
      return [
        // ...
        {  
          address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
          abi,
          functionName: 'getChest', // [!code hl]
          args 
        },
        // ...
      ]
    }
    query: {
      initialPageParam: 0,
      getNextPageParam: (_lastPage, _allPages, lastPageParam) => {
        return lastPageParam + 1
      }
    }
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

#### args

`readonly unknown[] | undefined`

* Arguments to pass when calling the contract.
* Inferred from [`abi`](#abi) and [`functionName`](#functionname).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useInfiniteReadContracts.md","from":6968,"to":7569}<fsm-vh3gqscxm4e>
import { useInfiniteReadContracts } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useInfiniteReadContracts({
    cacheKey: 'mlootAttributes',
    contracts(pageParam) {
      return [
        // ...
        {  
          address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
          abi,
          functionName: 'getChest', 
          args: [pageParam] // [!code hl]
        },
        // ...
      ]
    }
    query: {
      initialPageParam: 0,
      getNextPageParam: (_lastPage, _allPages, lastPageParam) => {
        return lastPageParam + 1
      }
    }
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

#### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useInfiniteReadContracts.md","from":7798,"to":8448}<fsm-vh3gqscxm4e>
import { useInfiniteReadContracts } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useInfiniteReadContracts({
    cacheKey: 'mlootAttributes',
    contracts(pageParam) {
      const args = [pageParam] as const
      return [
        // ...
        {  
          address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
          abi,
          functionName: 'getChest', 
          args,
          chainId: 1 // [!code hl]
        },
        // ...
      ]
    }
    query: {
      initialPageParam: 0,
      getNextPageParam: (_lastPage, _allPages, lastPageParam) => {
        return lastPageParam + 1
      }
    }
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useInfiniteReadContracts.md","from":8608,"to":8672}<fsm-vh3gqscxm4e>
import { type UseInfiniteReadContractsReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

---

---
url: /react/api/hooks/usePrepareTransactionRequest.md
description: >-
  Hook for preparing a transaction request for signing by populating a nonce,
  gas limit, fee values, and a transaction type.
---

# usePrepareTransactionRequest

Hook for preparing a transaction request for signing by populating a nonce, gas limit, fee values, and a transaction type.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePrepareTransactionRequest.md","from":598,"to":651}<fsm-vh3gqscxm4e>
import { usePrepareTransactionRequest } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePrepareTransactionRequest.md","from":700,"to":942}<fsm-vh3gqscxm4e>
import { usePrepareTransactionRequest } from 'wagmi'
import { parseEther } from 'viem'

function App() {
  const result = usePrepareTransactionRequest({
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    value: parseEther('1'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePrepareTransactionRequest.md","from":1014,"to":1082}<fsm-vh3gqscxm4e>
import { type UsePrepareTransactionRequestParameters } from 'wagmi'
```

### account

`Account | Address | undefined`

The Account to send the transaction from.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePrepareTransactionRequest.md","from":1211,"to":1529}<fsm-vh3gqscxm4e>
import { usePrepareTransactionRequest } from 'wagmi'
import { parseEther } from 'viem'

function App() {
  const result = usePrepareTransactionRequest({
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', // [!code focus]
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    value: parseEther('1'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### to

`` `0x${string}` | undefined ``

The transaction recipient or contract address.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePrepareTransactionRequest.md","from":1703,"to":2022}<fsm-vh3gqscxm4e>
import { usePrepareTransactionRequest } from 'wagmi'
import { parseEther } from 'viem'

function App() {
  const result = usePrepareTransactionRequest({
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',  // [!code focus]
    value: parseEther('1'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### accessList

`AccessList | undefined`

The access list.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePrepareTransactionRequest.md","from":2167,"to":2583}<fsm-vh3gqscxm4e>
import { usePrepareTransactionRequest } from 'wagmi'
import { parseEther } from 'viem'

function App() {
  const result = usePrepareTransactionRequest({
    accessList: [ // [!code focus:6]
      {
        address: '0x1',
        storageKeys: ['0x1'],
      },
    ],
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    value: parseEther('1'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

Chain ID to prepare the transaction request for.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePrepareTransactionRequest.md","from":2777,"to":3120}<fsm-vh3gqscxm4e>
import { usePrepareTransactionRequest } from 'wagmi'
import { parseEther } from 'viem'

function App() {
  const result = usePrepareTransactionRequest({
    chainId: mainnet.id, // [!code focus]
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    value: parseEther('1'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### data

`` `0x${string}` | undefined ``

A contract hashed method call with encoded args.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePrepareTransactionRequest.md","from":3298,"to":3672}<fsm-vh3gqscxm4e>
import { usePrepareTransactionRequest } from 'wagmi'
import { parseEther } from 'viem'

function App() {
  const result = usePrepareTransactionRequest({
    data: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', // [!code focus]
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    value: parseEther('1'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### gasPrice

`bigint | undefined`

The price (in wei) to pay per gas. Only applies to [Legacy Transactions](https://viem.sh/docs/glossary/terms#legacy-transaction).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePrepareTransactionRequest.md","from":3924,"to":4284}<fsm-vh3gqscxm4e>
import { usePrepareTransactionRequest } from 'wagmi'
import { parseEther, parseGwei } from 'viem'

function App() {
  const result = usePrepareTransactionRequest({
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    gasPrice: parseGwei('20'), // [!code focus]
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    value: parseEther('1'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxFeePerGas

`bigint | undefined`

Total fee per gas (in wei), inclusive of `maxPriorityFeePerGas`. Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePrepareTransactionRequest.md","from":4574,"to":4938}<fsm-vh3gqscxm4e>
import { usePrepareTransactionRequest } from 'wagmi'
import { parseEther, parseGwei } from 'viem'

function App() {
  const result = usePrepareTransactionRequest({
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    maxFeePerGas: parseGwei('20'), // [!code focus]
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    value: parseEther('1'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxPriorityFeePerGas

`bigint | undefined`

Max priority fee per gas (in wei). Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePrepareTransactionRequest.md","from":5206,"to":5612}<fsm-vh3gqscxm4e>
import { usePrepareTransactionRequest } from 'wagmi'
import { parseEther, parseGwei } from 'viem'

function App() {
  const result = usePrepareTransactionRequest({
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    maxFeePerGas: parseGwei('20'),
    maxPriorityFeePerGas: parseGwei('2'), // [!code focus]
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    value: parseEther('1'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### nonce

`number | undefined`

Unique number identifying this transaction.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePrepareTransactionRequest.md","from":5775,"to":6107}<fsm-vh3gqscxm4e>
import { usePrepareTransactionRequest } from 'wagmi'
import { parseEther } from 'viem'

function App() {
  const result = usePrepareTransactionRequest({
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    value: parseEther('1'),
    nonce: 5, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### parameters

`("fees" | "gas" | "nonce" | "type")[] | undefined`

Parameters to prepare.

For instance, if `["gas", "nonce"]` is provided, then only the `gas` and `nonce` parameters will be prepared.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePrepareTransactionRequest.md","from":6396,"to":6748}<fsm-vh3gqscxm4e>
import { usePrepareTransactionRequest } from 'wagmi'
import { parseEther } from 'viem'

function App() {
  const result = usePrepareTransactionRequest({
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    parameters: ['gas', 'nonce'], // [!code focus]
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    value: parseEther('1'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### value

`bigint | undefined`

Value in wei sent with this transaction.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePrepareTransactionRequest.md","from":6908,"to":7226}<fsm-vh3gqscxm4e>
import { usePrepareTransactionRequest } from 'wagmi'
import { parseEther } from 'viem'

function App() {
  const result = usePrepareTransactionRequest({
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    value: parseEther('1'), // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePrepareTransactionRequest.md","from":7481,"to":7862}<fsm-vh3gqscxm4e>
import { usePrepareTransactionRequest } from 'wagmi'
import { parseEther } from 'viem'
import { config } from './config' // [!code focus]

function App() {
  const result = usePrepareTransactionRequest({
    config, // [!code focus]
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    value: parseEther('1'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePrepareTransactionRequest.md","from":8082,"to":8454}<fsm-vh3gqscxm4e>
import { usePrepareTransactionRequest } from 'wagmi'
import { parseEther } from 'viem'
import { config } from './config'

function App() {
  const result = usePrepareTransactionRequest({
    scopeKey: 'foo' // [!code focus]
    account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    value: parseEther('1'),
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePrepareTransactionRequest.md","from":8570,"to":8638}<fsm-vh3gqscxm4e>
import { type UsePrepareTransactionRequestReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`prepareTransactionRequest`](/core/api/actions/prepareTransactionRequest)

---

---
url: /react/api/hooks/useProof.md
description: >-
  Hook for return the account and storage values of the specified account
  including the Merkle-proof.
---

# useProof

Hook for return the account and storage values of the specified account including the Merkle-proof.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useProof.md","from":444,"to":477}<fsm-vh3gqscxm4e>
import { useProof } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useProof.md","from":526,"to":773}<fsm-vh3gqscxm4e>
import { useProof } from 'wagmi'

function App() {
  const result = useProof({
    address: '0x4200000000000000000000000000000000000016',
    storageKeys: [
      '0x4a932049252365b3eedbc5190e18949f2ec11f39d3bef2d259764799a1b27d99',
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useProof.md","from":845,"to":893}<fsm-vh3gqscxm4e>
import { type UseProofParameters } from 'wagmi'
```

### address

`Address | undefined`

The account address to get the proof for.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useProof.md","from":1011,"to":1275}<fsm-vh3gqscxm4e>
import { useProof } from 'wagmi'

function App() {
  const result = useProof({
    address: '0x4200000000000000000000000000000000000016', // [!code focus]
    storageKeys: [
      '0x4a932049252365b3eedbc5190e18949f2ec11f39d3bef2d259764799a1b27d99',
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### storageKeys

`` `0x${string}`[] | undefined ``

Array of storage-keys that should be proofed and included.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useProof.md","from":1472,"to":1738}<fsm-vh3gqscxm4e>
import { useProof } from 'wagmi'

function App() {
  const result = useProof({
    address: '0x4200000000000000000000000000000000000016',
    storageKeys: [ // [!code focus:3]
      '0x4a932049252365b3eedbc5190e18949f2ec11f39d3bef2d259764799a1b27d99',
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`bigint | undefined`

Proof at a given block number.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useProof.md","from":1894,"to":2183}<fsm-vh3gqscxm4e>
import { useProof } from 'wagmi'

function App() {
  const result = useProof({
    address: '0x4200000000000000000000000000000000000016',
    blockNumber: 42069n, // [!code focus]
    storageKeys: [
      '0x4a932049252365b3eedbc5190e18949f2ec11f39d3bef2d259764799a1b27d99',
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Proof at a given block tag.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useProof.md","from":2383,"to":2671}<fsm-vh3gqscxm4e>
import { useProof } from 'wagmi'

function App() {
  const result = useProof({
    address: '0x4200000000000000000000000000000000000016',
    blockTag: 'latest', // [!code focus]
    storageKeys: [
      '0x4a932049252365b3eedbc5190e18949f2ec11f39d3bef2d259764799a1b27d99',
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

The ID of chain to get the proof for.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useProof.md","from":2854,"to":3184}<fsm-vh3gqscxm4e>
import { useProof } from 'wagmi'
import { optimism } from 'wagmi/chains'

function App() {
  const result = useProof({
    chainId: optimism.id, // [!code focus]
    address: '0x4200000000000000000000000000000000000016',
    storageKeys: [
      '0x4a932049252365b3eedbc5190e18949f2ec11f39d3bef2d259764799a1b27d99',
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useProof.md","from":3438,"to":3765}<fsm-vh3gqscxm4e>
import { useProof } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useProof({
    config, // [!code focus]
    address: '0x4200000000000000000000000000000000000016',
    storageKeys: [
      '0x4a932049252365b3eedbc5190e18949f2ec11f39d3bef2d259764799a1b27d99',
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useProof.md","from":3985,"to":4303}<fsm-vh3gqscxm4e>
import { useProof } from 'wagmi'
import { config } from './config'

function App() {
  const result = useProof({
    scopeKey: 'foo' // [!code focus]
    address: '0x4200000000000000000000000000000000000016',
    storageKeys: [
      '0x4a932049252365b3eedbc5190e18949f2ec11f39d3bef2d259764799a1b27d99',
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useProof.md","from":4419,"to":4467}<fsm-vh3gqscxm4e>
import { type UseProofReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getProof`](/core/api/actions/getProof)

---

---
url: /react/api/hooks/usePublicClient.md
description: Hook for getting Viem `PublicClient` instance.
---

# usePublicClient

Hook for getting Viem [`PublicClient`](https://viem.sh/docs/clients/public) instance.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePublicClient.md","from":215,"to":255}<fsm-vh3gqscxm4e>
import { usePublicClient } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePublicClient.md","from":304,"to":399}<fsm-vh3gqscxm4e>
import { usePublicClient } from 'wagmi'

function App() {
  const client = usePublicClient()
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: warning
If you want to optimize bundle size, you should use [`useClient`](/react/api/hooks/useClient) along with Viem's [tree-shakable actions](https://viem.sh/docs/clients/custom#tree-shaking) instead. Since Public Client has all public actions attached directly to it.
:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePublicClient.md","from":751,"to":806}<fsm-vh3gqscxm4e>
import { type UsePublicClientParameters } from 'wagmi'
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when getting Viem Public Client.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePublicClient.md","from":955,"to":1187}<fsm-vh3gqscxm4e>
import { usePublicClient } from 'wagmi'
import { mainnet } from 'wagmi/chains' // [!code focus]
import { config } from './config'

function App() {
  const client = usePublicClient({
    chainId: mainnet.id, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePublicClient.md","from":1440,"to":1620}<fsm-vh3gqscxm4e>
import { usePublicClient } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const client = usePublicClient({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/usePublicClient.md","from":1693,"to":1748}<fsm-vh3gqscxm4e>
import { type UsePublicClientReturnType } from 'wagmi'
```

`PublicClient | undefined`

Viem [`PublicClient`](https://viem.sh/docs/clients/public) instance.

## Action

* [`getPublicClient`](/core/api/actions/getPublicClient)
* [`watchPublicClient`](/core/api/actions/watchPublicClient)

---

---
url: /react/api/hooks/useReadContract.md
description: >-
  Hook for calling a read-only function on a contract, and returning the
  response.
---

# useReadContract

Hook for calling a **read-only** function on a contract, and returning the response.

A **read-only** function (constant function) on a Solidity contract is denoted by a pure or view keyword. They can only read the state of the contract, and cannot make any changes to it. Since read-only methods do not change the state of the contract, they do not require any gas to be executed, and can be called by any user without the need to pay for gas.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContract.md","from":806,"to":846}<fsm-vh3gqscxm4e>
import { useReadContract } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContract.md","from":895,"to":1124}<fsm-vh3gqscxm4e>
import { useReadContract } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useReadContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'totalSupply',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContract.md","from":1231,"to":1286}<fsm-vh3gqscxm4e>
import { type UseReadContractParameters } from 'wagmi'
```

### abi

`Abi | undefined`

The contract's ABI. Check out the [TypeScript docs](/react/typescript#const-assert-abis-typed-data) for how to set up ABIs for maximum type inference and safety.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContract.md","from":1516,"to":1779}<fsm-vh3gqscxm4e>
import { useReadContract } from 'wagmi'
import { abi } from './abi' // [!code focus]

function App() {
  const result = useReadContract({
    abi, // [!code focus]
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'totalSupply',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### account

`Account | undefined`

Account to use when calling the contract (`msg.sender`).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContract.md","from":1993,"to":2354}<fsm-vh3gqscxm4e>
import { useReadContract } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useReadContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'balanceOf',
    args: ['0x6b175474e89094c44da98b954eedeac495271d0f'],
    account: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### address

`Address | undefined`

The contract's address.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContract.md","from":2535,"to":2781}<fsm-vh3gqscxm4e>
import { useReadContract } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useReadContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f', // [!code focus]
    functionName: 'totalSupply',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### args

`readonly unknown[] | undefined`

* Arguments to pass when calling the contract.
* Inferred from [`abi`](#abi) and [`functionName`](#functionname).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContract.md","from":3060,"to":3362}<fsm-vh3gqscxm4e>
import { useReadContract } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useReadContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'balanceOf',
    args: ['0x6b175474e89094c44da98b954eedeac495271d0f'], // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### blockNumber

`bigint | undefined`

Block number to call contract at.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContract.md","from":3561,"to":3835}<fsm-vh3gqscxm4e>
import { useReadContract } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useReadContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'totalSupply',
    blockNumber: 17829139n, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to call contract at.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContract.md","from":4073,"to":4341}<fsm-vh3gqscxm4e>
import { useReadContract } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useReadContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'totalSupply',
    blockTag: 'safe', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContract.md","from":4565,"to":4892}<fsm-vh3gqscxm4e>
import { useReadContract } from 'wagmi'
import { mainnet } from 'wagmi/chains' // [!code focus]
import { abi } from './abi'

function App() {
  const result = useReadContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'totalSupply',
    chainId: mainnet.id, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContract.md","from":5181,"to":5490}<fsm-vh3gqscxm4e>
import { useReadContract } from 'wagmi'
import { abi } from './abi'
import { config } from './config' // [!code focus]

function App() {
  const result = useReadContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'totalSupply',
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### functionName

`string | undefined`

* Function to call on the contract.
* Inferred from [`abi`](#abi).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContract.md","from":5718,"to":6020}<fsm-vh3gqscxm4e>
import { useReadContract } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useReadContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'balanceOf', // [!code focus]
    args: ['0x6b175474e89094c44da98b954eedeac495271d0f'],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContract.md","from":6275,"to":6598}<fsm-vh3gqscxm4e>
import { useReadContract } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useReadContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'balanceOf',
    args: ['0x6b175474e89094c44da98b954eedeac495271d0f'],
    scopeKey: 'foo', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContract.md","from":6749,"to":6804}<fsm-vh3gqscxm4e>
import { type UseReadContractReturnType } from 'wagmi'
```

The return type's [`data`](#data) property is inferrable via the combination of [`abi`](#abi), [`functionName`](#functionname), and [`args`](#args). Check out the [TypeScript docs](/react/typescript#const-assert-abis-typed-data) for more info.

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## Type Inference

With [`abi`](#abi) setup correctly, TypeScript will infer the correct types for [`functionName`](#functionname), [`args`](#args), and the return type. See the Wagmi [TypeScript docs](/react/typescript) for more information.

::: code-group

```ts twoslash [Inline]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContract.md","from":7379,"to":12198}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"8bfa3d1e805ee2d7a8b83c91b1e75f961b748f9d5c3b79a8bca9b7494b57cb8e","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BjCMONAAlPgFcAbNROwCqcGACUYAQygBhFmlKTGaCWm6kwAFWwwAPF2kteGdqgA6Ydlc5SoRk5hyCzIAGbcwygJYsXAbgtrG0MwY3YwSQBbGGcQACNJXklPGAB5V39A6wM7UJM2SRoAWW40STivXi9MWKIvGAB3TMts23t2LzAsUrhBHPbzFqCrfrzwqJj2FyVmDzRm4daQsMdJ6agoLjg4BesAXwBdAKHg3LCIUu60XtOB4CzF0ZWdWO5OtAAmAFYANl2rQ7HPYUdj3E5PBwvKZuDzeXwgY5BCHjaKxNAQMq8ADK3CwWGM/1uYwKxVK5Uq1QwtXqTQRDyJYU6VxuyOQR3pyIuaGZfTaY0GixGfLCEVR0LguPxGEJSOFkKc0LeYE+v0JgIshxBLgSSRS6RcINZLgADLQfnEAIwAdi+ABYrbaYAAOACcxpdtsYtttUEkLqdcRddpgMFgSltQY+VotUGNGRABxBFQA5u8AHyUEAFUgMRA/Ki8GBgZNofBIfPUSSkZMwXMgLZ8BgFzq4RDGqiMfBVpQ0ch54HoHR4QgkchUGj0PAACkSXkkcAAlOxuKIJNI5MrFMp9HLTGDZct5WsYZ40D4wITkaLjzrkow0vHEUszvkyqSyhUqjVoXVGpfd0yPS8oee70geL4oseMwXMqMrPu0qyxNImzwDsdInOq4K7lyPIMiYAqCsiiGKu83x/OhQSYcCoIcruxEuO4p7nv+IHXmiGKJDieIEhR8HEm+MAlB+FLfi4v60k+QogYB1zARBbKSXh7A4UBSkEY8u5seKko8Yp4EIVCLhKiq5GKVRibQreerxoau7ICaZqWja9qOq67qet6vr+oGwahlIXqRtGsbxhZG6uF4yZJhF6ZTlg3bRL2cAAPyCCI4i2BuCg9gACvFtZkHAO4gepSn0SecIXrxUkQVp2qJHeD4sRBJKCWSn6UtSf5VUpMksnZ+6EZpExIYwsywd1+ljGVyFbGhZnslhIEqbJakDRpIFlcZZFqgt1FraVhnlWe8KKVew3QuimJcVKTXtC1Qnkl+VI/jSt1jL1ckDAtk3nJcqmsvtP0mLVWY6dKE18c8CpGaRqrdeZWrxPV1kGmpAB0GOhSw4WRewKbpguqWrhl8hbiotbqFoOi6BjaNphYXiRFgEA5suxPrqTPaZnYjAIIgBBoNyvQAPTCw0kjJpEXho3A+DCwYyjC5IWBeMLhAQAA1nAwsrulHOblzVDZrmFpfAWRYlmWiCm+OVY1nWutrrInPKJmVRgK27YgJ23bKGQSCmwO1BDvzI7++OdB1rFpAQDgOYYEu5IpattEbYdjEVW9IrnXVur3vq3XIvdbUic9YmvYXAFdP9/VgZDwM5yA0FzHB1UGdDTcbLNO2ndhf0rQDddt1Nh1bXD81AiC+1EensLHZVvesY3l2cWDWevoUrXCU9nUSanEEfWp3318p/d9cVgMnyDErceDekn5tsOmfS5nsAAPsuYCwOFHtQJmxtIAAMxmxAIWYspYgG22rLWPA5I3YtgDh2LsZN/aIA+EHVYw5iDh2oJHacWAY5x0wEuMqGd54uH/mUHMSA7Tm3AVbW0UD7Z4Ewc2D2kDvbIJ7Kgn4GCQ4EGwWOXBk5+bR1jmQYhkFYhWXzvGShVZcxWidHQy2SBGGVmgXWa88D2GIHUT7FBfZeEUEHDgLBo5MwTijgQ8R8clzF23h1F6XV5HUOtsaQBKiIHWxAVQ5h/MHGPUpDo1sICDHcKMXwsxodBGWLwaImxRCE4dGrgPWui0aqN2buNReEFppd1Qs0Q4riTaAPUWA1ReYmEwP5r1EJ5YkG+17OWKJrYBEWIjiIkAYiklLhBtk+YIASkB1tCAip3j1F+JqeACY9SqmcKaag60rTzE4KsfgwhEjkn5JQtsChRsqEmx+B8LxDDql1lYaAhB8zwl+z7GUlZMSOnCOsZsuxp9uQ1wvvvdux4x7PzAMUg5CiA5OmUaAi23irTnLwMtBAbDWzQoWYYlpJjg7RPaWs+J3TElbJIaPJ++ysyHKQB8Y0XtxlnI0f49FuAEVICRbc5p1snSPMxUI9ZCS3mSNIXPZiQzgVuI+IAl0py1Ewv5pc92rYLReyZTwtlYcOXYp6XiqRF0OLYjXgK4lIK0E/E8RC+h4rqXTO0fS62FpGkov7GizBTysVdNVe8wJ7VRIgHEkSgBaC3Rip8RK3V74gmYDmRaE5yKImotMW0pVcSnW4veYfVkBxhmIEAR8K1RrKkVimXWOpFqLSGvlZEu1/DY2dNebYyRcLPr8mnkNMULgb43UrmnDu/yikpsFbmQBIq/VItzbCs+ob9FcLuVG2lqzlXxu5ck6+2rU3AMzZSk1g7+bmquboi0o7Fl9gtKy0tGLy0vI2VW7ZBLlTbR1d6wBPwkUrr0QGqV1zt3WsjWm20irYkVtPb09gM1ULJwAAamgACTADYKQToyY9hAffp/b+LY/7drUcaZdkKrYDrttMgD2xQ2MrHcy9Bh6Y3fpPVys9S4yHngAHITGTrnBqBd4MuBXlq2+Lh4MeEQ7/VNozwUPrDQG6jLA6PRFDeC4tpK2UAEduBkAwHGytf6RNgDEzABjSM86NRACx6gmrro8S41/GAP9Qx8a+AJjDAdw1rqOrR2ZBbJOEdQcR6NU6lO/rVXbZKtawjIAGYIEDtBwOQeg7Bg4xmePmZQ3o10frJnYbrD5uZGa33jrQbJ+TpBFM/oo3+nzydWSBfYMF0LChwtAcix/bjpmkN8fi1miZAaUsWrSxGjLbnJ0OunXWZgrAOANn4ETPWzsDbKFUJTbQOAiryXrW248qn17qsYyjVtzUBIPTdWXD1FdcntCTekwUSl+mjRgoM++w8oZQQKXs+Gx8rsmBrSnE4QN2CP0vePF+u0p4/JHh3Jb632ggzY4Zu+f2wiutLrvZbh3ioPaUs9wer2r6N2bbpIeB122Evu0CCyq3ZGoyNCAU05prR2gdM6N0HovQ+j9AGIMjo/LhkCjGOMLgLL42VBmWLFO/U5qS3gIbTZN2tg+Dum1xov3PM5Ti2dS5fRlEEFzjgNWTNmeQyAHmfMQCaHwDAdgSQ2DsAlKNVC7heBhC2BAXgJAoDsEV5IdgrgWbvf1+wOTCm0YWB91od3RuOCm/vNsC3Vv4A27tw7woTuXekDdwbz3OXvcXhT3rg3AeTfcDNyHvgYe4AR9DFHsozvXelgT9ljAyffdp8N/OQPWfg9wFDyYa3tvC+O5L3HsvHuK9V9T/7uvmfs9N9zy38Pbf7cd9j/HnvXvU1fFoU1qldnHepYl++q0WWFOefy2qx3yvorKii3V3jVBtd4BrxnoP5vR82HzxPovMfS/u8T5X33FhL+D+vzny3Y/7+R6n2f3Ly93fz93Ty/wbxv1/zvwL0n2j07xn1fz7w/wH2N2/xH2gNbwAPgOn27yQNAM/zQMgJ/zz1gMfwQLwN73n0XwfUS00TwFXza3Xwy030TG9mgDaX62N2F3YAAF42ZRtMoyYpwBpyRBB7IThL5iIAByVTaQigOuLSaQmRB8eQuuKHHedgaQ8SNQlHQ+VAdVaQgZeQ97KEIw27OAaQ9gTUOuZ7AwmQ/5KwmwjCBQyQuuGQuQ1wxYJQ0HMGXQxYDQpxbQmkfw4YfQxMWws+cQ4AQw9HDAEwhwp+JwiIlwrIFIqwXDG4aQ0nJyCnVyanDyOnbyRnEMMMAKL4KMNnVwUI1TdTQQZQ5GWRXQ33DI6sG4ZAbIxycnFyKndyWnLyBnXyMoiMCooKOMaQlIvYBcX3YXNGR3CwTMBKSQJAUASOIsOAc8FhBAPYPYIAA="}
import { createConfig, http, useReadContract } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
// ---cut---
const result = useReadContract({
  abi: [
    {
      type: 'function',
      name: 'balanceOf',
      stateMutability: 'view',
      inputs: [{ name: 'account', type: 'address' }],
      outputs: [{ type: 'uint256' }],
    },
    {
      type: 'function',
      name: 'totalSupply',
      stateMutability: 'view',
      inputs: [],
      outputs: [{ name: 'supply', type: 'uint256' }],
    },
  ],
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'balanceOf',
  // ^?


  args: ['0x6b175474e89094c44da98b954eedeac495271d0f'],
  // ^?
})

result.data
//     ^?
```

```ts twoslash [Const-Asserted]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContract.md","from":12234,"to":17436}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"9f8b59d36cf11dedf27c45ac2abd580ec38459b071c6641a3e4025c048f71072","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BjCMONAAgEMAjAS0XakYnKCwA2GdqgA6YdvMHDRYCe0w4B0kADMArmEZpeLLQG5ZCxSPGSwnALYxNIbpzGcDMAPLazFhULWKpJsnDQAsrpoPLxivJjORLwwAO5+cgFKNuy8YFhRcAKByqoyGZbyxdl2js6cjMz6aOkVmUGq6k7sWiJQQnBwLQoAvgC65uVWJZIQUflohVPZZa2VWcFq2F1aurloAEwArABsQ/JjE8MU7MD+a+2Snc56BkYmIBOWVRs129QQ0TEAGVdFgsBIzksNqEIlEYnEEt0QElUpDvqpcvNFujJMhxncoapZmgsUV1qVbpMvuTbA4/nBQeCMJDqQ9NhokbswAcTpCLrIxpQQKFSAxEMcqGIYGAAOZofBIADMVGipBlMDFIBiQriYFwiAADFRGPhOKR6jRyOKrugtnhCCRyCq6JqABRYUgQHCijAASnZfxehmMYC0QpFYv2+0l0rlCsQABYVWb1ZrOjrcvroyATWaLWQkAmbdQ7YgCMQC876Hh3Z7vZh/b9nK53J4fGGqBHC0mQFLZfLC8m1Rq8L8M3qlcbTebDAXE8X02WHZXqC6ax6vWQG+wYTBItE+AiMIlkmkQOHVWLjgB2GP9+MARkOQ9TeF3+/h8Qw4/1PdzM8tQsF1LctHSFGhqzLWtNx9f1MQKMk2RWNppnYJskXqRpuTRGkAzqKA+ngQYPgFUYLzNMUAE4JV7WMB3FF8RzLeCFh/JBnxzad8ytIsKFtHB7QrJ1V0gkBoPrP00LpOoGlmbDz07S8kAfA1b1o+9B2oFMmPAOk2MQDj/245TDmAgSlyE8C1ygjcJP9J4MII/piPI0VlP2Hs+zjTTVVfMt00lTN2KnPNZytRV9jM/VQJXCC3VsrdJOJUlCVxSlWVQhydj2I5ThIsBBUUijlITAAOO9vMQNTfJ05KCn0mijLCoC+JLcyYuEuL1zrRL7K2ZwuR5PLXLFB9jiNdTKp7Gq0ztQKJwYzjQsAxAxqiwSwKreKetgvCkSDN5QwU4UlNWyjlUm+jpu02aBPm/VKJCgC514/jouXTrrLEhLdvQrQ0ABNwQTBCFjq7RB9ifCqrsYzUx3u5SJqalbXra97LK27qYO3d84UPL8T1RMHTo8iavPoqGtOHTVcYPWIv30h8Hye4z51axcOqs0TxN6nI8gQ1KpDIoq3Ih45Hsu+MaJmvAWIQBHVuzZGXvWizNpE7bsaSuYBZxKR0pQ6ppKRBkQeZfKMuyLKQEG3L0kKk7ioh0qOPJ+NqpuvA6tYhWHwu5WeNVznMZsnbtz+4VGVBkakH2Si1LdnzPbLeHeyC1b/a45rVuOIOPq5zW7L27LuTt4mncVP3ofja7qbwAK04Wqulue8LIvZkD85DtH2GYVgOAAXkF5D7ky/r9v0YN3k+Q2fmNrQWw8RhvF8C3Z9UWnP0RLQUTPGfR+yOXENQkeKj1iPMLk5o19aPXrd6Zy+XxSY9e97FcNPy2Nmt23eRv9h+QFWuAbA+39x5aAOiGHCbII4A0BMDJk0DUKb3xtvZEp4kGH35gsY+yxn5fyJDrHBw8QFn1whHU2iD/4EMeOAm2OU/77wAc/B24NFQJguonAysMmAsDYIzQyWcVqmQ7u1LuGteH90UAyMQaABAAFU4AwAAEpKAAMIsDQABVRaBdCkDAAAFS2AAHj1qfO+dDIHTwJOfeeLg3BLxXpg6E0RYR0yPITPeNjcJHxIQSGhUlagYVkk0Fk69aEch6E5IiT8mGvyIe/JCpCAk/wYXlJhgCrg3G8Wya2VijpxPIXYuBQMo7m0KWyFB9M0G72cRibBiST74PCewN+uCNifxaRQspYTQEdDob/dJBJMmjGuAvBxbZV7XDMVoA0tBjjcAfNeQ4CZrwJhgKVSiBpKIJkYAmBMUBOCUVKtwSiKyYAwFgPUBMZz9jXgfFAA0q9RnsD4DKPYAA+GOiBFQnGrkgaWycQD9F0LIxmakA4ArzhjCRUE3C8E4HAf0uglGqJEBo7kAFTEf1IRYyJOhJ6HTqbSIJ4zWzL3bP/PWVSPFIlqVSnxDT2kUn8V0uxl9QnUJaffaJAxYk5NQm0vxVJuUDLSfyoB2SX64TyYSqBDKYHFMBsCHpCrkGuL3Hjapx46UYLVVglKZjml9JmAk5laVWUmsCfSVVTCUlitLow4ZLCXlkscZS6ZH9ZnzMWcs1Z6zNnbN2fsw5xzTnnMucIPZtz7mPOedcDF2heAymuG8z57o8yOEtHAAA/Ao1F6jNEAQAAqZo1GQOA2KkkCqtpYuV1jpWKtJfY8lTj9UuLCJq9xBNdVEwqahXxZjklsubRy+SdrRX4ofjE/+gCAlCqHZawWqTHVDMmJk4BNawH4vycS61zgSkqrNnumlPad56v7Qa3WH9jWCwXTipdtjm2UNBhOq1K6hoSrGGMlt7qpnDwAHRAZeYm5Nqbk2fN9PmlRhbMUWh0XowxJigMAY+bIXg9gsAQFFOwFFMH0VFotEKUQjAEBLjQCSQoAB6KjKROAynsLwADcB8BUcCIYKjnAsC8Co4QCAABrOAVG8NoqgBirRRGRZikVMcV2dFHwcRlmWETsGJOGHBSzbOT5oXqy6qHLW/oYh5uFfand9aClbtUBHRekyT0ao/KgnV56+2WckIOh9IqrUXxCeOx9Mq6HTr5bO298SSTXurZ55dDrP3BcuJuxtY8zOvHlZeuezbD0INfa5nc9mtW0uc14hLV7iFGtS4QsLJWPOrEFt049XL33RbLhkl17AAA+uGwCwCTXqKA3zFQu3+T8nhZZtS+3Ki3Vm7c3obVil9Hmu1Au5oEAAAzmQAEmAGwUguQZTDGW21jrXXMy9ak0qSi2YuEezriN3l8tG76gfBLSFEMdOze5j9bc+SABydJjNutsyAA7/1lWZfNgd/QR2evfP2RLLhD5sxKYJcllgP3HD6X2EjIRc4ptozwAAR10GQb83d5uffM6jmAf3f0A6B/8eBqrwedZgN1y50ObmDfh8NpHU8wAU/R5j5a2PXufXe2HSSKYlvDzHXI9gq3aAba2ztvboxGeQ9Z6dxMpUybyaTtdrUao7u6izJnQXVocccwJ0TguWMi4S+M2Y6XK31uba0Ur5bKv2sQ+Z8d6HWvBu1z8vrmUhv077BN63WOwvrdlj7mwaRoKZeKPw2JwjhgEP6KMTgKtJ9cX+aSzzvd1mJkUtXmVkIuXu01Ivdl9zEXqtPr+NL3pUWp23YlfOs1JnVh4r+IMr98XTOBnM4XpV9O6tl5y52hz2rPF7tr00if966/d6Kc+21fncmNadeul1P6bMl60J6pC3qFlLJWWsjZWydl7IOUck5Zz1mRuuTGh5TytAvLTdyL5GvDj9cG4CvXEFMFBWfYRqLHK0A0KPEnD7SSQ5aIAQT/DgT3JnFnE7EAEjMjEAAxfAGAdgdwOPBkBoIiPQMQVQfoCAMQEgKAdgOAzgdgbQbDNQHA9gS3UgDAADWQTgwxZg/AjgQg5eAYEgsg+ACgqgmgsIOghg0gJg3A1g9grg2QbA3A3gncXQIgwQ0FYQuAUQy5cQ6Iegxg+UWQwnNgjg0McwpQvAxFPgtQgQuAIQyQcgyg3Q2ggw6Qowlgkw+Q8wxQng6w1Q9Q+wzQxwkQ5w6g1wqQmQzwonADb5FZOTDSRMLnWg9HMA03JAa8IOOQ6Pb6MXf0WghAiDbkVXb3KHKgDAvASwlQ/g4g4I6RHQ8IiQtwqIuQswrgqo/wmojQ0gkI7QsIvQyQww5g1ohQ7g5Qzo2w2ono+o/oiIoY4wmI0YjoggyY7orQhogY5ojwkYnwsYqwlYwIhwmYsQuY9w4Yrw2In/BMBIqaZIiQ1IzTFaTI0ZHMaAaKWPDgGIdgIeZAfwUhByAAcnyQBIoAJHQgBP3xXhBIJFPURABN3mhMmF8VQH3XYABOlxBL2nRNuwBOYVBMmCFRRMBMGVxO/X8CuD+IJEBOBPxMsHBIyzKURMsFhJ1XhNPCZIUGRNGQJEJOAFRIBJfQwExOJLSVJO5IyApLABV0RV7j4WaHMI+Pj1kW+NwwLQIzg0MFdANhiFpK4FuwEABLmVPz9Qv0DWvxDTv3DUfyuWjUODuVf20A5O+2NghOLyhPxK4PkAlwEGQENJ9TP39UvyDRv1DXvwjRtJuTtNjSeQBPFOGF9C4KALQAA1oNkCFCzU4CQFABdGlDgBDHrgQGGGGCAA="}
import { createConfig, http, useReadContract } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
// ---cut---
const abi = [
  {
    type: 'function',
    name: 'balanceOf',
    stateMutability: 'view',
    inputs: [{ name: 'account', type: 'address' }],
    outputs: [{ type: 'uint256' }],
  },
  {
    type: 'function',
    name: 'totalSupply',
    stateMutability: 'view',
    inputs: [],
    outputs: [{ name: 'supply', type: 'uint256' }],
  },
] as const

const result = useReadContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'balanceOf',
  // ^?


  args: ['0x6b175474e89094c44da98b954eedeac495271d0f'],
  // ^?
})

result.data
//     ^?
```

:::

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`readContract`](/core/api/actions/readContract)

---

---
url: /vue/api/composables/useReadContract.md
description: >-
  Composable for calling a read-only function on a contract, and returning the
  response.
---

# useReadContract

Composable for calling a **read-only** function on a contract, and returning the response.

A **read-only** function (constant function) on a Solidity contract is denoted by a pure or view keyword. They can only read the state of the contract, and cannot make any changes to it. Since read-only methods do not change the state of the contract, they do not require any gas to be executed, and can be called by any user without the need to pay for gas.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReadContract.md","from":823,"to":868}<fsm-vh3gqscxm4e>
import { useReadContract } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReadContract.md","from":917,"to":1157}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useReadContract } from '@wagmi/vue'
import { abi } from './abi'

const result = useReadContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'totalSupply',
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReadContract.md","from":1262,"to":1322}<fsm-vh3gqscxm4e>
import { type UseReadContractParameters } from '@wagmi/vue'
```

### abi

`Abi | undefined`

The contract's ABI. Check out the [TypeScript docs](/vue/typescript#const-assert-abis-typed-data) for how to set up ABIs for maximum type inference and safety.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReadContract.md","from":1550,"to":1824}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useReadContract } from '@wagmi/vue'
import { abi } from './abi' // [!code focus]

const result = useReadContract({
  abi, // [!code focus]
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'totalSupply',
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### account

`Account | undefined`

Account to use when calling the contract (`msg.sender`).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReadContract.md","from":2036,"to":2404}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useReadContract } from '@wagmi/vue'
import { abi } from './abi'

const result = useReadContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'balanceOf',
  args: ['0x6b175474e89094c44da98b954eedeac495271d0f'],
  account: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### address

`Address | undefined`

The contract's address.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReadContract.md","from":2583,"to":2840}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useReadContract } from '@wagmi/vue'
import { abi } from './abi'

const result = useReadContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f', // [!code focus]
  functionName: 'totalSupply',
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### args

`readonly unknown[] | undefined`

* Arguments to pass when calling the contract.
* Inferred from [`abi`](#abi) and [`functionName`](#functionname).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReadContract.md","from":3117,"to":3428}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useReadContract } from '@wagmi/vue'
import { abi } from './abi'

const result = useReadContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'balanceOf',
  args: ['0x6b175474e89094c44da98b954eedeac495271d0f'], // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### blockNumber

`bigint | undefined`

Block number to call contract at.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReadContract.md","from":3625,"to":3908}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useReadContract } from '@wagmi/vue'
import { abi } from './abi'

const result = useReadContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'totalSupply',
  blockNumber: 17829139n, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to call contract at.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReadContract.md","from":4144,"to":4421}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useReadContract } from '@wagmi/vue'
import { abi } from './abi'

const result = useReadContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'totalSupply',
  blockTag: 'safe', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReadContract.md","from":4643,"to":4979}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useReadContract } from '@wagmi/vue'
import { mainnet } from 'wagmi/chains' // [!code focus]
import { abi } from './abi'

const result = useReadContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'totalSupply',
  chainId: mainnet.id, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReadContract.md","from":5250,"to":5568}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useReadContract } from '@wagmi/vue'
import { abi } from './abi'
import { config } from './config' // [!code focus]

const result = useReadContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'totalSupply',
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### functionName

`string | undefined`

* Function to call on the contract.
* Inferred from [`abi`](#abi).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReadContract.md","from":5794,"to":6105}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useReadContract } from '@wagmi/vue'
import { abi } from './abi'

const result = useReadContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'balanceOf', // [!code focus]
  args: ['0x6b175474e89094c44da98b954eedeac495271d0f'],
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Composables that have identical context will share the same cache.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReadContract.md","from":6364,"to":6694}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useReadContract } from '@wagmi/vue'
import { abi } from './abi'

const result = useReadContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'balanceOf',
  args: ['0x6b175474e89094c44da98b954eedeac495271d0f'],
  scopeKey: 'foo', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReadContract.md","from":6843,"to":6903}<fsm-vh3gqscxm4e>
import { type UseReadContractReturnType } from '@wagmi/vue'
```

The return type's [`data`](#data) property is inferrable via the combination of [`abi`](#abi), [`functionName`](#functionname), and [`args`](#args). Check out the [TypeScript docs](/vue/typescript#const-assert-abis-typed-data) for more info.

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## Type Inference

With [`abi`](#abi) setup correctly, TypeScript will infer the correct types for [`functionName`](#functionname), [`args`](#args), and the return type. See the Wagmi [TypeScript docs](/vue/typescript) for more information.

::: code-group

```ts twoslash [Inline]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReadContract.md","from":7474,"to":11889}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"c9cd30cf155368eb52dff62473381dfcdf7018daabaed2ca4c58019bdbc995a3","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BjCMONAAlPgFcAbNROwCqcGACUYAQygBhFmlKTGaCWm6kwAFWwwAPAApgAHTDsz7TDkFGQAM25hlASxY2A3CfPswkgLYxBNlInMABzD1NzNkkaAFluNEkAIydeJ0xrECInGAB3d09zEKwEuEFjSK8zH39AhRDwwqqLHUzpKC44OALK9gBfZABdCK8IBJK0MvYK5rNLAPYbbhC0ACYAVgA2Hq8B4ZM+9gAfaaaWq0W7B2dXEBHzGoWghvuzaLiE5NT0jEzsvJ2RTAEymYBgJFIQ1e7DGaBB5TOXkedWCYWhXnmmWWYDWW0BZj2ET6AEohhRLklJLxJI4YAB5Ww2cnPMJk7zgsgAPkoIGipAYiE2VF4MDCaHwSCF1EkpFCMAFIE6fAYwpCuEQAAYqIx8DKlDRyIK+hR0Do8IQITyaPQ8PoqU5JHBiexuKIJNI5DjFMoDDNzJjLvZHGgXGB8d4/E96mizu8YPFEik0hlLv98nczsVSgjekjIyiXoj/a1Lu1Ot0M71CWdYfDTrnixclisNttK7soQdjvWMSWbEGbmH2w98+wWY1enGE19k79Uzl09Cs5NBGCIZ3erXsz3Zsix9GJ7NzgtmzjW+Hq2ASWybJTqbSGUz96jQmzPbYnKFyWuufosHr/ANOAAH0AH5BBEcQpFkeRvTQAAFAD5TIOBfTOAN+2uENbmhPdx2hKdPiTH4/gXcNlymP1mjwg90UbE8QDLeAK2hS9RnGbcqKqDCQGxXE21YjdDhOLieIHbCh1w0d8NjRIPkTb4UxsNNyOBbcf0hfZNw4lcd2o6TaKLOY+14ls8WHAkhNJQZyVvKkaUYelGUoZ8GjfFgPy/dkIU5YkILdaDPQUfVVHULQdF0AA6aLORMJxfCwCB+RdAKPVg/UeSgCBGAQRACDQOEygAeiK3JJFCXwnEiuB8CKohuBgIrJCwJwisICAAGs4CK10oLSr0MqoPkBQARnWYVRVCcUkDGqhElleU8F690YIG5QeTSMEkC1EAdT1ZQyBm9ZjVNHBzWIQ65roBU/1ICAcH5DBnS+QRDHQkzxNDcMaJfAi5PjIjFLnZSyIs9gKJzI8fsLBtjKbRioA6ZiLw3di4U4ozjyxMyBLOS9hL0rHAywr6wehmNJ3+6diKUrJQaXNTdI01HzC3XSuLzWpXIpo8eL488wfx6yeWGpAAGZxpAEUxQlRAxbmmU5QVL4NrVGbtV1ODDsQVYTuoM08otS7qGu20sDuh7MGdMSSduEX5oFdYABYJplpAXelBaFXmVWtrljX9oNSU9Z9w2LvIK6bTy277rIK2Iy58d7ZlAUAHYAA5Xam2WPfmpW8EeX31Q9vatcNTYQ4Nghw6tU3o/N2PHudQiFNnUiARAZP+RmjV5alybpsQWbPfzvKW5nH4i6QSXS/1bWK5NfWzrDy1I5uhvLae8HGcos5ycPei2kR8sej2LvRrFj3pezyUFa9vAKKnwUA7L4PF9D6vV5NqOQBjzfnT3AAERgDALAsRJAYCSFBWwuhxzciGg7GaTtJbX0HrnRWi08qF1VH7KUs8DqGhGqnSuy9P7G2tOvC2cct4BmAaA8BkDoG6BsExLoNh4G8kQUPTYqws5oLvqPJeuAcHqjwZrOehpL4kPVGQiO39KGN3jmzXevQ+Y41PkMc+M106Z37m7RAqcBGYJAMop+hjdriIIW/U6MijZyIoWbKhTciann4jYLROsNQ7VQTnIx3szQiKQOY/BQch7p2kedL+Dj65OPjjbYMpMPGrDFgATj4b4kexifaBKHjtEJ88Ikr3IXXX+G9qEAIMi+JJmw+4+Pdn4gukYn4jRGi/CR1ihGROKT/P+5T9wxABq3Ei84O5JJSd4gesth552MePGmGBmm8IsYHAp78q52Nrj0spziIbeTIJohBKdxarFaXom+z9MkKkfjkkafd8nl0KbIzZCj/4wh0iozmUZfrvXhvzcyRIDmcKOXLVJ6SgkNLyqYm5JdLGhIXjYrp9iSm9OcUAkBYCIFQIkDAuBHiJanLqYgdB98sFNOhW0qxYTHkbLXo4xRNCTJ/LbHizY5jCXEsEdkqWash4wpWZIp21Ka60pifS56x9mKZA1LQTYSQiHO1Tk7GA6dxkpKdowJ2TsoCSBSenJIKTnYgNgEoJ2BrVipxGlADUzkPFOw1ASyZ4LLl4FYQgG5wTYXa11ms0hNL5F0teZ9FgAA5SpDRbXrF0YSkaSyZkKiDWAUN/hmm6PuUgb1CK8oAEcGqkAWSK0psSt4JqTV88Nhzu5EsjWCoesaMHxttomsl3K/YjVTZ6w0GbOlFKRVsotz1ZRTHHIC0WRKVU1o5cYxWbqW3qhORS0JXaP45rIPm/1orXnToLKyQYtrx1nP4c6vK06n7zuWa/HWQqoklOYKwDgSp+D+T6qtYKyhQoaG0DgNCqiPqNu+mGnmUQqaAzbiMxcmYd6Q13ABg+zQeKupRlpNGdYOaH0uEyxDRJuyiV/QknCe8YN/QGdTIG7dwO9F2czJDrN3lQf0onQysMXGmTPP8vGVkbwgDvA5JyT5h02T2aQDho71jrAmfoqUca8APpVLO9NHr+XbSvd0l5fTtWJEENi3QDhYAfjBFATk3YtMaQ4VlHKeBND4BgOwakbAxzcEYI5Lo9heC8AwJweAEBeAkCgOwdTkh2C2CShYKz7AV15siiYKLWhQu2Y4HABzTm4Aubcx5uAXmfN+ZiAFoLpAQvWfCxgSLYYSuWes3F+zjnmIpfc50DLMBfP+cC8F8UBXc1FeiyYMrNnHTxcS9VvgqW6veYa1lxIzW8utbC+14r0XusVYS1V5zg3aueZG417LE38vTdXZFDxom2WOqJRCkA/nT0KYvcQn1MjCvPIDWp7LmmYAwJ089tUBmjPPd0CZzK2VcogHm71yrSWatpfqxt8buXtuFdm6V2LQPFsg5W2D9bY2cstdCzDzrMXysI/68t1zq30uo6a1DqbWOStdfh3ZxHA3Cco8y6TjHbXdvY8BzT/HyXkfDcZ5tsnmOZv7fWId/Rk6FRnZyeahd2tiE2V2tAGRt67MyfYAAXhSs+oKcE3qRBeuwZAZxUMBgAOQJuNxQIse5jfcYfLYc3RY5mkfYMbtM9uGy7NQAnBYxulDMAcGgc3RMfcSq6Mb/oNkizKMEJ7k3TKw99Aj1WC3vQjcllN42t39HvdoAgIkXgABlbgWAsBucz1UR3oGXcLjL14D3ifmhR/18AL3ghjcJeL6X8ksecbx/r+YY0hQ++utb9K2V8qnaKuVaq9VmrtW6v1YahrUgNVmotVau3yezAltHNb+ytu3fRbMFu/XxvR9ytTgqpVKqNRqo1VqnVeqDVKqXya1flrrXG8T9jkk0WZORX8yYDyIBJIEgKANdKKHAKGHgJMCAH0H0EAA="}
import { createConfig, http, useReadContract } from '@wagmi/vue'
import { mainnet, sepolia } from 'wagmi/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
// ---cut---
const result = useReadContract({
  abi: [
    {
      type: 'function',
      name: 'balanceOf',
      stateMutability: 'view',
      inputs: [{ name: 'account', type: 'address' }],
      outputs: [{ type: 'uint256' }],
    },
    {
      type: 'function',
      name: 'totalSupply',
      stateMutability: 'view',
      inputs: [],
      outputs: [{ name: 'supply', type: 'uint256' }],
    },
  ],
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'balanceOf',
  // ^?


  args: ['0x6b175474e89094c44da98b954eedeac495271d0f'],
  // ^?



})

result.data
//     ^?
```

```ts twoslash [Const-Asserted]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReadContract.md","from":11926,"to":17121}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"b21638ef6d0df571da0457691c07531820bda58a8bf70cddee1ce9852f692ff4","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BjCMONAAgEMAjAS0XakYnKCwA2GdqgA6YdvMHDRYCe0w4B0kADMArmEZpeLLQG5ZCxSPGSwnALYxNIbpzGcDMAPLazFhULWKpJsnDQAsrpoPLxivJjORLwwAO5+cgFKNuy8YFhRcAKByqoyGZbyxdl2js6cjMz6aOkVmUGq6k7sWiJQQnBwLQoAvgC65uVWJZIQUflohVPZZa2VWcFq2F1aurloAEwArABsQ/JjE8MU7MD+a+2Snc56BkYmIBOWVRs129QQ0TEAGVdFgsBIzksNqEIlEYnEEt0QElUpDvqpcvNFujJMhxncoapZmgsUV1qVbpMvuTbA4/nBQeCMJDqQ9NhokbswAcTpCLrIxpQQKFSAxEMcqGIYGAAOZofBIADMVGipBlMDFIBiQriYFwiAADFRGPhOKR6jRyOKrugtnhCCRyCq6JqABRYUgQHCijAASnZfxehmMYC0QpFYv2+0l0rlCsQABYVWb1ZrOjrcvroyATWaLWQkAmbdQ7YgCMQC876Hh3Z7vZh/b9nK53J4fGGqBHC0mQFLZfLC8m1Rq8L8M3qlcbTebDAXE8X02WHZXqC6ax6vWQG+wYTBItE+AiMIlkmkQOHVWLjgB2GP9+MARkOQ9TeF3+/h8Qw4/1PdzM8tQsF1LctHSFGhqzLWtNx9f1MQKMk2RWNppnYJskXqRpuTRGkAzqKA+ngQYPgFUYLzNMUAE4JV7WMB3FF8RzLeCFh/JBnxzad8ytIsKFtHB7QrJ1V0gkBoPrP00LpOoGlmbDz07S8kAfA1b1o+9B2oFMmPAOk2MQDj/245TDmAgSlyE8C1ygjcJP9J4MII/piPI0VlP2Hs+zjTTVVfMt00lTN2KnPNZytRV9jM/VQJXCC3VsrdJOJUlCVxSlWVQhydj2I5ThIsBBUUijlITAAOO9vMQNTfJ05KCn0mijLCoC+JLcyYuEuL1zrRL7K2ZwuR5PLXLFB9jiNdTKp7Gq0ztQKJwYzjQsAxAxqiwSwKreKetgvCkSDN5QwU4UlNWyjlUm+jpu02aBPm/VKJCgC514/jouXTrrLEhLdvQrQ0ABNwQTBCFjq7RB9ifCqrsYzUx3u5SJqalbXra97LK27qYO3d84UPL8T1RMHTo8iavPoqGtOHTVcYPWIv30h8Hye4z51axcOqs0TxN6nI8gQ1KpDIoq3Ih45Hsu+MaJmvAWIQBHVuzZGXvWizNpE7bsaSuYBZxKR0pQ6ppKRBkQeZfKMuyLKQEG3L0kKk7ioh0qOPJ+NqpuvA6tYhWHwu5WeNVznMZsnbtz+4VGVBkakH2Si1LdnzPbLeHeyC1b/a45rVuOIOPq5zW7L27LuTt4mncVP3ofja7qbwAK04Wqulue8LIvZkD85DtH2GYVgOAAXkF5D7ky/r9v0YN3k+Q2fmNrQWw8RhvF8C3Z9UWnP0RLQUTPGfR+yOXENQkeKj1iPMLk5o19aPXrd6Zy+XxSY9e97FcNPy2Nmt23eRv9h+QFWuAbA+39x5aAOiGHCbII4A0BMDJk0DUKb3xtvZEp4kGH35gsY+yxn5fyJDrHBw8QFn1whHU2iD/4EMeOAm2OU/77wAc/B24NFQJguonAysMmAsDYIzQyWcVqmQ7u1LuGteH90UAyMQaABAAFU4AwAAEpKAAMIsDQABVRaBdCkDAAAFS2AAHj1qfO+dDIHTwJOfeeLg3BLxXpg6E0RYR0yPITPeNjcJHxIQSGhUlagYVkk0Fk69aEch6E5IiT8mGvyIe/JCpCAk/wYXlJhgCrg3G8Wya2VijpxPIXYuBQMo7m0KWyFB9M0G72cRibBiST74PCewN+uCNifxaRQspYTQEdDob/dJBJMmjGuAvBxbZV7XDMZfJoAgAAGBpaAABJgBsFILkGUwx5mjPYHwGUewAB8MdECKhONXJA0tk4gH6LoWRjM1IB0uXnDGEioJuF4JwOA/pdBKNUSIDR3IAKmI/qQixkSdCT0OnU2kQTxmtmXu2f+esqkeKRLU5FPiGntIpP4rpdjZnySYSkuhD8Yn/0AQEtpfiqQtNSaXRhwyWHAJyWPCF+SYWBL+CU4EPTMWVNcXuPG1Tjzoowfy1CvizHNL6TMBJOK0p4tlVy5wlDQbErpQMtJsTSJjPsQipxlBh6ErkewRZKy1laM2ds3ZgLtC8BlNcfZRz3R5kcJaOAAB9AA/Aov56jNEAQAApuo1GQOAIKkmsqtpYqFUCJVGzhfqxxSKKnIMFR+VBoqd7irTVglKZjkn4qTSa3pgt77RIGDql+uFqWFqVeWrVDKhmTEySymtuTY2vHjXmueSaeUIPVdGlxYQhXuIJmKomvb6kFo/jKwWdbQUNtsUmtV5Tl24XpUNatYw9WL0mVoaZH8TUCAAHTnttSwe1jq9kOqOb6P1KiA1AotDovRhiTHntPYc2QvB7BYAgKKdgvyn0AsDRaIUohGAICXGgEkhQAD0CGUicBlPYXgp64D4AQ0QXQMAEOcCwLwBDhAIAAGs4AIZA/8qAgKtEQZFmKRUxxXZ0UfBxGWZZqPPvo4YB5LNs5PheerLqoctb+hiAq/Ww7+nsrjdYjtqEI77sRavadIQM3CrRTmqdMnJBSqXbS5VF8QlEo3Z2iFZKq0UvnfEkkutDOrEbRCwZO720krk92hTATYGA15WbTlqKJ06a8Yp/NDmkK2drfKmlTmV30j5Rq5VW6y4ZJYcLR2otFQuwuacnhZZtS+3Ki3Vm7c3obVil9Hmu0rOLC0Es443AHzXkOAma8CYYClUogaSiCZGAJgTFATglFSrcEoq1mAMBYD1ATON/Y14HxQANKvE5ipKLZi4R7OuBXK3y0bvqB8EsnkQ2E5V7mP1tz5IAHJ2JU4ak5A2JZcIfNmTjkKvNgBu44fS+wkZCLnGVtGeAACOeHSDfm7tVy78nPu3YmapjsmWxSPdyy9/L72p6w++wrX7AmVqA45uI0T30w6SRTIsZA9XaCNea619rnXuu9f64N4bo3xsdam8Ifrc2FtLdXhl8GZUyZsaTttrUao9u6izJnZaAOg6g7IBDt5JPxNcAlwISnIAGtNZa21jrXWet9YG0NkbY2Juc5mzzxby2tAC9OkL3Ltc/Li5lJL9O+wZet1jqdz6ok+5sGkXc01ijQO0fA4YN9+ijE4EjSfMFm6u2Y85cp+Hhr1M7k0+Ompua9N81nVGozgsTNYWvkl5zfxavVqpTF+thfwV/FczZy47nNWeaTwmvt3K/ODvXWFkdbit7ZvQbpvvM6ItNPT4ugvcWimrsS+ZtlDftVN91UiO7SKj1IRPWapZqz1nWp2U6u93JjmMfYtl3LVyxe3PuTjxq/2rQGh9wXLGRchvRAEKo7Qxj9CwHtXqKAQ5dgAAH3YC/2MWdRP0gwgGgzwAMXwBgHYHcADwZAaCIj0DEFUH6AgDEBICgHYHf04HYG0EAzUAQPYAV3B1PVkBoMMXIOQI4FQOXgGAwKwPgBwLwIILCCIJINIDIMQMoIwGoNDBEPgMQIYJ3F0DQJYLuTYLgA4Kmy4OiGINIPlAELByENoNkDEKQK+UYKkOYLgFYMkGwNwMUMIJUL4LUIoI0OENoJ0IkKYPQNkJMPYLMPwIsN4P4JsMV1PROVa1Yw0kTHR0IJ+3v1lytGvHlw0JfzEzf24M/xgG/1/ySMzEAJALAKSIgOPzQFPxACgxgxAAcL0MkOkKMJcOkQUI8O4MsO8MELsNEPoJKKcJkMwNcPkPcKUJ4NUPIPqK0LoPEOaIMOcLaMqM6M8J6PUN8P6OKJQOGNaLkKqK6NqOsL6JEO0KaLmLKOMLGM4ImKsN6NsP8ITECKmhCO4LCLxznCiNGRzGgGin9w4BiHYCHkpwyFIQcgAHJ8lPiKACR0JPj19tBfiCQgtERPjd4QTJhfFUAVV2BPiTVfi9oETdtPjmE/jJhqVYSvjBk0Td1/Arh/APjx5viYcoTLAASB0ylySFAwTRUITTwaT5AYTRkCQsTgA4TPi10kScS0k8TWSMhCSwBRguA4Be4+FmgRDHjA9ZEXjgN/UwMX1DBXQDYYgMT5BasBBPjtdac9cGdDdmcTc2dzdptudDh5trdgT1TiCYcvsuhATU8fAoTaCNT1cpBtTqcdc6d9dGcjcWdTd2dJtTTZtzTedltPiBThhfRaCb80BT1CDZAhR3VOAkBQAXRpQ4AQx64EBhhhggA"}
import { createConfig, http, useReadContract } from '@wagmi/vue'
import { mainnet, sepolia } from 'wagmi/chains'

const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
// ---cut---
const abi = [
  {
    type: 'function',
    name: 'balanceOf',
    stateMutability: 'view',
    inputs: [{ name: 'account', type: 'address' }],
    outputs: [{ type: 'uint256' }],
  },
  {
    type: 'function',
    name: 'totalSupply',
    stateMutability: 'view',
    inputs: [],
    outputs: [{ name: 'supply', type: 'uint256' }],
  },
] as const

const result = useReadContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'balanceOf',
  // ^?


  args: ['0x6b175474e89094c44da98b954eedeac495271d0f'],
  // ^?
})

result.data
//     ^?
```

:::

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`readContract`](/core/api/actions/readContract)

---

---
url: /react/api/hooks/useReadContracts.md
description: Hook for calling multiple read methods on a contract.
---

# useReadContracts

Hook for calling multiple read methods on a contract.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContracts.md","from":394,"to":435}<fsm-vh3gqscxm4e>
import { useReadContracts } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContracts.md","from":484,"to":1203}<fsm-vh3gqscxm4e>
import { useReadContracts } from 'wagmi'

const wagmigotchiContract = {
  address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
  abi: wagmigotchiABI,
} as const
const mlootContract = {
  address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
  abi: mlootABI,
} as const

function App() {
  const result = useReadContracts({
    contracts: [
      {
        ...wagmigotchiContract,
        functionName: 'getAlive',
      },
      {
        ...wagmigotchiContract,
        functionName: 'getBoredom',
      },
      {
        ...mlootContract,
        functionName: 'getChest',
        args: [69],
      },
      {
        ...mlootContract,
        functionName: 'getWaist',
        args: [69],
      },
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContracts.md","from":1275,"to":1331}<fsm-vh3gqscxm4e>
import { type UseReadContractsParameters } from 'wagmi'
```

### contracts

`readonly Contract[]`

Set of contracts to call.

#### abi

`Abi | undefined`

The contract's ABI. Check out the [TypeScript docs](/react/typescript#const-assert-abis-typed-data) for how to set up ABIs for maximum type inference and safety.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContracts.md","from":1627,"to":1937}<fsm-vh3gqscxm4e>
import { useReadContracts } from 'wagmi'

function App() {
  const result = useReadContracts({
    contracts: [
      {
        address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
        abi: mlootABI, // [!code hl]
        functionName: 'getChest',
        args: [69],
      },
      // ...
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

#### address

`Address | undefined`

The contract's address.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContracts.md","from":2084,"to":2395}<fsm-vh3gqscxm4e>
import { useReadContracts } from 'wagmi'

function App() {
  const result = useReadContracts({
    contracts: [
      {
        address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',  // [!code hl]
        abi: mlootABI,
        functionName: 'getChest',
        args: [69],
      },
      // ...
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

#### functionName

`string | undefined`

* Function to call on the contract.
* Inferred from [`abi`](#abi).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContracts.md","from":2589,"to":2899}<fsm-vh3gqscxm4e>
import { useReadContracts } from 'wagmi'

function App() {
  const result = useReadContracts({
    contracts: [
      {
        address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
        abi: mlootABI,
        functionName: 'getChest', // [!code hl]
        args: [69],
      },
      // ...
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

#### args

`readonly unknown[] | undefined`

* Arguments to pass when calling the contract.
* Inferred from [`abi`](#abi) and [`functionName`](#functionname).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContracts.md","from":3144,"to":3454}<fsm-vh3gqscxm4e>
import { useReadContracts } from 'wagmi'

function App() {
  const result = useReadContracts({
    contracts: [
      {
        address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
        abi: mlootABI,
        functionName: 'getChest',
        args: [69], // [!code hl]
      },
      // ...
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

#### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContracts.md","from":3639,"to":3969}<fsm-vh3gqscxm4e>
import { useReadContracts } from 'wagmi'

function App() {
  const result = useReadContracts({
    contracts: [
      {
        address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
        abi: mlootABI,
        functionName: 'getChest',
        args: [69],
        chainId: 1  // [!code hl]
      },
      // ...
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### allowFailure

`boolean`

Whether or not the Hook should throw if a call reverts. If set to `true` (default), and a call reverts, then `useReadContracts` will fail silently and its error will be logged in the results array. Defaults to `true`.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContracts.md","from":4303,"to":4637}<fsm-vh3gqscxm4e>
import { useReadContracts } from 'wagmi'

function App() {
  const result = useReadContracts({
    allowFailure: false, // [!code hl]
    contracts: [
      {
        address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
        abi: mlootABI,
        functionName: 'getChest',
        args: [69]
      },
      // ...
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### batchSize

`number`

The maximum size (in bytes) for each calldata chunk. Set to `0` to disable the size limit. Defaults to `1024`.

> Note: Some RPC Providers limit the amount of calldata (`data`) that can be sent in a single `eth_call` request. It is best to check with your RPC Provider to see if there are any calldata size limits to `eth_call` requests.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContracts.md","from":5087,"to":5417}<fsm-vh3gqscxm4e>
import { useReadContracts } from 'wagmi'

function App() {
  const result = useReadContracts({
    batchSize: 1024, // [!code hl]
    contracts: [
      {
        address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
        abi: mlootABI,
        functionName: 'getChest',
        args: [69]
      },
      // ...
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`number`

The block number to perform the read against.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContracts.md","from":5576,"to":5910}<fsm-vh3gqscxm4e>
import { useReadContracts } from 'wagmi'

function App() {
  const result = useReadContracts({
    blockNumber: 69420n, // [!code hl]
    contracts: [
      {
        address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
        abi: mlootABI,
        functionName: 'getChest',
        args: [69]
      },
      // ...
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to read against.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContracts.md","from":6109,"to":6440}<fsm-vh3gqscxm4e>
import { useReadContracts } from 'wagmi'

function App() {
  const result = useReadContracts({
    blockTag: 'safe', // [!code hl]
    contracts: [
      {
        address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
        abi: mlootABI,
        functionName: 'getChest',
        args: [69]
      },
      // ...
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContracts.md","from":6694,"to":7049}<fsm-vh3gqscxm4e>
import { useReadContracts } from 'wagmi'
import { config } from './config'

function App() {
  const result = useReadContracts({
    config, // [!code hl]
    contracts: [
      {
        address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
        abi: mlootABI,
        functionName: 'getChest',
        args: [69]
      },
      // ...
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### multicallAddress

`Address`

Address of multicall contract.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContracts.md","from":7199,"to":7576}<fsm-vh3gqscxm4e>
import { useReadContracts } from 'wagmi'

function App() {
  const result = useReadContracts({
    contracts: [
      {
        address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
        abi: mlootABI,
        functionName: 'getChest',
        args: [69]
      },
      // ...
    ],
    multicallAddress: '0xca11bde05977b3631167028862be2a173976ca11', // [!code hl]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReadContracts.md","from":7692,"to":7748}<fsm-vh3gqscxm4e>
import { type UseReadContractsReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`readContracts`](/core/api/actions/readContracts)

---

---
url: /react/api/hooks/useReconnect.md
description: Hook for reconnecting connectors.
---

# useReconnect

Hook for reconnecting [connectors](/core/api/connectors).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReconnect.md","from":532,"to":569}<fsm-vh3gqscxm4e>
import { useReconnect } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReconnect.md","from":618,"to":796}<fsm-vh3gqscxm4e>
import { useReconnect } from 'wagmi'
import { useEffect } from 'react'

function App() {
  const reconnect = useReconnect()
  useEffect(() => {
    reconnect.mutate()
  }, [])
}
```

:::

::: tip
When [`WagmiProvider['reconnectOnMount']`](/react/api/WagmiProvider#reconnectonmount) is `true`, `reconnect` is called automatically on mount.
:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReconnect.md","from":983,"to":1035}<fsm-vh3gqscxm4e>
import { type UseReconnectParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReconnect.md","from":1243,"to":1420}<fsm-vh3gqscxm4e>
import { useReconnect } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const reconnect = useReconnect({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReconnect.md","from":1539,"to":1591}<fsm-vh3gqscxm4e>
import { type UseReconnectReturnType } from 'wagmi'
```

### connectors [deprecated](/react/guides/migrate-from-v2-to-v3#removed-useconnect-connectors-usereconnect-connectors)

`readonly Connector[]`

Globally configured connectors via [`createConfig`](/react/api/createConfig#connectors).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useReconnect.md","from":1894,"to":2148}<fsm-vh3gqscxm4e>
import { useReconnect } from 'wagmi'
import { mainnet } from 'wagmi/chains'
import { useEffect } from 'react'

function App() {
  const reconnect = useReconnect()

  useEffect(() => {
    reconnect.mutate({ connectors: reconnect.connectors })
  }, [])
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`reconnect`](/core/api/actions/reconnect)

---

---
url: /solid/api/primitives/useReconnect.md
description: Primitive for reconnecting to previously connected connectors.
---

# useReconnect

Primitive for reconnecting to previously connected connectors.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useReconnect.md","from":469,"to":513}<fsm-vh3gqscxm4e>
import { useReconnect } from '@wagmi/solid'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useReconnect.md","from":562,"to":757}<fsm-vh3gqscxm4e>
import { useReconnect } from '@wagmi/solid'

function App() {
  const reconnect = useReconnect()
  
  return (
    <button onClick={() => reconnect.mutate()}>
      Reconnect
    </button>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useReconnect.md","from":829,"to":927}<fsm-vh3gqscxm4e>
import { useReconnect } from '@wagmi/solid'

useReconnect.Parameters
useReconnect.SolidParameters
```

Parameters are passed as a getter function to maintain Solid reactivity.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useReconnect.md","from":1012,"to":1073}<fsm-vh3gqscxm4e>
useReconnect(() => ({
  config,
  // mutation options...
}))
```

### config

`Config | undefined`

[`Config`](/solid/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/solid/api/WagmiProvider).

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useReconnect.md","from":1315,"to":1384}<fsm-vh3gqscxm4e>
import { useReconnect } from '@wagmi/solid'

useReconnect.ReturnType
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`reconnect`](/core/api/actions/reconnect)

---

---
url: /vue/api/composables/useReconnect.md
description: Composable for reconnecting connectors.
---

# useReconnect

Composable for reconnecting [connectors](/core/api/connectors).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReconnect.md","from":549,"to":591}<fsm-vh3gqscxm4e>
import { useReconnect } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReconnect.md","from":640,"to":805}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useReconnect } from '@wagmi/vue'
import { useEffect } from 'react'

const reconnect = useReconnect()

reconnect.mutate()
</script>
```

:::

::: tip
When [`WagmiPlugin['reconnectOnMount']`](/vue/api/WagmiPlugin#reconnectonmount) is `true`, `reconnect` is called automatically on mount.
:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReconnect.md","from":986,"to":1043}<fsm-vh3gqscxm4e>
import { type UseReconnectParameters } from '@wagmi/vue'
```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReconnect.md","from":1235,"to":1427}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useReconnect } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const reconnect = useReconnect({
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useReconnect.md","from":1544,"to":1601}<fsm-vh3gqscxm4e>
import { type UseReconnectReturnType } from '@wagmi/vue'
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`reconnect`](/core/api/actions/reconnect)

---

---
url: /react/api/hooks/useSendCalls.md
description: >-
  Hook that requests for the wallet to sign and broadcast a batch of calls
  (transactions) to the network.
---

# useSendCalls

Hook that requests for the wallet to sign and broadcast a batch of calls (transactions) to the network.

[Read more.](https://github.com/ethereum/EIPs/blob/815028dc634463e1716fc5ce44c019a6040f0bef/EIPS/eip-5792.md#wallet_sendcalls)

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSendCalls.md","from":661,"to":698}<fsm-vh3gqscxm4e>
import { useSendCalls } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSendCalls.md","from":747,"to":1292}<fsm-vh3gqscxm4e>
import { useSendCalls } from 'wagmi'
import { parseEther } from 'viem'

function App() {
  const sendCalls = useSendCalls()
  return (
    <button
      onClick={() =>
        sendCalls.mutate({
          calls: [
            {
              to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
              value: parseEther('1')
            },
            {
              data: '0xdeadbeef',
              to: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
            },
          ]
        })
      }
    >
      Send calls
    </button>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### Synchronous Usage

If you want to wait for the calls to be included in a block, you can use `useSendCallsSync`:

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSendCalls.md","from":1494,"to":2055}<fsm-vh3gqscxm4e>
import { useSendCallsSync } from 'wagmi'
import { parseEther } from 'viem'

function App() {
  const sendCallsSync = useSendCallsSync()
  return (
    <button
      onClick={() =>
        sendCallsSync.mutate({
          calls: [
            {
              to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
              value: parseEther('1')
            },
            {
              data: '0xdeadbeef',
              to: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
            },
          ]
        })
      }
    >
      Send calls
    </button>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSendCalls.md","from":2127,"to":2179}<fsm-vh3gqscxm4e>
import { type UseSendCallsParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSendCalls.md","from":2387,"to":2564}<fsm-vh3gqscxm4e>
import { useSendCalls } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const sendCalls = useSendCalls({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSendCalls.md","from":2683,"to":2735}<fsm-vh3gqscxm4e>
import { type UseSendCallsReturnType } from 'wagmi'
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`sendCalls`](/core/api/actions/sendCalls)

---

---
url: /react/api/hooks/useSendTransaction.md
description: 'Hook for creating, signing, and sending transactions to networks.'
---

# useSendTransaction

Hook for creating, signing, and sending transactions to networks.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSendTransaction.md","from":503,"to":546}<fsm-vh3gqscxm4e>
import { useSendTransaction } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSendTransaction.md","from":595,"to":979}<fsm-vh3gqscxm4e>
import { useSendTransaction } from 'wagmi'
import { parseEther } from 'viem'

function App() {
  const sendTransaction = useSendTransaction()
  return (
    <button
      onClick={() =>
        sendTransaction.mutate({
          to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
          value: parseEther('0.01'),
        })
      }
    >
      Send transaction
    </button>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### Synchronous Usage

If you want to wait for the transaction to be included in a block, you can use `useSendTransactionSync`:

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSendTransaction.md","from":1193,"to":1593}<fsm-vh3gqscxm4e>
import { useSendTransactionSync } from 'wagmi'
import { parseEther } from 'viem'

function App() {
  const sendTransactionSync = useSendTransactionSync()
  return (
    <button
      onClick={() =>
        sendTransactionSync.mutate({
          to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
          value: parseEther('0.01'),
        })
      }
    >
      Send transaction
    </button>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSendTransaction.md","from":1665,"to":1723}<fsm-vh3gqscxm4e>
import { type UseSendTransactionParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSendTransaction.md","from":1931,"to":2126}<fsm-vh3gqscxm4e>
import { useSendTransaction } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const sendTransaction = useSendTransaction({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSendTransaction.md","from":2245,"to":2303}<fsm-vh3gqscxm4e>
import { type UseSendTransactionReturnType } from 'wagmi'
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`sendTransaction`](/core/api/actions/sendTransaction)

---

---
url: /vue/api/composables/useSendTransaction.md
description: 'Composable for creating, signing, and sending transactions to networks.'
---

# useSendTransaction

Composable for creating, signing, and sending transactions to networks.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSendTransaction.md","from":520,"to":568}<fsm-vh3gqscxm4e>
import { useSendTransaction } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSendTransaction.md","from":617,"to":984}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSendTransaction } from '@wagmi/vue'
import { parseEther } from 'viem'

const sendTransaction = useSendTransaction()
</script>

<template>
  <button
    @click="sendTransaction.mutate({
      to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      value: parseEther('0.01')
    })"
  >
    Send transaction
  </button>
</template>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSendTransaction.md","from":1054,"to":1117}<fsm-vh3gqscxm4e>
import { type UseSendTransactionParameters } from '@wagmi/vue'
```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSendTransaction.md","from":1309,"to":1519}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSendTransaction } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const sendTransaction = useSendTransaction({
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSendTransaction.md","from":1636,"to":1699}<fsm-vh3gqscxm4e>
import { type UseSendTransactionReturnType } from '@wagmi/vue'
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`sendTransaction`](/core/api/actions/sendTransaction)

---

---
url: /react/api/hooks/useShowCallsStatus.md
description: Action to request for the wallet to show information about a call batch
---

# useShowCallsStatus

Action to request for the wallet to show information about a call batch that was sent via `useSendCalls`.

[Read more.](https://github.com/ethereum/EIPs/blob/1663ea2e7a683285f977eda51c32cec86553f585/EIPS/eip-5792.md#wallet_showcallsstatus)

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useShowCallsStatus.md","from":686,"to":729}<fsm-vh3gqscxm4e>
import { useShowCallsStatus } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useShowCallsStatus.md","from":778,"to":1102}<fsm-vh3gqscxm4e>
import { useShowCallsStatus } from 'wagmi'
import { parseEther } from 'viem'

function App() {
  const showCallsStatus = useShowCallsStatus()
  return (
    <button
      onClick={() =>
        showCallsStatus.mutate({
          id: '0x1234567890abcdef',
        })
      }
    >
      Show calls status
    </button>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useShowCallsStatus.md","from":1174,"to":1232}<fsm-vh3gqscxm4e>
import { type UseShowCallsStatusParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useShowCallsStatus.md","from":1440,"to":1635}<fsm-vh3gqscxm4e>
import { useShowCallsStatus } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const showCallsStatus = useShowCallsStatus({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useShowCallsStatus.md","from":1754,"to":1812}<fsm-vh3gqscxm4e>
import { type UseShowCallsStatusReturnType } from 'wagmi'
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`showCallsStatus`](/core/api/actions/showCallsStatus)

---

---
url: /react/api/hooks/useSignMessage.md
description: Hook for signing messages.
---

# useSignMessage

Hook for signing messages.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSignMessage.md","from":393,"to":432}<fsm-vh3gqscxm4e>
import { useSignMessage } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSignMessage.md","from":481,"to":703}<fsm-vh3gqscxm4e>
import { useSignMessage } from 'wagmi'

function App() {
  const signMessage = useSignMessage()
  return (
    <button onClick={() => signMessage.mutate({ message: 'hello world' })}>
      Sign message
    </button>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSignMessage.md","from":775,"to":829}<fsm-vh3gqscxm4e>
import { type UseSignMessageParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSignMessage.md","from":1037,"to":1220}<fsm-vh3gqscxm4e>
import { useSignMessage } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const signMessage = useSignMessage({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSignMessage.md","from":1339,"to":1393}<fsm-vh3gqscxm4e>
import { type UseSignMessageReturnType } from 'wagmi'
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`signMessage`](/core/api/actions/signMessage)

---

---
url: /vue/api/composables/useSignMessage.md
description: Composable for signing messages.
---

# useSignMessage

Composable for signing messages.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSignMessage.md","from":410,"to":454}<fsm-vh3gqscxm4e>
import { useSignMessage } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSignMessage.md","from":503,"to":740}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSignMessage } from '@wagmi/vue'

const signMessage = useSignMessage()
</script>

<template>
  <button @click="signMessage.mutate({ message: 'hello world' })">
    Sign message
  </button>
</template>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSignMessage.md","from":810,"to":869}<fsm-vh3gqscxm4e>
import { type UseSignMessageParameters } from '@wagmi/vue'
```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSignMessage.md","from":1061,"to":1258}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSignMessage } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const signMessage = useSignMessage({
  config // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSignMessage.md","from":1375,"to":1434}<fsm-vh3gqscxm4e>
import { type UseSignMessageReturnType } from '@wagmi/vue'
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`signMessage`](/core/api/actions/signMessage)

---

---
url: /react/api/hooks/useSignTransaction.md
description: Hook for signing transactions.
---

# useSignTransaction

Hook for signing transactions.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSignTransaction.md","from":433,"to":476}<fsm-vh3gqscxm4e>
import { useSignTransaction } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSignTransaction.md","from":525,"to":909}<fsm-vh3gqscxm4e>
import { useSignTransaction } from 'wagmi'
import { parseEther } from 'viem'

function App() {
  const signTransaction = useSignTransaction()
  return (
    <button
      onClick={() =>
        signTransaction.mutate({
          to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
          value: parseEther('0.01'),
        })
      }
    >
      Sign transaction
    </button>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSignTransaction.md","from":981,"to":1039}<fsm-vh3gqscxm4e>
import { type UseSignTransactionParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSignTransaction.md","from":1247,"to":1442}<fsm-vh3gqscxm4e>
import { useSignTransaction } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const signTransaction = useSignTransaction({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSignTransaction.md","from":1561,"to":1619}<fsm-vh3gqscxm4e>
import { type UseSignTransactionReturnType } from 'wagmi'
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`signTransaction`](/core/api/actions/signTransaction)

---

---
url: /vue/api/composables/useSignTransaction.md
description: 'Composable for creating, and signing transactions to networks.'
---

# useSignTransaction

Composable for signing transactions.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSignTransaction.md","from":476,"to":524}<fsm-vh3gqscxm4e>
import { useSignTransaction } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSignTransaction.md","from":574,"to":941}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSignTransaction } from '@wagmi/vue'
import { parseEther } from 'viem'

const signTransaction = useSignTransaction()
</script>

<template>
  <button
    @click="signTransaction.mutate({
      to: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      value: parseEther('0.01')
    })"
  >
    Sign transaction
  </button>
</template>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSignTransaction.md","from":1012,"to":1075}<fsm-vh3gqscxm4e>
import { type UseSignTransactionParameters } from '@wagmi/vue'
```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSignTransaction.md","from":1268,"to":1478}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSignTransaction } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const signTransaction = useSignTransaction({
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSignTransaction.md","from":1596,"to":1659}<fsm-vh3gqscxm4e>
import { type UseSignTransactionReturnType } from '@wagmi/vue'
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`signTransaction`](/core/api/actions/signTransaction)

---

---
url: /react/api/hooks/useSignTypedData.md
description: >-
  Hook for signing typed data and calculating an Ethereum-specific EIP-712
  signature.
---

# useSignTypedData

Hook for signing typed data and calculating an Ethereum-specific [EIP-712](https://eips.ethereum.org/EIPS/eip-712) signature.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSignTypedData.md","from":565,"to":606}<fsm-vh3gqscxm4e>
import { useSignTypedData } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSignTypedData.md","from":655,"to":1605}<fsm-vh3gqscxm4e>
import { useSignTypedData } from 'wagmi'

function App() {
  const signTypedData = useSignTypedData()
  return (
    <button
      onClick={() =>
        signTypedData.mutate({
          types: {
            Person: [
              { name: 'name', type: 'string' },
              { name: 'wallet', type: 'address' },
            ],
            Mail: [
              { name: 'from', type: 'Person' },
              { name: 'to', type: 'Person' },
              { name: 'contents', type: 'string' },
            ],
          },
          primaryType: 'Mail',
          message: {
            from: {
              name: 'Cow',
              wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
            },
            to: {
              name: 'Bob',
              wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
            },
            contents: 'Hello, Bob!',
          },
        })
      }
    >
      Sign message
    </button>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSignTypedData.md","from":1677,"to":1733}<fsm-vh3gqscxm4e>
import { type UseSignTypedDataParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSignTypedData.md","from":1941,"to":2130}<fsm-vh3gqscxm4e>
import { useSignTypedData } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const signTypedData = useSignTypedData({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSignTypedData.md","from":2249,"to":2305}<fsm-vh3gqscxm4e>
import { type UseSignTypedDataReturnType } from 'wagmi'
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## Type Inference

With [`types`](/core/api/actions/signTypedData#types) setup correctly, TypeScript will infer the correct types for [`domain`](/core/api/actions/signTypedData#domain), [`message`](/core/api/actions/signTypedData#message), and [`primaryType`](/core/api/actions/signTypedData#primarytype). See the Wagmi [TypeScript docs](/react/typescript) for more information.

::: code-group

```ts twoslash [Inline]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSignTypedData.md","from":2774,"to":8051}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"d2bde2039b22db2dad4de0b0b1a903198c36d1f3885f32042523a928c54eac6c","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BjCMONAAjgEsBzMAFWwwoAEQCGaMYnYBVODADKvAUNESxAJRhoArqRU4APDrABrSAHcwAPkog2Y0g0QA2KgBsYYHmnxIAjADMVJKkPNp43HyCOGqSdu5cYLiIAAxUjPiOYow05K4AvhToQniEJOQhdM4gABRiiWJwAJTsOvJK0ariksZmlja1WNkAttpkcAD80sAAOmDsi+zMYABmvNPsAMIs6zzsAD5tYLDryVAA3PNL7CM6kmhcLJtzCzdLLACy9xIwm7W1IiOLhiABGnjgM2u7xhmBwkPYrxhyKWyFo0jYpCSPAAutJSDAxFAWO4MOwYsIemIAAqjcakZA4q5vFEwtHSAAGmOxyAAJMBud4CjiOXjjqcksJmazkez2BzViZck8wHyBWgsUKRWKTBLztKZe85RyiVACXA4GrBTxhaLpLqYGcpdDDaj0fLQRAIO4rRrsbadSdHZLLi7XexjaCMDRLfzrQH7UGnaGWeHI9H4P5fZqbdrE3rnanXemYwAmbP+vPi4P6sPF90cqMxwIVrV26vJg3hiMNpvwAAsrdz7YdnbrhpL8AArEOEx2Q12072M3AXLOq6OF+OZZO4AB2dcjpNbosT5cxgAch8DBZT3cWu4AnNf8zXC/ee5y+3B/KkX/Pa1PHdz0zLM4z9NsbzfO9713fxy3AnM503QCPzgltEMrI9b0XesvxXfxB0wyDXzHIDWTgmdiOHKCyLQkCfzXajkOPVDYIY/wD2YjdWPfdj8Jjfwr247DoNws8BMzZ8RNok96MkuBSz/GTSLk/iPRXUswPVJCeJw7cKIY0sEJ0rDZLY7td1LDDTJIgC+MsoyiNsmjVIspcFNLKiXJY/TyJRKymJ8vSxIMgKjK44LRLo9TG004SovMhyPI0stpMStzkrw1L4ECZSMvsmDHIUwJtPjEKYuKnK4ECEzyuitSqo5JI0H/FCsok+UWoS+qkqKlLmrANB/CC3rMv67LBrQUtnLGwrxOAzkWtqtreImzqpv7fK5va9bFq6ob+x6iDXPmsLZQbFqp1Gk7fNC/yLqWoaXFm26KsagaWr3Oq3oa9zJu67bfr6hbDKetAL2O3S/o6/apsfG7oZB862Uuobf1epHxtB8Lwf8eDVr8+SDuGpTCfu4mpvgqGzOxlGjTR4bAkR2mzoe1G8f7THWd2nHHpJ/wpx+rG2cplqRqBkXefpm5jXFlwabs6X2YZvG9xZpW1r5jmBYvbnNaJ2LxcfYWea1mW3XBpTJbNw2mpapTFdO5WxaGrSNed82VdlxnjP1z27c+t2VpU0WjbdrbycqoPpqOqOPoBt3rvj/6Np0FqU9hsH5XToanbu6PJtz4aPYLhO04d/2y9TuHi5DgqXdi4vI9Dxumub/P3pr7OOWL5PW69yni5ezO9p74vvtH7XVZzwGp4th8G2LyH5+9y3Z6GhHV6H8XUirrus9xjfhoJgfA6L8WybPimm8vzuYbHo/e/F5nt9v9Gubf9vxaFr+BuLiWap2AADpQHzC4CMLAEAnBtA6MoCkcQxB2GJIwBAiACBoDQFgSEAB6HBFgxA8BGFwYBcB8A4IJDkNAOCxBYC4DgwgEBTBwBwe0RQ8DujqDsA4JwSBjIeC8D4PwiARohEcOEGobDOgGEpFwjwkokDpBAJkbIuQyB8NLEUEoOAyjEHUVUegTAWBsE4Bw2IVJpByHYV0cx6gtC6H0BSPo5gIBWFsFQHhzh+ylgEd4XwARgjUHEREdBUQZGIISAoxAPjlFZFIFQ9RaQtHUFKOg8o+jqDVDwEMUgEAcBOAwK0O4DwYDSEMEiJYlDiRgFJOwakEwWD4kJNU2pqADJVJJGSMAYgxjSFmOAHpMB+mgw6TUskcJSnsH6daYZYYiiInac0zp7Bum9KmSAAh7hPBoFmeRUZtSJl9JAKac0cBdk3GFIufZZJPhiC4O4JpRJlltL2UssZKzBlHNWLkkY5zkTXPYIc9Z9TSBwBYH8xY8yKkwgBasyZ/S0AQAhe8AFQL+kgrBWAZFULFlPPeXCo5KwaBDTOSAEZbyDlCCOTMslcymTzHmf0259z+nWEBMCMEEIoSpgmQiaFKKKVkgxY09gAKXmulhZ89ZcLkUolRVS9ZNLQY4pVpKtZ/TNnbNlf8wVgKFX9JOfAUlyr6WvLxbU5lDzRW6vFYaNV8KQDfIgL82lqrdVopAMKrFrqUQqolbqgl6zEXaphe6/VnqGneuVRQBZbrzVdKlf0olXg0DGvpvKnA1KTohvYJcuZi5QHAPYP2W40CYAgNAYuFYyRcjQM2DsMANbEWkEOGzeZeTHjGM2N8EpAB5LAnbWCGELdYVtu1WgAF5R1EAgFwKA3DQjOGur4oRSA3BBLCCEkAxTfiROSHwjIcSEn5EIskiZuiKh2BoIY9BOS8lkEwK0Xl3KbgAq9Y8lpZJbWhvjR89VAyxg5ozQ6pVcyY38tfQGxNGyGhap9Tq39HrDUWmxaayDv7LUfueRBypUH/1OpdeSxD4avXYvA7iz9f6HXBvgz+yjHrSO0dzeRs1lHA1JpYMS1NQGw2ZsVdmpjeawAFAXY4ZwLg9wrv8YgKcYjN01F5XulIgSVHxLUfkTRxQUk6LSXoyomSb11CwLk/Jj66mRqw+8791rf3sYA0MpjwGs05l2X63DtnoOau0Mipz6zkNpuEziUTvDEAXiUZ4Pxwj12hAkXgL1SmkD9kPaovIiWz2pIIHpq9WTb3GfvQU1odmZUgGC84R8F4pPCKSxu2L6C4UJZk8ltTqXQvpZ05ly9Biah3tM4UvVfHpkCdKwEeClXEtydq9p3A8j92NdiSlxJxk2spA6xk693W8u9cK552D3mSseMXQEirIAIursQNVmLW76szZSOu1Tx6kAXmWxetbOWjMmYfX1pDUAzRGv6cNkRU5qunekxd4JCnSg3bXU1h70T+zPd051gzG2PsFfYJhmzlHrP2q+T8nzvGHWMeZG5xYOOg1IscwTo5ROGUsfQ2x6DyaSX4+IwN+wAnidBYO2JgIesxvnYm1uy1DXjv3fU2lrT57EevcMz1z7238N4/2+znn0TUjhcEaDwXNRrsnaiY+GH4vWuS4y+k/T63smbfl/1wnkb/vc5C1pYHmuqva7wOeqHiADfzea4tzT2iVtm+y7Lq3aO7M0YBzNDXkXxs1au4Mhrv5Dctaeyb9rQeuuW9R2ZhjdvleeL4ULfnYP5Pu8h3r2bSefew6Ugj1b5u3ty7D4zzjKbSWR73MdkHru4864T57/GyfEmp4Dy9hvIfs9ffDTSyPCNi9u/QR7ivKRB/V6N6WFwdeM/I6z/lszxmIGOAwBSanefW1Mrue4e3KuQu1S7y7kbC+QAH5GEfikifqti5a/7qbeAACOOgZAGAweKOe+fWL+b+JGZ+RwF+LK+eh2iAd+/Oq+l2NQEBpAx+5eiQlen+R66+W+WWmeuWk+RSRqhCky/KBGL6yIga1ooMXmaAnIqQtAzEHIi4BQi4iK1BMItBJ09Bu2jB8ozBrB7BVareJKGIfBDKAOgQU4gS3eSAkmveeAYwFo5BieShX+i2deABQBIBu+W2twZB4Q3B7AVBsaKIvBOY/BWy2gTBLBPkbB+aYYXBFhNBUqdBBkDB9hIhzhqYTOqakh1h0hDuzgsh8hD+iAShqBKhxh02y+AQmheB3+BBSOFuxBYBrQ5h/KVh2Ii43hQhDh8YThwmMhYW8+yh6CBGDWeUQ++Q8OaegehBO+GRhhuR3gMhj4zuMeAulR9mNR/gdRa6qRMuoBhhBRHIwhjhAO/YQQ/O0W4OeADBNRMSWh+Qm+jRY++hrR1urhORHhUhqYExUxxRxOMxne/OMSMRi+EANRuBC29RIx4+Yx1u7RPAMxj40eZ2Jek2uu2Bymsma+LWGxo+0uzxBh1uxxRRt0HIAOU4qQ3uChrgT+yxnuzMQxhQmxYJ2x72mRyw4hgRnAJ0cJe43RZ2x21xyiBJCAaJouyRiS8OOIGQ0AK2KwJiYSCCVI7AE6sC1i4SVItQzQ8w8wHJnCkgwCO6NAtQFSz6bhiw76EY44wAVG0gAA5HCqqTGkCqqdaKqcxkqSqewKqQwZqTbmqf5nqUUGGEyWGBjsgAaYGqqQRqadqV6paRQA6VKqqYii6QqqqW6fqaeMqY6QEXAL6XxjqSdO6daR6W8FaW8OgZgRGZapqcKVim8KoXAOQdymmbmemXmXmTcNkeOI6TsBYKmaeAUaqcwVsCIKWGIIEFAI+AAGKPiBAXgACiQQtZXRe4HZjAqQU4AAgqCFsHuM2R2XuIEP2CIKsBeCICIBeBvhWRcrGTcHsSWV6QAEIQCggrnvBVnMGghbnHlblnmginknkXlXlXnXknm3nHmPmnnHn7mQprlLChlqkAASMAWyEAMaO5oIAAhPufGQUM0HYGMPEIgKANUF4NwCwO7ggAUAUEAA=="}
import { useSignTypedData } from 'wagmi'
// ---cut---
const signTypedData = useSignTypedData()

signTypedData.mutate({
  types: {
    Person: [
      { name: 'name', type: 'string' },
      { name: 'wallet', type: 'address' },
    ],
    Mail: [
      { name: 'from', type: 'Person' },
      { name: 'to', type: 'Person' },
      { name: 'contents', type: 'string' },
    ],
  },
  primaryType: 'Mail',
  // ^?


  message: {
  // ^?












    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
})
```

```ts twoslash [Const-Asserted]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSignTypedData.md","from":8087,"to":13727}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"8427c5e54a9e414e6af6101fcf5a4a859fe80517a66aac11a86d69f45d4b46b5","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BjCMONAAkxzkXeAB0w7Ye1IwAhlBYAbDOwAKZOC15jJMuakEidoiVLCz2YcQFsYvfuDMwrAbm27hag0a4X2VtqQCWYAOb2jsIAvhR8wbouGsY2liAA7uLS0jBoQUJOeuqGcu7xklBicHAZOiEAug6ZzvoxALLiPtKqdbnsWjVRbUYm5vEAZqQQpmVZ0e35niCKpMpgY6HhAl06E71x02gQi905btgeVrPzu2ERqyLrcn1HIMxgNI+lINVZ2a55h/HefoGvkUq1RClBAbHEpAYiAAbFRUgE0PgkABWKhoCH+NJ4dwIOF+XCIAAMVEY+Ah4kYNHIMLC6EOeEIJHIaLoUJAAAosMMcJCMABKBRKFQfGKdNY9G6bKy3XbXTjfaa/AIZc4rcX7SX9aZJFJpWUS+U4ApQIrwF7Aiqg8GQpAARgAHHCYAikTC0RisYgZkKwKDpPi7SSyaQKVSkAAmWnUelexlkUE0eh4TncsiYAW3eIykBW9E2xAAZgALE6XUgS9QPWzbn6A4hw0HyZT4zSKHScAziPGWUmvSmIDz04a7kr/rmIVCi46QPD/Ijy+7SJi2e5a2ACQ37sHQy3w4So6vY13mdRWcmuQO0/zYlqrDrUukc1RrVCAOyb2fzxAVvPLvA1vF1yQAtGxDZtqWhA8YwIY8EzPPsL0Ha8pisQpihecd83tadP1dH8q2xelAIJECtybMN60jNtow7I8mTg3sOUQq8BUaZpWg1Do1SuA1M2mIYRn1TiUO9OYWBVZZIjlPirG2ITPmHeITnEgEwFVKTeKle4WCeNBzQ04SFS8NBfGVVTKkwqFbVtCtcIXSsl09EA2OkNcCVRMiwIoqj2wJGD6J7Nl+yQjMtIE0YnzBPMrPDHDnTnPDFz/L0AJnOtYU8ncIKg2j/O7U9GOCljFOmZSFkil87SLD94q/fDHJXIi0qAt1MvAiN92ow88pPRMguY3lQtvagdgq6K7WhDK7O/JKnNS/0WtfUCsqQSCuuguNevgpjU0Gkrjh9KxLLtV84rLGaHOSmjcGIpAlraiiHRyvzNoY/rdqHGTtMeZ09KO59xvrQkavO+qrvmutp1JciWzW3zOwCgr3svPaRNHf6oonCM91LBL7N/JzV1uxAoe3dr6yLZ6EfyvrCJwdgHjYdgAF4LnVBSyo4hSxXGTThuzN5ecMo1FRMv4zkky5ak4r77z1VT3jlES0LNM4qgMhSXK50VuKcaSwuGCLBb1g0RLKiW2aFhSvrkhWrZiM3DrtpZLZNmWtIeXT9KlkVJiMqLTP+Y32CBQQQQBrGKbOvHEA8gm2UZhhidtYkHpbZEqbomntsT9g4B8fwwAAFUOKAABFxHRXgAFU4BgABlAvi9Liv0QAJTSABXUhm5wAAeTuwAAa0gBIwAAPmO+toVtXGv1tUj47wfPC5LnBy8r8Q3LtTdoa82HM56t7k2SHxxDgAVO7rxvV5bzeB+H0eJ85clzCpOAAH5eF1hmWAGAuv7sAAMJ/wLuwAAPuwQesB/7rigMHUwnd0RoB8CwQBP8dAsHqEgyuMBAHsnZEQCEZ8ABGqQeCu3eMOChGCqHCGQLQXgo4Kja3aGvGAG90TyFfmkMgyB1Y+3eAw3gAADUcyAAAkwBRyVBESwqBYAYH4ngZEOh9DGHsBEQMQelJUFgEkdIsWARZHyOgTAWBHDg5qI6BokRKsSgGJkRUORvAzEWJUYIrIwjNEkIgBAaQjijH+BMa4xR5jlFWLUd4kRJCMA0DgIEwOISFFKLgZEuh0TYnxPDIkv4yS3ERNUVE2xWT4AFlycY5xpiwnuPSVQzJcT4C2gqcEqpoTUmWKKRkkpjS4BFhafkmphTPFOAafE5EAy2kpPCWkrp9SenxOhJMlx0zalzKEQs+Ar5lnVI6R46xOgxnwHtDs9pMzOkjN0EcuAABOU5qzhkHJENclO9yCmzMuYczZcBrJvKGR8p56jRGlJ+TkqRTiVnvIuYCmxwLekLz+XsupGy4XxJsoi85+zAUvImeCoJgykXrK8d820Sy8VJKmVCrFTyXnbPJXkyl/zoXYpJSc+llTIVMupQcl5dz2WtM5YSz5zzvl7gxWs4VQKfG9PDM0/lBLMXIuJai+A4YwWGIpYKxVRLRmivKfKxlQqYXXPDP0g1WqJXGtFbijVDKLWPJZSquA4YyW2o5bs7VkrYXSuyXSt1AqPWWsdT61VbL/UKqDTS0VfLw2Gs9Vap1BZCTiodVGxNcrY32oBcGmJvSCzqohYG1NPLbF+DQCm7NabNFlrDYWs5kaS2iLLaSitzKq0iLLaa1t3LrHRLLfm7tSrdVNseEWZN5qi2VsbdW0dtb8Vxobb20tjxkSurrQ8qdS6R1oGhGazNk623To7Y8d8g6dVXOXWge047931uLVumdV652aoPT24p26blrvnVmw9D7j1oBTnu9dVKh0Xu3dZAt37X2ga+eBsVE672bvfY+20sUz1er7Y8BeX6X2Id/ch/9NkgNQbw2+7p4HkSQdwxu/D5GUPQhvcBrlMGRXgehM+u10Hz2wZQ6+HDnHSMsalYR+0xHqMge46xlDNyqMCZo2R+Z269yMZI/JoT3r/17g4+6wTknhOdpbQhtTemNOdq7UZiTGHL3hgHRZ5jJnMNoFNSp8T9mrNKanOhhNj7wyrq8zmzuZb/PtsC48bTAbdPuc0aFgD/GdPGaiyImL5nb0Je80l/tsn4uWfSzFsdwWj15fCxG+9BGYt+bs0agLZbd0Fb/TF09lX43VbCy5uTOWWtPrq2Vstn7ut0Yy1hwkYn2tudy821D/XFPRebfB1LHWQuzeKwu0rA2YvYamyimbWGiwjey2NzrtpKObeVdt2LN72AADpruCB8KYLAEBIRQOvk3dhnCt5UCkIwBAsY0BoCwDwAA9IDpI/hTA+Eu3AfAgO1CUkB+ILAPhAeEAgEPOAgOr4N1e3fdEU9wyvnutNUls02SY5vr3DhrcPvNQJKh5a5M1WH1eoFJgLAmYrwp+9muL3b7rypx3NA3cKcPxHhAMek8I75nDDcwntVXQLxJ8vbHfPN7b0QDZenFFOrwyzltQqA0hyIOQR4PuP85Sc19kYHmbtrZaQFnMpW/t0bOxDpLRWfM7hy0fHUx3ItUImnQmrYOcotaW80LQ6WtvhrhV2OzB2/tzYu/Uj7fWw1bY+9Ngnp2wdk/u/dsNT2v1vZ54UmjIJQew7hCsC5Kw49CHEPEGQ+A39Ig4hbyng0Fu5TW6oanu49vLm+5HOXl35Q3dqL7/EL3sf7Z+z9yAexxesihw75xUP3eI97Cj3cGPo/Z8HHn4nupueJ8e/iOn89Q+lLZ7mSfuhk/piF+eDPm38f5/O+PwI8owdruXfYEWdgUwR7GAK7a7YOB4dcSkR7QBEBMASA7YUgCBBLc4AcFBNnQBbBY3AAeSwDQNYD7l/3HiQKpQFGZiIKIAgB8CgCngLGsjnldAyiXi9CN1wTVw1zTmpBsiZ1ghZwQg+mQkOBoQ1hiC7wNB7zj3aC+gHxLzf2H0Dgtk3wfzvGSAfBfzD32gXwD1ViTy/x4jXyaBaHUPEL0O30GENjUKv1Khvy6Dvy3xiBtlGgz2FjuCP0BHH1f0kI9h0iLwsMz3fxHxzwEXDkxnzHzRBhjjjgIi9BxDYI8j3hWnrG4MRlpj4JRiHC5DuwhAwHYWvzEnKiQOrwMIxkqkLFoPoLtFnkuicgyNMCyPYTYIyniIZ0PgAEdO4yAMBj5UiQp2Aai6is88irACjnIiixpI4CwyiZw5cKjFcvQ+jSBsimoFpadGiyZvIkjs59d+CBRzAShxBMR28dBwpDisg+JRw6kvdRFCRaB5UREc9g5tgTinAzigkLiVC0gribjw07jARwDvDngmFXiw4aDV1yjEB7omCQBdi4B9iboac7QblNddxWj2iFiuido0jrxoTYSnj2BjjKEdAXjA43jdQ0BPjbj7jW8IBcTCTNhzi5lLjNFriKTfjIgn89JATiTgTJcoQCxQSpjzoISoioSzRYS2DESOCIwNi9dkYej8Sf4iS/hg5GSRFmTvjgQaD7RSJpowYnJwo1d80kTqRKZ1pcpmckZzxtibwPBRwaCZcwTdTqwbADTSImiKI4ZrpqYZTLTMSBQVS1SZEREp4ixicBSY5GDhSvcDSKw3SD5TSXoeCLTujipHjKFFSAhlT3iySmSvjAyNSeTyx7RKjppNxITtgDTViYZjTpT0Sio9p0z/BgybltTpiLpISIYWoCx7pYzsp4yvTayDdrx/Tcz8UgyCzY46cwyvwIyGo8AoziYCxSYqzVoazeCMSej2SKFbTxzkQCcwTpxITNy1cx0jTyxKgSRoA/Jc4cQWZLYLdkBIhgBrTeAAByW4F88IKYF80cF813R8589gF8r3D8kqF8xfX8sIRwCoCgRwUPB8roJ8viF88KECr8sqCCmChCgCl87YVChUF89Cv8rCpCzcvCkWb8oJDCqCzCkIdgc+X+VgdIBYMAXODnN7KnW8snZXSnTedkPkQQQQNinHcQS7FgmgdkbiHETC4QeYxY8ilyD8gS5i4QbEg4i4JSjS5izSzSo4w2Gk7CkBBIRSy4Rkl864oBMucMcQAsKAG5AAMWbPtAAFEF4LKbkixXwnLGBCRkQABBEhIBV8Oypy18YsMuAYe0MuMue0F1YysfKk/SpCgAIQgBITit0FMuuJISSuyqSrypIVypyoKqKqKuKpytKuysqtyuyvSqWDZP+I5MAoAAkYAUgIBwgUqSEABCdKyCtSPkUEN+LeRAUAVkZ0fOFgbEBAEIEIIAA=="}
import { useSignTypedData } from 'wagmi'
// ---cut---
const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const

const signTypedData = useSignTypedData()

signTypedData.mutate({
  types,
  primaryType: 'Mail',
  // ^?


  message: {
  // ^?












    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
})
```

:::

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`signTypedData`](/core/api/actions/signTypedData)

---

---
url: /vue/api/composables/useSignTypedData.md
description: >-
  Composable for signing typed data and calculating an Ethereum-specific EIP-712
  signature.
---

# useSignTypedData

Composable for signing typed data and calculating an Ethereum-specific [EIP-712](https://eips.ethereum.org/EIPS/eip-712) signature.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSignTypedData.md","from":582,"to":628}<fsm-vh3gqscxm4e>
import { useSignTypedData } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSignTypedData.md","from":677,"to":1527}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSignTypedData } from '@wagmi/vue'

const signTypedData = useSignTypedData()
</script>

<template>
  <button
    @click="signTypedData.mutate({
      types: {
        Person: [
          { name: 'name', type: 'string' },
          { name: 'wallet', type: 'address' },
        ],
        Mail: [
          { name: 'from', type: 'Person' },
          { name: 'to', type: 'Person' },
          { name: 'contents', type: 'string' },
        ],
      },
      primaryType: 'Mail',
      message: {
        from: {
          name: 'Cow',
          wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
        },
        to: {
          name: 'Bob',
          wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
        },
        contents: 'Hello, Bob!',
      },
    })"
  >
    Sign message
  </button>
</template>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSignTypedData.md","from":1597,"to":1658}<fsm-vh3gqscxm4e>
import { type UseSignTypedDataParameters } from '@wagmi/vue'
```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSignTypedData.md","from":1850,"to":2054}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSignTypedData } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const signTypedData = useSignTypedData({
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSignTypedData.md","from":2171,"to":2232}<fsm-vh3gqscxm4e>
import { type UseSignTypedDataReturnType } from '@wagmi/vue'
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## Type Inference

With [`types`](/core/api/actions/signTypedData#types) setup correctly, TypeScript will infer the correct types for [`domain`](/core/api/actions/signTypedData#domain), [`message`](/core/api/actions/signTypedData#message), and [`primaryType`](/core/api/actions/signTypedData#primarytype). See the Wagmi [TypeScript docs](/vue/typescript) for more information.

::: code-group

```ts twoslash [Inline]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSignTypedData.md","from":2699,"to":8053}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"d347b35c1f3533593f8f8fd4f638678cdbe6746b6703290029ec262c44dffe62","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BjCMONAAjgEsBzMAFWwwoAEQCGaMYnYBVODADKvAUNESxAJRhoArqRU4APDrABrSAHcwAPkog2Y0g0QA2KgBsYYHmnxIAjADMVJKkPNp43HyCOGqSdu5cYLiIAAxUjPiOYow05K4AvhToQniEJOQhdM4gABRiiWJwAJTsOvJK0ariksZmlja1WNkAttpkcAD80sAAOmDsi+zMYABmvNPsAMIs6zzsAD5tYLDryVAA3PNL7CM6kmhcLJtyMACy9xJPYAAKo+OkOCGAAGqVoABJgGxSEkeAVgRR2J0DMIemIAKKkUgQUgxGCIuYLG5LTA4OAza7EqnIWjSaGwgC60lIMDEUBY7gw7DxcTEf1IYjGeWQDKuRKpNxp0mB9O8yEhsrhDOBTOOpySwjFEuJUvYwNWJly33lULQMO8BWVqpM6vOWu1S11wLZUBZcDgJsVlpV0htMDOmspDvYToARhAIO5PWbYd7rSd/RrLkGHWGMDQPQqYxarb6EwHk+LU7S9aH0/B/NHzUqfWrE3aU9q0xmAExV2O5usF+3B5vwQLtnO1v3dxsSvtwAAsg5r8dtgaLTZLwLLGYArDO43n54Xg4sJy5N52R0me8Xpav4AB2I/D/OnsfU5eXuAADlvc/rC73Ief5bgACcH7bl+u57hO/ipMBXYPou45/hm/iVlm1ZbjBDZwU+F7/v4bYoR2d47meS7YYhA74UOn6jphOoIRW04UbOIHUT+EEboxaEnhhrF0XA/iHhxx73tx4G8f4N6CYRoHEfBpEVu+klUbBPFyXxQGKcxymiapLZQRp6Hftppb/i2yGmqhQlEY+tE6Xh5kEUpIm9rxLbkfZlGaU557Ga2DHuUxBlgc5Onsf5nHCYZwU+fALYCWFlnSdZkouRJ8VSSxRkriZClpY5kXeVlrbqblnn5SR0VwIEeklYFMlYRVgRmV6CUZVFhX9nZzXpVpbVJGg0FcWVsl6n1OVdXlQUFX1/EDRFk3lcCfUtn542lfNw2LWAaCBJ12YBYN631ZtaCTtVq21UljrLn1k5jXt4VWTRyXSn1a5xedB11TZI1bS4K33S1PVTVtV67RZ3VeQto1nQDENDUdo13eDE1fc9P1oAB72wyjl37tdW2Qf9yNrajV0vQTuGzY9Kno7hMPExdT1k7TLZIw5JO47+5NoEEWMM59nNOtNk5E+zjM08d/hrmDYsC0zePc/x9Oy3NpMK7TLhsx54uZdNV58yr1O6wTr6i9rcsS9NAEy+bquC/jaC6crttG71W26Vr+12/LXPo6ZBsu4lPtC+7y1U0Hlvuzt4etcDjunTHQNQ+7t2J5DG1LW9afw99wI6H12eHbn+dbZ7D0R5lJc8wHXuuwVVdh/pFuV310dN97EtVwn7d1wtXdl4D6dHVXWc9xXbVV39hdq77ed9aD0/29KVevs7tfj/XiOL8Hy5V5j2+d9NqRm+vsd99NlNj2fG1V3TB8twTrP3xP02BDX5fX8Pwsnx/Sc39N0tn6bwJi4Nev8h7F2mprIB58Cb6xgf/E2P9B45zRnPAm1sEFf3dqkMBKCi5oIbqkAecMCHM3QY7GakJ2AADo6HzC4CMLAOIODtEUMoHkaI7DskYAgRABA0BoCwOSAA9CIiwYgeAjC4DQuA+ARFEB0DAERYgsBcBEcwJhEA4BiFDJ4OAIi2HIk4eoOwDgnBIBbC2DwXgfB+EQPxEIjhwg1CMRw7opiPAaiQOkEAmRsi5DIJYlsRQSg4DKMQIJVR6BMBYGwTg7jYhomkK8YxHjJBaF0PoPEfRzAQCsLYKg5jnCTmsSATw3hfABGCNQZxER+FRBRLyBI3jEBlP8QKQJ+RUihOoKUfh5QonUGqHgIY2IcBOAwK0O4DwYDSEMISG4LI2Qci5D8CYLBmSsnZGATkIZFkSmWTsvZYBBRzPYLMcAZzLlfSOas9gpJzmXMVDclMRR2AHKpHc3ZXJTljGkJciR7hPBoFeTRb5ezHkApAC6N0cAwU3EtGeCFXI3hiC4O4LZKyfn7Osii9gfynkgFWNiEYCLDnbPuVCi5IB1mAhYOSxY7zPnEnxYS6FaAICMtZZSnF1LLl0rgAykAZ5mV4t5Scs50KVg0C2vCkV4rsWQqENCl5CqixIvmO8y5aKMWXOsLUIgjguC6P0RSIsjzyQfMVcctZGywBYttbin2bKpU0sJdy7U+L+X2D2p6pYYqXUSt+W6wFDQQX+q+cGh5KqaWwvgPKr6mrwXRt1Zi9g+LUCc1df8mlJKIBkvVT+b1saBX2sjewQNxbo3sppZyitSzo0+sFcKpNBJs01tDX4lgsq0CJo7UqrkPq1VJtFG8s8dCaHsEnLcHEMBaF0LPCsZIuQcSbB2GAFdnLSCHEZu8iAWBHhxM2B8WZAB5Q93wgSTusLug6rQAC8t6iAQC4FAMxoRnBvRsZU+xbhalhHqSAGZEhcBeOSJYjIWROl5ACJOXpjyIkVDsDQGJ/CxkHrIJgVolrzWNsHewFtDqM3RqzSmgjtbLkeqLRSgjw6/U0aZe28jTrKMgCBRGxjPK6OlphVAV0CbuXJvw06tNjr7lka9Z23Nlz82FtuU23jRGhPMakxRrt9auMiapUp8tXGq20dY12mVXg+0VpLTgVVDHRVjrAAUD9jhnAuCvD+uxSA1xOMAzUS1LSIOIBqR0nIsG2kIf6QQSJlRhlobqFgcZWGpmEfteJnFkmlg5qJdR5FinLM0pHVq1TaXpNEo49oblFmiXxvdGCy0DmLGIFXq5qprhPMuLwER3zKRJxQYCcF+DxQ+nhIGRFlDIz0Oxcw5M1obHqO1ecABV8jX7FdYA61/hhKOvue6zBoJ9XQuDfC8h6JNQMMTOwzGnLzyGOzYCLhRbSBluhFWwNsD5TWkeb8dBoLO2rF7ZSAdoZqHjvjdOwltjJXQUgGuw4wIC3ym2Kaw9upNR1vgZSP+wLXSkCvl+0hgHo2Ytxcm+dir/G4WXKh1LZbFS3OIER15vAiHUdIHR59zHbS+thL+4MyLgPRnA/i60MTJGCOpcWOl6FcmyvZaJcp9VBmxdFY5Vyrj5XoWy7FPL4XRmZPdq2qZ/tRZVe5es1qhkFPTZ3dpy1oDaaNv1a219/IHPnu455/jk7AuCVdsl5Dopn7LG4Mt3Tp7KPXt+YAg7tn2P+uIaG4dqLQPCdnebXpqHpkqfw6W9b7zpQmeIAjx9nr32Qkx7C9zkb0WPdE7Y5ptPp0g/Z7wKHxIfnIKR+C9HznruK+J4m8n3T9KwDk7945yx0sG8raA4zsPKQ2+F+2/kXSOO4948r/z6vxme36+H760fbSryw+pwjxva2zl26Qu3nbneXcr7d2vpPCX6PVh38UyxmMJ+Pan7nmfN3L+L5cMvv9nfr3iDq0LFowo4BgHiGrnprujquiu4C/v7v5qzJbhfpPjUOASMJAXiOfsthjsFiXl3vwgAI5KKkAYA9584P5gEwjYEUHQE0qy5wEgBppIF747SH6Z6/4YF4BYE4Hf4t6z74Gs6EGAHl5HbUF94JZjDuiSLnIspyZ4YSi1qKhfTg7ShggcTAiipnicrKFUiqF7TqHhraCaEQhhQ6HjopgmZyp0jGFapQ6BBrg1JH72Iua8H8KyE6LhDn4eEEHfaAFkFkCUGSFjY0G3AJryEGHsBKHWo0RGHVgmHApmF6haGWG6Epj6HxHaiJGwjJEgrmHaGZFFi2F9r2FJGOEj51bOGuHcGIAeGf41DeHyF+F/6WLiHDZhEE7SGtBxEsp5HeBngaFpEWFehWF2ZOENZw6/r3Yn7Eqkp25VTtG06dHx687hG9Fe65qKhOEAQZ6zFW6eFXJjBLH+ArEAGl77YSEJ5SGgHsAjGghjH3TAhQ6ThBCW7/pNF4Dg5LHtKiE7aXHEFAFUGbH3HZEDFupqEpiPHpHjEa5vEH6W5lLfH8KcpLEiFF5O5rGr4gGe6DE8BvEAS+JuFzHHHN6tLOEXE4nAF3Ge6wnPGoSvHVFfqpAF6knNbHG/F55vzUlXFc5dG3Fgme5lFWq7EsnuZXgHE06w6om669oIA8mw4BHYkMgZDQB/YrDxKNImKSDsAPptAdCJKojqC1DNDzDzA6npJiA0IgY0C1AHK4Y5FLBEbSDIBjjADbHnIADkhK3piI1K3pio3plaFAHpXp0g3p4O/pxOkZlWcAIZRQKYapKYQu7pcEnpta3pcmMZgZRGiZYZGZEZ7A3pnKuZsa3p+ZoZ4ZWZop5ZOWQZe0BZyZhZTGlI/BDBFZaa/pFpQ+RILR4Q5qvZw5fZI5I5Nw/RY4WZOwFgPZcEIx3pYIWwIgLYYggQUAAEAAYgBDDuiEEMufsVeOiIwKkGuAAIKhhbBXibnohXiBCTgiCrCvgiAiCvixRzmIqtkkgQAxGLBZkABCEAoYH5xIC5YIoY/5EF/50FoYUFkFsF8F8FCFkFSFEFaFUFEFIFbZpRW+dhJZAAEjAMChAIiIBaGAAIQgVJl2bNB2BChiBICgDVBeDcAsAM4IAFAFBAA"}
import { useSignTypedData } from '@wagmi/vue'
// ---cut---
const signTypedData = useSignTypedData()

signTypedData.mutate({
  types: {
    Person: [
      { name: 'name', type: 'string' },
      { name: 'wallet', type: 'address' },
    ],
    Mail: [
      { name: 'from', type: 'Person' },
      { name: 'to', type: 'Person' },
      { name: 'contents', type: 'string' },
    ],
  },
  primaryType: 'Mail',
  // ^?


  message: {
  // ^?












    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
})
```

```ts twoslash [Const-Asserted]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSignTypedData.md","from":8089,"to":13794}<fsm-vh3gqscxm4e>
// @twoslash-cache: {"v":1,"hash":"eaf9c3d409bf800893a6c4a9064554dc68fdcaaccc9fdd1dd7d8f8bf1a066ba2","data":"N4Igdg9gJgpgziAXAbVAFwJ4AcZJACwgDcYAnEAGhDRgA808BjCMONAAkxzkXeAB0w7Ye1IwAhlBYAbDOwAKZOC15jJMuakEidoiVLCz2YcQFsYvfuDMwrAbm27hag0a4X2VtqQCWYAOb2jsIAvhR8wbouGsY2liAA7uLS0jBoQUJOeuqGcu7xklBicHAZOiEAug6ZzvoxALLiPtKqdbnsWjVRbUYm5vEAZqQQpmVZ0e35niCKpMpgY6HhAl06E71x02gQi905btgeVrPzu2ERqyLrcn1HIMxgNI+lINVZ2a55h/HefoGvkUq1RClBAbHEpAYiAAbFRUgE0PgkABWKhoCH+NJ4dwIOF+XCIAAMVEY+Ah4kYNHIMLC6EOeEIJHIaLoUJAAAosMMcJCMABKBRKFQfGKdNY9G6bKy3XbXTjfaa/AIZc4rcX7SX9aZJFJpWUS+U4ApQIrwF7Aiqg8GQpAARgAHHCYAikTC0RisYgZkKwKDpPi7SSyaQKVSkAAmWnUelexlkUE0eh4TncsiYAW3eIykBW9E2xAAZgALE6XUgS9QPWzbn6A4hw0HyZT4zSKHScAziPGWUmvSmIDz04a7kr/rmIVCi46QPD/Ijy+7SJi2e5a2ACQ37sHQy3w4So6vY13mdRWcmuQO0/zYlqrDrUukc1RrVCAOyb2fzxAVvPLvA1vF1yQAtGxDZtqWhA8YwIY8EzPPsL0Ha8pisQpihecd83tadP1dH8q2xelAIJECtybMN60jNtow7I8mTg3sOUQq8BUaZpWg1Do1SuA1M2mIYRn1TiUO9OYWBVZZIjlPirG2ITPmHeITnEgEwFVKTeKle4WCeNBzQ04SFS8NBfGVVTKkwqFbVtCtcIXSsl09EA2OkNcCVRMiwIoqj2wJGD6J7Nl+yQjMtIE0YnzBPMrPDHDnTnPDFz/L0AJnOtYU8ncIKg2j/O7U9GOCljFOmZSFkil87SLD94q/fDHJXIi0qAt1MvAiN92ow88pPRMguY3lQtvagdgq6K7WhDK7O/JKnNS/0WtfUCsqQSCuuguNevgpjU0Gkrjh9KxLLtV84rLGaHOSmjcGIpAlraiiHRyvzNoY/rdqHGTtMeZ09KO59xvrQkavO+qrvmutp1JciWzW3zOwCgr3svPaRNHf6oonCM91LBL7N/JzV1uxAoe3dr6yLZ6EfyvrCJwdgHjYdgAF4LnVBSyo4hSxXGTThuzN5ecMo1FRMv4zkky5ak4r77z1VT3jlES0LNM4qgMhSXK50VuKcaSwuGCLBb1g0RLKiW2aFhSvrkhWrZiM3DrtpZLZNmWtIeXT9KlkVJiMqLTP+Y32CBQQQQBrGKbOvHEA8gm2UZhhidtYkHpbZEqbomntsT9g4B8fwwAAFUOKAABFxHRXgAFU4BgABlAvi9Liv0QAJTSABXUhm5wAAeTuwAAa0gBIwAAPmO+toVtXGv1tUj47wfPC5LnBy8r8Q3LtTdoa82HM56t7k2SHxxDgAVO7rxvV5bzeB+H0eJ85clzCpOAAH5eF1hmWAGAuv7sAAMJ/wLuwAAPuwQesB/7rigMHUwnd0RoB8CwQBtcYD1CQZXVBYB5CvzSEoPuAADQktAAAkwBRwhGIeEG+vcYAb3RAAUVIMMUga8YCS3eDib+kR3jIFoLwUcFRtbtE4Uw8Q+CQxvzIMgdWPsdCCN4MQ0cyBKHUIqMQ0RUCwAwPxPA/hWRlHsGIQMQelJcHqKoWLAIlRtG8GgTAWBjDg4CKEaYlWJRrGaIcbo/RcC3HGI8cQgARhACA0gfG2P8PYnRTiXGGMUSIExYSMA0DgNEwOcTHF6OcQYoJThUmhPSfAcMWS/g5P8fkwJRiikhJKRkgsFS7FaPiXkxJhTdDFNKXAW0LTYltNyQE1xdTukNN6UWAZVSEkFLGUoiZGTkTTKGdUzp8yUmLPgNCFZfjZm1OScIHpGTXy7PaSMpJ7wFkqMafAe0Zzhk1NGYcjoWy4AAE4HlrLmS8458AU5fP2c8q5mybm9OsoCjpPyQVHLebacpGiYkzKhQcmFrywUZIXpCi5XTrmmNuX0qZiLsmrKBZcmFfy+nLOJZU0lKLgUUrhTsmlrS9n0vJSCyltpTkssGWynFGzYUYv+fc3lyKBW/LhZ8sVdKJVospXubFTyOVXIVf0mV/LlW4tBfi3p4YEU2JJZq9ZkrhVwHDM0jV5ytWCvRbqjJ4YiWGtpca6FjKzXhmpc61l1qTXyreeGZl3q+W+rdZygNPLg3iptaa+1ZTRVRtlTG/1HrpWJtdai91ca4AFkJEqv1Wa0lNPVem0Nmbw1moLAa3xZaGUVtMX4NA+aw2qpCY2hNNbHkFvrcQxttog2du+eW1tKjG2OubcO9xo7HhVonXWkdDbHhFjzVartLap2LrQFOOdKqN29seMiAdSKk3doXfutA0InWDrJdqoVm73w7tvXa899oV2lrXZO4J060DYUfba1Jjb3lHqNbW3dX7N0pyvcejN86919vhX+2N574Vvuveyp9AHHjwo7dB0DGG21YYLMBl1eH/0EbQDZKDIGP2wfA8h5E1bcM0bA/U79/bUNMaHbR1jEHoQ4eo1xlj4y2OvmIz65j+G2P2ioyRiTZG2PvMYwJm98nN17g48p9Dqnz17n47JwTkm1P9sQymtT47V0Ge02O2dFmVNIbHcukzhaHN6fE5Z+zjxPViZDXJpDndG1OZ7f5x4rmfPudM8Q4LFHvPRtPXuqL5n33hcLVFmzSW7MRai452zWm/ONu3TluVKXG2HsC2eqLl6yvxcbQ+wrybishY0/pjLDWf2hdi+uujUWgNVa632wkMm3MtaC/BpTzXcuZb7YqurcW+tYdir1njkW+1EcW8J0xUXKNrbxctrDDHts6t29FprQ2Jutf7e1k9nWlubdEwdu9R2HSDbC8N8rfbFP3efQlwkJ2XtnZG55wkl2YNCZ2wl4zlD2AADoYeCB8KYLAEBIRQOvk3CRrct5UCkIwBAsY0BoCwDwAA9ETpI/hTA+Ch3AfAROiCdxgET8QWAfBE+YAjiAcBxChNSHAInV8G5o7vuiKe4ZXz3Wmv22abJ+f0PR5vbeiB4XLXJvqw+r1ApMBYEzFeDDJE11R7fdeGOO5oG7gwh+I8IBj0nhHfM4Z3ni9qq6BeUvl6C6N/L5OFY94rSJGr2CGuEIfWvIg5BHg+4/zlJzX2RgeZu2tlpAWYylb+3Rs7EO3D7btFlskB8ux2YO39l4725QFEF/aFrGPmgf7l42MNcK+eeLCzuObdP6kfb62GrbLpKeRYHTEuVYO7fFZ8zuJ7X6Jes8HD7wHcWbeFHnCsC5Kw492REAhGfbn8A+FdF4a7PYHMfRiNjzXqfmo7hJ5eb3kcMTG8u1P/HmIOfdSPifdf40poSh35DmXs/7BK9yhx5XKd53AN7p4j7N5KROxdLD4wogHxDd62rv6lTQFjKwEgrwHTDj7PDf615fAz5p4wG/6hDBww5Q7sBFjsCmBI4wDQ4w7BwPDriUhI6AIgJgBMHbCkAQLubnADgoJa6AJYJh4ADyWA/BrAfcZB483BZKAozM0hRAEAPgUAU8BY1kc8roGUS8XooelcN0zUBINkyuj0lM60uU6uSM54weAoe+keBo0egBD+VeN4F+Ng3+yBxkgcFsThmBd4ue8sPepsReJo6EaswccoABBoQBeBLhgwhs7hQRM+reQ+mej+2eWkiBHeiRLeqBXQ6BB+T+HsOkE+CRkBosXh8+wIqh+qGhKIruXoOICutoHkPuKu/uiMtMQeKMQ4XI8OEIGAnCUBA+Vg3BS+TQ0gGMlUhYahtRius8l0TkvRpg/RnCTRGUrR3kh8AAjvTqQBgMfF0SFOwEsSsf7K3qMc5OMZMYDAWDMTOE7naPMdoSACcXsascnOsWTJsWYS9AHpYYccVOYCUOIJiDvjoOFGCVkHxKOF0nLGgComQmKsQkPsHNsJCU4NCTErCf4fCaYoiVGsiYCAwcUc8MIliWHKoYerMfdM8UCZzpiE0e8sYbuNsbsfsYHjtN0SHmaCCR4D/BCfvjoJiYHNiS/giRQgSSiZEGiYKSIMKX8KKQ+OKUiVKV0NgXpGSSKRSbblCAWFSfcedDSQRDoTyQycnEyWnNSD5NdNTFtIVANEOAKT/PKQEMHHCcqZKdqZjPmAWPaKRNNGDE5OFArlWsydSKYfDFnHacjEcS6f4KoQ7rMYGdWDYCGaRBsQfD8baQcZyUce6XiRKdQsQlPEWJLgaTHFocaYkDiSGd7l8ZmZGUfByUVKjBAOibEXnOSV0PmaQoWUioSWpCWfaPMdNJuM8dsCGZ8TDOGe0dnPadYR2aOCWe8v6Q8RdM8RDC1AWPdBmdlFmVGTmS2UOD2fiUWVPMiEruWV+JWQ1HgHCSGaTNOatLOdGVYVyQKOqTwJ2YHOeWLrMdOM8Z+QrsumGeWJUCSNAH5LnDiCzJbNHsgJEMAB2QAOS3DIXhBTDIWjjIUZ6IUoVwnoUlTIXF44VhCOAVAUCOCV4IVdBIV8TIXhSEWYVlSkWUW0UoXbBMUKjIUsW4XsX0WflcUixYUxKsXkVsUhDsDny/ysDpALBgC5w65y7oiwUy7u6MIY7sh8iCCCBKVC7iBQ66E0DsjcQ4hsXCCvEDHcUuToU6XyXCB0m8k752UuXyWuWuXgmGztnCD0UgIJC2WXD5nIVkJAJlzhjiAFhQDvIABiK59ozCC8oV7yRYr4zCjAhIyIAAgqEkAq+NFcwq+MWGXAMPaGXGXPaIGgFeUOZSIDKafvRQAEIQChJVW6BBVkKhINWdUNU9WhLdVdV9UDUDWDVdXDWdXjXdWdWtVLCRCfm8DIUAASMAKQEA4QTVoSAAhK1WRWpHyKCG/FvIgKAKyM6PnCwNiAgCECEEAA=="}
import { useSignTypedData } from '@wagmi/vue'
// ---cut---
const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const

const signTypedData = useSignTypedData()

signTypedData.mutate({
  types,
  primaryType: 'Mail',
  // ^?


  message: {
  // ^?












    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
})
```

:::

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`signTypedData`](/core/api/actions/signTypedData)

---

---
url: /react/api/hooks/useSimulateContract.md
description: Hook for simulating/validating a contract interaction.
---

# useSimulateContract

Hook for simulating/validating a contract interaction.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":414,"to":458}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":507,"to":880}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: details Composing with `useWriteContract`

`useSimulateContract` can be combined with [`useWriteContract`](/react/api/hooks/useWriteContract) to reduce the amount of validation required by wallets.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":1205,"to":1790}<fsm-vh3gqscxm4e>
import { useSimulateContract, useWriteContract } from 'wagmi'
import { abi } from './abi'

function App() {
  const { data } = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
  })
  const { writeContract } = useWriteContract()
  return (
    <button
      disabled={!data?.request}
      onClick={() => writeContract(data!.request)}
    >
      Transfer
    </button>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":1898,"to":1957}<fsm-vh3gqscxm4e>
import { type UseSimulateContractParameters } from 'wagmi'
```

### abi

`Abi | undefined`

The contract's ABI. Check out the [TypeScript docs](/react/typescript#const-assert-abis-typed-data) for how to set up ABIs for maximum type inference and safety.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":2187,"to":2594}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { abi } from './abi' // [!code focus]

function App() {
  const result = useSimulateContract({
    abi, // [!code focus]
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### accessList

`AccessList | undefined`

The access list.

::: code-group

```tsx [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":2774,"to":3326}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { abi } from './abi'
import { config } from './config'

function App() {
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
    accessList: [{ // [!code focus]
      address: '0x1', // [!code focus]
      storageKeys: ['0x1'], // [!code focus]
    }], // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### account

`Account | undefined`

Account to use when calling the contract (`msg.sender`). Throws if account is not found on [`connector`](#connector).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":3602,"to":4051}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
    account: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### address

`Address | undefined`

The contract's address.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":4233,"to":4623}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f', // [!code focus]
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### args

`readonly unknown[] | undefined`

* Arguments to pass when calling the contract.
* Inferred from [`abi`](#abi) and [`functionName`](#functionname).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":4903,"to":5362}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f', 
    functionName: 'transferFrom',
    args: [ // [!code focus]
      '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', // [!code focus]
      123n, // [!code focus]
    ], // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### blockNumber

`bigint | undefined`

Block number to call contract at.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":5562,"to":5981}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f', 
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
    blockNumber: 17829139n, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to call contract at.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":6220,"to":6633}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f', 
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
    blockTag: 'safe', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":6858,"to":7330}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { mainnet } from 'wagmi/chains' // [!code focus]
import { abi } from './abi'

function App() {
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f', 
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
    chainId: mainnet.id, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":7620,"to":8074}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { abi } from './abi'
import { config } from './config' // [!code focus]

function App() {
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f', 
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

[Connector](/react/api/connectors) to simulate transaction with.

::: code-group

```tsx [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":8300,"to":8810}<fsm-vh3gqscxm4e>
import { useConnectorClient, useSimulateContract } from 'wagmi'
import { abi } from './abi'
import { config } from './config'

function App() {
  const { data: connector } = useConnectorClient()
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
    connector, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### dataSuffix

`` `0x${string}` | undefined ``

Data to append to the end of the calldata. Useful for adding a ["domain" tag](https://opensea.notion.site/opensea/Seaport-Order-Attributions-ec2d69bf455041a5baa490941aad307f).

::: code-group

```tsx [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":9156,"to":9643}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

function App() {
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
    dataSuffix: '0xdeadbeef', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### functionName

`string | undefined`

* Function to call on the contract.
* Inferred from [`abi`](#abi).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":9872,"to":10263}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { abi } from './abi'

function App() {
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f', 
    functionName: 'transferFrom', // [!code focus]
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### gas

`bigint | undefined`

Gas provided for transaction execution.

::: code-group

```tsx [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":10455,"to":10938}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

function App() {
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
    gas: parseGwei('20'), // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### gasPrice

`bigint | undefined`

The price in wei to pay per gas. Only applies to [Legacy Transactions](https://viem.sh/docs/glossary/terms#legacy-transaction).

::: code-group

```tsx [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":11228,"to":11716}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

function App() {
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
    gasPrice: parseGwei('20'), // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxFeePerGas

`bigint | undefined`

Total fee per gas in wei, inclusive of [`maxPriorityFeePerGas`](#maxPriorityFeePerGas). Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```tsx [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":12064,"to":12556}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

function App() {
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
    maxFeePerGas: parseGwei('20'), // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxPriorityFeePerGas

`bigint | undefined`

Max priority fee per gas in wei. Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```tsx [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":12857,"to":13391}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

function App() {
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
    maxFeePerGas: parseGwei('20'),
    maxPriorityFeePerGas: parseGwei('2'), // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### nonce

`number`

Unique number identifying this transaction.

::: code-group

```tsx [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":13582,"to":14022}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { abi } from './abi'
import { config } from './config'

function App() {
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
    nonce: 123, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### type

`'legacy' | 'eip1559' | 'eip2930' | undefined`

Optional transaction request type to narrow parameters.

::: code-group

```tsx [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":14257,"to":14702}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { abi } from './abi'
import { config } from './config'

function App() {
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
    type: 'eip1559', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### value

`bigint | undefined`

Value in wei sent with this transaction.

::: code-group

```tsx [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":14897,"to":15386}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { parseEther } from 'viem'
import { abi } from './abi'
import { config } from './config'

function App() {
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
    value: parseEther('0.01'), // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":15641,"to":16086}<fsm-vh3gqscxm4e>
import { useSimulateContract } from 'wagmi'
import { abi } from './abi'
import { config } from './config'

function App() {
  const result = useSimulateContract({
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
    scopeKey: 'foo', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSimulateContract.md","from":16238,"to":16297}<fsm-vh3gqscxm4e>
import { type UseSimulateContractReturnType } from 'wagmi'
```

The return type's [`data`](#data) property is inferrable via the combination of [`abi`](#abi), [`functionName`](#functionname), and [`args`](#args). Check out the [TypeScript docs](/react/typescript#const-assert-abis-typed-data) for more info.

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## Type Inference

With [`abi`](#abi) setup correctly, TypeScript will infer the correct types for [`functionName`](#functionname), [`args`](#args), and [`value`](#value). See the Wagmi [TypeScript docs](/react/typescript) for more information.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`simulateContract`](/core/api/actions/simulateContract)

---

---
url: /vue/api/composables/useSimulateContract.md
description: Composable for simulating/validating a contract interaction.
---

# useSimulateContract

Composable for simulating/validating a contract interaction.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":431,"to":480}<fsm-vh3gqscxm4e>
import { useSimulateContract } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":529,"to":903}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { abi } from './abi'

const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":1067,"to":1131}<fsm-vh3gqscxm4e>
import { type UseSimulateContractParameters } from '@wagmi/vue'
```

### abi

`Abi | undefined`

The contract's ABI. Check out the [TypeScript docs](/vue/typescript#const-assert-abis-typed-data) for how to set up ABIs for maximum type inference and safety.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":1359,"to":1767}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { abi } from './abi' // [!code focus]

const result = useSimulateContract({
  abi, // [!code focus]
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### accessList

`AccessList | undefined`

The access list.

::: code-group

```vue [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":1945,"to":2490}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { abi } from './abi'
import { config } from './config'

const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  accessList: [{ // [!code focus]
    address: '0x1', // [!code focus]
    storageKeys: ['0x1'], // [!code focus]
  }], // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### account

`Account | undefined`

Account to use when calling the contract (`msg.sender`). Throws if account is not found on [`connector`](#connector).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":2764,"to":3212}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { abi } from './abi'

const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  account: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### address

`Address | undefined`

The contract's address.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":3392,"to":3783}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { abi } from './abi'

const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f', // [!code focus]
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### args

`readonly unknown[] | undefined`

* Arguments to pass when calling the contract.
* Inferred from [`abi`](#abi) and [`functionName`](#functionname).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":4061,"to":4521}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { abi } from './abi'

const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f', 
  functionName: 'transferFrom',
  args: [ // [!code focus]
    '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', // [!code focus]
    123n, // [!code focus]
  ], // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### blockNumber

`bigint | undefined`

Block number to call contract at.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":4719,"to":5137}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { abi } from './abi'

const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f', 
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  blockNumber: 17829139n, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to call contract at.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":5374,"to":5786}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { abi } from './abi'

const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f', 
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  blockTag: 'safe', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":6009,"to":6480}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { mainnet } from 'wagmi/chains' // [!code focus]
import { abi } from './abi'

const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f', 
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  chainId: mainnet.id, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":6752,"to":7205}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { abi } from './abi'
import { config } from './config' // [!code focus]

const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f', 
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

[Connector](/vue/api/connectors) to simulate transaction with.

::: code-group

```vue [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":7427,"to":7934}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnectorClient, useSimulateContract } from '@wagmi/vue'
import { abi } from './abi'
import { config } from './config'

const { data: connector } = useConnectorClient()
const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  connector, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### dataSuffix

`` `0x${string}` | undefined ``

Data to append to the end of the calldata. Useful for adding a ["domain" tag](https://opensea.notion.site/opensea/Seaport-Order-Attributions-ec2d69bf455041a5baa490941aad307f).

::: code-group

```vue [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":8278,"to":8764}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  dataSuffix: '0xdeadbeef', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### functionName

`string | undefined`

* Function to call on the contract.
* Inferred from [`abi`](#abi).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":8991,"to":9383}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { abi } from './abi'

const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f', 
  functionName: 'transferFrom', // [!code focus]
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### gas

`bigint | undefined`

Gas provided for transaction execution.

::: code-group

```vue [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":9573,"to":10055}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  gas: parseGwei('20'), // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### gasPrice

`bigint | undefined`

The price in wei to pay per gas. Only applies to [Legacy Transactions](https://viem.sh/docs/glossary/terms#legacy-transaction).

::: code-group

```vue [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":10343,"to":10830}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  gasPrice: parseGwei('20'), // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxFeePerGas

`bigint | undefined`

Total fee per gas in wei, inclusive of [`maxPriorityFeePerGas`](#maxPriorityFeePerGas). Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```vue [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":11176,"to":11667}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  maxFeePerGas: parseGwei('20'), // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxPriorityFeePerGas

`bigint | undefined`

Max priority fee per gas in wei. Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```vue [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":11966,"to":12497}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  maxFeePerGas: parseGwei('20'),
  maxPriorityFeePerGas: parseGwei('2'), // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### nonce

`number`

Unique number identifying this transaction.

::: code-group

```vue [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":12686,"to":13125}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { abi } from './abi'
import { config } from './config'

const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  nonce: 123, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### type

`'legacy' | 'eip1559' | 'eip2930' | undefined`

Optional transaction request type to narrow parameters.

::: code-group

```vue [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":13358,"to":13802}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { abi } from './abi'
import { config } from './config'

const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  type: 'eip1559', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### value

`bigint | undefined`

Value in wei sent with this transaction.

::: code-group

```vue [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":13995,"to":14483}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { parseEther } from 'viem'
import { abi } from './abi'
import { config } from './config'

const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  value: parseEther('0.01'), // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Composables that have identical context will share the same cache.

::: code-group

```vue [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":14742,"to":15186}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSimulateContract } from '@wagmi/vue'
import { abi } from './abi'
import { config } from './config'

const result = useSimulateContract({
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  scopeKey: 'foo', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSimulateContract.md","from":15336,"to":15400}<fsm-vh3gqscxm4e>
import { type UseSimulateContractReturnType } from '@wagmi/vue'
```

The return type's [`data`](#data) property is inferrable via the combination of [`abi`](#abi), [`functionName`](#functionname), and [`args`](#args). Check out the [TypeScript docs](/vue/typescript#const-assert-abis-typed-data) for more info.

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## Type Inference

With [`abi`](#abi) setup correctly, TypeScript will infer the correct types for [`functionName`](#functionname), [`args`](#args), and [`value`](#value). See the Wagmi [TypeScript docs](/vue/typescript) for more information.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`simulateContract`](/core/api/actions/simulateContract)

---

---
url: /react/api/hooks/useStorageAt.md
description: Hook for returning the value from a storage slot at a given address.
---

# useStorageAt

Hook for returning the value from a storage slot at a given address.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useStorageAt.md","from":406,"to":443}<fsm-vh3gqscxm4e>
import { useStorageAt } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useStorageAt.md","from":492,"to":662}<fsm-vh3gqscxm4e>
import { useStorageAt } from 'wagmi'

function App() {
  const result = useStorageAt({
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
    slot: '0x0',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useStorageAt.md","from":734,"to":786}<fsm-vh3gqscxm4e>
import { type UseStorageAtParameters } from 'wagmi'
```

### address

`Address | undefined`

The contract address.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useStorageAt.md","from":884,"to":1071}<fsm-vh3gqscxm4e>
import { useStorageAt } from 'wagmi'

function App() {
  const result = useStorageAt({
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', // [!code focus]
    slot: '0x0',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### slot

`Hex | undefined`

The storage position (as a hex encoded value).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useStorageAt.md","from":1233,"to":1420}<fsm-vh3gqscxm4e>
import { useStorageAt } from 'wagmi'

function App() {
  const result = useStorageAt({
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
    slot: '0x0', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## blockNumber

`bigint | undefined`

The block number to check the storage at.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useStorageAt.md","from":1586,"to":1801}<fsm-vh3gqscxm4e>
import { useStorageAt } from 'wagmi'

function App() {
  const result = useStorageAt({
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
    blockNumber: 16280770n, // [!code focus]
    slot: '0x0',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

The block tag to check the storage at.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useStorageAt.md","from":2012,"to":2221}<fsm-vh3gqscxm4e>
import { useStorageAt } from 'wagmi'

function App() {
  const result = useStorageAt({
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
    blockTag: 'safe', // [!code focus]
    slot: '0x0',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

The chain ID to check the storage at.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useStorageAt.md","from":2404,"to":2661}<fsm-vh3gqscxm4e>
import { useStorageAt } from 'wagmi'
import { mainnet } from '@wagmi/core/chains'

function App() {
  const result = useStorageAt({
    chainId: mainnet.id, // [!code focus]
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
    slot: '0x0',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useStorageAt.md","from":2915,"to":3165}<fsm-vh3gqscxm4e>
import { useStorageAt } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useStorageAt({
    config, // [!code focus]
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
    slot: '0x0',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useStorageAt.md","from":3385,"to":3626}<fsm-vh3gqscxm4e>
import { useStorageAt } from 'wagmi'
import { config } from './config'

function App() {
  const result = useStorageAt({
    scopeKey: 'foo' // [!code focus]
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
    slot: '0x0',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useStorageAt.md","from":3742,"to":3794}<fsm-vh3gqscxm4e>
import { type UseStorageAtReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getStorageAt`](/core/api/actions/getStorageAt)

---

---
url: /react/api/hooks/useSwitchChain.md
description: Hook for switching the target chain for a connector or the Wagmi `Config`.
---

# useSwitchChain

Hook for switching the target chain for a connector or the Wagmi [`Config`](/react/api/createConfig#config).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSwitchChain.md","from":523,"to":562}<fsm-vh3gqscxm4e>
import { useSwitchChain } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSwitchChain.md","from":611,"to":957}<fsm-vh3gqscxm4e>
import { useChains, useSwitchChain } from 'wagmi'

function App() {
  const switchChain = useSwitchChain()
  const chains = useChains()
  return (
    <div>
      {chains.map((chain) => (
        <button key={chain.id} onClick={() => switchChain.mutate({ chainId: chain.id })}>
          {chain.name}
        </button>
      ))}
    </div>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: tip
When connected, `switchChain` will switch the target chain for the connector. When not connected, `switchChain` will switch the target chain for the Wagmi [`Config`](/react/api/createConfig#config).
:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSwitchChain.md","from":1241,"to":1295}<fsm-vh3gqscxm4e>
import { type UseSwitchChainParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSwitchChain.md","from":1503,"to":1686}<fsm-vh3gqscxm4e>
import { useSwitchChain } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const switchChain = useSwitchChain({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSwitchChain.md","from":1805,"to":1859}<fsm-vh3gqscxm4e>
import { type UseSwitchChainReturnType } from 'wagmi'
```

### chains [deprecated](/react/guides/migrate-from-v2-to-v3#removed-useswitchchain-chains)

`readonly [Chain, ...Chain[]]`

Globally configured chains. Useful for rendering a list of available chains to switch to.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSwitchChain.md","from":2143,"to":2454}<fsm-vh3gqscxm4e>
import { useSwitchChain } from 'wagmi'

function App() {
  const switchChain = useSwitchChain()
  return (
    <div>
      {switchChain.chains.map((chain) => (
        <button key={chain.id} onClick={() => switchChain({ chainId: chain.id })}>
          {chain.name}
        </button>
      ))}
    </div>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`switchChain`](/core/api/actions/switchChain)

---

---
url: /solid/api/primitives/useSwitchChain.md
description: Primitive for switching chains.
---

# useSwitchChain

Primitive for switching chains.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useSwitchChain.md","from":406,"to":452}<fsm-vh3gqscxm4e>
import { useSwitchChain } from '@wagmi/solid'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useSwitchChain.md","from":501,"to":1005}<fsm-vh3gqscxm4e>
import { useSwitchChain } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'
import { For } from 'solid-js'

function App() {
  const switchChain = useSwitchChain()
  
  return (
    <div>
      <For each={[mainnet, sepolia]}>
        {(chain) => (
          <button
            disabled={switchChain.isPending}
            onClick={() => switchChain.mutate({ chainId: chain.id })}
          >
            {chain.name}
          </button>
        )}
      </For>
    </div>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useSwitchChain.md","from":1077,"to":1181}<fsm-vh3gqscxm4e>
import { useSwitchChain } from '@wagmi/solid'

useSwitchChain.Parameters
useSwitchChain.SolidParameters
```

Parameters are passed as a getter function to maintain Solid reactivity.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useSwitchChain.md","from":1266,"to":1329}<fsm-vh3gqscxm4e>
useSwitchChain(() => ({
  config,
  // mutation options...
}))
```

### config

`Config | undefined`

[`Config`](/solid/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/solid/api/WagmiProvider).

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useSwitchChain.md","from":1571,"to":1644}<fsm-vh3gqscxm4e>
import { useSwitchChain } from '@wagmi/solid'

useSwitchChain.ReturnType
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`switchChain`](/core/api/actions/switchChain)

---

---
url: /vue/api/composables/useSwitchChain.md
description: >-
  Composable for switching the target chain for a connector or the Wagmi
  `Config`.
---

# useSwitchChain

Composable for switching the target chain for a connector or the Wagmi [`Config`](/vue/api/createConfig#config).

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSwitchChain.md","from":538,"to":582}<fsm-vh3gqscxm4e>
import { useSwitchChain } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSwitchChain.md","from":631,"to":1000}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useChains, useSwitchChain } from '@wagmi/vue'

const switchChain = useSwitchChain()
const chains = useSwitchChains()
</script>

<template>
  <div>
    <button 
      v-for="chain in chains" 
      :key="chain.id" 
      @click="switchChain.mutate({ chainId: chain.id })"
    >
      {{ chain.name }}
    </button>
  </div>
</template>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: tip
When connected, `switchChain` will switch the target chain for the connector. When not connected, `switchChain` will switch the target chain for the Wagmi [`Config`](/vue/api/createConfig#config).
:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSwitchChain.md","from":1280,"to":1339}<fsm-vh3gqscxm4e>
import { type UseSwitchChainParameters } from '@wagmi/vue'
```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSwitchChain.md","from":1531,"to":1729}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSwitchChain } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const switchChain = useSwitchChain({
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSwitchChain.md","from":1846,"to":1905}<fsm-vh3gqscxm4e>
import { type UseSwitchChainReturnType } from '@wagmi/vue'
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`switchChain`](/core/api/actions/switchChain)

---

---
url: /react/api/hooks/useSwitchConnection.md
description: Hook for switching the current connection.
---

# useSwitchConnection

Hook for switching the current connection.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSwitchConnection.md","from":465,"to":509}<fsm-vh3gqscxm4e>
import { useSwitchConnection } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSwitchConnection.md","from":558,"to":983}<fsm-vh3gqscxm4e>
import { useConnections, useSwitchConnection } from 'wagmi'

function App() {
  const switchConnection = useSwitchConnection()
  const connections = useConnections()
  return (
    <div>
      {connections.map((connection) => (
        <button key={connection.id} onClick={() => switchConnection.mutate({ connector: connection.connector })}>
          {connection.connector.name}
        </button>
      ))}
    </div>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSwitchConnection.md","from":1055,"to":1114}<fsm-vh3gqscxm4e>
import { type UseSwitchConnectionParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSwitchConnection.md","from":1322,"to":1510}<fsm-vh3gqscxm4e>
import { useSwitchConnection } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useSwitchConnection({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSwitchConnection.md","from":1629,"to":1688}<fsm-vh3gqscxm4e>
import { type UseSwitchConnectionReturnType } from 'wagmi'
```

### connectors [deprecated](/react/guides/migrate-from-v2-to-v3#removed-usedisconnect-connectors-useswitchconnection-connectors)

`readonly Connector[]`

Globally configured and actively connected connectors. Useful for rendering a list of available connectors to switch to.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useSwitchConnection.md","from":2033,"to":2385}<fsm-vh3gqscxm4e>
import { useSwitchConnection } from 'wagmi'

function App() {
  const switchConnection = useSwitchConnection()

  return (
    <div>
      {switchConnection.connectors.map((connector) => (
        <button key={connector.id} onClick={() => switchConnection.mutate({ connector })}>
          {connector.name}
        </button>
      ))}
    </div>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`switchConnection`](/core/api/actions/switchConnection)

---

---
url: /solid/api/primitives/useSwitchConnection.md
description: Primitive for switching between connections.
---

# useSwitchConnection

Primitive for switching between connections when multiple wallets are connected.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useSwitchConnection.md","from":462,"to":513}<fsm-vh3gqscxm4e>
import { useSwitchConnection } from '@wagmi/solid'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useSwitchConnection.md","from":562,"to":1080}<fsm-vh3gqscxm4e>
import { useConnections, useSwitchConnection } from '@wagmi/solid'
import { For } from 'solid-js'

function App() {
  const connections = useConnections()
  const switchConnection = useSwitchConnection()
  
  return (
    <div>
      <For each={connections()}>
        {(connection) => (
          <button
            onClick={() => switchConnection.mutate({ connector: connection.connector })}
          >
            Switch to {connection.connector.name}
          </button>
        )}
      </For>
    </div>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useSwitchConnection.md","from":1152,"to":1271}<fsm-vh3gqscxm4e>
import { useSwitchConnection } from '@wagmi/solid'

useSwitchConnection.Parameters
useSwitchConnection.SolidParameters
```

Parameters are passed as a getter function to maintain Solid reactivity.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useSwitchConnection.md","from":1356,"to":1424}<fsm-vh3gqscxm4e>
useSwitchConnection(() => ({
  config,
  // mutation options...
}))
```

### config

`Config | undefined`

[`Config`](/solid/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/solid/api/WagmiProvider).

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useSwitchConnection.md","from":1666,"to":1749}<fsm-vh3gqscxm4e>
import { useSwitchConnection } from '@wagmi/solid'

useSwitchConnection.ReturnType
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`switchConnection`](/core/api/actions/switchConnection)

---

---
url: /vue/api/composables/useSwitchConnection.md
description: Composable for switching the current connection.
---

# useSwitchConnection

Composable for switching the current connection.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSwitchConnection.md","from":477,"to":521}<fsm-vh3gqscxm4e>
import { useSwitchConnection } from 'wagmi'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSwitchConnection.md","from":570,"to":1007}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnections, useSwitchConnection } from 'wagmi'

const switchConnection = useSwitchConnection()
const connections = useConnections()
</script>

<template>
  <div>
    <button 
      v-for="connection in connections" 
      :key="connection.id" 
      @click="switchConnection.mutate({ connector: connection.connector })"
    >
      {{ connection.connector.name }}
    </button>
  </div>
</template>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSwitchConnection.md","from":1077,"to":1136}<fsm-vh3gqscxm4e>
import { type UseSwitchConnectionParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSwitchConnection.md","from":1328,"to":1536}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useSwitchConnection } from 'wagmi'
import { config } from './config' // [!code focus]

const switchConnection = useSwitchConnection({
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useSwitchConnection.md","from":1653,"to":1712}<fsm-vh3gqscxm4e>
import { type UseSwitchConnectionReturnType } from 'wagmi'
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`switchConnection`](/core/api/actions/switchConnection)

---

---
url: /react/api/hooks/useTransaction.md
description: Hook for fetching transactions given hashes or block identifiers.
---

# useTransaction

Hook for fetching transactions given hashes or block identifiers.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransaction.md","from":412,"to":451}<fsm-vh3gqscxm4e>
import { useTransaction } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransaction.md","from":500,"to":678}<fsm-vh3gqscxm4e>
import { useTransaction } from 'wagmi'

function App() {
  const result = useTransaction({
    hash: '0x0fa64daeae54e207aa98613e308c2ba8abfe274f75507e741508cc4db82c8cb5',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransaction.md","from":750,"to":804}<fsm-vh3gqscxm4e>
import { type UseTransactionParameters } from 'wagmi'
```

***

### blockHash

`bigint | undefined`

Block hash to get transaction at (with [`index`](#index)).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransaction.md","from":917,"to":1131}<fsm-vh3gqscxm4e>
import { useTransaction } from 'wagmi'

function App() {
  const result = useTransaction({
    blockHash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', // [!code focus]
    index: 0,
  })
}
```

### blockNumber

`bigint | undefined`

Block number to get transaction at (with [`index`](#index)).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransaction.md","from":1243,"to":1400}<fsm-vh3gqscxm4e>
import { useTransaction } from 'wagmi'

function App() {
  const result = useTransaction({
    blockNumber: 17829139n, // [!code focus]
    index: 0,
  })
}
```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get transaction at (with [`index`](#index)).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransaction.md","from":1556,"to":1707}<fsm-vh3gqscxm4e>
import { useTransaction } from 'wagmi'

function App() {
  const result = useTransaction({
    blockTag: 'safe', // [!code focus]
    index: 0,
  })
}
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransaction.md","from":1817,"to":2076}<fsm-vh3gqscxm4e>
import { useTransaction } from 'wagmi'
import { mainnet } from 'wagmi/chains'

function App() {
  const result = useTransaction({
    chainId: mainnet.id, // [!code focus]
    hash: '0x0fa64daeae54e207aa98613e308c2ba8abfe274f75507e741508cc4db82c8cb5',
  })
}
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransaction.md","from":2284,"to":2542}<fsm-vh3gqscxm4e>
import { useTransaction } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useTransaction({
    hash: '0x0fa64daeae54e207aa98613e308c2ba8abfe274f75507e741508cc4db82c8cb5',
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### hash

`` `0x${string}` | undefined ``

Hash to get transaction. [`enabled`](#enabled) set to `false` if `hash` and [`index`](#index) are `undefined`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransaction.md","from":2754,"to":2949}<fsm-vh3gqscxm4e>
import { useTransaction } from 'wagmi'

function App() {
  const result = useTransaction({
    hash: '0x0fa64daeae54e207aa98613e308c2ba8abfe274f75507e741508cc4db82c8cb5', // [!code focus]
  })
}
```

### index

`number | undefined`

An index to be used with a block identifier ([hash](#blockhash), [number](#blocknumber), or [tag](#blocktag)). [`enabled`](#enabled) set to `false` if `index` and [`hash`](#hash) are `undefined`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransaction.md","from":3190,"to":3341}<fsm-vh3gqscxm4e>
import { useTransaction } from 'wagmi'

function App() {
  const result = useTransaction({
    blockTag: 'safe',
    index: 0  // [!code focus]
  })
}
```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransaction.md","from":3411,"to":3465}<fsm-vh3gqscxm4e>
import { type UseTransactionReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getTransaction`](/core/api/actions/getTransaction)

---

---
url: /vue/api/composables/useTransaction.md
description: Composable for fetching transactions given hashes or block identifiers.
---

# useTransaction

Composable for fetching transactions given hashes or block identifiers.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useTransaction.md","from":429,"to":473}<fsm-vh3gqscxm4e>
import { useTransaction } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useTransaction.md","from":522,"to":715}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useTransaction } from '@wagmi/vue'

const result = useTransaction({
  hash: '0x0fa64daeae54e207aa98613e308c2ba8abfe274f75507e741508cc4db82c8cb5',
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useTransaction.md","from":785,"to":844}<fsm-vh3gqscxm4e>
import { type UseTransactionParameters } from '@wagmi/vue'
```

***

### blockHash

`bigint | undefined`

Block hash to get transaction at (with [`index`](#index)).

```vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useTransaction.md","from":958,"to":1185}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useTransaction } from '@wagmi/vue'

const result = useTransaction({
  blockHash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', // [!code focus]
  index: 0,
})
</script>
```

### blockNumber

`bigint | undefined`

Block number to get transaction at (with [`index`](#index)).

```vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useTransaction.md","from":1298,"to":1468}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useTransaction } from '@wagmi/vue'

const result = useTransaction({
  blockNumber: 17829139n, // [!code focus]
  index: 0,
})
</script>
```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get transaction at (with [`index`](#index)).

```vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useTransaction.md","from":1625,"to":1789}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useTransaction } from '@wagmi/vue'

const result = useTransaction({
  blockTag: 'safe', // [!code focus]
  index: 0,
})
</script>
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

```vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useTransaction.md","from":1900,"to":2172}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useTransaction } from '@wagmi/vue'
import { mainnet } from 'wagmi/chains'

const result = useTransaction({
  chainId: mainnet.id, // [!code focus]
  hash: '0x0fa64daeae54e207aa98613e308c2ba8abfe274f75507e741508cc4db82c8cb5',
})
</script>
```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useTransaction.md","from":2364,"to":2635}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useTransaction } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const result = useTransaction({
  hash: '0x0fa64daeae54e207aa98613e308c2ba8abfe274f75507e741508cc4db82c8cb5',
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### hash

`` `0x${string}` | undefined ``

Hash to get transaction. [`enabled`](#enabled) set to `false` if `hash` and [`index`](#index) are `undefined`.

```vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useTransaction.md","from":2846,"to":3056}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useTransaction } from '@wagmi/vue'

const result = useTransaction({
  hash: '0x0fa64daeae54e207aa98613e308c2ba8abfe274f75507e741508cc4db82c8cb5', // [!code focus]
})
</script>
```

### index

`number | undefined`

An index to be used with a block identifier ([hash](#blockhash), [number](#blocknumber), or [tag](#blocktag)). [`enabled`](#enabled) set to `false` if `index` and [`hash`](#hash) are `undefined`.

```vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useTransaction.md","from":3298,"to":3462}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useTransaction } from '@wagmi/vue'

const result = useTransaction({
  blockTag: 'safe',
  index: 0  // [!code focus]
})
</script>
```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useTransaction.md","from":3532,"to":3591}<fsm-vh3gqscxm4e>
import { type UseTransactionReturnType } from '@wagmi/vue'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getTransaction`](/core/api/actions/getTransaction)

---

---
url: /react/api/hooks/useTransactionConfirmations.md
description: >-
  Hook for fetching the number of blocks passed (confirmations) since the
  transaction was processed on a block.
---

# useTransactionConfirmations

Hook for fetching the number of blocks passed (confirmations) since the transaction was processed on a block. If confirmations is 0, then the Transaction has not been confirmed & processed yet.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionConfirmations.md","from":662,"to":714}<fsm-vh3gqscxm4e>
import { useTransactionConfirmations } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionConfirmations.md","from":763,"to":967}<fsm-vh3gqscxm4e>
import { useTransactionConfirmations } from 'wagmi'

function App() {
  const result = useTransactionConfirmations({
    hash: '0x0fa64daeae54e207aa98613e308c2ba8abfe274f75507e741508cc4db82c8cb5',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionConfirmations.md","from":1039,"to":1106}<fsm-vh3gqscxm4e>
import { type UseTransactionConfirmationsParameters } from 'wagmi'
```

***

### hash

`` `0x${string}` | undefined ``

The hash of the transaction.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionConfirmations.md","from":1195,"to":1416}<fsm-vh3gqscxm4e>
import { useTransactionConfirmations } from 'wagmi'

function App() {
  const result = useTransactionConfirmations({
    hash: '0x0fa64daeae54e207aa98613e308c2ba8abfe274f75507e741508cc4db82c8cb5', // [!code focus]
  })
}
```

### transactionReceipt

`TransactionReceipt | undefined`

The transaction receipt.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionConfirmations.md","from":1511,"to":1685}<fsm-vh3gqscxm4e>
import { useTransactionConfirmations } from 'wagmi'

function App() {
  const result = useTransactionConfirmations({
    transactionReceipt: { ... }, // [!code focus]
  })
}
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionConfirmations.md","from":1795,"to":2080}<fsm-vh3gqscxm4e>
import { useTransactionConfirmations } from 'wagmi'
import { mainnet } from 'wagmi/chains'

function App() {
  const result = useTransactionConfirmations({
    chainId: mainnet.id, // [!code focus]
    hash: '0x0fa64daeae54e207aa98613e308c2ba8abfe274f75507e741508cc4db82c8cb5',
  })
}
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionConfirmations.md","from":2288,"to":2572}<fsm-vh3gqscxm4e>
import { useTransactionConfirmations } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useTransactionConfirmations({
    config, // [!code focus]
    hash: '0x0fa64daeae54e207aa98613e308c2ba8abfe274f75507e741508cc4db82c8cb5',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionConfirmations.md","from":2792,"to":3048}<fsm-vh3gqscxm4e>
import { useBlock } from 'wagmi'
import { config } from './config'

function App() {
  const result = useTransactionConfirmations({
    scopeKey: 'foo' // [!code focus]
    hash: '0x0fa64daeae54e207aa98613e308c2ba8abfe274f75507e741508cc4db82c8cb5',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionConfirmations.md","from":3164,"to":3231}<fsm-vh3gqscxm4e>
import { type UseTransactionConfirmationsReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getTransactionConfirmations`](/core/api/actions/getTransactionConfirmations)

---

---
url: /react/api/hooks/useTransactionCount.md
description: Hook for fetching the number of transactions an Account has broadcast / sent.
---

# useTransactionCount

Hook for fetching the number of transactions an Account has sent.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionCount.md","from":437,"to":481}<fsm-vh3gqscxm4e>
import { useTransactionCount } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionCount.md","from":530,"to":697}<fsm-vh3gqscxm4e>
import { useTransactionCount } from 'wagmi'

function App() {
  const result = useTransactionCount({
    address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionCount.md","from":769,"to":828}<fsm-vh3gqscxm4e>
import { type UseTransactionCountParameters } from 'wagmi'
```

### address

`Address | undefined`

Address to get the transaction count for. [`enabled`](#enabled) set to `false` if `address` is `undefined`.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionCount.md","from":1012,"to":1235}<fsm-vh3gqscxm4e>
import { useTransactionCount } from 'wagmi'
import { mainnet } from 'wagmi/chains'

function App() {
  const result = useTransactionCount({
    address: '0x4557B18E779944BFE9d78A672452331C186a9f48', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### blockNumber

`bigint | undefined`

Block number to get the transaction count at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionCount.md","from":1409,"to":1621}<fsm-vh3gqscxm4e>
import { useTransactionCount } from 'wagmi'

function App() {
  const result = useTransactionCount({
    address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
    blockNumber: 17829139n, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to get the transaction count at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionCount.md","from":1834,"to":2042}<fsm-vh3gqscxm4e>
import { useTransactionCount } from 'wagmi'

function App() {
  const result = useTransactionCount({
    address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
    blockTag: 'latest', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionCount.md","from":2231,"to":2496}<fsm-vh3gqscxm4e>
import { useTransactionCount } from 'wagmi'
import { mainnet } from 'wagmi/chains' // [!code focus]

function App() {
  const result = useTransactionCount({
    address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
    chainId: mainnet.id, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionCount.md","from":2750,"to":2997}<fsm-vh3gqscxm4e>
import { useTransactionCount } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useTransactionCount({
    address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionCount.md","from":3217,"to":3422}<fsm-vh3gqscxm4e>
import { useTransactionCount } from 'wagmi'

function App() {
  const result = useTransactionCount({
    address: '0x4557B18E779944BFE9d78A672452331C186a9f48',
    scopeKey: 'foo', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionCount.md","from":3538,"to":3597}<fsm-vh3gqscxm4e>
import { type UseTransactionCountReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getTransactionCount`](/core/api/actions/getTransactionCount)

---

---
url: /react/api/hooks/useTransactionReceipt.md
description: Hook for return the Transaction Receipt given a Transaction hash.
---

# useTransactionReceipt

Hook for return the [Transaction Receipt](https://viem.sh/docs/glossary/terms#transaction-receipt) given a [Transaction](https://viem.sh/docs/glossary/terms#transaction) hash.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionReceipt.md","from":564,"to":610}<fsm-vh3gqscxm4e>
import { useTransactionReceipt } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionReceipt.md","from":659,"to":851}<fsm-vh3gqscxm4e>
import { useTransactionReceipt } from 'wagmi'

function App() {
  const result = useTransactionReceipt({
    hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionReceipt.md","from":923,"to":984}<fsm-vh3gqscxm4e>
import { type UseTransactionReceiptParameters } from 'wagmi'
```

### hash

`` `0x${string}` | undefined ``

A transaction hash.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionReceipt.md","from":1087,"to":1296}<fsm-vh3gqscxm4e>
import { useTransactionReceipt } from 'wagmi'

function App() {
  const result = useTransactionReceipt({
    hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

The ID of chain to return the transaction receipt from.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionReceipt.md","from":1497,"to":1771}<fsm-vh3gqscxm4e>
import { useTransactionReceipt } from 'wagmi'
import { mainnet } from 'wagmi/chains'


function App() {
  const result = useTransactionReceipt({
    chainId: mainnet.id, // [!code focus]
    hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionReceipt.md","from":2025,"to":2297}<fsm-vh3gqscxm4e>
import { useTransactionReceipt } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useTransactionReceipt({
    config, // [!code focus]
    hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionReceipt.md","from":2517,"to":2780}<fsm-vh3gqscxm4e>
import { useTransactionReceipt } from 'wagmi'
import { config } from './config'

function App() {
  const result = useTransactionReceipt({
    scopeKey: 'foo' // [!code focus]
    hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useTransactionReceipt.md","from":2896,"to":2957}<fsm-vh3gqscxm4e>
import { type UseTransactionReceiptReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getTransactionReceipt`](/core/api/actions/getTransactionReceipt)

---

---
url: /vue/api/composables/useTransactionReceipt.md
description: Composable for return the Transaction Receipt given a Transaction hash.
---

# useTransactionReceipt

Composable for return the [Transaction Receipt](https://viem.sh/docs/glossary/terms#transaction-receipt) given a [Transaction](https://viem.sh/docs/glossary/terms#transaction) hash.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useTransactionReceipt.md","from":581,"to":632}<fsm-vh3gqscxm4e>
import { useTransactionReceipt } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useTransactionReceipt.md","from":681,"to":888}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useTransactionReceipt } from '@wagmi/vue'

const result = useTransactionReceipt({
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useTransactionReceipt.md","from":958,"to":1024}<fsm-vh3gqscxm4e>
import { type UseTransactionReceiptParameters } from '@wagmi/vue'
```

### hash

`` `0x${string}` | undefined ``

A transaction hash.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useTransactionReceipt.md","from":1127,"to":1351}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useTransactionReceipt } from '@wagmi/vue'

const result = useTransactionReceipt({
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

The ID of chain to return the transaction receipt from.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useTransactionReceipt.md","from":1550,"to":1836}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useTransactionReceipt } from '@wagmi/vue'
import { mainnet } from 'wagmi/chains'

const result = useTransactionReceipt({
  chainId: mainnet.id, // [!code focus]
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useTransactionReceipt.md","from":2072,"to":2357}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useTransactionReceipt } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const result = useTransactionReceipt({
  config, // [!code focus]
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Composables that have identical context will share the same cache.

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useTransactionReceipt.md","from":2581,"to":2857}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useTransactionReceipt } from '@wagmi/vue'
import { config } from './config'

const result = useTransactionReceipt({
  scopeKey: 'foo' // [!code focus]
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useTransactionReceipt.md","from":2971,"to":3037}<fsm-vh3gqscxm4e>
import { type UseTransactionReceiptReturnType } from '@wagmi/vue'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getTransactionReceipt`](/core/api/actions/getTransactionReceipt)

---

---
url: /react/api/hooks/useVerifyMessage.md
description: Hook for verify that a message was signed by the provided address.
---

# useVerifyMessage

Hook for verify that a message was signed by the provided address. It supports verifying messages that were signed by either a Smart Contract Account or Externally Owned Account.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyMessage.md","from":526,"to":567}<fsm-vh3gqscxm4e>
import { useVerifyMessage } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyMessage.md","from":616,"to":956}<fsm-vh3gqscxm4e>
import { useVerifyMessage } from 'wagmi'

function App() {
  const result = useVerifyMessage({
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    message: 'hello world',
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyMessage.md","from":1028,"to":1084}<fsm-vh3gqscxm4e>
import { type UseVerifyMessageParameters } from 'wagmi'
```

### address

`Address | undefined`

The Ethereum address that signed the original message.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyMessage.md","from":1215,"to":1572}<fsm-vh3gqscxm4e>
import { useVerifyMessage } from 'wagmi'

function App() {
  const result = useVerifyMessage({
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', // [!code focus]
    message: 'hello world',
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### message

`string | { raw: Hex | ByteArray } | undefined`

The message to be verified.

By default, wagmi verifies the UTF-8 representation of the message.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyMessage.md","from":1817,"to":2174}<fsm-vh3gqscxm4e>
import { useVerifyMessage } from 'wagmi'

function App() {
  const result = useVerifyMessage({
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    message: 'hello world', // [!code focus]
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: tip
By default, viem signs the UTF-8 representation of the message. To sign the data representation of the message, you can use the `raw` attribute.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyMessage.md","from":2385,"to":2763}<fsm-vh3gqscxm4e>
import { useVerifyMessage } from 'wagmi'

function App() {
  const result = useVerifyMessage({
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    message: { raw: '0x68656c6c6f20776f726c64' } // [!code focus]
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

:::

### signature

`Hex | ByteArray | undefined`

The signature that was generated by signing the message with the address's signer.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyMessage.md","from":2936,"to":3293}<fsm-vh3gqscxm4e>
import { useVerifyMessage } from 'wagmi'

function App() {
  const result = useVerifyMessage({
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    message: 'hello world',
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

Only used when verifying a message that was signed by a Smart Contract Account. The ID of chain to check if the contract was already deployed.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyMessage.md","from":3581,"to":4002}<fsm-vh3gqscxm4e>
import { useVerifyMessage } from 'wagmi'
import { mainnet } from 'wagmi/chains'

function App() {
  const result = useVerifyMessage({
    chainId: mainnet.id, // [!code focus]
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    message: 'hello world',
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`bigint | undefined`

Only used when verifying a message that was signed by a Smart Contract Account. The block number to check if the contract was already deployed.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyMessage.md","from":4271,"to":4695}<fsm-vh3gqscxm4e>
import { useVerifyMessage } from 'wagmi'
import { mainnet } from 'wagmi/chains'

function App() {
  const result = useVerifyMessage({
    blockNumber: 12345678n, // [!code focus]
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    message: 'hello world',
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Only used when verifying a message that was signed by a Smart Contract Account. The block tag to check if the contract was already deployed.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyMessage.md","from":5008,"to":5429}<fsm-vh3gqscxm4e>
import { useVerifyMessage } from 'wagmi'
import { mainnet } from 'wagmi/chains'

function App() {
  const result = useVerifyMessage({
    blockTag: 'pending', // [!code focus]
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    message: 'hello world',
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyMessage.md","from":5683,"to":6103}<fsm-vh3gqscxm4e>
import { useVerifyMessage } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useVerifyMessage({
    config, // [!code focus]
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    message: 'hello world',
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyMessage.md","from":6323,"to":6734}<fsm-vh3gqscxm4e>
import { useVerifyMessage } from 'wagmi'
import { config } from './config'

function App() {
  const result = useVerifyMessage({
    scopeKey: 'foo' // [!code focus]
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    message: 'hello world',
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyMessage.md","from":6850,"to":6906}<fsm-vh3gqscxm4e>
import { type UseVerifyMessageReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`verifyMessage`](/core/api/actions/verifyMessage)

---

---
url: /react/api/hooks/useVerifyTypedData.md
description: Hook for verify that a typed data was signed by the provided address.
---

# useVerifyTypedData

Hook for verify that a typed data was signed by the provided address. It supports verifying typed data that were signed by either a Smart Contract Account or Externally Owned Account.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":546,"to":589}<fsm-vh3gqscxm4e>
import { useVerifyTypedData } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":638,"to":1304}<fsm-vh3gqscxm4e>
import { domain, types } from './data'
import { useVerifyTypedData } from 'wagmi'

function App() {
  const result = useVerifyTypedData({
    domain,
    types,
    message: {
      from: {
        name: 'Cow',
        wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
      },
      to: {
        name: 'Bob',
        wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
      },
      contents: 'Hello, Bob!',
    },
    primaryType: 'Mail',
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":1324,"to":1825}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const

// The named list of all type definitions
export const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":1897,"to":1955}<fsm-vh3gqscxm4e>
import { type UseVerifyTypedDataParameters } from 'wagmi'
```

### address

`Address | undefined`

The Ethereum address that signed the original typed data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":2089,"to":2772}<fsm-vh3gqscxm4e>
import { domain, types } from './data'
import { useVerifyTypedData } from 'wagmi'

function App() {
  const result = useVerifyTypedData({
    domain,
    types,
    message: {
      from: {
        name: 'Cow',
        wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
      },
      to: {
        name: 'Bob',
        wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
      },
      contents: 'Hello, Bob!',
    },
    primaryType: 'Mail',
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', // [!code focus]
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":2792,"to":3293}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const

// The named list of all type definitions
export const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### domain

`TypedDataDomain | undefined`

The typed data domain.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":3445,"to":4266}<fsm-vh3gqscxm4e>
import { types } from './data'
import { useVerifyTypedData } from 'wagmi'

function App() {
  const result = useVerifyTypedData({
    domain: { // [!code focus:6]
      name: 'Ether Mail',
      version: '1',
      chainId: 1,
      verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
    },
    types,
    message: {
      from: {
        name: 'Cow',
        wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
      },
      to: {
        name: 'Bob',
        wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
      },
      contents: 'Hello, Bob!',
    },
    primaryType: 'Mail',
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":4286,"to":4589}<fsm-vh3gqscxm4e>
// The named list of all type definitions
export const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### types

The type definitions for the typed data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":4727,"to":5678}<fsm-vh3gqscxm4e>
import { domain } from './data'
import { useVerifyTypedData } from 'wagmi'

function App() {
  const result = useVerifyTypedData({
    domain,
    types: { // [!code focus:11]
      Person: [
        { name: 'name', type: 'string' },
        { name: 'wallet', type: 'address' },
      ],
      Mail: [
        { name: 'from', type: 'Person' },
        { name: 'to', type: 'Person' },
        { name: 'contents', type: 'string' },
      ],
    },
    message: {
      from: {
        name: 'Cow',
        wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
      },
      to: {
        name: 'Bob',
        wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
      },
      contents: 'Hello, Bob!',
    },
    primaryType: 'Mail',
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":5698,"to":5895}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### primaryType

`string | undefined`

The primary `type` to extract from types and use in `value`.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":6081,"to":7048}<fsm-vh3gqscxm4e>
import { domain } from './data'
import { useVerifyTypedData } from 'wagmi'

function App() {
  const result = useVerifyTypedData({
    domain,
    types: {
      Person: [
        { name: 'name', type: 'string' },
        { name: 'wallet', type: 'address' },
      ],
      Mail: [ // [!code focus:5]
        { name: 'from', type: 'Person' },
        { name: 'to', type: 'Person' },
        { name: 'contents', type: 'string' },
      ],
    },
    primaryType: 'Mail', // [!code focus]
    message: {
      from: {
        name: 'Cow',
        wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
      },
      to: {
        name: 'Bob',
        wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
      },
      contents: 'Hello, Bob!',
    },
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":7068,"to":7265}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### message

Type inferred from `types` & `primaryType`.

The message to be verified.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":7437,"to":8123}<fsm-vh3gqscxm4e>
import { domain, types } from './data'
import { useVerifyTypedData } from 'wagmi'

function App() {
  const result = useVerifyTypedData({
    domain,
    types,
    message: { // [!code focus:11]
      from: {
        name: 'Cow',
        wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
      },
      to: {
        name: 'Bob',
        wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
      },
      contents: 'Hello, Bob!',
    },
    primaryType: 'Mail',
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":8143,"to":8644}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const

// The named list of all type definitions
export const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### signature

`Hex | ByteArray | undefined`

The signature that was generated by signing the typed data with the address's signer.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":8862,"to":9545}<fsm-vh3gqscxm4e>
import { domain, types } from './data'
import { useVerifyTypedData } from 'wagmi'

function App() {
  const result = useVerifyTypedData({
    domain,
    types,
    message: {
      from: {
        name: 'Cow',
        wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
      },
      to: {
        name: 'Bob',
        wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
      },
      contents: 'Hello, Bob!',
    },
    primaryType: 'Mail',
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c', // [!code focus]
  })
}
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":9565,"to":10066}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const

// The named list of all type definitions
export const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

Only used when verifying a typed data that was signed by a Smart Contract Account. The ID of chain to check if the contract was already deployed.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":10357,"to":11104}<fsm-vh3gqscxm4e>
import { domain, types } from './data'
import { useVerifyTypedData } from 'wagmi'
import { mainnet } from 'wagmi/chains'

function App() {
  const result = useVerifyTypedData({
    chainId: mainnet.id, // [!code focus]
    domain,
    types,
    message: {
      from: {
        name: 'Cow',
        wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
      },
      to: {
        name: 'Bob',
        wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
      },
      contents: 'Hello, Bob!',
    },
    primaryType: 'Mail',
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":11124,"to":11625}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const

// The named list of all type definitions
export const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`bigint | undefined`

Only used when verifying a typed data that was signed by a Smart Contract Account. The block number to check if the contract was already deployed.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":11897,"to":12608}<fsm-vh3gqscxm4e>
import { domain, types } from './data'
import { useVerifyTypedData } from 'wagmi'

function App() {
  const result = useVerifyTypedData({
    blockNumber: 12345678n, // [!code focus]
    domain,
    types,
    message: {
      from: {
        name: 'Cow',
        wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
      },
      to: {
        name: 'Bob',
        wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
      },
      contents: 'Hello, Bob!',
    },
    primaryType: 'Mail',
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":12628,"to":13129}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const

// The named list of all type definitions
export const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Only used when verifying a typed data that was signed by a Smart Contract Account. The block tag to check if the contract was already deployed.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":13445,"to":14152}<fsm-vh3gqscxm4e>
import { domain, types } from './data'
import { useVerifyTypedData } from 'wagmi'

function App() {
  const result = useVerifyTypedData({
    blockTag: 'latest', // [!code focus]
    domain,
    types,
    message: {
      from: {
        name: 'Cow',
        wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
      },
      to: {
        name: 'Bob',
        wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
      },
      contents: 'Hello, Bob!',
    },
    primaryType: 'Mail',
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":14172,"to":14673}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const

// The named list of all type definitions
export const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":14927,"to":15673}<fsm-vh3gqscxm4e>
import { domain, types } from './data'
import { useVerifyTypedData } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useVerifyTypedData({
    config, // [!code focus]
    domain,
    types,
    message: {
      from: {
        name: 'Cow',
        wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
      },
      to: {
        name: 'Bob',
        wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
      },
      contents: 'Hello, Bob!',
    },
    primaryType: 'Mail',
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":15693,"to":16194}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const

// The named list of all type definitions
export const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":16414,"to":17117}<fsm-vh3gqscxm4e>
import { domain, types } from './data'
import { useVerifyTypedData } from 'wagmi'

function App() {
  const result = useVerifyTypedData({
    scopeKey: 'foo' // [!code focus]
    domain,
    types,
    message: {
      from: {
        name: 'Cow',
        wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
      },
      to: {
        name: 'Bob',
        wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
      },
      contents: 'Hello, Bob!',
    },
    primaryType: 'Mail',
    address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
    signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
  })
}
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":17137,"to":17638}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const

// The named list of all type definitions
export const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useVerifyTypedData.md","from":17754,"to":17812}<fsm-vh3gqscxm4e>
import { type UseVerifyTypedDataReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## Type Inference

With [`types`](#types) setup correctly, TypeScript will infer the correct types for [`domain`](#domain), [`message`](#message), and [`primaryType`](#primarytype). See the Wagmi [TypeScript docs](/react/typescript) for more information.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`verifyTypedData`](/core/api/actions/verifyTypedData)

---

---
url: /react/api/hooks/useWaitForCallsStatus.md
description: Waits for a call bundle to be confirmed & included on a block.
---

# useWaitForCallsStatus

Waits for a call bundle to be confirmed & included on a block before returning the status & receipts.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForCallsStatus.md","from":484,"to":530}<fsm-vh3gqscxm4e>
import { useWaitForCallsStatus } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForCallsStatus.md","from":579,"to":725}<fsm-vh3gqscxm4e>
import { useWaitForCallsStatus } from 'wagmi'

function App() {
  const result = useWaitForCallsStatus({
    id: '0x...', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForCallsStatus.md","from":797,"to":858}<fsm-vh3gqscxm4e>
import { type UseWaitForCallsStatusParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForCallsStatus.md","from":1066,"to":1275}<fsm-vh3gqscxm4e>
import { useWaitForCallsStatus } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useWaitForCallsStatus({
    config, // [!code focus]
    id: '0x...',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

Connector to get call statuses with.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForCallsStatus.md","from":1438,"to":1732}<fsm-vh3gqscxm4e>
import { useWaitForCallsStatus, useConnections } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const connections = useConnections()
  const result = useWaitForCallsStatus({
    connector: connections[0]?.connector, // [!code focus]
    id: '0x...',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### id

`string`

Identifier of the call batch.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForCallsStatus.md","from":1864,"to":2044}<fsm-vh3gqscxm4e>
import { useWaitForCallsStatus } from '@wagmi/core'
import { config } from './config'

const status = await useWaitForCallsStatus({
  id: '0x1234567890abcdef', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### pollingInterval

`number | undefined`

Polling interval in milliseconds.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForCallsStatus.md","from":2205,"to":2411}<fsm-vh3gqscxm4e>
import { useWaitForCallsStatus } from '@wagmi/core'
import { config } from './config'

const status = await useWaitForCallsStatus({
  id: '0x1234567890abcdef',
  pollingInterval: 1_000, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### scopeKey

`string | undefined`

Scopes the cache to a given context. Hooks that have identical context will share the same cache.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForCallsStatus.md","from":2631,"to":2849}<fsm-vh3gqscxm4e>
import { useWaitForCallsStatus } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useWaitForCallsStatus({
    id: '0x...',
    scopeKey: 'foo', // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### timeout

`number | undefined`

Timeout in milliseconds.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForCallsStatus.md","from":2993,"to":3192}<fsm-vh3gqscxm4e>
import { useWaitForCallsStatus } from '@wagmi/core'
import { config } from './config'

const status = await useWaitForCallsStatus({
  id: '0x1234567890abcdef',
  timeout: 10_000, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForCallsStatus.md","from":3308,"to":3369}<fsm-vh3gqscxm4e>
import { type UseWaitForCallsStatusReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`waitForCallsStatus`](https://viem.sh/docs/actions/wallet/waitForCallsStatus)

---

---
url: /react/api/hooks/useWaitForTransactionReceipt.md
description: >-
  Hook that waits for the transaction to be included on a block, and then
  returns the transaction receipt. If the transaction reverts, then the action
  will throw an error. Replacement detection (e.g. sped up transactions) is also
  supported.
---

# useWaitForTransactionReceipt

Hook that waits for the transaction to be included on a block, and then returns the transaction receipt. If the transaction reverts, then the action will throw an error. Replacement detection (e.g. sped up transactions) is also supported.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForTransactionReceipt.md","from":830,"to":883}<fsm-vh3gqscxm4e>
import { useWaitForTransactionReceipt } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForTransactionReceipt.md","from":932,"to":1138}<fsm-vh3gqscxm4e>
import { useWaitForTransactionReceipt } from 'wagmi'

function App() {
  const result = useWaitForTransactionReceipt({
    hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForTransactionReceipt.md","from":1210,"to":1278}<fsm-vh3gqscxm4e>
import { type UseWaitForTransactionReceiptParameters } from 'wagmi'
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForTransactionReceipt.md","from":1399,"to":1686}<fsm-vh3gqscxm4e>
import { useWaitForTransactionReceipt } from 'wagmi'
import { mainnet } from 'wagmi/chains'

function App() {
  const result = useWaitForTransactionReceipt({
    chainId: mainnet.id, // [!code focus]
    hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
  })
}
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForTransactionReceipt.md","from":1894,"to":2180}<fsm-vh3gqscxm4e>
import { useWaitForTransactionReceipt } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useWaitForTransactionReceipt({
    hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### confirmations

`number | undefined`

The number of confirmations (blocks that have passed) to wait before resolving.

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForTransactionReceipt.md","from":2370,"to":2615}<fsm-vh3gqscxm4e>
import { useWaitForTransactionReceipt } from 'wagmi'

function App() {
  const result = useWaitForTransactionReceipt({
    confirmations: 2, // [!code focus]
    hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
  })
}
```

### onReplaced

`(({ reason: 'replaced' | 'repriced' | 'cancelled'; replacedTransaction: Transaction; transaction: Transaction; transactionReceipt: TransactionReceipt }) => void) | undefined`

Optional callback to emit if the transaction has been replaced.

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForTransactionReceipt.md","from":2897,"to":3177}<fsm-vh3gqscxm4e>
import { useWaitForTransactionReceipt } from 'wagmi'

function App() {
  const result = useWaitForTransactionReceipt({
    hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
    onReplaced: replacement => console.log(replacement), // [!code focus]
  })
}
```

### pollingInterval

`number | undefined`

* Polling frequency (in milliseconds).
* Defaults to the [Config's `pollingInterval` config](/react/api/createConfig#pollinginterval).

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForTransactionReceipt.md","from":3378,"to":3629}<fsm-vh3gqscxm4e>
import { useWaitForTransactionReceipt } from 'wagmi'

function App() {
  const result = useWaitForTransactionReceipt({
    hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
    pollingInterval: 1_000, // [!code focus]
  })
}
```

### hash

`` `0x${string}` | undefined ``

The transaction hash to wait for. [`enabled`](#enabled) set to `false` if `hash` is `undefined`.

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForTransactionReceipt.md","from":3792,"to":4015}<fsm-vh3gqscxm4e>
import { useWaitForTransactionReceipt } from 'wagmi'

function App() {
  const result = useWaitForTransactionReceipt({
    hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', // [!code focus]
  })
}
```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWaitForTransactionReceipt.md","from":4085,"to":4153}<fsm-vh3gqscxm4e>
import { type UseWaitForTransactionReceiptReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`waitForTransactionReceipt`](/core/api/actions/waitForTransactionReceipt)

---

---
url: /vue/api/composables/useWaitForTransactionReceipt.md
description: >-
  Composable that waits for the transaction to be included on a block, and then
  returns the transaction receipt. If the transaction reverts, then the action
  will throw an error. Replacement detection (e.g. sped up transactions) is also
  supported.
---

# useWaitForTransactionReceipt

Composable that waits for the transaction to be included on a block, and then returns the transaction receipt. If the transaction reverts, then the action will throw an error. Replacement detection (e.g. sped up transactions) is also supported.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWaitForTransactionReceipt.md","from":847,"to":905}<fsm-vh3gqscxm4e>
import { useWaitForTransactionReceipt } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWaitForTransactionReceipt.md","from":954,"to":1175}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useWaitForTransactionReceipt } from '@wagmi/vue'

const result = useWaitForTransactionReceipt({
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWaitForTransactionReceipt.md","from":1245,"to":1316}<fsm-vh3gqscxm4e>
import { type WaitForTransactionReceiptParameters } from '@wagmi/core'
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWaitForTransactionReceipt.md","from":1439,"to":1744}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useWaitForTransactionReceipt } from '@wagmi/vue'
import { mainnet } from '@wagmi/vue/chains'

const result = useWaitForTransactionReceipt({
  chainId: mainnet.id, // [!code focus]
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
</script>
```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWaitForTransactionReceipt.md","from":1936,"to":2235}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useWaitForTransactionReceipt } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const result = useWaitForTransactionReceipt({
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### confirmations

`number | undefined`

The number of confirmations (blocks that have passed) to wait before resolving.

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWaitForTransactionReceipt.md","from":2425,"to":2683}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useWaitForTransactionReceipt } from '@wagmi/vue'

const result = useWaitForTransactionReceipt({
  confirmations: 2, // [!code focus]
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
</script>
```

### onReplaced

`(({ reason: 'replaced' | 'repriced' | 'cancelled'; replacedTransaction: Transaction; transaction: Transaction; transactionReceipt: TransactionReceipt }) => void) | undefined`

Optional callback to emit if the transaction has been replaced.

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWaitForTransactionReceipt.md","from":2967,"to":3260}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useWaitForTransactionReceipt } from '@wagmi/vue'

const result = useWaitForTransactionReceipt({
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
  onReplaced: replacement => console.log(replacement), // [!code focus]
})
</script>
```

### pollingInterval

`number | undefined`

* Polling frequency (in milliseconds).
* Defaults to the [Config's `pollingInterval` config](/vue/api/createConfig#pollinginterval).

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWaitForTransactionReceipt.md","from":3461,"to":3725}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useWaitForTransactionReceipt } from '@wagmi/vue'

const result = useWaitForTransactionReceipt({
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
  pollingInterval: 1_000, // [!code focus]
})
</script>
```

### hash

`` `0x${string}` | undefined ``

The transaction hash to wait for. [`enabled`](#enabled) set to `false` if `hash` is `undefined`.

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWaitForTransactionReceipt.md","from":3890,"to":4128}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useWaitForTransactionReceipt } from '@wagmi/vue'

const result = useWaitForTransactionReceipt({
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', // [!code focus]
})
</script>
```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWaitForTransactionReceipt.md","from":4198,"to":4271}<fsm-vh3gqscxm4e>
import { type UseWaitForTransactionReceiptReturnType } from '@wagmi/vue'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`waitForTransactionReceipt`](/core/api/actions/waitForTransactionReceipt)

---

---
url: /react/api/hooks/useWalletClient.md
description: >-
  Hook for getting a Viem `WalletClient` object for the current or provided
  connector.
---

# useWalletClient

Hook for getting a Viem [`WalletClient`](https://viem.sh/docs/clients/wallet) object for the current or provided connector.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWalletClient.md","from":537,"to":577}<fsm-vh3gqscxm4e>
import { useWalletClient } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWalletClient.md","from":626,"to":721}<fsm-vh3gqscxm4e>
import { useWalletClient } from 'wagmi'

function App() {
  const result = useWalletClient()
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: warning
If you want to optimize bundle size, you should use [`useConnectorClient`](/react/api/hooks/useConnectorClient) along with Viem's [tree-shakable actions](https://viem.sh/docs/clients/custom#tree-shaking) instead. Since Wallet Client has all wallet actions attached directly to it.
:::

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWalletClient.md","from":1091,"to":1146}<fsm-vh3gqscxm4e>
import { type UseWalletClientParameters } from 'wagmi'
```

### account

`Address | Account | undefined`

Account to use with client. Throws if account is not found on [`connector`](#connector).

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWalletClient.md","from":1293,"to":1469}<fsm-vh3gqscxm4e>
import { useWalletClient } from 'wagmi'

function App() {
  const result = useWalletClient({
    account: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
  })
}
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use with client.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWalletClient.md","from":1572,"to":1714}<fsm-vh3gqscxm4e>
import { useWalletClient } from 'wagmi'

function App() {
  const result = useWalletClient({
    chainId: mainnet.id, // [!code focus]
  })
}
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWalletClient.md","from":1922,"to":2102}<fsm-vh3gqscxm4e>
import { useWalletClient } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useWalletClient({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

* Connector to get client for.
* Defaults to current connector.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWalletClient.md","from":2264,"to":2484}<fsm-vh3gqscxm4e>
import { useConnections, useWalletClient } from 'wagmi'

function App() {
  const connections = useConnections(config)
  const result = useWalletClient({
    connector: connections[0]?.connector, // [!code focus]
  })
}
```

***

### query

TanStack Query parameters. See the [TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `queryFn` and `queryKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/types/properties.ts#L27) to see what parameters are not supported. All parameters listed below are supported.
:::

#### enabled

`boolean | undefined`

* Set this to `false` to disable this query from automatically running.
* Can be used for [Dependent Queries](https://tanstack.com/query/v5/docs/react/guides/dependent-queries).

#### gcTime

`number | Infinity | undefined`

* Defaults to `5 * 60 * 1000` (5 minutes) or `Infinity` during SSR
* The time in milliseconds that unused/inactive cache data remains in memory. When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different garbage collection times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### initialData

`{{TData}} | (() => {{TData}}) | undefined`

* If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)
* If set to a function, the function will be called **once** during the shared/root query initialization, and be expected to synchronously return the initialData
* Initial data is considered stale by default unless a `staleTime` has been set.
* `initialData` **is persisted** to the cache

#### initialDataUpdatedAt

`number | ((() => number | undefined)) | undefined`

If set, this value will be used as the time (in milliseconds) of when the `initialData` itself was last updated.

#### initialPageParam

`{{TPageParam}}`

The initial page parameter to be passed to the query function.

#### getPreviousPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(firstPage: {{TData}}, allPages: {{TData}}[], firstPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### getNextPageParam

This function can be set to automatically get the previous cursor for infinite queries.
The result will also be used to determine the value of `hasPreviousPage`.

`(lastPage: {{TData}}, allPages: {{TData}}[], lastPageParam: {{TPageParam}}, allPageParams: {{TPageParam}}[]) => {{TPageParam}} | undefined | null`

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the `query` is available, and is also part of the `QueryFunctionContext` provided to the `queryFn`.

#### networkMode

`online' | 'always' | 'offlineFirst' | undefined`

* Defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### notifyOnChangeProps

`string[] | 'all' | (() => string[] | 'all') | undefined`

* If set, the component will only re-render if any of the listed properties change.
* If set to `['data', 'error']` for example, the component will only re-render when the `data` or `error` properties change.
* If set to `'all'`, the component will opt-out of smart tracking and re-render whenever a query is updated.
* If set to a function, the function will be executed to compute the list of properties.
* By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.

#### placeholderData

`{{TData}} | ((previousValue: {{TData}} | undefined; previousQuery: Query | undefined) => {{TData}}) | undefined`

* If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `pending` state.
* `placeholderData` is **not persisted** to the cache
* If you provide a function for `placeholderData`, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.

#### queryClient

`QueryClient | undefined`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### refetchInterval

`number | false | ((data: {{TData}} | undefined, query: Query) => number | false | undefined) | undefined`

* If set to a number, all queries will continuously refetch at this frequency in milliseconds
* If set to a function, the function will be executed with the latest data and query to compute a frequency

#### refetchIntervalInBackground

`boolean | undefined`

If set to `true`, queries that are set to continuously refetch with a `refetchInterval` will continue to refetch while their tab/window is in the background

#### refetchOnMount

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on mount if the data is stale.
* If set to `false`, the query will not refetch on mount.
* If set to `'always'`, the query will always refetch on mount.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnReconnect

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on reconnect if the data is stale.
* If set to `false`, the query will not refetch on reconnect.
* If set to `'always'`, the query will always refetch on reconnect.
* If set to a function, the function will be executed with the query to compute the value

#### refetchOnWindowFocus

`boolean | 'always' | ((query: Query) => boolean | 'always') | undefined`

* Defaults to `true`
* If set to `true`, the query will refetch on window focus if the data is stale.
* If set to `false`, the query will not refetch on window focus.
* If set to `'always'`, the query will always refetch on window focus.
* If set to a function, the function will be executed with the query to compute the value

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* If `false`, failed queries will not retry by default.
* If `true`, failed queries will retry infinitely.
* If set to a `number`, e.g. `3`, failed queries will retry until the failed query count meets that number.
* Defaults to `3` on the client and `0` on the server

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

#### retryOnMount

`boolean | undefined`

If set to `false`, the query will not be retried on mount if it contains an error. Defaults to `true`.

#### select

`((data: {{TData}}) => unknown) | undefined`

This option can be used to transform or select a part of the data returned by the query function. It affects the returned `data` value, but does not affect what gets stored in the query cache.

#### staleTime

`number | Infinity | undefined`

* Defaults to `0`
* The time in milliseconds after data is considered stale. This value only applies to the hook it is defined on.
* If set to `Infinity`, the data will never be considered stale

#### structuralSharing

`boolean | (((oldData: {{TData}} | undefined, newData: {{TData}}) => {{TData}})) | undefined`

* Defaults to `true`
* If set to `false`, structural sharing between query results will be disabled.
* If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWalletClient.md","from":2554,"to":2609}<fsm-vh3gqscxm4e>
import { type UseWalletClientReturnType } from 'wagmi'
```

***

[TanStack Query query docs](https://tanstack.com/query/v5/docs/react/reference/useQuery)

### data

`{{TData}}`

* The last successfully resolved data for the query.
* Defaults to `undefined`.

### dataUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'success'`.

### error

`null | {{TError}}`

* The error object for the query, if an error was thrown.
* Defaults to `null`

### errorUpdatedAt

`number`

The timestamp for when the query most recently returned the `status` as `'error'`.

### errorUpdateCount

`number`

The sum of all errors.

### failureCount

`number`

* The failure count for the query.
* Incremented every time the query fails.
* Reset to `0` when the query succeeds.

### failureReason

`null | {{TError}}`

* The failure reason for the query retry.
* Reset to `null` when the query succeeds.

### fetchNextPage

`(options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<{{TData}}, {{TError}}>>`

This function allows you to fetch the next "page" of results.

### fetchPreviousPage

`(options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>>`

This function allows you to fetch the previous "page" of results.

### hasNextPage

`boolean`

This will be `true` if there is a next page to be fetched (known via the `getNextPageParam` option).

### hasPreviousPage

`boolean`

This will be `true` if there is a previous page to be fetched (known via the `getPreviousPageParam` option).

### isFetchingNextPage

`boolean`

Will be `true` while fetching the next page with `fetchNextPage`.

### isFetchingPreviousPage

`boolean`

Will be `true` while fetching the previous page with `fetchPreviousPage`.

### fetchStatus

`'fetching' | 'idle' | 'paused'`

* `fetching` Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetches.
* `paused` The query wanted to fetch, but has been `paused`.
* `idle` The query is not fetching.
* See [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### isError / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isFetched

`boolean`

Will be `true` if the query has been fetched.

### isFetchedAfterMount

`boolean`

* Will be `true` if the query has been fetched after the component mounted.
* This property can be used to not show any previously cached data.

### isFetching / isPaused

`boolean`

Boolean variables derived from [`fetchStatus`](#fetchstatus).

### isLoading

`boolean`

* Is `true` whenever the first fetch for a query is in-flight
* Is the same as `isFetching && isPending`

### isLoadingError

`boolean`

Will be `true` if the query failed while fetching for the first time.

### isPlaceholderData

`boolean`

Will be `true` if the data shown is the placeholder data.

### isRefetchError

`boolean`

Will be `true` if the query failed while refetching.

### isRefetching

`boolean`

* Is `true` whenever a background refetch is in-flight, which *does not* include initial `'pending'`.
* Is the same as `isFetching && !isPending`

### isStale

`boolean`

Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.

### refetch

`(options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise<UseQueryResult<{{TData}}, {{TError}}>>`

* A function to manually refetch the query.
* `throwOnError`
  * When set to `true`, an error will be thrown if the query fails.
  * When set to `false`, an error will be logged if the query fails.
* `cancelRefetch`
  * When set to `true`, a currently running request will be cancelled before a new request is made.
  * When set to `false`, no refetch will be made if there is already a request running.
  * Defaults to `true`

### status

`'error' | 'pending' | 'success'`

* `pending` if there's no cached data and no query attempt was finished yet.
* `error` if the query attempt resulted in an error. The corresponding `error` property has the error received from the attempted fetch
* `success` if the query has received a response with no errors and is ready to display its data. The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false` and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Action

* [`getWalletClient`](/core/api/actions/getWalletClient)

---

---
url: /react/api/hooks/useWatchAsset.md
description: >-
  Hook for requesting user tracks the token in their wallet. Returns a boolean
  indicating if the token was successfully added.
---

# useWatchAsset

Hook for requesting user tracks the token in their wallet. Returns a boolean indicating if the token was successfully added.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchAsset.md","from":581,"to":619}<fsm-vh3gqscxm4e>
import { useWatchAsset } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchAsset.md","from":668,"to":1046}<fsm-vh3gqscxm4e>
import { useWatchAsset } from 'wagmi'

function App() {
  const { watchAsset } = useWatchAsset()

  return (
    <button
      onClick={() => watchAsset({
        type: 'ERC20',
        options: {
          address: '0x0000000000000000000000000000000000000000',
          symbol: 'WAGMI',
          decimals: 18,
        },
      })}
    >
      Watch asset
    </button>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchAsset.md","from":1118,"to":1171}<fsm-vh3gqscxm4e>
import { type UseWatchAssetParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchAsset.md","from":1379,"to":1555}<fsm-vh3gqscxm4e>
import { useWatchAsset } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const result = useWatchAsset({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchAsset.md","from":1674,"to":1727}<fsm-vh3gqscxm4e>
import { type UseWatchAssetReturnType } from 'wagmi'
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`watchAsset`](/core/api/actions/watchAsset)

---

---
url: /react/api/hooks/useWatchBlockNumber.md
description: Hook that watches for block number changes.
---

# useWatchBlockNumber

Hook that watches for block number changes.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlockNumber.md","from":178,"to":222}<fsm-vh3gqscxm4e>
import { useWatchBlockNumber } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlockNumber.md","from":271,"to":460}<fsm-vh3gqscxm4e>
import { useWatchBlockNumber } from 'wagmi'

function App() {
  useWatchBlockNumber({
    onBlockNumber(blockNumber) {
      console.log('Block number changed!', blockNumber)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlockNumber.md","from":532,"to":591}<fsm-vh3gqscxm4e>
import { type UseWatchBlockNumberParameters } from 'wagmi'
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to watch blocks at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlockNumber.md","from":720,"to":937}<fsm-vh3gqscxm4e>
import { useWatchBlockNumber } from 'wagmi'

function App() {
  useWatchBlockNumber({
    chainId: 1, // [!code focus]
    onBlockNumber(blockNumber) {
      console.log('New block number', blockNumber)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlockNumber.md","from":1188,"to":1435}<fsm-vh3gqscxm4e>
import { useWatchBlockNumber } from 'wagmi'
import { config } from './config'

function App() {
  useWatchBlockNumber({
    config, // [!code focus]
    onBlockNumber(blockNumber) {
      console.log('New block number', blockNumber)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### emitMissed

`boolean`

Whether or not to emit missed blocks to the callback. Defaults to `false`.

Missed blocks may occur in instances where internet connection is lost, or the block time is lesser than the polling interval of the client.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlockNumber.md","from":1762,"to":1985}<fsm-vh3gqscxm4e>
import { useWatchBlockNumber } from 'wagmi'

function App() {
  useWatchBlockNumber({
    emitMissed: true, // [!code focus]
    onBlockNumber(blockNumber) {
      console.log('New block number', blockNumber)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### emitOnBegin

`boolean`

Whether or not to emit the block to the callback when the subscription opens. Defaults to `false`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlockNumber.md","from":2195,"to":2419}<fsm-vh3gqscxm4e>
import { useWatchBlockNumber } from 'wagmi'

function App() {
  useWatchBlockNumber({
    emitOnBegin: true, // [!code focus]
    onBlockNumber(blockNumber) {
      console.log('New block number', blockNumber)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### enabled

`boolean`

Whether or not to watch for blocks. Defaults to `true`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlockNumber.md","from":2582,"to":2803}<fsm-vh3gqscxm4e>
import { useWatchBlockNumber } from 'wagmi'

function App() {
  useWatchBlockNumber({
    enabled: false, // [!code focus]
    onBlockNumber(blockNumber) {
      console.log('New block number', blockNumber)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onBlockNumber

`(block: Block, prevblock: Block | undefined) => void`

Callback for when block changes.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlockNumber.md","from":2994,"to":3229}<fsm-vh3gqscxm4e>
import { useWatchBlockNumber } from 'wagmi'

function App() {
  useWatchBlockNumber({
    onBlockNumber(blockNumber) { // [!code focus]
      console.log('New block number', blockNumber) // [!code focus]
    }, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onError

`((error: Error) => void) | undefined`

Error thrown from getting the block.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlockNumber.md","from":3402,"to":3710}<fsm-vh3gqscxm4e>
import { useWatchBlockNumber } from 'wagmi'

function App() {
  useWatchBlockNumber({
    onBlockNumber(blockNumber) { 
      console.log('New block number', blockNumber) 
    }, 
    onError(error) { // [!code focus]
      console.error('Block error', error) // [!code focus]
    }, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### poll

`boolean | undefined`

* Whether or not to use a polling mechanism to check for new blocks instead of a WebSocket subscription.
* Defaults to `false` for WebSocket Clients, and `true` for non-WebSocket Clients.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlockNumber.md","from":4014,"to":4232}<fsm-vh3gqscxm4e>
import { useWatchBlockNumber } from 'wagmi'

function App() {
  useWatchBlockNumber({
    onBlockNumber(blockNumber) { 
      console.log('New block number', blockNumber) 
    }
    poll: true, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### pollingInterval

`number | undefined`

* Polling frequency (in milliseconds).
* Defaults to the [Config's `pollingInterval` config](/core/api/createConfig#pollinginterval).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlockNumber.md","from":4492,"to":4722}<fsm-vh3gqscxm4e>
import { useWatchBlockNumber } from 'wagmi'

function App() {
  useWatchBlockNumber({
    onBlockNumber(blockNumber) { 
      console.log('New block number', blockNumber) 
    }
    pollingInterval: 1_000, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### syncConnectedChain

`boolean | undefined`

* Set up subscriber for connected chain changes.
* Defaults to [`Config['syncConnectedChain']`](/core/api/createConfig#syncconnectedchain).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlockNumber.md","from":4992,"to":5225}<fsm-vh3gqscxm4e>
import { useWatchBlockNumber } from 'wagmi'

function App() {
  useWatchBlockNumber({
    onBlockNumber(blockNumber) { 
      console.log('New block number', blockNumber) 
    }
    syncConnectedChain: false, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlockNumber.md","from":5297,"to":5356}<fsm-vh3gqscxm4e>
import { type UseWatchBlockNumberReturnType } from 'wagmi'
```

Function for cleaning up watcher.

## Action

* [`watchBlockNumber`](/core/api/actions/watchBlockNumber)

---

---
url: /solid/api/primitives/useWatchBlockNumber.md
description: Primitive for watching block number changes.
---

# useWatchBlockNumber

Primitive for watching block number changes.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useWatchBlockNumber.md","from":180,"to":231}<fsm-vh3gqscxm4e>
import { useWatchBlockNumber } from '@wagmi/solid'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useWatchBlockNumber.md","from":280,"to":629}<fsm-vh3gqscxm4e>
import { useWatchBlockNumber } from '@wagmi/solid'
import { createSignal } from 'solid-js'

function App() {
  const [blockNumber, setBlockNumber] = createSignal<bigint>()
  
  useWatchBlockNumber(() => ({
    onBlockNumber(blockNumber) {
      setBlockNumber(blockNumber)
    },
  }))
  
  return <p>Block number: {blockNumber()?.toString()}</p>
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/solid'
import { mainnet, sepolia } from '@wagmi/solid/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useWatchBlockNumber.md","from":701,"to":820}<fsm-vh3gqscxm4e>
import { useWatchBlockNumber } from '@wagmi/solid'

useWatchBlockNumber.Parameters
useWatchBlockNumber.SolidParameters
```

Parameters are passed as a getter function to maintain Solid reactivity.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useWatchBlockNumber.md","from":905,"to":1005}<fsm-vh3gqscxm4e>
useWatchBlockNumber(() => ({
  onBlockNumber(blockNumber) {
    // Handle new block number
  },
}))
```

### onBlockNumber

`(blockNumber: bigint, prevBlockNumber: bigint | undefined) => void`

Callback function called when the block number changes.

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when watching.

### config

`Config | undefined`

[`Config`](/solid/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/solid/api/WagmiProvider).

### emitMissed

`boolean | undefined`

Whether or not to emit missed block numbers to the callback. Defaults to `false`.

Missed block numbers may occur in instances where internet connection is lost, or the block time is lesser than the polling interval of the client.

### emitOnBegin

`boolean | undefined`

Whether or not to emit the current block number when the watcher starts. Defaults to `false`.

### enabled

`boolean | undefined`

Whether or not to enable the watcher. Defaults to `true`.

### onError

`((error: Error) => void) | undefined`

Error handler called when an error occurs.

### poll

`boolean | undefined`

Whether or not to use polling. Defaults to the transport's `pollingInterval`.

### pollingInterval

`number | undefined`

Polling frequency (in ms). Defaults to the transport's `pollingInterval`.

### syncConnectedChain

`boolean | undefined`

Whether or not to sync the chain with the connected chain. Defaults to `true`.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/primitives/useWatchBlockNumber.md","from":2396,"to":2479}<fsm-vh3gqscxm4e>
import { useWatchBlockNumber } from '@wagmi/solid'

useWatchBlockNumber.ReturnType
```

`void`

## Action

* [`watchBlockNumber`](/core/api/actions/watchBlockNumber)

---

---
url: /vue/api/composables/useWatchBlockNumber.md
---
# useWatchBlockNumber

Composable that watches for block number changes.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWatchBlockNumber.md","from":91,"to":140}<fsm-vh3gqscxm4e>
import { useWatchBlockNumber } from '@wagmi/vue'
```

## Usage

::: code-group

```ts [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWatchBlockNumber.md","from":188,"to":388}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useWatchBlockNumber } from '@wagmi/vue'

useWatchBlockNumber({
  onBlockNumber(blockNumber) {
    console.log('Block number changed!', blockNumber)
  },
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWatchBlockNumber.md","from":458,"to":522}<fsm-vh3gqscxm4e>
import { type UseWatchBlockNumberParameters } from '@wagmi/vue'
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to watch blocks at.

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

### emitMissed

`boolean`

Whether or not to emit missed blocks to the callback. Defaults to `false`.

Missed blocks may occur in instances where internet connection is lost, or the block time is lesser than the polling interval of the client.

### emitOnBegin

`boolean`

Whether or not to emit the block to the callback when the subscription opens. Defaults to `false`.

### enabled

`boolean`

Whether or not to watch for blocks. Defaults to `true`.

### onBlockNumber

`(block: Block, prevblock: Block | undefined) => void`

Callback for when block changes.

### onError

`((error: Error) => void) | undefined`

Error thrown from getting the block.

### poll

`boolean | undefined`

* Whether or not to use a polling mechanism to check for new blocks instead of a WebSocket subscription.
* Defaults to `false` for WebSocket Clients, and `true` for non-WebSocket Clients.

### pollingInterval

`number | undefined`

* Polling frequency (in milliseconds).
* Defaults to the [Config's `pollingInterval` config](/core/api/createConfig#pollinginterval).

### syncConnectedChain

`boolean | undefined`

* Set up subscriber for connected chain changes.
* Defaults to [`Config['syncConnectedChain']`](/core/api/createConfig#syncconnectedchain).

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWatchBlockNumber.md","from":2052,"to":2116}<fsm-vh3gqscxm4e>
import { type UseWatchBlockNumberReturnType } from '@wagmi/vue'
```

Function for cleaning up watcher.

## Action

* [`watchBlockNumber`](/core/api/actions/watchBlockNumber)

---

---
url: /react/api/hooks/useWatchBlocks.md
description: Hook that watches for block changes.
---

# useWatchBlocks

Hook that watches for block changes.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlocks.md","from":154,"to":193}<fsm-vh3gqscxm4e>
import { useWatchBlocks } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlocks.md","from":242,"to":398}<fsm-vh3gqscxm4e>
import { useWatchBlocks } from 'wagmi'

function App() {
  useWatchBlocks({
    onBlock(block) {
      console.log('New block', block.number)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlocks.md","from":470,"to":524}<fsm-vh3gqscxm4e>
import { type UseWatchBlocksParameters } from 'wagmi'
```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Block tag to watch blocks at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlocks.md","from":678,"to":875}<fsm-vh3gqscxm4e>
import { useWatchBlocks } from 'wagmi'

function App() {
  useWatchBlocks({
    blockTag: 'latest', // [!code focus]
    onBlock(block) {
      console.log('New block', block.number)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to watch blocks at.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlocks.md","from":1049,"to":1238}<fsm-vh3gqscxm4e>
import { useWatchBlocks } from 'wagmi'

function App() {
  useWatchBlocks({
    chainId: 1, // [!code focus]
    onBlock(block) {
      console.log('New block', block.number)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlocks.md","from":1489,"to":1708}<fsm-vh3gqscxm4e>
import { useWatchBlocks } from 'wagmi'
import { config } from './config'

function App() {
  useWatchBlocks({
    config, // [!code focus]
    onBlock(block) {
      console.log('New block', block.number)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### emitMissed

`boolean`

Whether or not to emit missed blocks to the callback. Defaults to `false`.

Missed blocks may occur in instances where internet connection is lost, or the block time is lesser than the polling interval of the client.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlocks.md","from":2035,"to":2230}<fsm-vh3gqscxm4e>
import { useWatchBlocks } from 'wagmi'

function App() {
  useWatchBlocks({
    emitMissed: true, // [!code focus]
    onBlock(block) {
      console.log('New block', block.number)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### emitOnBegin

`boolean`

Whether or not to emit the block to the callback when the subscription opens. Defaults to `false`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlocks.md","from":2440,"to":2636}<fsm-vh3gqscxm4e>
import { useWatchBlocks } from 'wagmi'

function App() {
  useWatchBlocks({
    emitOnBegin: true, // [!code focus]
    onBlock(block) {
      console.log('New block', block.number)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### enabled

`boolean`

Whether or not to watch for blocks. Defaults to `true`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlocks.md","from":2799,"to":2992}<fsm-vh3gqscxm4e>
import { useWatchBlocks } from 'wagmi'

function App() {
  useWatchBlocks({
    enabled: false, // [!code focus]
    onBlock(block) {
      console.log('New block', block.number)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### includeTransactions

`boolean`

Whether or not to unwrap transactions as objects (instead of hashes) in blocks. Defaults to `false`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlocks.md","from":3212,"to":3416}<fsm-vh3gqscxm4e>
import { useWatchBlocks } from 'wagmi'

function App() {
  useWatchBlocks({
    includeTransactions: true, // [!code focus]
    onBlock(block) {
      console.log('New block', block.number)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onBlock

`(block: Block, prevblock: Block | undefined) => void`

Callback for when block changes.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlocks.md","from":3601,"to":3808}<fsm-vh3gqscxm4e>
import { useWatchBlocks } from 'wagmi'

function App() {
  useWatchBlocks({
    onBlock(block) { // [!code focus]
      console.log('New block', block.number) // [!code focus]
    }, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onError

`((error: Error) => void) | undefined`

Error thrown from getting the block.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlocks.md","from":3981,"to":4261}<fsm-vh3gqscxm4e>
import { useWatchBlocks } from 'wagmi'

function App() {
  useWatchBlocks({
    onBlock(block) { 
      console.log('New block', block.number) 
    }, 
    onError(error) { // [!code focus]
      console.error('Block error', error) // [!code focus]
    }, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### poll

`boolean | undefined`

* Whether or not to use a polling mechanism to check for new blocks instead of a WebSocket subscription.
* Defaults to `false` for WebSocket Clients, and `true` for non-WebSocket Clients.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlocks.md","from":4565,"to":4755}<fsm-vh3gqscxm4e>
import { useWatchBlocks } from 'wagmi'

function App() {
  useWatchBlocks({
    onBlock(block) { 
      console.log('New block', block.number) 
    }
    poll: true, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### pollingInterval

`number | undefined`

* Polling frequency (in milliseconds).
* Defaults to the [Config's `pollingInterval` config](/core/api/createConfig#pollinginterval).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlocks.md","from":5015,"to":5217}<fsm-vh3gqscxm4e>
import { useWatchBlocks } from 'wagmi'

function App() {
  useWatchBlocks({
    onBlock(block) { 
      console.log('New block', block.number) 
    }
    pollingInterval: 1_000, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### syncConnectedChain

`boolean | undefined`

* Set up subscriber for connected chain changes.
* Defaults to [`Config['syncConnectedChain']`](/core/api/createConfig#syncconnectedchain).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlocks.md","from":5487,"to":5692}<fsm-vh3gqscxm4e>
import { useWatchBlocks } from 'wagmi'

function App() {
  useWatchBlocks({
    onBlock(block) { 
      console.log('New block', block.number) 
    }
    syncConnectedChain: false, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchBlocks.md","from":5764,"to":5818}<fsm-vh3gqscxm4e>
import { type UseWatchBlocksReturnType } from 'wagmi'
```

## Action

* [`watchBlocks`](/core/api/actions/watchBlocks)

---

---
url: /react/api/hooks/useWatchContractEvent.md
description: Hook that watches and returns emitted contract event logs.
---

# useWatchContractEvent

Hook that watches and returns emitted contract event logs.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchContractEvent.md","from":212,"to":258}<fsm-vh3gqscxm4e>
import { useWatchContractEvent } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchContractEvent.md","from":307,"to":590}<fsm-vh3gqscxm4e>
import { useWatchContractEvent } from 'wagmi'
import { abi } from './abi'

function App() {
  useWatchContractEvent({
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    abi,
    eventName: 'Transfer',
    onLogs(logs) {
      console.log('New logs!', logs)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchContractEvent.md","from":698,"to":759}<fsm-vh3gqscxm4e>
import { type UseWatchContractEventParameters } from 'wagmi'
```

### abi

`Abi`

The contract's ABI. Check out the [TypeScript docs](/react/typescript#const-assert-abis-typed-data) for how to set up ABIs for maximum type inference and safety.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchContractEvent.md","from":977,"to":1277}<fsm-vh3gqscxm4e>
import { useWatchContractEvent } from 'wagmi'
import { abi } from './abi'

function App() {
  useWatchContractEvent({
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    abi, // [!code focus]
    eventName: 'Transfer',
    onLogs(logs) {
      console.log('New logs!', logs)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### address

`Address | undefined`

The contract's address.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchContractEvent.md","from":1459,"to":1759}<fsm-vh3gqscxm4e>
import { useWatchContractEvent } from 'wagmi'
import { abi } from './abi'

function App() {
  useWatchContractEvent({
    address: '0x6b175474e89094c44da98b954eedeac495271d0f', // [!code focus]
    abi,
    eventName: 'Transfer',
    onLogs(logs) {
      console.log('New logs!', logs)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### args

`object | readonly unknown[] | undefined`

* Arguments to pass when calling the contract.
* Inferred from [`abi`](#abi) and [`eventName`](#eventname).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchContractEvent.md","from":2042,"to":2449}<fsm-vh3gqscxm4e>
import { useWatchContractEvent } from 'wagmi'
import { abi } from './abi'

function App() {
  useWatchContractEvent({
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    abi,
    args: { // [!code focus]
      to: '0xd2135CfB216b74109775236E36d4b433F1DF507B' // [!code focus]
    } // [!code focus]
    eventName: 'Transfer',
    onLogs(logs) {
      console.log('New logs!', logs)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### batch

`boolean | undefined`

* Whether or not the events should be batched on each invocation.
* Defaults to `true`.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchContractEvent.md","from":2693,"to":3011}<fsm-vh3gqscxm4e>
import { useWatchContractEvent } from 'wagmi'
import { abi } from './abi'

function App() {
  useWatchContractEvent({
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    abi,
    batch: false, // [!code focus]
    eventName: 'Transfer',
    onLogs(logs) {
      console.log('New logs!', logs)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchContractEvent.md","from":3231,"to":3547}<fsm-vh3gqscxm4e>
import { useWatchContractEvent } from 'wagmi'
import { abi } from './abi'

function App() {
  useWatchContractEvent({
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    abi,
    chainId: 1, // [!code focus]
    eventName: 'Transfer',
    onLogs(logs) {
      console.log('New logs!', logs)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchContractEvent.md","from":3837,"to":4183}<fsm-vh3gqscxm4e>
import { useWatchContractEvent } from 'wagmi'
import { abi } from './abi'
import { config } from './config'

function App() {
  useWatchContractEvent({
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    abi,
    config, // [!code focus]
    eventName: 'Transfer',
    onLogs(logs) {
      console.log('New logs!', logs)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### eventName

`string`

* Event to listen for the contract.
* Inferred from [`abi`](#abi).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchContractEvent.md","from":4397,"to":4731}<fsm-vh3gqscxm4e>
import { useWatchContractEvent } from 'wagmi'
import { abi } from './abi'
import { config } from './config'

function App() {
  useWatchContractEvent({
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    abi,
    eventName: 'Transfer', // [!code focus]
    onLogs(logs) {
      console.log('New logs!', logs)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onError

`((error: Error) => void) | undefined`

Error thrown from getting the block number.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchContractEvent.md","from":4950,"to":5345}<fsm-vh3gqscxm4e>
import { useWatchContractEvent } from 'wagmi'
import { abi } from './abi'

function App() {
  useWatchContractEvent({
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    abi,
    eventName: 'Transfer',
    onLogs(logs) {
      console.log('New logs!', logs)
    },
    onError(error) { // [!code focus]
      console.log('Error', error) // [!code focus]
    } // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onLogs

`(logs: Log[], prevLogs: Log[] | undefined) => void`

Callback for when logs changes.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchContractEvent.md","from":5565,"to":5898}<fsm-vh3gqscxm4e>
import { useWatchContractEvent } from 'wagmi'
import { abi } from './abi'

function App() {
  useWatchContractEvent({
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    abi,
    eventName: 'Transfer',
    onLogs(logs) { // [!code focus]
      console.log('New logs!', logs) // [!code focus]
    } // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### poll

`boolean | undefined`

* Whether or not to use a polling mechanism to check for new blocks instead of a WebSocket subscription.
* Defaults to `false` for WebSocket Clients, and `true` for non-WebSocket Clients.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchContractEvent.md","from":6241,"to":6556}<fsm-vh3gqscxm4e>
import { useWatchContractEvent } from 'wagmi'
import { abi } from './abi'

function App() {
  useWatchContractEvent({
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    abi,
    eventName: 'Transfer',
    onLogs(logs) {
      console.log('New logs!', logs)
    },
    poll: true // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### pollingInterval

`number | undefined`

* Polling frequency (in milliseconds).
* Defaults to the [Config's `pollingInterval` config](/core/api/createConfig#pollinginterval).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchContractEvent.md","from":6855,"to":7182}<fsm-vh3gqscxm4e>
import { useWatchContractEvent } from 'wagmi'
import { abi } from './abi'

function App() {
  useWatchContractEvent({
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    abi,
    eventName: 'Transfer',
    onLogs(logs) {
      console.log('New logs!', logs)
    },
    pollingInterval: 1_000 // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### strict

`boolean | undefined`

* Defaults to `false`.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchContractEvent.md","from":7362,"to":7679}<fsm-vh3gqscxm4e>
import { useWatchContractEvent } from 'wagmi'
import { abi } from './abi'

function App() {
  useWatchContractEvent({
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    abi,
    eventName: 'Transfer',
    onLogs(logs) {
      console.log('New logs!', logs)
    },
    strict: true // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### syncConnectedChain

`boolean | undefined`

* Set up subscriber for connected chain changes.
* Defaults to [`Config['syncConnectedChain']`](/core/api/createConfig#syncconnectedchain).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchContractEvent.md","from":7988,"to":8317}<fsm-vh3gqscxm4e>
import { useWatchContractEvent } from 'wagmi'
import { abi } from './abi'

function App() {
  useWatchContractEvent({
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    abi,
    eventName: 'Transfer',
    onLogs(logs) {
      console.log('New logs!', logs)
    },
    syncConnectedChain: true // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchContractEvent.md","from":8426,"to":8487}<fsm-vh3gqscxm4e>
import { type UseWatchContractEventReturnType } from 'wagmi'
```

Hook returns `void`

## Action

* [`watchContractEvent`](/core/api/actions/watchContractEvent)

---

---
url: /vue/api/composables/useWatchContractEvent.md
---
# useWatchContractEvent

Composable that watches and returns emitted contract event logs.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWatchContractEvent.md","from":108,"to":159}<fsm-vh3gqscxm4e>
import { useWatchContractEvent } from '@wagmi/vue'
```

## Usage

::: code-group

```ts [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWatchContractEvent.md","from":207,"to":495}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useWatchContractEvent } from '@wagmi/vue'
import { abi } from './abi'

useWatchContractEvent({
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  abi,
  eventName: 'Transfer',
  onLogs(logs) {
    console.log('New logs!', logs)
  },
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWatchContractEvent.md","from":601,"to":667}<fsm-vh3gqscxm4e>
import { type UseWatchContractEventParameters } from '@wagmi/vue'
```

### abi

`Abi`

The contract's ABI. Check out the [TypeScript docs](/vue/typescript#const-assert-abis-typed-data) for how to set up ABIs for maximum type inference and safety.

### address

`Address | undefined`

The contract's address.

### args

`object | readonly unknown[] | undefined`

* Arguments to pass when calling the contract.
* Inferred from [`abi`](#abi) and [`eventName`](#eventname).

### batch

`boolean | undefined`

* Whether or not the events should be batched on each invocation.
* Defaults to `true`.

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

### eventName

`string`

* Event to listen for the contract.
* Inferred from [`abi`](#abi).

### onError

`((error: Error) => void) | undefined`

Error thrown from getting the block number.

### onLogs

`(logs: Log[], prevLogs: Log[] | undefined) => void`

Callback for when logs changes.

### poll

`boolean | undefined`

* Whether or not to use a polling mechanism to check for new blocks instead of a WebSocket subscription.
* Defaults to `false` for WebSocket Clients, and `true` for non-WebSocket Clients.

### pollingInterval

`number | undefined`

* Polling frequency (in milliseconds).
* Defaults to the [Config's `pollingInterval` config](/core/api/createConfig#pollinginterval).

### strict

`boolean | undefined`

* Defaults to `false`.

### syncConnectedChain

`boolean | undefined`

* Set up subscriber for connected chain changes.
* Defaults to [`Config['syncConnectedChain']`](/core/api/createConfig#syncconnectedchain).

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWatchContractEvent.md","from":2422,"to":2488}<fsm-vh3gqscxm4e>
import { type UseWatchContractEventReturnType } from '@wagmi/vue'
```

Hook returns `void`

## Action

* [`watchContractEvent`](/core/api/actions/watchContractEvent)

---

---
url: /react/api/hooks/useWatchPendingTransactions.md
description: Hook that watches and returns pending transaction hashes.
---

# useWatchPendingTransactions

Hook that watches and returns pending transaction hashes.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchPendingTransactions.md","from":222,"to":274}<fsm-vh3gqscxm4e>
import { useWatchPendingTransactions } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchPendingTransactions.md","from":323,"to":527}<fsm-vh3gqscxm4e>
import { useWatchPendingTransactions } from 'wagmi'

function App() {
  useWatchPendingTransactions({
    onTransactions(transactions) {
      console.log('New transactions!', transactions)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchPendingTransactions.md","from":599,"to":666}<fsm-vh3gqscxm4e>
import { type UseWatchPendingTransactionsParameters } from 'wagmi'
```

### batch

`boolean | undefined`

* Whether or not the transactions should be batched on each invocation.
* Defaults to `true`.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchPendingTransactions.md","from":834,"to":1071}<fsm-vh3gqscxm4e>
import { useWatchPendingTransactions } from 'wagmi'

function App() {
  useWatchPendingTransactions({
    batch: true // [!code focus]
    onTransactions(transactions) {
      console.log('New transactions!', transactions)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchPendingTransactions.md","from":1255,"to":1491}<fsm-vh3gqscxm4e>
import { useWatchPendingTransactions } from 'wagmi'

function App() {
  useWatchPendingTransactions({
    chainId: 1 // [!code focus]
    onTransactions(transactions) {
      console.log('New transactions!', transactions)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchPendingTransactions.md","from":1745,"to":2011}<fsm-vh3gqscxm4e>
import { useWatchPendingTransactions } from 'wagmi'
import { config } from './config'

function App() {
  useWatchPendingTransactions({
    config // [!code focus]
    onTransactions(transactions) {
      console.log('New transactions!', transactions)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onError

`((error: Error) => void) | undefined`

Error thrown from watching pending transactions.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchPendingTransactions.md","from":2199,"to":2516}<fsm-vh3gqscxm4e>
import { useWatchPendingTransactions } from 'wagmi'

function App() {
  useWatchPendingTransactions({
    onError(error) { // [!code focus]
      console.log('Error', error) // [!code focus]
    }, // [!code focus]
    onTransactions(transactions) {
      console.log('New transactions!', transactions)
    },
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onTransactions

`(transactions: Hash[], prevTransactions: Hash[] | undefined) => void`

Callback when new incoming pending transactions are detected.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchPendingTransactions.md","from":2756,"to":3011}<fsm-vh3gqscxm4e>
import { useWatchPendingTransactions } from 'wagmi'

function App() {
  useWatchPendingTransactions({
    onTransactions(transactions) { // [!code focus]
      console.log('New transactions!', transactions) // [!code focus]
    }, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### poll

`boolean | undefined`

* Whether or not to use a polling mechanism to check for new pending transactions instead of a WebSocket subscription.
* Defaults to `false` for WebSocket Clients, and `true` for non-WebSocket Clients.

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchPendingTransactions.md","from":3332,"to":3569}<fsm-vh3gqscxm4e>
import { useWatchPendingTransactions } from 'wagmi'

function App() {
  useWatchPendingTransactions({
    onTransactions(transactions) {
      console.log('New transactions!', transactions)
    },
    poll: true, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### pollingInterval

`number | undefined`

* Polling frequency (in milliseconds).
* Defaults to the [Config's `pollingInterval` config](/core/api/createConfig#pollinginterval).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchPendingTransactions.md","from":3832,"to":4081}<fsm-vh3gqscxm4e>
import { useWatchPendingTransactions } from 'wagmi'

function App() {
  useWatchPendingTransactions({
    onTransactions(transactions) {
      console.log('New transactions!', transactions)
    },
    pollingInterval: 1_000, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### syncConnectedChain

`boolean | undefined`

* Set up subscriber for connected chain changes.
* Defaults to [`Config['syncConnectedChain']`](/core/api/createConfig#syncconnectedchain).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchPendingTransactions.md","from":4354,"to":4606}<fsm-vh3gqscxm4e>
import { useWatchPendingTransactions } from 'wagmi'

function App() {
  useWatchPendingTransactions({
    onTransactions(transactions) {
      console.log('New transactions!', transactions)
    },
    syncConnectedChain: false, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWatchPendingTransactions.md","from":4679,"to":4746}<fsm-vh3gqscxm4e>
import { type UseWatchPendingTransactionsReturnType } from 'wagmi'
```

## Action

* [`watchPendingTransactions`](/core/api/actions/watchPendingTransactions)

---

---
url: /react/api/hooks/useWriteContract.md
description: Action for executing a write function on a contract.
---

# useWriteContract

Action for executing a write function on a contract.

A "write" function on a Solidity contract modifies the state of the blockchain. These types of functions require gas to be executed, hence a transaction is broadcasted in order to change the state.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWriteContract.md","from":666,"to":707}<fsm-vh3gqscxm4e>
import { useWriteContract } from 'wagmi'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWriteContract.md","from":757,"to":1309}<fsm-vh3gqscxm4e>
import { useWriteContract } from 'wagmi'
import { abi } from './abi'

function App() {
  const writeContract = useWriteContract()
  return (
    <button 
      onClick={() => 
        writeContract.mutate({ 
          abi,
          address: '0x6b175474e89094c44da98b954eedeac495271d0f',
          functionName: 'transferFrom',
          args: [
            '0xd2135CfB216b74109775236E36d4b433F1DF507B',
            '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
            123n,
          ],
       })
      }
    >
      Transfer
    </button>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### Synchronous Usage

If you want to wait for the transaction to be included in a block, you can use `useWriteContractSync`:

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWriteContract.md","from":1559,"to":2127}<fsm-vh3gqscxm4e>
import { useWriteContractSync } from 'wagmi'
import { abi } from './abi'

function App() {
  const writeContractSync = useWriteContractSync()
  return (
    <button 
      onClick={() => 
        writeContractSync.mutate({ 
          abi,
          address: '0x6b175474e89094c44da98b954eedeac495271d0f',
          functionName: 'transferFrom',
          args: [
            '0xd2135CfB216b74109775236E36d4b433F1DF507B',
            '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
            123n,
          ],
       })
      }
    >
      Transfer
    </button>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWriteContract.md","from":2328,"to":2384}<fsm-vh3gqscxm4e>
import { type UseWriteContractParameters } from 'wagmi'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWriteContract.md","from":2593,"to":2782}<fsm-vh3gqscxm4e>
import { useWriteContract } from 'wagmi'
import { config } from './config' // [!code focus]

function App() {
  const writeContract = useWriteContract({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWriteContract.md","from":2902,"to":2958}<fsm-vh3gqscxm4e>
import { type UseWriteContractReturnType } from 'wagmi'
```

The return type's [`data`](#data) property is inferrable via the combination of [`abi`](#abi), [`functionName`](#functionname), and [`args`](#args). Check out the [TypeScript docs](/react/typescript#const-assert-abis-typed-data) for more info.

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## Type Inference

With [`abi`](/core/api/actions/writeContract#abi) setup correctly, TypeScript will infer the correct types for [`functionName`](/core/api/actions/writeContract#functionname), [`args`](/core/api/actions/writeContract#args), and the [`value`](/core/api/actions/writeContract##value). See the Wagmi [TypeScript docs](/react/typescript) for more information.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`writeContract`](/core/api/actions/writeContract)

---

---
url: /vue/api/composables/useWriteContract.md
description: Composable for executing a write function on a contract.
---

# useWriteContract

Composable for executing a write function on a contract.

A "write" function on a Solidity contract modifies the state of the blockchain. These types of functions require gas to be executed, hence a transaction is broadcasted in order to change the state.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWriteContract.md","from":679,"to":725}<fsm-vh3gqscxm4e>
import { useWriteContract } from '@wagmi/vue'
```

## Usage

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWriteContract.md","from":775,"to":1261}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useWriteContract } from '@wagmi/vue'
import { abi } from './abi'

const writeContract = useWriteContract()
</script>

<template>
  <button @click="writeContract.mutate({ 
    abi,
    address: '0x6b175474e89094c44da98b954eedeac495271d0f',
    functionName: 'transferFrom',
    args: [
      '0xd2135CfB216b74109775236E36d4b433F1DF507B',
      '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
      123n,
    ],
  })">
    Transfer
  </button>
</template>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWriteContract.md","from":1460,"to":1521}<fsm-vh3gqscxm4e>
import { type UseWriteContractParameters } from '@wagmi/vue'
```

### config

`Config | undefined`

[`Config`](/vue/api/createConfig#config) to use instead of retrieving from the [`WagmiPlugin`](/vue/api/WagmiPlugin).

::: code-group

```vue [index.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWriteContract.md","from":1714,"to":1918}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useWriteContract } from '@wagmi/vue'
import { config } from './config' // [!code focus]

const writeContract = useWriteContract({
  config, // [!code focus]
})
</script>
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/composables/useWriteContract.md","from":2036,"to":2097}<fsm-vh3gqscxm4e>
import { type UseWriteContractReturnType } from '@wagmi/vue'
```

The return type's [`data`](#data) property is inferrable via the combination of [`abi`](#abi), [`functionName`](#functionname), and [`args`](#args). Check out the [TypeScript docs](/vue/typescript#const-assert-abis-typed-data) for more info.

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## Type Inference

With [`abi`](/core/api/actions/writeContract#abi) setup correctly, TypeScript will infer the correct types for [`functionName`](/core/api/actions/writeContract#functionname), [`args`](/core/api/actions/writeContract#args), and the [`value`](/core/api/actions/writeContract##value). See the Wagmi [TypeScript docs](/vue/typescript) for more information.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`writeContract`](/core/api/actions/writeContract)

---

---
url: /react/api/hooks/useWriteContracts.md
description: >-
  Hook that requests for the wallet to sign and broadcast a batch of calls
  (transactions) to the network.
---

# useWriteContracts

Hook that requests for the wallet to sign and broadcast a batch of write contract calls (transactions) to the network.

[Read more.](https://github.com/ethereum/EIPs/blob/815028dc634463e1716fc5ce44c019a6040f0bef/EIPS/eip-5792.md#wallet_sendcalls)

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWriteContracts.md","from":728,"to":783}<fsm-vh3gqscxm4e>
import { useWriteContracts } from 'wagmi/experimental'
```

## Usage

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWriteContracts.md","from":832,"to":1929}<fsm-vh3gqscxm4e>
import { useWriteContracts } from 'wagmi/experimental'
import { parseAbi } from 'viem'

const abi = parseAbi([
  'function approve(address, uint256) returns (bool)',
  'function transferFrom(address, address, uint256) returns (bool)',
])

function App() {
  const { writeContracts } = useWriteContracts()

  return (
    <button
      onClick={() =>
        writeContracts({
          contracts: [
            {
              address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
              abi,
              functionName: 'approve',
              args: [
                '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC', 
                100n
              ],
            },
            {
              address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
              abi,
              functionName: 'transferFrom',
              args: [
                '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
                '0x0000000000000000000000000000000000000000',
                100n
              ],
            },
          ],
        })
      }
    >
      Send calls
    </button>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWriteContracts.md","from":2001,"to":2071}<fsm-vh3gqscxm4e>
import { type UseWriteContractsParameters } from 'wagmi/experimental'
```

### config

`Config | undefined`

[`Config`](/react/api/createConfig#config) to use instead of retrieving from the nearest [`WagmiProvider`](/react/api/WagmiProvider).

::: code-group

```tsx [index.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWriteContracts.md","from":2279,"to":2476}<fsm-vh3gqscxm4e>
import { useWriteContracts } from 'wagmi/experimental'
import { config } from './config' // [!code focus]

function App() {
  const result = useWriteContracts({
    config, // [!code focus]
  })
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### mutation

TanStack Query parameters. See the [TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation) for more info.

::: info Wagmi does not support passing all TanStack Query parameters
TanStack Query parameters, like `mutationFn` and `mutationKey`, are used internally to make Wagmi work and you cannot override them. Check out the [source](https://github.com/wevm/wagmi/blob/main/packages/react/src/utils/query.ts#L30) to see what parameters are not supported. All parameters listed below are supported.
:::

#### gcTime

`number | Infinity | undefined`

* The time in milliseconds that unused/inactive cache data remains in memory. When a mutation's cache becomes unused or inactive, that cache data will be garbage collected after this duration. When different cache times are specified, the longest one will be used.
* If set to `Infinity`, will disable garbage collection

#### meta

`Record<string, unknown> | undefined`

If set, stores additional information on the mutation cache entry that can be used as needed. It will be accessible wherever [`{{mutate}}`](#mutate) is available (e.g. [`onError`](#onerror), [`onSuccess`](#onsuccess) functions).

#### networkMode

`'online' | 'always' | 'offlineFirst' | undefined`

* defaults to `'online'`
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

#### onError

`((error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire if the mutation encounters an error and will be passed the error.

#### onMutate

`((variables: {{TVariables}}) => Promise<context | void> | context | void) | undefined`

* This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
* Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
* The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.

#### onSuccess

`((data: {{TData}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is successful and will be passed the mutation's result.

#### onSettled

`((data: {{TData}}, error: {{TError}}, variables: {{TVariables}}, context?: context | undefined) => Promise<unknown> | unknown) | undefined`

This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error

#### queryClient

`QueryClient`

Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used.

#### retry

`boolean | number | ((failureCount: number, error: {{TError}}) => boolean) | undefined`

* Defaults to `0`.
* If `false`, failed mutations will not retry.
* If `true`, failed mutations will retry infinitely.
* If set to an `number`, e.g. `3`, failed mutations will retry until the failed mutations count meets that number.

#### retryDelay

`number | ((retryAttempt: number, error: {{TError}}) => number) | undefined`

* This function receives a `retryAttempt` integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.
* A function like `attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000)` applies exponential backoff.
* A function like `attempt => attempt * 1000` applies linear backoff.

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/hooks/useWriteContracts.md","from":2595,"to":2665}<fsm-vh3gqscxm4e>
import { type UseWriteContractsReturnType } from 'wagmi/experimental'
```

***

[TanStack Query mutation docs](https://tanstack.com/query/v5/docs/react/reference/useMutation)

### mutate

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => void`

The mutation function you can call with variables to trigger the mutation and optionally hooks on additional callback options.

* #### variables

  `{{TVariables}}`

  The variables object to pass to the `{{mutate}}` action.

* #### onSuccess

  `(data: {{TData}}, variables: {{TVariables}}, context: TContext) => void`

  This function will fire when the mutation is successful and will be passed the mutation's result.

* #### onError

  `(error: {{TError}}, variables: {{TVariables}}, context: TContext | undefined) => void`

  This function will fire if the mutation encounters an error and will be passed the error.

* #### onSettled

  `(data: {{TData}} | undefined, error: {{TError}} | null, variables: {{TVariables}}, context: TContext | undefined) => void`

  * This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
  * If you make multiple requests, `onSuccess` will fire only after the latest call you've made.

### mutateAsync

`(variables: {{TVariables}}, { onSuccess, onSettled, onError }) => Promise<{{TData}}>`

Similar to [`mutate`](#mutate) but returns a promise which can be awaited.

### data

`{{TData}} | undefined`

* `{{mutate}}` return type
* Defaults to `undefined`
* The last successfully resolved data for the mutation.

### error

`{{TError}} | null`

The error object for the mutation, if an error was encountered.

### failureCount

`number`

* The failure count for the mutation.
* Incremented every time the mutation fails.
* Reset to `0` when the mutation succeeds.

### failureReason

`{{TError}} | null`

* The failure reason for the mutation retry.
* Reset to `null` when the mutation succeeds.

### isError / isIdle / isPending / isSuccess

`boolean`

Boolean variables derived from [`status`](#status).

### isPaused

`boolean`

* will be `true` if the mutation has been `paused`.
* see [Network Mode](https://tanstack.com/query/v5/docs/react/guides/network-mode) for more information.

### reset

`() => void`

A function to clean the mutation internal state (e.g. it resets the mutation to its initial state).

### status

`'idle' | 'pending' | 'error' | 'success'`

* `'idle'` initial status prior to the mutation function executing.
* `'pending'` if the mutation is currently executing.
* `'error'` if the last mutation attempt resulted in an error.
* `'success'` if the last mutation attempt was successful.

### submittedAt

`number`

* The timestamp for when the mutation was submitted.
* Defaults to `0`.

### variables

`{{TVariables}} | undefined`

* The variables object passed to [`mutate`](#mutate).
* Defaults to `undefined`.

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Action

* [`writeContracts`](/core/api/actions/writeContracts)

---

---
url: /core/api/actions/verifyMessage.md
---
# verifyMessage

Action for verify that a message was signed by the provided address. It supports verifying messages that were signed by either a Smart Contract Account or Externally Owned Account.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyMessage.md","from":344,"to":388}<fsm-vh3gqscxm4e>
import { verifyMessage } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyMessage.md","from":435,"to":779}<fsm-vh3gqscxm4e>
import { verifyMessage } from '@wagmi/core'
import { config } from './config'

await verifyMessage(config, {
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  message: 'hello world',
  signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyMessage.md","from":850,"to":909}<fsm-vh3gqscxm4e>
import { type VerifyMessageParameters } from '@wagmi/core'
```

### address

`Address`

The Ethereum address that signed the original message.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyMessage.md","from":1026,"to":1387}<fsm-vh3gqscxm4e>
import { verifyMessage } from '@wagmi/core'
import { config } from './config'

await verifyMessage(config, {
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', // [!code focus]
  message: 'hello world',
  signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### message

`string | { raw: Hex | ByteArray }`

The message to be verified.

By default, wagmi verifies the UTF-8 representation of the message.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyMessage.md","from":1617,"to":1978}<fsm-vh3gqscxm4e>
import { verifyMessage } from '@wagmi/core'
import { config } from './config'

await verifyMessage(config, {
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  message: 'hello world', // [!code focus]
  signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::: tip
By default, viem signs the UTF-8 representation of the message. To sign the data representation of the message, you can use the `raw` attribute.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyMessage.md","from":2188,"to":2570}<fsm-vh3gqscxm4e>
import { verifyMessage } from '@wagmi/core'
import { config } from './config'

await verifyMessage(config, {
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  message: { raw: '0x68656c6c6f20776f726c64' } // [!code focus]
  signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})
```

:::

### signature

`Hex | ByteArray `

The signature that was generated by signing the message with the address's signer.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyMessage.md","from":2730,"to":3091}<fsm-vh3gqscxm4e>
import { verifyMessage } from '@wagmi/core'
import { config } from './config'

await verifyMessage(config, {
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  message: 'hello world',
  signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

Only used when verifying a message that was signed by a Smart Contract Account. The ID of chain to check if the contract was already deployed.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyMessage.md","from":3376,"to":3805}<fsm-vh3gqscxm4e>
import { verifyMessage } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

await verifyMessage(config, {
  chainId: mainnet.id, // [!code focus]
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  message: 'hello world',
  signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`bigint | undefined`

Only used when verifying a message that was signed by a Smart Contract Account. The block number to check if the contract was already deployed.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyMessage.md","from":4071,"to":4458}<fsm-vh3gqscxm4e>
import { verifyMessage } from '@wagmi/core'
import { config } from './config'

await verifyMessage(config, {
  blockNumber: 12345678n, // [!code focus]
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  message: 'hello world',
  signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Only used when verifying a message that was signed by a Smart Contract Account. The block tag to check if the contract was already deployed.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyMessage.md","from":4768,"to":5151}<fsm-vh3gqscxm4e>
import { verifyMessage } from '@wagmi/core'
import { config } from './config'

await verifyMessage(config, {
  blockTag: 'latest', // [!code focus]
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  message: 'hello world',
  signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyMessage.md","from":5223,"to":5282}<fsm-vh3gqscxm4e>
import { type VerifyMessageReturnType } from '@wagmi/core'
```

`boolean`

Whether the signed message is valid for the given address.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyMessage.md","from":5374,"to":5432}<fsm-vh3gqscxm4e>
import { type VerifyMessageErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Viem

* [`verifyMessage`](https://viem.sh/docs/actions/public/verifyMessage)

---

---
url: /core/api/actions/verifyTypedData.md
---
# verifyTypedData

Action for verify that a typed data was signed by the provided address. It supports verifying typed data that were signed by either a Smart Contract Account or Externally Owned Account.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":355,"to":401}<fsm-vh3gqscxm4e>
import { verifyTypedData } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":448,"to":1114}<fsm-vh3gqscxm4e>
import { verifyTypedData } from '@wagmi/core'
import { domain, types } from './data'
import { config } from './config'

const valid = await verifyTypedData(config, {
  domain,
  types,
  message: {
    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
  primaryType: 'Mail',
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})
// true
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":1134,"to":1635}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const

// The named list of all type definitions
export const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":1706,"to":1767}<fsm-vh3gqscxm4e>
import { type VerifyTypedDataParameters } from '@wagmi/core'
```

### address

`Address`

The Ethereum address that signed the original typed data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":1887,"to":2570}<fsm-vh3gqscxm4e>
import { verifyTypedData } from '@wagmi/core'
import { domain, types } from './data'
import { config } from './config'

const valid = await verifyTypedData(config, {
  domain,
  types,
  message: {
    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
  primaryType: 'Mail',
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', // [!code focus]
  signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})
// true
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":2590,"to":3091}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const

// The named list of all type definitions
export const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### domain

`TypedDataDomain`

The typed data domain.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":3228,"to":4039}<fsm-vh3gqscxm4e>
import { verifyTypedData } from '@wagmi/core'
import { types } from './data'
import { config } from './config'

const valid = await verifyTypedData(config, {
  domain: { // [!code focus:6]
    name: 'Ether Mail',
    version: '1',
    chainId: 1,
    verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
  },
  types,
  message: {
    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
  primaryType: 'Mail',
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})
// true
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":4059,"to":4362}<fsm-vh3gqscxm4e>
// The named list of all type definitions
export const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### types

The type definitions for the typed data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":4497,"to":5187}<fsm-vh3gqscxm4e>
import { verifyTypedData } from '@wagmi/core'
import { domain } from './data'
import { config } from './config'

const valid = await verifyTypedData(config, {
  domain,
  types: { // [!code focus:11]
    Person: [
      { name: 'name', type: 'string' },
      { name: 'wallet', type: 'address' },
    ],
    Mail: [
      { name: 'from', type: 'Person' },
      { name: 'to', type: 'Person' },
      { name: 'contents', type: 'string' },
    ],
  },
  primaryType: 'Mail',
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})
// true
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":5207,"to":5404}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### primaryType

`string`

The primary `type` to extract from types and use in `value`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":5575,"to":6522}<fsm-vh3gqscxm4e>
import { verifyTypedData } from '@wagmi/core'
import { domain } from './data'
import { config } from './config'

const valid = await verifyTypedData(config, {
  domain,
  types: {
    Person: [
      { name: 'name', type: 'string' },
      { name: 'wallet', type: 'address' },
    ],
    Mail: [ // [!code focus:5]
      { name: 'from', type: 'Person' },
      { name: 'to', type: 'Person' },
      { name: 'contents', type: 'string' },
    ],
  },
  message: {
    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
  primaryType: 'Mail', // [!code focus]
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})
// true
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":6542,"to":6739}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### message

Type inferred from `types` & `primaryType`.

The message to be verified.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":6908,"to":7594}<fsm-vh3gqscxm4e>
import { verifyTypedData } from '@wagmi/core'
import { domain, types } from './data'
import { config } from './config'

const valid = await verifyTypedData(config, {
  domain,
  types,
  message: { // [!code focus:11]
    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
  primaryType: 'Mail',
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})
// true
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":7614,"to":8115}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const

// The named list of all type definitions
export const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### signature

`Hex | ByteArray`

The signature that was generated by signing the typed data with the address's signer.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":8318,"to":9003}<fsm-vh3gqscxm4e>
import { verifyTypedData } from '@wagmi/core'
import { domain, types } from './data'
import { config } from './config'

const valid = await verifyTypedData(config, {
  domain,
  types,
  message: {
    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },  
  primaryType: 'Mail',
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c', // [!code focus]
})
// true
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":9023,"to":9524}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const

// The named list of all type definitions
export const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

Only used when verifying a typed data that was signed by a Smart Contract Account. The ID of chain to check if the contract was already deployed.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":9812,"to":10563}<fsm-vh3gqscxm4e>
import { verifyTypedData } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { domain, types } from './data'
import { config } from './config'

const valid = await verifyTypedData(config, {
  chainId: mainnet.id, // [!code focus]
  domain,
  types,
  message: {
    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
  primaryType: 'Mail',
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})
// true
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":10583,"to":11084}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const

// The named list of all type definitions
export const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockNumber

`bigint | undefined`

Only used when verifying a typed data that was signed by a Smart Contract Account. The block number to check if the contract was already deployed.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":11353,"to":12062}<fsm-vh3gqscxm4e>
import { verifyTypedData } from '@wagmi/core'
import { domain, types } from './data'
import { config } from './config'

const valid = await verifyTypedData(config, {
  blockNumber: 12345678n, // [!code focus]
  domain,
  types,
  message: {
    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
  primaryType: 'Mail',
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})
// true
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":12082,"to":12583}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const

// The named list of all type definitions
export const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized' | undefined`

Only used when verifying a typed data that was signed by a Smart Contract Account. The block number to check if the contract was already deployed.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":12899,"to":13604}<fsm-vh3gqscxm4e>
import { verifyTypedData } from '@wagmi/core'
import { domain, types } from './data'
import { config } from './config'

const valid = await verifyTypedData(config, {
  blockTag: 'latest', // [!code focus]
  domain,
  types,
  message: {
    from: {
      name: 'Cow',
      wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
    },
    to: {
      name: 'Bob',
      wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
    },
    contents: 'Hello, Bob!',
  },
  primaryType: 'Mail',
  address: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  signature: '0x66edc32e2ab001213321ab7d959a2207fcef5190cc9abb6da5b0d2a8a9af2d4d2b0700e2c317c4106f337fd934fbbb0bf62efc8811a78603b33a8265d3b8f8cb1c',
})
// true
```

```ts [data.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":13624,"to":14125}<fsm-vh3gqscxm4e>
// All properties on a domain are optional
export const domain = {
  name: 'Ether Mail',
  version: '1',
  chainId: 1,
  verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC',
} as const

// The named list of all type definitions
export const types = {
  Person: [
    { name: 'name', type: 'string' },
    { name: 'wallet', type: 'address' },
  ],
  Mail: [
    { name: 'from', type: 'Person' },
    { name: 'to', type: 'Person' },
    { name: 'contents', type: 'string' },
  ],
} as const
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":14197,"to":14258}<fsm-vh3gqscxm4e>
import { type VerifyTypedDataReturnType } from '@wagmi/core'
```

`boolean`

Whether the signed message is valid for the given address.

## Type Inference

With [`types`](#types) setup correctly, TypeScript will infer the correct types for [`domain`](#domain), [`message`](#message), and [`primaryType`](#primarytype). See the Wagmi [TypeScript docs](/core/typescript) for more information.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/verifyTypedData.md","from":14605,"to":14665}<fsm-vh3gqscxm4e>
import { type VerifyTypedDataErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Viem

* [`verifyTypedData`](https://viem.sh/docs/actions/public/verifyTypedData)

---

---
url: /core/guides/viem.md
---
# Viem

[Viem](https://viem.sh) is a low-level TypeScript Interface for Ethereum that enables developers to interact with the Ethereum blockchain, including: JSON-RPC API abstractions, Smart Contract interaction, wallet & signing implementations, coding/parsing utilities and more.

**Wagmi Core** is essentially a wrapper over **Viem** that provides multi-chain functionality via [Wagmi Config](/core/api/createConfig) and automatic account management via [Connectors](/core/api/connectors).

## Leveraging Viem Actions

All of the core [Wagmi Actions](/core/api/actions) are friendly wrappers around [Viem Actions](https://viem.sh/docs/actions/public/introduction) that inject a multi-chain and connector aware [Wagmi Config](/core/api/createConfig).

There may be cases where you might want to dig deeper and utilize Viem Actions directly (maybe an Action doesn't exist in Wagmi yet). In these cases, you can import Viem Actions directly via `viem/actions` and plug in a Viem Client returned by the [`getClient` Action](/core/api/actions/getClient).

The example below demonstrates two different ways to utilize Viem Actions:

1. **Tree-shakable Actions (recommended):** Uses `getClient` (for public actions) and `getConnectorClient` (for wallet actions).
2. **Client Actions:** Uses `getPublicClient` (for public actions) and  `getWalletClient` (for wallet actions).

::: tip

It is highly recommended to use the **tree-shakable** method to ensure that you are only pulling modules you use, and keep your bundle size low.

:::

::: code-group

```tsx [Tree-shakable Actions]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/viem.md","from":1579,"to":2411}<fsm-vh3gqscxm4e>
// 1. Import modules. 
import { http, createConfig, getClient, getConnectorClient } from '@wagmi/core' 
import { base, mainnet, optimism, zora } from '@wagmi/core/chains' 
import { getLogs, watchAsset } from 'viem/actions' // [!code hl]

// 2. Set up a Wagmi Config 
export const config = createConfig({ 
  chains: [base, mainnet, optimism, zora], 
  transports: { 
    [base.id]: http(), 
    [mainnet.id]: http(), 
    [optimism.id]: http(), 
    [zora.id]: http(), 
  }, 
}) 

// 3. Extract a Viem Client for the current active chain.
const publicClient = getClient(config)
const logs = await getLogs(publicClient, /* ... */) // [!code hl]

// 4. Extract a Viem Client for the current active chain & account.
const walletClient = getConnectorClient(config)
const success = await watchAsset(walletClient, /* ... */) // [!code hl]
```

```tsx [Client Actions]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/viem.md","from":2440,"to":3253}<fsm-vh3gqscxm4e>
// 1. Import modules. 
import { http, createConfig, getPublicClient, getWalletClient } from '@wagmi/core' 
import { base, mainnet, optimism, zora } from '@wagmi/core/chains' 

// 2. Set up a Wagmi Config 
export const config = createConfig({ 
  chains: [base, mainnet, optimism, zora], 
  transports: { 
    [base.id]: http(), 
    [mainnet.id]: http(), 
    [optimism.id]: http(), 
    [zora.id]: http(), 
  }, 
}) 

// 3. Extract a Viem Public Client for the current active chain.
const publicClient = getPublicClient(config)
const logs = await publicClient.getLogs(publicClient, /* ... */) // [!code hl]

// 4. Extract a Viem Wallet Client for the current active chain & account.
const walletClient = getWalletClient(config)
const success = await walletClient.watchAsset(walletClient, /* ... */) // [!code hl]
```

:::

## Multi-chain Viem Client

The [Viem Client](https://viem.sh/docs/clients/intro) provides an interface to interact with an JSON-RPC Provider. By nature, JSON-RPC Providers are single-chain, so the Viem Client is designed to be instantiated with a single `chain`. As a result, setting up Viem to be multi-chain aware can get a bit verbose.

The good news is that you can create a **"multi-chain Viem Client"** with **Wagmi** by utilizing [`createConfig`](/core/api/createConfig) and [`getClient`](/core/api/actions/getClient).

::: code-group

```tsx [Wagmi Usage]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/viem.md","from":3828,"to":4677}<fsm-vh3gqscxm4e>
// 1. Import modules. 
import { http, createConfig, getClient, getConnectorClient } from '@wagmi/core' 
import { base, mainnet, optimism, zora } from '@wagmi/core/chains' 
import { getBlockNumber, sendTransaction } from 'viem/actions' // [!code hl]

// 2. Set up a Wagmi Config 
export const config = createConfig({ 
  chains: [base, mainnet, optimism, zora], 
  transports: { 
    [base.id]: http(), 
    [mainnet.id]: http(), 
    [optimism.id]: http(), 
    [zora.id]: http(), 
  }, 
}) 

// 3. Extract a Viem Client for the current active chain.
const publicClient = getClient(config)
const blockNumber = await getBlockNumber(publicClient) // [!code hl]

// 4. Extract a Viem Client for the current active chain & account.
const walletClient = getConnectorClient(config)
const hash = await sendTransaction(walletClient, /* ... */) // [!code hl]
```

```tsx [Viem Usage]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/viem.md","from":4702,"to":5851}<fsm-vh3gqscxm4e>
// Manually set up Viem Clients without wagmi. Don't do this, it's only here 
// to demonstrate the amount of boilerplate required.

import { createPublicClient, createWalletClient, http } from 'viem'
import { base, mainnet, optimism, zora } from 'viem/chains'

const publicClient = {
  base: createPublicClient({
    chain: base,
    transport: http()
  }),
  mainnet: createPublicClient({
    chain: mainnet,
    transport: http()
  }),
  optimism: createPublicClient({
    chain: optimism,
    transport: http()
  }),
  zora: createPublicClient({
    chain: zora,
    transport: http()
  })
} as const

const walletClient = {
  base: createWalletClient({
    chain: base,
    transport: custom(window.ethereum)
  }),
  mainnet: createWalletClient({
    chain: mainnet,
    transport: custom(window.ethereum)
  }),
  optimism: createWalletClient({
    chain: optimism,
    transport: custom(window.ethereum)
  }),
  zora: createWalletClient({
    chain: zora,
    transport: custom(window.ethereum)
  })
} as const

const blockNumber = await publicClient.mainnet.getBlockNumber()
const hash = await walletClient.mainnet.sendTransaction(/* ... */)
```

:::

## Private Key & Mnemonic Accounts

It is possible to utilize Viem's [Private Key & Mnemonic Accounts](https://viem.sh/docs/accounts/local) with Wagmi by explicitly passing through the account via the `account` argument on Wagmi Actions.

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/guides/viem.md","from":6107,"to":6749}<fsm-vh3gqscxm4e>
import { http, createConfig, sendTransaction } from '@wagmi/core' 
import { base, mainnet, optimism, zora } from '@wagmi/core/chains' 
import { parseEther } from 'viem'
import { privateKeyToAccount } from 'viem/accounts'

export const config = createConfig({ 
  chains: [base, mainnet, optimism, zora], 
  transports: { 
    [base.id]: http(), 
    [mainnet.id]: http(), 
    [optimism.id]: http(), 
    [zora.id]: http(), 
  }, 
}) 

const account = privateKeyToAccount('0x...') // [!code hl]

const hash = await sendTransaction({ 
  account, // [!code hl]
  to: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
  value: parseEther('0.001')
})
```

::: info

Wagmi currently does not support hoisting Private Key & Mnemonic Accounts to the top-level Wagmi Config – meaning you have to explicitly pass through the account to every Action. If you feel like this is a feature that should be added, please [open a discussion](https://github.com/wevm/wagmi/discussions/new?category=ideas).

:::

---

---
url: /react/guides/viem.md
---
# Viem

[Viem](https://viem.sh) is a low-level TypeScript Interface for Ethereum that enables developers to interact with the Ethereum blockchain, including: JSON-RPC API abstractions, Smart Contract interaction, wallet & signing implementations, coding/parsing utilities and more.

**Wagmi Core** is essentially a wrapper over **Viem** that provides multi-chain functionality via [Wagmi Config](/react/api/createConfig) and automatic account management via [Connectors](/react/api/connectors).

## Leveraging Viem Actions

All of the core [Wagmi Hooks](/react/api/actions) are friendly wrappers around [Viem Actions](https://viem.sh/docs/actions/public/introduction) that inject a multi-chain and connector aware [Wagmi Config](/react/api/createConfig).

There may be cases where you might want to dig deeper and utilize Viem Actions directly (maybe a Hook doesn't exist in Wagmi yet). In these cases, you can create your own custom Wagmi Hook by importing Viem Actions directly via `viem/actions` and plugging in a Viem Client returned by the [`useClient` Hook](/react/api/hooks/useClient).

The example below demonstrates two different ways to utilize Viem Actions:

1. **Tree-shakable Actions (recommended):** Uses `useClient` (for public actions) and `useConnectorClient` (for wallet actions).
2. **Client Actions:** Uses `usePublicClient` (for public actions) and  `useWalletClient` (for wallet actions).

::: tip

It is highly recommended to use the **tree-shakable** method to ensure that you are only pulling modules you use, and keep your bundle size low.

:::

::: code-group

```tsx [Tree-shakable Actions]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/viem.md","from":1619,"to":3002}<fsm-vh3gqscxm4e>
// 1. Import modules. 
import { useMutation, useQuery } from '@tanstack/react-query'
import { http, createConfig, useClient, useConnectorClient } from 'wagmi' 
import { base, mainnet, optimism, zora } from 'wagmi/chains' 
import { getLogs, watchAsset } from 'viem/actions'

// 2. Set up a Wagmi Config 
export const config = createConfig({ 
  chains: [base, mainnet, optimism, zora], 
  transports: { 
    [base.id]: http(), 
    [mainnet.id]: http(), 
    [optimism.id]: http(), 
    [zora.id]: http(), 
  }, 
}) 

function Example() {
  // 3. Extract a Viem Client for the current active chain. // [!code hl]
  const publicClient = useClient({ config }) // [!code hl]

  // 4. Create a "custom" Query Hook that utilizes the Client. // [!code hl]
  const { data: logs } = useQuery({ // [!code hl]
    queryKey: ['logs', publicClient.uid], // [!code hl]
    queryFn: () => getLogs(publicClient, /* ... */) // [!code hl]
  }) // [!code hl]
  
  // 5. Extract a Viem Client for the current active chain & account. // [!code hl]
  const { data: walletClient } = useConnectorClient({ config }) // [!code hl]

  // 6. Create a "custom" Mutation Hook that utilizes the Client. // [!code hl]
  const { mutate } = useMutation({ // [!code hl]
    mutationFn: (asset) => watchAsset(walletClient, asset) // [!code hl]
  }) // [!code hl]

  return (
    <div>
      {/* ... */}
    </div>
  )
}
```

```tsx [Client Actions]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/viem.md","from":3031,"to":4361}<fsm-vh3gqscxm4e>
// 1. Import modules. 
import { useMutation, useQuery } from '@tanstack/react-query'
import { http, createConfig, useClient, useConnectorClient } from 'wagmi' 
import { base, mainnet, optimism, zora } from 'wagmi/chains' 

// 2. Set up a Wagmi Config 
export const config = createConfig({ 
  chains: [base, mainnet, optimism, zora], 
  transports: { 
    [base.id]: http(), 
    [mainnet.id]: http(), 
    [optimism.id]: http(), 
    [zora.id]: http(), 
  }, 
}) 

function Example() {
  // 3. Extract a Viem Client for the current active chain. // [!code hl]
  const publicClient = useClient({ config }) // [!code hl]

  // 4. Create a "custom" Query Hook that utilizes the Client. // [!code hl]
  const { data: logs } = useQuery({ // [!code hl]
    queryKey: ['logs', publicClient.uid], // [!code hl]
    queryFn: () => publicClient.getLogs(/* ... */) // [!code hl]
  }) // [!code hl]
  
  // 5. Extract a Viem Client for the current active chain & account. // [!code hl]
  const { data: walletClient } = useConnectorClient({ config }) // [!code hl]

  // 6. Create a "custom" Mutation Hook that utilizes the Client. // [!code hl]
  const { mutate } = useMutation({ // [!code hl]
    mutationFn: (asset) => walletClient.watchAsset(asset) // [!code hl]
  }) // [!code hl]

  return (
    <div>
      {/* ... */}
    </div>
  )
}
```

:::

## Private Key & Mnemonic Accounts

It is possible to utilize Viem's [Private Key & Mnemonic Accounts](https://viem.sh/docs/accounts/local) with Wagmi by explicitly passing through the account via the `account` argument on Wagmi Actions.

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/viem.md","from":4617,"to":5289}<fsm-vh3gqscxm4e>
import { http, createConfig, useSendTransaction } from 'wagmi' 
import { base, mainnet, optimism, zora } from 'wagmi/chains' 
import { parseEther } from 'viem'
import { privateKeyToAccount } from 'viem/accounts'

export const config = createConfig({ 
  chains: [base, mainnet, optimism, zora], 
  transports: { 
    [base.id]: http(), 
    [mainnet.id]: http(), 
    [optimism.id]: http(), 
    [zora.id]: http(), 
  }, 
}) 

const account = privateKeyToAccount('0x...') // [!code hl]

function Example() {
  const { data: hash } = useSendTransaction({
    account, // [!code hl]
    to: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
    value: parseEther('0.001')
  })
}
```

::: info

Wagmi currently does not support hoisting Private Key & Mnemonic Accounts to the top-level Wagmi Config – meaning you have to explicitly pass through the account to every Action. If you feel like this is a feature that should be added, please [open a discussion](https://github.com/wevm/wagmi/discussions/new?category=ideas).

:::

---

---
url: /solid/guides/viem.md
---
# Viem

[Viem](https://viem.sh) is a TypeScript interface for Ethereum that provides low-level primitives for interacting with Ethereum. `@wagmi/solid` is built on top of Viem.

## Overview

Wagmi uses Viem internally to perform blockchain operations like sending transactions, reading from contracts, and more. You can also use Viem directly alongside Wagmi when you need lower-level control.

## Using Viem with Wagmi

### Getting the Viem Client

You can get a Viem Public Client or Wallet Client using Wagmi primitives:

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/guides/viem.md","from":532,"to":842}<fsm-vh3gqscxm4e>
import { useClient, useConnectorClient } from '@wagmi/solid'

function Example() {
  // Get a Public Client for read operations
  const publicClient = useClient()

  // Get a Wallet Client for write operations (requires connected account)
  const walletClient = useConnectorClient()

  // Use the clients...
}
```

### Using Viem Actions Directly

Once you have a client, you can use Viem actions directly:

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/guides/viem.md","from":947,"to":1342}<fsm-vh3gqscxm4e>
import { useClient } from '@wagmi/solid'
import { getBlockNumber } from 'viem/actions'
import { createEffect } from 'solid-js'

function Example() {
  const client = useClient()

  createEffect(async () => {
    const clientValue = client()
    if (clientValue) {
      const blockNumber = await getBlockNumber(clientValue)
      console.log('Block number:', blockNumber)
    }
  })

  // ...
}
```

## Viem Concepts

### Public Client vs Wallet Client

* **Public Client**: Used for read-only operations (e.g., getting block numbers, reading contract state)
* **Wallet Client**: Used for write operations that require signing (e.g., sending transactions, signing messages)

### Transports

Wagmi uses Viem's transport system to communicate with Ethereum nodes. Common transports include:

* `http`: HTTP JSON-RPC transport
* `webSocket`: WebSocket transport for real-time updates
* `fallback`: Fallback transport for reliability

## Further Reading

For more information about Viem, check out:

* [Viem Documentation](https://viem.sh)
* [Viem Actions](https://viem.sh/docs/actions/public/introduction)
* [Viem Clients](https://viem.sh/docs/clients/intro)

---

---
url: /vue/guides/viem.md
---
# Viem

[Viem](https://viem.sh) is a low-level TypeScript Interface for Ethereum that enables developers to interact with the Ethereum blockchain, including: JSON-RPC API abstractions, Smart Contract interaction, wallet & signing implementations, coding/parsing utilities and more.

**Wagmi Core** is essentially a wrapper over **Viem** that provides multi-chain functionality via [Wagmi Config](/react/api/createConfig) and automatic account management via [Connectors](/react/api/connectors).

## Leveraging Viem Actions

All of the core [Wagmi Composables](/vue/api/composables) are friendly wrappers around [Viem Actions](https://viem.sh/docs/actions/public/introduction) that inject a multi-chain and connector aware [Wagmi Config](/vue/api/createConfig).

There may be cases where you might want to dig deeper and utilize Viem Actions directly (maybe a Composable doesn't exist in Wagmi yet). In these cases, you can create your own custom Wagmi Composable by importing Viem Actions directly via `viem/actions` and plugging in a Viem Client returned by the [`useClient` Composable](/vue/api/composables/useClient).

There are two categories of Viem Actions:

* **[Public Actions](https://viem.sh/docs/actions/public/introduction):** Actions that are "read-only" and do not require a wallet connection.
* **[Wallet Actions](https://viem.sh/docs/actions/wallet/introduction):** Actions that interface with a Wallet and require a wallet connection.

While it is not mandatory, it is also recommended to pair Actions with either `useQuery` or `useMutation` to effectively leverage the reactivity and caching capabilities of [Tanstack Query](/vue/guides/tanstack-query).

### Public Actions

The example below demonstrates how to utilize Viem's `getLogs` Action with a `useQuery` Composable to create your own abstraction akin to a `useLogs` Composable.

```vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/viem.md","from":1863,"to":2396}<fsm-vh3gqscxm4e>
<script setup lang="ts">
// 1. Import modules. 
import { useClient, useConnectorClient } from '@wagmi/vue' 
import { useMutation, useQuery } from '@wagmi/vue/query'
import { getLogs, watchAsset } from 'viem/actions'

// 2. Extract a Viem Client for the current active chain. 
const client = useClient() 

// 3. Create a "custom" Query Composable that utilizes the Client. 
const { data: logs } = useQuery( 
  computed(() => ({ 
    queryKey: ['logs', client.value.uid], 
    queryFn: () => getLogs(client.value) 
  })) 
) 
</script>
```

### Wallet Actions

The example below demonstrates how to utilize Viem's `watchAsset` Action with a `useMutation` Composable to create your own abstraction akin to a `useWatchAsset` Composable.

```vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/viem.md","from":2603,"to":3082}<fsm-vh3gqscxm4e>
<script setup lang="ts">
// 1. Import modules. 
import { useConnectorClient } from '@wagmi/vue' 
import { useMutation } from '@wagmi/vue/query'
import { watchAsset } from 'viem/actions'

// 2. Extract a Viem Client for the current active chain. 
const { data: connectorClient } = useConnectorClient()

// 3. Create a "custom" Mutation Composable that utilizes the Client. 
const { mutate } = useMutation({
  mutationFn: (asset) => watchAsset(connectorClient, asset)
})
</script>
```

## Private Key & Mnemonic Accounts

It is possible to utilize Viem's [Private Key & Mnemonic Accounts](https://viem.sh/docs/accounts/local) with Wagmi by explicitly passing through the account via the `account` argument on Wagmi Actions.

```vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/viem.md","from":3333,"to":3846}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { privateKeyToAccount } from 'viem/accounts'
import { useConfig } from '@wagmi/vue'
import { sendTransactionMutationOptions, useMutation } from '@wagmi/vue/query'

const config = useConfig()
const { mutate: sendTransaction } = useMutation(
  sendTransactionMutationOptions(config)
)

const account = privateKeyToAccount('0x...') // [!code hl]

sendTransaction({
  account, // [!code hl]
  to: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
  value: parseEther('0.001')
})
</script>
```

::: info

Wagmi currently does not support hoisting Private Key & Mnemonic Accounts to the top-level Wagmi Config – meaning you have to explicitly pass through the account to every Action. If you feel like this is a feature that should be added, please [open an discussion](https://github.com/wevm/wagmi/discussions/new?category=ideas).

:::

---

---
url: /vue/api/WagmiPlugin.md
---
# WagmiPlugin

[Vue Plugin](https://vuejs.org/guide/reusability/plugins.html#plugins) for Wagmi.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/WagmiPlugin.md","from":115,"to":156}<fsm-vh3gqscxm4e>
import { WagmiPlugin } from '@wagmi/vue'
```

## Usage

::: code-group

```ts [main.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/WagmiPlugin.md","from":202,"to":404}<fsm-vh3gqscxm4e>
import { createApp } from 'vue'
import { WagmiPlugin } from '@wagmi/vue'

import App from './App.vue'
import { config } from './config' 

createApp(App)
  .use(WagmiPlugin, { config })
  .mount('#app')
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/WagmiPlugin.md","from":474,"to":525}<fsm-vh3gqscxm4e>
import { type WagmiPluginProps } from '@wagmi/vue'
```

### config

[`Config`](/vue/api/createConfig#config) object to inject with context.

::: code-group

```ts [main.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/WagmiPlugin.md","from":646,"to":872}<fsm-vh3gqscxm4e>
import { createApp } from 'vue'
import { WagmiPlugin } from '@wagmi/vue'

import App from './App.vue'
import { config } from './config' 

createApp(App)
  .use(WagmiPlugin, { 
    config // [!code focus]
  })
  .mount('#app')
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### initialState

`State | undefined`

* Initial state to hydrate into the [Wagmi Config](/vue/api/createConfig). Useful for SSR.

::: code-group

```ts [main.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/WagmiPlugin.md","from":1083,"to":1338}<fsm-vh3gqscxm4e>
import { createApp } from 'vue'
import { WagmiPlugin } from '@wagmi/vue'

import App from './App.vue'
import { config } from './config' 

createApp(App)
  .use(WagmiPlugin, { 
    config,
    initialState: /* ... */ // [!code focus]
  })
  .mount('#app')
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### reconnectOnMount

`boolean | undefined`

* Whether or not to reconnect previously connected [connectors](/vue/api/createConfig#connectors) on mount.
* Defaults to `true`.

::: code-group

```ts [main.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/WagmiPlugin.md","from":1594,"to":1849}<fsm-vh3gqscxm4e>
import { createApp } from 'vue'
import { WagmiPlugin } from '@wagmi/vue'

import App from './App.vue'
import { config } from './config' 

createApp(App)
  .use(WagmiPlugin, { 
    config,
    reconnectOnMount: false // [!code focus]
  })
  .mount('#app')
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/vue'
import { mainnet, sepolia } from '@wagmi/vue/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## configKey

Key to use to provide/inject `Config` via `WagmiPlugin`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/api/WagmiPlugin.md","from":1976,"to":2096}<fsm-vh3gqscxm4e>
import { configKey, type Config } from '@wagmi/vue'
import { inject } from 'vue'

inject<Config | undefined>(configKey)
```

---

---
url: /react/api/WagmiProvider.md
---
# WagmiProvider

React Context Provider for Wagmi.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/WagmiProvider.md","from":69,"to":107}<fsm-vh3gqscxm4e>
import { WagmiProvider } from 'wagmi'
```

## Usage

::: code-group

```tsx [app.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/WagmiProvider.md","from":154,"to":339}<fsm-vh3gqscxm4e>
import { WagmiProvider } from 'wagmi'
import { config } from './config' 

function App() {
  return (
    <WagmiProvider config={config}> 
      {/** ... */}
    </WagmiProvider>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/WagmiProvider.md","from":411,"to":459}<fsm-vh3gqscxm4e>
import { type WagmiProviderProps } from 'wagmi'
```

### config

[`Config`](/react/api/createConfig#config) object to inject with context.

::: code-group

```tsx [app.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/WagmiProvider.md","from":583,"to":795}<fsm-vh3gqscxm4e>
import { WagmiProvider } from 'wagmi'
import { config } from './config' 

function App() {
  return (
    <WagmiProvider
      config={config} // [!code focus]
    >
      {/** ... */}
    </WagmiProvider>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### initialState

`State | undefined`

* Initial state to hydrate into the [Wagmi Config](/react/api/createConfig). Useful for SSR.

::: code-group

```tsx [app.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/WagmiProvider.md","from":1011,"to":1254}<fsm-vh3gqscxm4e>
import { WagmiProvider } from 'wagmi'
import { config } from './config' 

function App() {
  return (
    <WagmiProvider
      config={config}
      initialState={/* ... /*} // [!code focus]
    >
      {/** ... */}
    </WagmiProvider>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### reconnectOnMount

`boolean | undefined`

* Whether or not to reconnect previously connected [connectors](/react/api/createConfig#connectors) on mount.
* Defaults to `true`.

::: code-group

```tsx [app.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/WagmiProvider.md","from":1515,"to":1758}<fsm-vh3gqscxm4e>
import { WagmiProvider } from 'wagmi'
import { config } from './config' 

function App() {
  return (
    <WagmiProvider
      config={config}
      reconnectOnMount={false} // [!code focus]
    >
      {/** ... */}
    </WagmiProvider>
  )
}
```

```ts \[config.ts]
import { createConfig, http } from 'wagmi'
import { mainnet, sepolia } from 'wagmi/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Context

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/api/WagmiProvider.md","from":1827,"to":1869}<fsm-vh3gqscxm4e>
import { type WagmiContext } from 'wagmi'
```

---

---
url: /solid/api/WagmiProvider.md
---
# WagmiProvider

Solid Context Provider for Wagmi.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/WagmiProvider.md","from":69,"to":114}<fsm-vh3gqscxm4e>
import { WagmiProvider } from '@wagmi/solid'
```

## Usage

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/WagmiProvider.md","from":136,"to":326}<fsm-vh3gqscxm4e>
import { WagmiProvider } from '@wagmi/solid'
import { config } from './config'

function App() {
  return (
    <WagmiProvider config={config}>
      {/** ... */}
    </WagmiProvider>
  )
}
```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/WagmiProvider.md","from":352,"to":407}<fsm-vh3gqscxm4e>
import { type WagmiProviderProps } from '@wagmi/solid'
```

### config

[`Config`](/solid/api/createConfig#config) object to inject with context.

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/WagmiProvider.md","from":506,"to":724}<fsm-vh3gqscxm4e>
import { WagmiProvider } from '@wagmi/solid'
import { config } from './config'

function App() {
  return (
    <WagmiProvider
      config={config} // [!code focus]
    >
      {/** ... */}
    </WagmiProvider>
  )
}
```

### initialState

`State | undefined`

* Initial state to hydrate into the [Wagmi Config](/solid/api/createConfig). Useful for SSR.

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/WagmiProvider.md","from":869,"to":1118}<fsm-vh3gqscxm4e>
import { WagmiProvider } from '@wagmi/solid'
import { config } from './config'

function App() {
  return (
    <WagmiProvider
      config={config}
      initialState={/* ... */} // [!code focus]
    >
      {/** ... */}
    </WagmiProvider>
  )
}
```

### reconnectOnMount

`boolean | undefined`

* Whether or not to reconnect previously connected [connectors](/solid/api/createConfig#connectors) on mount.
* Defaults to `true`.

```tsx
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/WagmiProvider.md","from":1308,"to":1557}<fsm-vh3gqscxm4e>
import { WagmiProvider } from '@wagmi/solid'
import { config } from './config'

function App() {
  return (
    <WagmiProvider
      config={config}
      reconnectOnMount={false} // [!code focus]
    >
      {/** ... */}
    </WagmiProvider>
  )
}
```

## Context

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/solid/api/WagmiProvider.md","from":1580,"to":1629}<fsm-vh3gqscxm4e>
import { type WagmiContext } from '@wagmi/solid'
```

---

---
url: /core/api/actions/waitForCallsStatus.md
---
# waitForCallsStatus

Waits for a call bundle to be confirmed & included on a block before returning the status & receipts.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/waitForCallsStatus.md","from":283,"to":332}<fsm-vh3gqscxm4e>
import { waitForCallsStatus } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/waitForCallsStatus.md","from":379,"to":771}<fsm-vh3gqscxm4e>
import { parseEther } from 'viem'
import { sendCalls, waitForCallsStatus } from '@wagmi/core'
import { config } from './config'

const id = await sendCalls(config, {
  calls: [{
    to: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8',
    value: parseEther('1')
  }]
})

const { status, receipts } = await waitForCallsStatus(config, { // [!code focus]
  id, // [!code focus]
}) // [!code focus]
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/waitForCallsStatus.md","from":842,"to":906}<fsm-vh3gqscxm4e>
import { type WaitForCallsStatusParameters } from '@wagmi/core'
```

### connector

`Connector | undefined`

Connector to get call statuses with.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/waitForCallsStatus.md","from":1021,"to":1302}<fsm-vh3gqscxm4e>
import { getConnections, waitForCallsStatus } from '@wagmi/core'
import { config } from './config'

const connections = getConnections(config)
const status = await waitForCallsStatus(config, {
  connector: connections[0]?.connector, // [!code focus]
  id: '0x1234567890abcdef',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### id

`string`

Identifier of the call batch.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/waitForCallsStatus.md","from":1433,"to":1615}<fsm-vh3gqscxm4e>
import { waitForCallsStatus } from '@wagmi/core'
import { config } from './config'

const status = await waitForCallsStatus(config, {
  id: '0x1234567890abcdef', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### pollingInterval

`number`

Polling interval in milliseconds.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/waitForCallsStatus.md","from":1763,"to":1971}<fsm-vh3gqscxm4e>
import { waitForCallsStatus } from '@wagmi/core'
import { config } from './config'

const status = await waitForCallsStatus(config, {
  id: '0x1234567890abcdef',
  pollingInterval: 1_000, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### timeout

`number`

Timeout in milliseconds before `waitForCallsStatus` stops polling.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/waitForCallsStatus.md","from":2144,"to":2345}<fsm-vh3gqscxm4e>
import { waitForCallsStatus } from '@wagmi/core'
import { config } from './config'

const status = await waitForCallsStatus(config, {
  id: '0x1234567890abcdef',
  timeout: 10_000, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/waitForCallsStatus.md","from":2417,"to":2481}<fsm-vh3gqscxm4e>
import { type WaitForCallsStatusReturnType } from '@wagmi/core'
```

`{ status: 'PENDING' | 'CONFIRMED', receipts: TransactionReceipt[] }`

The status and receipts of the call batch.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/waitForCallsStatus.md","from":2617,"to":2680}<fsm-vh3gqscxm4e>
import { type WaitForCallsStatusErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`waitForCallsStatus`](https://viem.sh/docs/actions/wallet/waitForCallsStatus)

---

---
url: /core/api/actions/waitForTransactionReceipt.md
---
# waitForTransactionReceipt

Action that waits for the transaction to be included on a block, and then returns the transaction receipt. If the transaction reverts, then the action will throw an error. Replacement detection (e.g. sped up transactions) is also supported.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/waitForTransactionReceipt.md","from":440,"to":496}<fsm-vh3gqscxm4e>
import { waitForTransactionReceipt } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/waitForTransactionReceipt.md","from":543,"to":778}<fsm-vh3gqscxm4e>
import { waitForTransactionReceipt } from '@wagmi/core'
import { config } from './config'

const transactionReceipt = waitForTransactionReceipt(config, {
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/waitForTransactionReceipt.md","from":849,"to":920}<fsm-vh3gqscxm4e>
import { type WaitForTransactionReceiptParameters } from '@wagmi/core'
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/waitForTransactionReceipt.md","from":1056,"to":1382}<fsm-vh3gqscxm4e>
import { waitForTransactionReceipt } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const transactionReceipt = await waitForTransactionReceipt(config, {
  chainId: mainnet.id, // [!code focus]
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### confirmations

`number | undefined`

The number of confirmations (blocks that have passed) to wait before resolving.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/waitForTransactionReceipt.md","from":1586,"to":1864}<fsm-vh3gqscxm4e>
import { waitForTransactionReceipt } from '@wagmi/core'
import { config } from './config'

const transactionReceipt = await waitForTransactionReceipt(config, {
  confirmations: 2, // [!code focus]
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onReplaced

`(({ reason: 'replaced' | 'repriced' | 'cancelled'; replacedTransaction: Transaction; transaction: Transaction; transactionReceipt: TransactionReceipt }) => void) | undefined`

Optional callback to emit if the transaction has been replaced.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/waitForTransactionReceipt.md","from":2206,"to":2519}<fsm-vh3gqscxm4e>
import { waitForTransactionReceipt } from '@wagmi/core'
import { config } from './config'

const transactionReceipt = await waitForTransactionReceipt(config, {
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
  onReplaced: replacement => console.log(replacement), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### hash

`` `0x${string}` ``

The transaction hash to wait for.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/waitForTransactionReceipt.md","from":2667,"to":2925}<fsm-vh3gqscxm4e>
import { waitForTransactionReceipt } from '@wagmi/core'
import { config } from './config'

const transactionReceipt = await waitForTransactionReceipt(config, {
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### pollingInterval

`number | undefined`

* Polling frequency (in milliseconds).
* Defaults to the [Config's `pollingInterval` config](/core/api/createConfig#pollinginterval).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/waitForTransactionReceipt.md","from":3185,"to":3469}<fsm-vh3gqscxm4e>
import { waitForTransactionReceipt } from '@wagmi/core'
import { config } from './config'

const transactionReceipt = await waitForTransactionReceipt(config, {
  hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
  pollingInterval: 1_000, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/waitForTransactionReceipt.md","from":3541,"to":3612}<fsm-vh3gqscxm4e>
import { type WaitForTransactionReceiptReturnType } from '@wagmi/core'
```

[`TransactionReceipt`](https://viem.sh/docs/glossary/types#transactionreceipt)

The transaction receipt.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/waitForTransactionReceipt.md","from":3739,"to":3809}<fsm-vh3gqscxm4e>
import { type WaitForTransactionReceiptErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`waitForTransactionReceipt`](https://viem.sh/docs/actions/public/waitForTransactionReceipt)

---

---
url: /core/api/connectors/walletConnect.md
---

# walletConnect

Connector for [WalletConnect](https://walletconnect.com).

## Import

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue{3,8-10}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { walletConnect } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [
    walletConnect({
      projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
    }),
  ],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type WalletConnectParameters } from '{{connectorsPackageName}}'
```

Check out the [WalletConnect docs](https://github.com/WalletConnect/walletconnect-monorepo/tree/v2.0/providers/ethereum-provider) for more info. A few options are omitted that Wagmi manages internally.

### customStoragePrefix&#x20;

`string | undefined`

Custom storage prefix for persisting provider state.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  customStoragePrefix: 'wagmi', // [!code focus]
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
})
```

### disableProviderPing

`boolean | undefined`

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  disableProviderPing: false, // [!code focus]
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
})
```

### isNewChainsStale

`boolean | undefined`

* If a new chain is added to a previously existing configured connector `chains`, this flag
  will determine if that chain should be considered as stale. A stale chain is a chain that
  WalletConnect has yet to establish a relationship with (e.g. the user has not approved or
  rejected the chain).
* Defaults to `true`.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  isNewChainsStale: true, // [!code focus]
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
})
```

::: details More info
Preface: Whereas WalletConnect v1 supported dynamic chain switching, WalletConnect v2 requires
the user to pre-approve a set of chains up-front. This comes with consequent UX nuances (see below) when
a user tries to switch to a chain that they have not approved.

This flag mainly affects the behavior when a wallet does not support dynamic chain authorization
with WalletConnect v2.

If `true` (default), the new chain will be treated as a stale chain. If the user
has yet to establish a relationship (approved/rejected) with this chain in their WalletConnect
session, the connector will disconnect upon the dapp auto-connecting, and the user will have to
reconnect to the dapp (revalidate the chain) in order to approve the newly added chain.
This is the default behavior to avoid an unexpected error upon switching chains which may
be a confusing user experience (e.g. the user will not know they have to reconnect
unless the dapp handles these types of errors).

If `false`, the new chain will be treated as a validated chain. This means that if the user
has yet to establish a relationship with the chain in their WalletConnect session, wagmi will successfully
auto-connect the user. This comes with the trade-off that the connector will throw an error
when attempting to switch to the unapproved chain. This may be useful in cases where a dapp constantly
modifies their configured chains, and they do not want to disconnect the user upon
auto-connecting. If the user decides to switch to the unapproved chain, it is important that the
dapp handles this error and prompts the user to reconnect to the dapp in order to approve
the newly added chain.
:::

### metadata

`CoreTypes.Metadata | undefined`

Metadata related to the app requesting the connection.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  metadata: { // [!code focus]
    name: 'Example', // [!code focus]
    description: 'Example website', // [!code focus]
    url: 'https://example.com', // [!code focus]
  }, // [!code focus]
})
```

### projectId

`string`

WalletConnect Cloud project identifier. You can find your `projectId` on your [WalletConnect dashboard](https://dashboard.reown.com/sign-in).

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68', // [!code focus]
})
```

### qrModalOptions

`QrModalOptions | undefined`

Options for rendering QR modal.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  qrModalOptions: { // [!code focus]
    themeMode: 'dark', // [!code focus]
  }, // [!code focus]
})
```

### relayUrl

`string | undefined`

* WalletConnect relay URL to use.
* Defaults to `'wss://relay.walletconnect.com'`.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  relayUrl: 'wss://relay.walletconnect.org', // [!code focus]
})
```

### storageOptions

`KeyValueStorageOptions | undefined`

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  storageOptions: {}, // [!code focus]
})
```

### showQrModal

`boolean | undefined`

* Whether to show the QR code modal upon calling `connector.connect()`.
* Defaults to `true`.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  showQrModal: true, // [!code focus]
})
```

::: tip
This can be disabled and you can listen for a `'message'` event with payload `{ type: 'display_uri'; data: string }` if you want to render your own QR code.
:::

---

---
url: /react/api/connectors/walletConnect.md
---

# walletConnect

Connector for [WalletConnect](https://walletconnect.com).

## Import

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue{3,8-10}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { walletConnect } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [
    walletConnect({
      projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
    }),
  ],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type WalletConnectParameters } from '{{connectorsPackageName}}'
```

Check out the [WalletConnect docs](https://github.com/WalletConnect/walletconnect-monorepo/tree/v2.0/providers/ethereum-provider) for more info. A few options are omitted that Wagmi manages internally.

### customStoragePrefix&#x20;

`string | undefined`

Custom storage prefix for persisting provider state.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  customStoragePrefix: 'wagmi', // [!code focus]
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
})
```

### disableProviderPing

`boolean | undefined`

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  disableProviderPing: false, // [!code focus]
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
})
```

### isNewChainsStale

`boolean | undefined`

* If a new chain is added to a previously existing configured connector `chains`, this flag
  will determine if that chain should be considered as stale. A stale chain is a chain that
  WalletConnect has yet to establish a relationship with (e.g. the user has not approved or
  rejected the chain).
* Defaults to `true`.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  isNewChainsStale: true, // [!code focus]
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
})
```

::: details More info
Preface: Whereas WalletConnect v1 supported dynamic chain switching, WalletConnect v2 requires
the user to pre-approve a set of chains up-front. This comes with consequent UX nuances (see below) when
a user tries to switch to a chain that they have not approved.

This flag mainly affects the behavior when a wallet does not support dynamic chain authorization
with WalletConnect v2.

If `true` (default), the new chain will be treated as a stale chain. If the user
has yet to establish a relationship (approved/rejected) with this chain in their WalletConnect
session, the connector will disconnect upon the dapp auto-connecting, and the user will have to
reconnect to the dapp (revalidate the chain) in order to approve the newly added chain.
This is the default behavior to avoid an unexpected error upon switching chains which may
be a confusing user experience (e.g. the user will not know they have to reconnect
unless the dapp handles these types of errors).

If `false`, the new chain will be treated as a validated chain. This means that if the user
has yet to establish a relationship with the chain in their WalletConnect session, wagmi will successfully
auto-connect the user. This comes with the trade-off that the connector will throw an error
when attempting to switch to the unapproved chain. This may be useful in cases where a dapp constantly
modifies their configured chains, and they do not want to disconnect the user upon
auto-connecting. If the user decides to switch to the unapproved chain, it is important that the
dapp handles this error and prompts the user to reconnect to the dapp in order to approve
the newly added chain.
:::

### metadata

`CoreTypes.Metadata | undefined`

Metadata related to the app requesting the connection.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  metadata: { // [!code focus]
    name: 'Example', // [!code focus]
    description: 'Example website', // [!code focus]
    url: 'https://example.com', // [!code focus]
  }, // [!code focus]
})
```

### projectId

`string`

WalletConnect Cloud project identifier. You can find your `projectId` on your [WalletConnect dashboard](https://dashboard.reown.com/sign-in).

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68', // [!code focus]
})
```

### qrModalOptions

`QrModalOptions | undefined`

Options for rendering QR modal.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  qrModalOptions: { // [!code focus]
    themeMode: 'dark', // [!code focus]
  }, // [!code focus]
})
```

### relayUrl

`string | undefined`

* WalletConnect relay URL to use.
* Defaults to `'wss://relay.walletconnect.com'`.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  relayUrl: 'wss://relay.walletconnect.org', // [!code focus]
})
```

### storageOptions

`KeyValueStorageOptions | undefined`

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  storageOptions: {}, // [!code focus]
})
```

### showQrModal

`boolean | undefined`

* Whether to show the QR code modal upon calling `connector.connect()`.
* Defaults to `true`.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  showQrModal: true, // [!code focus]
})
```

::: tip
This can be disabled and you can listen for a `'message'` event with payload `{ type: 'display_uri'; data: string }` if you want to render your own QR code.
:::

---

---
url: /shared/connectors/walletConnect.md
---
# walletConnect

Connector for [WalletConnect](https://walletconnect.com).

## Import

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/walletConnect.md","from":252,"to":310}<fsm-vh3gqscxm4e>
import { walletConnect } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/walletConnect.md","from":587,"to":660}<fsm-vh3gqscxm4e>
pnpm add @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

```bash-vue [npm]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/walletConnect.md","from":683,"to":759}<fsm-vh3gqscxm4e>
npm install @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/walletConnect.md","from":783,"to":856}<fsm-vh3gqscxm4e>
yarn add @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

```bash-vue [bun]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/walletConnect.md","from":879,"to":951}<fsm-vh3gqscxm4e>
bun add @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue{3,8-10}
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/walletConnect.md","from":988,"to":1403}<fsm-vh3gqscxm4e>
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { walletConnect } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [
    walletConnect({
      projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
    }),
  ],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/walletConnect.md","from":1433,"to":1506}<fsm-vh3gqscxm4e>
import { type WalletConnectParameters } from '{{connectorsPackageName}}'
```

Check out the [WalletConnect docs](https://github.com/WalletConnect/walletconnect-monorepo/tree/v2.0/providers/ethereum-provider) for more info. A few options are omitted that Wagmi manages internally.

### customStoragePrefix&#x20;

`string | undefined`

Custom storage prefix for persisting provider state.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/walletConnect.md","from":2014,"to":2208}<fsm-vh3gqscxm4e>
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  customStoragePrefix: 'wagmi', // [!code focus]
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
})
```

### disableProviderPing

`boolean | undefined`

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/walletConnect.md","from":2271,"to":2463}<fsm-vh3gqscxm4e>
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  disableProviderPing: false, // [!code focus]
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
})
```

### isNewChainsStale

`boolean | undefined`

* If a new chain is added to a previously existing configured connector `chains`, this flag
  will determine if that chain should be considered as stale. A stale chain is a chain that
  WalletConnect has yet to establish a relationship with (e.g. the user has not approved or
  rejected the chain).
* Defaults to `true`.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/walletConnect.md","from":2839,"to":3027}<fsm-vh3gqscxm4e>
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  isNewChainsStale: true, // [!code focus]
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
})
```

::: details More info
Preface: Whereas WalletConnect v1 supported dynamic chain switching, WalletConnect v2 requires
the user to pre-approve a set of chains up-front. This comes with consequent UX nuances (see below) when
a user tries to switch to a chain that they have not approved.

This flag mainly affects the behavior when a wallet does not support dynamic chain authorization
with WalletConnect v2.

If `true` (default), the new chain will be treated as a stale chain. If the user
has yet to establish a relationship (approved/rejected) with this chain in their WalletConnect
session, the connector will disconnect upon the dapp auto-connecting, and the user will have to
reconnect to the dapp (revalidate the chain) in order to approve the newly added chain.
This is the default behavior to avoid an unexpected error upon switching chains which may
be a confusing user experience (e.g. the user will not know they have to reconnect
unless the dapp handles these types of errors).

If `false`, the new chain will be treated as a validated chain. This means that if the user
has yet to establish a relationship with the chain in their WalletConnect session, wagmi will successfully
auto-connect the user. This comes with the trade-off that the connector will throw an error
when attempting to switch to the unapproved chain. This may be useful in cases where a dapp constantly
modifies their configured chains, and they do not want to disconnect the user upon
auto-connecting. If the user decides to switch to the unapproved chain, it is important that the
dapp handles this error and prompts the user to reconnect to the dapp in order to approve
the newly added chain.
:::

### metadata

`CoreTypes.Metadata | undefined`

Metadata related to the app requesting the connection.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/walletConnect.md","from":4827,"to":5165}<fsm-vh3gqscxm4e>
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  metadata: { // [!code focus]
    name: 'Example', // [!code focus]
    description: 'Example website', // [!code focus]
    url: 'https://example.com', // [!code focus]
  }, // [!code focus]
})
```

### projectId

`string`

WalletConnect Cloud project identifier. You can find your `projectId` on your [WalletConnect dashboard](https://dashboard.reown.com/sign-in).

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/walletConnect.md","from":5348,"to":5510}<fsm-vh3gqscxm4e>
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68', // [!code focus]
})
```

### qrModalOptions

`QrModalOptions | undefined`

Options for rendering QR modal.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/walletConnect.md","from":5608,"to":5852}<fsm-vh3gqscxm4e>
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  qrModalOptions: { // [!code focus]
    themeMode: 'dark', // [!code focus]
  }, // [!code focus]
})
```

### relayUrl

`string | undefined`

* WalletConnect relay URL to use.
* Defaults to `'wss://relay.walletconnect.com'`.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/walletConnect.md","from":5987,"to":6194}<fsm-vh3gqscxm4e>
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  relayUrl: 'wss://relay.walletconnect.org', // [!code focus]
})
```

### storageOptions

`KeyValueStorageOptions | undefined`

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/walletConnect.md","from":6267,"to":6451}<fsm-vh3gqscxm4e>
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  storageOptions: {}, // [!code focus]
})
```

### showQrModal

`boolean | undefined`

* Whether to show the QR code modal upon calling `connector.connect()`.
* Defaults to `true`.

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/connectors/walletConnect.md","from":6601,"to":6784}<fsm-vh3gqscxm4e>
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  showQrModal: true, // [!code focus]
})
```

::: tip
This can be disabled and you can listen for a `'message'` event with payload `{ type: 'display_uri'; data: string }` if you want to render your own QR code.
:::

---

---
url: /solid/api/connectors/walletConnect.md
---

# walletConnect

Connector for [WalletConnect](https://walletconnect.com).

## Import

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue{3,8-10}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { walletConnect } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [
    walletConnect({
      projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
    }),
  ],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type WalletConnectParameters } from '{{connectorsPackageName}}'
```

Check out the [WalletConnect docs](https://github.com/WalletConnect/walletconnect-monorepo/tree/v2.0/providers/ethereum-provider) for more info. A few options are omitted that Wagmi manages internally.

### customStoragePrefix&#x20;

`string | undefined`

Custom storage prefix for persisting provider state.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  customStoragePrefix: 'wagmi', // [!code focus]
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
})
```

### disableProviderPing

`boolean | undefined`

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  disableProviderPing: false, // [!code focus]
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
})
```

### isNewChainsStale

`boolean | undefined`

* If a new chain is added to a previously existing configured connector `chains`, this flag
  will determine if that chain should be considered as stale. A stale chain is a chain that
  WalletConnect has yet to establish a relationship with (e.g. the user has not approved or
  rejected the chain).
* Defaults to `true`.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  isNewChainsStale: true, // [!code focus]
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
})
```

::: details More info
Preface: Whereas WalletConnect v1 supported dynamic chain switching, WalletConnect v2 requires
the user to pre-approve a set of chains up-front. This comes with consequent UX nuances (see below) when
a user tries to switch to a chain that they have not approved.

This flag mainly affects the behavior when a wallet does not support dynamic chain authorization
with WalletConnect v2.

If `true` (default), the new chain will be treated as a stale chain. If the user
has yet to establish a relationship (approved/rejected) with this chain in their WalletConnect
session, the connector will disconnect upon the dapp auto-connecting, and the user will have to
reconnect to the dapp (revalidate the chain) in order to approve the newly added chain.
This is the default behavior to avoid an unexpected error upon switching chains which may
be a confusing user experience (e.g. the user will not know they have to reconnect
unless the dapp handles these types of errors).

If `false`, the new chain will be treated as a validated chain. This means that if the user
has yet to establish a relationship with the chain in their WalletConnect session, wagmi will successfully
auto-connect the user. This comes with the trade-off that the connector will throw an error
when attempting to switch to the unapproved chain. This may be useful in cases where a dapp constantly
modifies their configured chains, and they do not want to disconnect the user upon
auto-connecting. If the user decides to switch to the unapproved chain, it is important that the
dapp handles this error and prompts the user to reconnect to the dapp in order to approve
the newly added chain.
:::

### metadata

`CoreTypes.Metadata | undefined`

Metadata related to the app requesting the connection.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  metadata: { // [!code focus]
    name: 'Example', // [!code focus]
    description: 'Example website', // [!code focus]
    url: 'https://example.com', // [!code focus]
  }, // [!code focus]
})
```

### projectId

`string`

WalletConnect Cloud project identifier. You can find your `projectId` on your [WalletConnect dashboard](https://dashboard.reown.com/sign-in).

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68', // [!code focus]
})
```

### qrModalOptions

`QrModalOptions | undefined`

Options for rendering QR modal.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  qrModalOptions: { // [!code focus]
    themeMode: 'dark', // [!code focus]
  }, // [!code focus]
})
```

### relayUrl

`string | undefined`

* WalletConnect relay URL to use.
* Defaults to `'wss://relay.walletconnect.com'`.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  relayUrl: 'wss://relay.walletconnect.org', // [!code focus]
})
```

### storageOptions

`KeyValueStorageOptions | undefined`

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  storageOptions: {}, // [!code focus]
})
```

### showQrModal

`boolean | undefined`

* Whether to show the QR code modal upon calling `connector.connect()`.
* Defaults to `true`.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  showQrModal: true, // [!code focus]
})
```

::: tip
This can be disabled and you can listen for a `'message'` event with payload `{ type: 'display_uri'; data: string }` if you want to render your own QR code.
:::

---

---
url: /vue/api/connectors/walletConnect.md
---

# walletConnect

Connector for [WalletConnect](https://walletconnect.com).

## Import

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'
```

## Install

::: code-group

```bash-vue [pnpm]
pnpm add @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

```bash-vue [npm]
npm install @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

```bash-vue [yarn]
yarn add @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

```bash-vue [bun]
bun add @walletconnect/ethereum-provider@{{connectorDependencyVersion}}
```

:::

## Usage

```ts-vue{3,8-10}
import { createConfig, http } from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'
import { walletConnect } from '{{connectorsPackageName}}'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [
    walletConnect({
      projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
    }),
  ],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})
```

## Parameters

```ts-vue
import { type WalletConnectParameters } from '{{connectorsPackageName}}'
```

Check out the [WalletConnect docs](https://github.com/WalletConnect/walletconnect-monorepo/tree/v2.0/providers/ethereum-provider) for more info. A few options are omitted that Wagmi manages internally.

### customStoragePrefix&#x20;

`string | undefined`

Custom storage prefix for persisting provider state.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  customStoragePrefix: 'wagmi', // [!code focus]
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
})
```

### disableProviderPing

`boolean | undefined`

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  disableProviderPing: false, // [!code focus]
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
})
```

### isNewChainsStale

`boolean | undefined`

* If a new chain is added to a previously existing configured connector `chains`, this flag
  will determine if that chain should be considered as stale. A stale chain is a chain that
  WalletConnect has yet to establish a relationship with (e.g. the user has not approved or
  rejected the chain).
* Defaults to `true`.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  isNewChainsStale: true, // [!code focus]
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
})
```

::: details More info
Preface: Whereas WalletConnect v1 supported dynamic chain switching, WalletConnect v2 requires
the user to pre-approve a set of chains up-front. This comes with consequent UX nuances (see below) when
a user tries to switch to a chain that they have not approved.

This flag mainly affects the behavior when a wallet does not support dynamic chain authorization
with WalletConnect v2.

If `true` (default), the new chain will be treated as a stale chain. If the user
has yet to establish a relationship (approved/rejected) with this chain in their WalletConnect
session, the connector will disconnect upon the dapp auto-connecting, and the user will have to
reconnect to the dapp (revalidate the chain) in order to approve the newly added chain.
This is the default behavior to avoid an unexpected error upon switching chains which may
be a confusing user experience (e.g. the user will not know they have to reconnect
unless the dapp handles these types of errors).

If `false`, the new chain will be treated as a validated chain. This means that if the user
has yet to establish a relationship with the chain in their WalletConnect session, wagmi will successfully
auto-connect the user. This comes with the trade-off that the connector will throw an error
when attempting to switch to the unapproved chain. This may be useful in cases where a dapp constantly
modifies their configured chains, and they do not want to disconnect the user upon
auto-connecting. If the user decides to switch to the unapproved chain, it is important that the
dapp handles this error and prompts the user to reconnect to the dapp in order to approve
the newly added chain.
:::

### metadata

`CoreTypes.Metadata | undefined`

Metadata related to the app requesting the connection.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  metadata: { // [!code focus]
    name: 'Example', // [!code focus]
    description: 'Example website', // [!code focus]
    url: 'https://example.com', // [!code focus]
  }, // [!code focus]
})
```

### projectId

`string`

WalletConnect Cloud project identifier. You can find your `projectId` on your [WalletConnect dashboard](https://dashboard.reown.com/sign-in).

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68', // [!code focus]
})
```

### qrModalOptions

`QrModalOptions | undefined`

Options for rendering QR modal.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  qrModalOptions: { // [!code focus]
    themeMode: 'dark', // [!code focus]
  }, // [!code focus]
})
```

### relayUrl

`string | undefined`

* WalletConnect relay URL to use.
* Defaults to `'wss://relay.walletconnect.com'`.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  relayUrl: 'wss://relay.walletconnect.org', // [!code focus]
})
```

### storageOptions

`KeyValueStorageOptions | undefined`

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  storageOptions: {}, // [!code focus]
})
```

### showQrModal

`boolean | undefined`

* Whether to show the QR code modal upon calling `connector.connect()`.
* Defaults to `true`.

```ts-vue
import { walletConnect } from '{{connectorsPackageName}}'

const connector = walletConnect({
  projectId: '3fcc6bba6f1de962d911bb5b5c3dba68',
  showQrModal: true, // [!code focus]
})
```

::: tip
This can be disabled and you can listen for a `'message'` event with payload `{ type: 'display_uri'; data: string }` if you want to render your own QR code.
:::

---

---
url: /core/api/actions/watchAsset.md
---
# watchAsset

Action for requesting user tracks the token in their wallet. Returns a boolean indicating if the token was successfully added.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchAsset.md","from":281,"to":322}<fsm-vh3gqscxm4e>
import { watchAsset } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchAsset.md","from":369,"to":608}<fsm-vh3gqscxm4e>
import { watchAsset } from '@wagmi/core'
import { config } from './config'

await watchAsset(config, {
  type: 'ERC20',
  options: {
    address: '0x0000000000000000000000000000000000000000',
    symbol: 'WAGMI',
    decimals: 18,
  },
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchAsset.md","from":679,"to":735}<fsm-vh3gqscxm4e>
import { type WatchAssetParameters } from '@wagmi/core'
```

### connector

`Connector | undefined`

[Connector](/core/api/connectors) to sign message with.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchAsset.md","from":869,"to":1212}<fsm-vh3gqscxm4e>
import { getConnection, watchAsset } from '@wagmi/core'
import { config } from './config'

const { connector } = getConnection(config)
const result = await watchAsset(config, {
  connector, // [!code focus]
  options: {
    address: '0x0000000000000000000000000000000000000000',
    symbol: 'WAGMI',
    decimals: 18,
  },
  type: 'ERC20',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### options

`{ address: string; symbol: string; decimals: number; image?: string | undefined; }`

Asset options.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchAsset.md","from":1409,"to":1748}<fsm-vh3gqscxm4e>
import { watchAsset } from '@wagmi/core'
import { config } from './config'

const result = await watchAsset(config, {
  options: { // [!code focus]
    address: '0x0000000000000000000000000000000000000000', // [!code focus]
    symbol: 'WAGMI', // [!code focus]
    decimals: 18, // [!code focus]
  }, // [!code focus]
  type: 'ERC20',
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### type

`'ERC20'`

Type of asset.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchAsset.md","from":1867,"to":2138}<fsm-vh3gqscxm4e>
import { watchAsset } from '@wagmi/core'
import { config } from './config'

const result = await watchAsset(config, {
  options: {
    address: '0x0000000000000000000000000000000000000000',
    symbol: 'WAGMI',
    decimals: 18,
  },
  type: 'ERC20', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchAsset.md","from":2210,"to":2266}<fsm-vh3gqscxm4e>
import { type WatchAssetReturnType } from '@wagmi/core'
```

`boolean`

Returns a boolean indicating if the token was successfully added.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchAsset.md","from":2365,"to":2420}<fsm-vh3gqscxm4e>
import { type WatchAssetErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Viem

* [`watchAsset`](https://viem.sh/docs/actions/wallet/watchAsset)

---

---
url: /core/api/actions/watchBlockNumber.md
---
# watchBlockNumber

Action that watches for block number changes.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlockNumber.md","from":84,"to":131}<fsm-vh3gqscxm4e>
import { watchBlockNumber } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlockNumber.md","from":178,"to":406}<fsm-vh3gqscxm4e>
import { watchBlockNumber } from '@wagmi/core'
import { config } from './config'

const unwatch = watchBlockNumber(config, {
  onBlockNumber(blockNumber) {
    console.log('Block number changed!', blockNumber)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlockNumber.md","from":477,"to":539}<fsm-vh3gqscxm4e>
import { type WatchBlockNumberParameters } from '@wagmi/core'
```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlockNumber.md","from":675,"to":988}<fsm-vh3gqscxm4e>
import { watchBlockNumber } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const unwatch = watchBlockNumber(config, {
  chainId: mainnet.id, // [!code focus]
  onBlockNumber(blockNumber) {
    console.log('Block number changed!', blockNumber)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### emitOnBegin

`boolean | undefined`

Whether or not to emit the latest block number to the callback when the subscription opens.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlockNumber.md","from":1203,"to":1469}<fsm-vh3gqscxm4e>
import { watchBlockNumber } from '@wagmi/core'
import { config } from './config'

const unwatch = watchBlockNumber(config, {
  emitOnBegin: true, // [!code focus]
  onBlockNumber(blockNumber) {
    console.log('Block number changed!', blockNumber)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### emitMissed

`boolean | undefined`

Whether or not to emit the missed block numbers to the callback.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlockNumber.md","from":1656,"to":1921}<fsm-vh3gqscxm4e>
import { watchBlockNumber } from '@wagmi/core'
import { config } from './config'

const unwatch = watchBlockNumber(config, {
  emitMissed: true, // [!code focus]
  onBlockNumber(blockNumber) {
    console.log('Block number changed!', blockNumber)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onBlockNumber

`(blockNumber: bigint, prevBlockNumber: bigint | undefined) => void`

Callback for when block number changes.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlockNumber.md","from":2134,"to":2413}<fsm-vh3gqscxm4e>
import { watchBlockNumber } from '@wagmi/core'
import { config } from './config'

const unwatch = watchBlockNumber(config, {
  onBlockNumber(blockNumber) { // [!code focus]
    console.log('Block number changed!', blockNumber) // [!code focus]
  }, // [!code focus]
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onError

`((error: Error) => void) | undefined`

Error thrown from getting the block number.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlockNumber.md","from":2593,"to":2946}<fsm-vh3gqscxm4e>
import { watchBlockNumber } from '@wagmi/core'
import { config } from './config'

const unwatch = watchBlockNumber(config, {
  onBlockNumber(blockNumber) { 
    console.log('Block number changed!', blockNumber) 
  }, 
  onError(error) { // [!code focus]
    console.error('Block number error', error) // [!code focus]
  }, // [!code focus]
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### poll

`boolean | undefined`

* Whether or not to use a polling mechanism to check for new blocks instead of a WebSocket subscription.
* Defaults to `false` for WebSocket Clients, and `true` for non-WebSocket Clients.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlockNumber.md","from":3250,"to":3512}<fsm-vh3gqscxm4e>
import { watchBlockNumber } from '@wagmi/core'
import { config } from './config'

const unwatch = watchBlockNumber(config, {
  onBlockNumber(blockNumber) { 
    console.log('Block number changed!', blockNumber) 
  }, 
  poll: true, // [!code focus]
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### pollingInterval

`number | undefined`

* Polling frequency (in milliseconds).
* Defaults to the [Config's `pollingInterval` config](/core/api/createConfig#pollinginterval).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlockNumber.md","from":3772,"to":4046}<fsm-vh3gqscxm4e>
import { watchBlockNumber } from '@wagmi/core'
import { config } from './config'

const unwatch = watchBlockNumber(config, {
  onBlockNumber(blockNumber) { 
    console.log('Block number changed!', blockNumber) 
  }, 
  pollingInterval: 1_000, // [!code focus]
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### syncConnectedChain

`boolean | undefined`

* Set up subscriber for connected chain changes.
* Defaults to [`Config['syncConnectedChain']`](/core/api/createConfig#syncconnectedchain).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlockNumber.md","from":4316,"to":4590}<fsm-vh3gqscxm4e>
import { watchBlockNumber } from '@wagmi/core'
import { config } from './config'

const unwatch = watchBlockNumber(config, {
  onBlockNumber(blockNumber) {
    console.log('Block number changed!', blockNumber)
  },
  syncConnectedChain: false, // [!code focus]
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlockNumber.md","from":4662,"to":4724}<fsm-vh3gqscxm4e>
import { type WatchBlockNumberReturnType } from '@wagmi/core'
```

Function for cleaning up watcher.

## Viem

* [`watchBlockNumber`](https://viem.sh/docs/actions/public/watchBlockNumber)

---

---
url: /core/api/actions/watchBlocks.md
---
# watchBlocks

Action that watches for block changes.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlocks.md","from":72,"to":114}<fsm-vh3gqscxm4e>
import { watchBlocks } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlocks.md","from":161,"to":354}<fsm-vh3gqscxm4e>
import { watchBlocks } from '@wagmi/core'
import { config } from './config'

const unwatch = watchBlocks(config, {
  onBlock(block) {
    console.log('Block changed!', block)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlocks.md","from":425,"to":482}<fsm-vh3gqscxm4e>
import { type WatchBlocksParameters } from '@wagmi/core'
```

### blockTag

`'latest' | 'earliest' | 'pending' | 'safe' | 'finalized'`

Watch for new blocks on a given tag. Defaults to `'latest'`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlocks.md","from":655,"to":888}<fsm-vh3gqscxm4e>
import { watchBlocks } from '@wagmi/core'
import { config } from './config'

const unwatch = watchBlocks(config, {
  blockTag: 'pending', // [!code focus]
  onBlock(block) {
    console.log('Block changed!', block)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlocks.md","from":1069,"to":1347}<fsm-vh3gqscxm4e>
import { watchBlocks } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const unwatch = watchBlocks(config, {
  chainId: mainnet.id, // [!code focus]
  onBlock(block) {
    console.log('Block changed!', block)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### emitMissed

`boolean`

Whether or not to emit missed blocks to the callback. Defaults to `false`.

Missed blocks may occur in instances where internet connection is lost, or the block time is lesser than the polling interval of the client.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlocks.md","from":1674,"to":1904}<fsm-vh3gqscxm4e>
import { watchBlocks } from '@wagmi/core'
import { config } from './config'

const unwatch = watchBlocks(config, {
  emitMissed: true, // [!code focus]
  onBlock(block) {
    console.log('Block changed!', block)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### emitOnBegin

`boolean`

Whether or not to emit the block to the callback when the subscription opens. Defaults to `false`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlocks.md","from":2114,"to":2345}<fsm-vh3gqscxm4e>
import { watchBlocks } from '@wagmi/core'
import { config } from './config'

const unwatch = watchBlocks(config, {
  emitOnBegin: true, // [!code focus]
  onBlock(block) {
    console.log('Block changed!', block)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onBlock

`(block: Block, prevblock: Block | undefined) => void`

Callback for when block changes.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlocks.md","from":2530,"to":2774}<fsm-vh3gqscxm4e>
import { watchBlocks } from '@wagmi/core'
import { config } from './config'

const unwatch = watchBlocks(config, {
  onBlock(block) { // [!code focus]
    console.log('Block changed!', block) // [!code focus]
  }, // [!code focus]
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onError

`((error: Error) => void) | undefined`

Error thrown from getting the block.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlocks.md","from":2947,"to":3258}<fsm-vh3gqscxm4e>
import { watchBlocks } from '@wagmi/core'
import { config } from './config'

const unwatch = watchBlocks(config, {
  onBlock(block) { 
    console.log('Block changed!', block) 
  }, 
  onError(error) { // [!code focus]
    console.error('Block error', error) // [!code focus]
  }, // [!code focus]
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### poll

`boolean | undefined`

* Whether or not to use a polling mechanism to check for new blocks instead of a WebSocket subscription.
* Defaults to `false` for WebSocket Clients, and `true` for non-WebSocket Clients.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlocks.md","from":3562,"to":3786}<fsm-vh3gqscxm4e>
import { watchBlocks } from '@wagmi/core'
import { config } from './config'

const unwatch = watchBlocks(config, {
  poll: true, // [!code focus]
  onBlock(block) {
    console.log('Block changed!', block)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### pollingInterval

`number | undefined`

* Polling frequency (in milliseconds).
* Defaults to the [Config's `pollingInterval` config](/core/api/createConfig#pollinginterval).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlocks.md","from":4046,"to":4282}<fsm-vh3gqscxm4e>
import { watchBlocks } from '@wagmi/core'
import { config } from './config'

const unwatch = watchBlocks(config, {
  pollingInterval: 1_000, // [!code focus]
  onBlock(block) {
    console.log('Block changed!', block)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### syncConnectedChain

`boolean | undefined`

* Set up subscriber for connected chain changes.
* Defaults to [`Config['syncConnectedChain']`](/core/api/createConfig#syncconnectedchain).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlocks.md","from":4552,"to":4791}<fsm-vh3gqscxm4e>
import { watchBlocks } from '@wagmi/core'
import { config } from './config'

const unwatch = watchBlocks(config, {
  onBlock(block) {
    console.log('Block changed!', block)
  },
  syncConnectedChain: false, // [!code focus]
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchBlocks.md","from":4863,"to":4920}<fsm-vh3gqscxm4e>
import { type WatchBlocksReturnType } from '@wagmi/core'
```

Function for cleaning up watcher.

## Viem

* [`watchBlocks`](https://viem.sh/docs/actions/public/watchBlocks)

---

---
url: /core/api/actions/watchChainId.md
---
# watchChainId

Subscribe to chain ID changes.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchChainId.md","from":65,"to":108}<fsm-vh3gqscxm4e>
import { watchChainId } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchChainId.md","from":155,"to":358}<fsm-vh3gqscxm4e>
import { watchChainId } from '@wagmi/core'
import { config } from './config'

const unwatch = watchChainId(config, {
  onChange(chainId) {
    console.log('Chain ID changed!', chainId)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchChainId.md","from":429,"to":487}<fsm-vh3gqscxm4e>
import { type WatchChainIdParameters } from '@wagmi/core'
```

### onChange

`onChange(chainId: GetChainIdReturnType, prevChainId: GetChainIdReturnType): void`

Callback function called when chain ID changes.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchChainId.md","from":671,"to":893}<fsm-vh3gqscxm4e>
import { watchChainId } from '@wagmi/core'
import { config } from './config'

const unwatch = watchChainId(config, {
  onChange(chainId) { // [!code focus:3]
    console.log('Chain ID changed!', chainId)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchChainId.md","from":965,"to":1023}<fsm-vh3gqscxm4e>
import { type WatchChainIdReturnType } from '@wagmi/core'
```

Function for cleaning up watcher.

---

---
url: /core/api/actions/watchClient.md
---
# watchClient

Subscribe to Client changes.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchClient.md","from":62,"to":104}<fsm-vh3gqscxm4e>
import { watchClient } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchClient.md","from":151,"to":348}<fsm-vh3gqscxm4e>
import { watchClient } from '@wagmi/core'
import { config } from './config'

const unwatch = watchClient(config, {
  onChange(client) {
    console.log('Client changed!', client)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchClient.md","from":419,"to":476}<fsm-vh3gqscxm4e>
import { type WatchClientParameters } from '@wagmi/core'
```

### onChange

`onChange(client: GetClientReturnType, prevClient: GetClientReturnType): void`

Callback function called when Client changes.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchClient.md","from":654,"to":870}<fsm-vh3gqscxm4e>
import { watchClient } from '@wagmi/core'
import { config } from './config'

const unwatch = watchClient(config, {
  onChange(client) { // [!code focus:3]
    console.log('Client changed!', client)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchClient.md","from":942,"to":999}<fsm-vh3gqscxm4e>
import { type WatchClientReturnType } from '@wagmi/core'
```

Function for cleaning up watcher.

---

---
url: /core/api/actions/watchConnection.md
---
# watchConnection

Subscribe to connection changes.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchConnection.md","from":70,"to":116}<fsm-vh3gqscxm4e>
import { watchConnection } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchConnection.md","from":163,"to":368}<fsm-vh3gqscxm4e>
import { watchConnection } from '@wagmi/core'
import { config } from './config'

const unwatch = watchConnection(config, {
  onChange(data) {
    console.log('Connection changed!', data)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchConnection.md","from":439,"to":500}<fsm-vh3gqscxm4e>
import { type WatchConnectionParameters } from '@wagmi/core'
```

### onChange

`onChange(connection: GetConnectionReturnType, prevConnection: GetConnectionReturnType): void`

Callback function called when connection changes.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchConnection.md","from":698,"to":934}<fsm-vh3gqscxm4e>
import { watchConnection } from '@wagmi/core'
import { config } from './config'

const unwatch = watchConnection(config, {
  onChange(connection) { // [!code focus:3]
    console.log('Connection changed!', connection)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchConnection.md","from":1006,"to":1067}<fsm-vh3gqscxm4e>
import { type WatchConnectionReturnType } from '@wagmi/core'
```

Function for cleaning up watcher.

---

---
url: /core/api/actions/watchConnections.md
---
# watchConnections

Subscribe to connections changes.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchConnections.md","from":72,"to":119}<fsm-vh3gqscxm4e>
import { watchConnections } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchConnections.md","from":166,"to":374}<fsm-vh3gqscxm4e>
import { watchConnections } from '@wagmi/core'
import { config } from './config'

const unwatch = watchConnections(config, {
  onChange(data) {
    console.log('Connections changed!', data)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchConnections.md","from":445,"to":507}<fsm-vh3gqscxm4e>
import { type WatchConnectionsParameters } from '@wagmi/core'
```

### onChange

`onChange(connections: GetConnectionsReturnType, prevConnections: GetConnectionsReturnType): void`

Callback function called when connections changes.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchConnections.md","from":710,"to":937}<fsm-vh3gqscxm4e>
import { watchConnections } from '@wagmi/core'
import { config } from './config'

const unwatch = watchConnections(config, {
  onChange(data) { // [!code focus:3]
    console.log('Connections changed!', data)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchConnections.md","from":1009,"to":1071}<fsm-vh3gqscxm4e>
import { type WatchConnectionsReturnType } from '@wagmi/core'
```

Function for cleaning up watcher.

---

---
url: /core/api/actions/watchConnectors.md
---
# watchConnectors

Subscribe to connectors changes.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchConnectors.md","from":70,"to":116}<fsm-vh3gqscxm4e>
import { watchConnectors } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchConnectors.md","from":163,"to":380}<fsm-vh3gqscxm4e>
import { watchConnectors } from '@wagmi/core'
import { config } from './config'

const unwatch = watchConnectors(config, {
  onChange(connectors) {
    console.log('Connectors changed!', connectors)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchConnectors.md","from":451,"to":512}<fsm-vh3gqscxm4e>
import { type WatchConnectorsParameters } from '@wagmi/core'
```

### onChange

`onChange(connectors: GetConnectorsReturnType, prevConnectors: GetConnectorsReturnType): void`

Callback function called when connectors changes.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchConnectors.md","from":710,"to":946}<fsm-vh3gqscxm4e>
import { watchConnectors } from '@wagmi/core'
import { config } from './config'

const unwatch = watchConnectors(config, {
  onChange(connectors) { // [!code focus:3]
    console.log('Connectors changed!', connectors)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchConnectors.md","from":1018,"to":1079}<fsm-vh3gqscxm4e>
import { type WatchConnectorsReturnType } from '@wagmi/core'
```

Function for cleaning up watcher.

---

---
url: /core/api/actions/watchContractEvent.md
---
# watchContractEvent

Action that watches and returns emitted contract event logs.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchContractEvent.md","from":239,"to":288}<fsm-vh3gqscxm4e>
import { watchContractEvent } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchContractEvent.md","from":335,"to":651}<fsm-vh3gqscxm4e>
import { watchContractEvent } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const unwatch = watchContractEvent(config, {
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  abi,
  eventName: 'Transfer',
  onLogs(logs) {
    console.log('New logs!', logs)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchContractEvent.md","from":758,"to":822}<fsm-vh3gqscxm4e>
import { type WatchContractEventParameters } from '@wagmi/core'
```

### abi

`Abi`

The contract's ABI. Check out the [TypeScript docs](/react/typescript#const-assert-abis-typed-data) for how to set up ABIs for maximum type inference and safety.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchContractEvent.md","from":1038,"to":1310}<fsm-vh3gqscxm4e>
import { watchContractEvent } from '@wagmi/core'
import { abi } from './abi' // [!code focus]
import { config } from './config'

const unwatch = watchContractEvent(config, {
  abi, // [!code focus]
  onLogs(logs) {
    console.log('Logs changed!', logs)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### address

`Address | undefined`

The contract's address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchContractEvent.md","from":1489,"to":1801}<fsm-vh3gqscxm4e>
import { watchContractEvent } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const unwatch = watchContractEvent(config, {
  address: '0x6b175474e89094c44da98b954eedeac495271d0f', // [!code focus]
  abi,
  onLogs(logs) {
    console.log('Logs changed!', logs)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### args

`object | readonly unknown[] | undefined`

* Arguments to pass when calling the contract.
* Inferred from [`abi`](#abi) and [`eventName`](#eventname).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchContractEvent.md","from":2081,"to":2439}<fsm-vh3gqscxm4e>
import { watchContractEvent } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const unwatch = watchContractEvent(config, {
  abi,
  args: { // [!code focus]
    to: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
  }, // [!code focus]
  onLogs(logs) {
    console.log('Logs changed!', logs)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### batch

`boolean | undefined`

* Whether or not the events should be batched on each invocation.
* Defaults to `true`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchContractEvent.md","from":2680,"to":2951}<fsm-vh3gqscxm4e>
import { watchContractEvent } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const unwatch = watchContractEvent(config, {
  abi,
  batch: false, // [!code focus]
  onLogs(logs) {
    console.log('Logs changed!', logs)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchContractEvent.md","from":3168,"to":3491}<fsm-vh3gqscxm4e>
import { watchContractEvent } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { abi } from './abi'
import { config } from './config'

const unwatch = watchContractEvent(config, {
  abi,
  chainId: mainnet.id, // [!code focus]
  onLogs(logs) {
    console.log('Logs changed!', logs)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### eventName

`string`

* Event to listen for the contract.
* Inferred from [`abi`](#abi).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchContractEvent.md","from":3702,"to":3982}<fsm-vh3gqscxm4e>
import { watchContractEvent } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const unwatch = watchContractEvent(config, {
  abi,
  eventName: 'Approval', // [!code focus]
  onLogs(logs) {
    console.log('Logs changed!', logs)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onError

`((error: Error) => void) | undefined`

Error thrown from getting the block number.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchContractEvent.md","from":4198,"to":4553}<fsm-vh3gqscxm4e>
import { watchContractEvent } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const unwatch = watchContractEvent(config, {
  abi,
  onLogs(logs) { 
    console.log('Logs changed!', logs) 
  }, 
  onError(error) { // [!code focus]
    console.error('Logs error', error) // [!code focus]
  }, // [!code focus]
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onLogs

`(logs: Log[], prevLogs: Log[] | undefined) => void`

Callback for when logs changes.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchContractEvent.md","from":4770,"to":5059}<fsm-vh3gqscxm4e>
import { watchContractEvent } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const unwatch = watchContractEvent(config, {
  abi,
  onLogs(logs) { // [!code focus]
    console.log('Logs changed!', logs) // [!code focus]
  }, // [!code focus]
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### poll

`boolean | undefined`

* Whether or not to use a polling mechanism to check for new blocks instead of a WebSocket subscription.
* Defaults to `false` for WebSocket Clients, and `true` for non-WebSocket Clients.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchContractEvent.md","from":5399,"to":5668}<fsm-vh3gqscxm4e>
import { watchContractEvent } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const unwatch = watchContractEvent(config, {
  abi,
  onLogs(logs) {
    console.log('Logs changed!', logs)
  },
  poll: true, // [!code focus]
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### pollingInterval

`number | undefined`

* Polling frequency (in milliseconds).
* Defaults to the [Config's `pollingInterval` config](/core/api/createConfig#pollinginterval).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchContractEvent.md","from":5964,"to":6245}<fsm-vh3gqscxm4e>
import { watchContractEvent } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const unwatch = watchContractEvent(config, {
  abi,
  onLogs(logs) {
    console.log('Logs changed!', logs)
  },
  pollingInterval: 1_000, // [!code focus]
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### strict

`boolean | undefined`

* Defaults to `false`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchContractEvent.md","from":6422,"to":6693}<fsm-vh3gqscxm4e>
import { watchContractEvent } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const unwatch = watchContractEvent(config, {
  abi,
  onLogs(logs) {
    console.log('Logs changed!', logs)
  },
  strict: true, // [!code focus]
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### syncConnectedChain

`boolean | undefined`

* Set up subscriber for connected chain changes.
* Defaults to [`Config['syncConnectedChain']`](/core/api/createConfig#syncconnectedchain).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchContractEvent.md","from":6999,"to":7283}<fsm-vh3gqscxm4e>
import { watchContractEvent } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const unwatch = watchContractEvent(config, {
  abi,
  onLogs(logs) {
    console.log('Logs changed!', logs)
  },
  syncConnectedChain: false, // [!code focus]
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchContractEvent.md","from":7391,"to":7455}<fsm-vh3gqscxm4e>
import { type WatchContractEventReturnType } from '@wagmi/core'
```

Function for cleaning up watcher.

## Type Inference

With [`abi`](#abi) setup correctly, TypeScript will infer the correct types for [`eventName`](#eventname), [`args`](#args), and [`onLogs`](#onlogs) parameters. See the Wagmi [TypeScript docs](/core/typescript) for more information.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchContractEvent.md","from":7763,"to":7822}<fsm-vh3gqscxm4e>
import { type WatchContractEventError } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`watchContractEvent`](https://viem.sh/docs/contract/watchContractEvent)

---

---
url: /core/api/actions/watchPendingTransactions.md
---
# watchPendingTransactions

Action that watches and returns pending transaction hashes.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchPendingTransactions.md","from":256,"to":311}<fsm-vh3gqscxm4e>
import { watchPendingTransactions } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchPendingTransactions.md","from":358,"to":591}<fsm-vh3gqscxm4e>
import { watchPendingTransactions } from '@wagmi/core'
import { config } from './config'

const unwatch = watchPendingTransactions(config, {
  onTransactions(transactions) {
    console.log('New transactions!', transactions)
  },
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchPendingTransactions.md","from":662,"to":732}<fsm-vh3gqscxm4e>
import { type WatchPendingTransactionsParameters } from '@wagmi/core'
```

### batch

`boolean | undefined`

* Whether or not the transactions should be batched on each invocation.
* Defaults to `true`.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchPendingTransactions.md","from":898,"to":1130}<fsm-vh3gqscxm4e>
import { watchPendingTransactions } from '@wagmi/core'

const unwatch = watchPendingTransactions(config, {
  batch: false, // [!code focus]
  onTransactions(transactions) {
    console.log('New transactions!', transactions)
  },
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

ID of chain to use when fetching data.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchPendingTransactions.md","from":1311,"to":1629}<fsm-vh3gqscxm4e>
import { watchPendingTransactions } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'

const unwatch = watchPendingTransactions(config, {
  chainId: mainnet.id, // [!code focus]
  onTransactions(transactions) {
    console.log('New transactions!', transactions)
  },
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onError

`((error: Error) => void) | undefined`

Error thrown from watching pending transactions.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchPendingTransactions.md","from":1814,"to":2154}<fsm-vh3gqscxm4e>
import { watchPendingTransactions } from '@wagmi/core'
import { config } from './config'

const unwatch = watchPendingTransactions(config, {
  onError(error) { // [!code focus]
    console.log('Error', error) // [!code focus]
  }, // [!code focus]
  onTransactions(transactions) {
    console.log('New transactions!', transactions)
  },
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### onTransactions

`(transactions: Hash[], prevTransactions: Hash[] | undefined) => void`

Callback when new incoming pending transactions are detected.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchPendingTransactions.md","from":2391,"to":2675}<fsm-vh3gqscxm4e>
import { watchPendingTransactions } from '@wagmi/core'
import { config } from './config'

const unwatch = watchPendingTransactions(config, {
  onTransactions(transactions) { // [!code focus]
    console.log('New transactions!', transactions) // [!code focus]
  }, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### poll

`boolean | undefined`

* Whether or not to use a polling mechanism to check for new pending transactions instead of a WebSocket subscription.
* Defaults to `false` for WebSocket Clients, and `true` for non-WebSocket Clients.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchPendingTransactions.md","from":2993,"to":3258}<fsm-vh3gqscxm4e>
import { watchPendingTransactions } from '@wagmi/core'
import { config } from './config'

const unwatch = watchPendingTransactions(config, {
  onTransactions(transactions) {
    console.log('New transactions!', transactions)
  },
  poll: false, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### pollingInterval

`number | undefined`

* Polling frequency (in milliseconds).
* Defaults to the [Config's `pollingInterval` config](/core/api/createConfig#pollinginterval).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchPendingTransactions.md","from":3518,"to":3794}<fsm-vh3gqscxm4e>
import { watchPendingTransactions } from '@wagmi/core'
import { config } from './config'

const unwatch = watchPendingTransactions(config, {
  onTransactions(transactions) {
    console.log('New transactions!', transactions)
  },
  pollingInterval: 1_000, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### syncConnectedChain

`boolean | undefined`

* Set up subscriber for connected chain changes.
* Defaults to [`Config['syncConnectedChain']`](/core/api/createConfig#syncconnectedchain).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchPendingTransactions.md","from":4064,"to":4343}<fsm-vh3gqscxm4e>
import { watchPendingTransactions } from '@wagmi/core'
import { config } from './config'

const unwatch = watchPendingTransactions(config, {
  onTransactions(transactions) {
    console.log('New transactions!', transactions)
  },
  syncConnectedChain: false, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchPendingTransactions.md","from":4415,"to":4485}<fsm-vh3gqscxm4e>
import { type WatchPendingTransactionsReturnType } from '@wagmi/core'
```

Function to unsubscribe from pending transaction listener.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchPendingTransactions.md","from":4566,"to":4631}<fsm-vh3gqscxm4e>
import { type WatchPendingTransactionsError } from '@wagmi/core'
```

## Viem

* [`watchPendingTransactions`](https://viem.sh/docs/actions/public/watchPendingTransactions)

---

---
url: /core/api/actions/watchPublicClient.md
---
# watchPublicClient

Subscribe to Public Client changes.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchPublicClient.md","from":75,"to":123}<fsm-vh3gqscxm4e>
import { watchPublicClient } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchPublicClient.md","from":170,"to":386}<fsm-vh3gqscxm4e>
import { watchPublicClient } from '@wagmi/core'
import { config } from './config'

const unwatch = watchPublicClient(config, {
  onChange(client) {
    console.log('Public Client changed!', client)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchPublicClient.md","from":457,"to":520}<fsm-vh3gqscxm4e>
import { type WatchPublicClientParameters } from '@wagmi/core'
```

### onChange

`onChange(client: GetPublicClientReturnType, prevClient: GetPublicClientReturnType): void`

Callback function called when Public Client changes.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchPublicClient.md","from":717,"to":952}<fsm-vh3gqscxm4e>
import { watchPublicClient } from '@wagmi/core'
import { config } from './config'

const unwatch = watchPublicClient(config, {
  onChange(client) { // [!code focus:3]
    console.log('Public Client changed!', client)
  },
})
unwatch()
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/watchPublicClient.md","from":1024,"to":1087}<fsm-vh3gqscxm4e>
import { type WatchPublicClientReturnType } from '@wagmi/core'
```

Function for cleaning up watcher.

---

---
url: /core/api/transports/webSocket.md
---

# webSocket

The `webSocket` Transport connects to a JSON-RPC API via a WebSocket. Wraps Viem's [`webSocket` Transport](https://viem.sh/docs/clients/transports/websocket).

## Import

```ts-vue
import { webSocket } from '{{packageName}}'
```

## Usage

```ts-vue
import { 
  createConfig, 
  webSocket // [!code hl]
} from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()],
  transports: {
    [mainnet.id]: webSocket('wss://foo-bar-baz.quiknode.pro/...'), // [!code hl]
    [sepolia.id]: webSocket('wss://foo-bar-sep.quicknode.pro/...'), // [!code hl]
  },
})
```

::: warning
If no URL is provided, then the transport will fall back to a public RPC URL on the chain. It is highly recommended to provide an authenticated RPC URL to prevent rate-limiting.
:::

## Parameters

### url

`string`

URL of the JSON-RPC API.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...')
```

### key (optional)

`string`

A key for the Transport. Defaults to `"webSocket"`.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', { 
  key: 'alchemy',  // [!code focus]
})
```

### name (optional)

`string`

A name for the Transport. Defaults to `"WebSocket JSON-RPC"`.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', { 
  name: 'Alchemy WebSocket Provider',  // [!code focus]
})
```

### retryCount (optional)

`number`

The max number of times to retry when a request fails. Defaults to `3`.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', {
  retryCount: 5, // [!code focus]
})
```

### retryDelay (optional)

`number`

The base delay (in ms) between retries. By default, the Transport will use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) (`~~(1 << count) * retryDelay`), which means the time between retries is not constant.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', {
  retryDelay: 100, // [!code focus]
})
```

### timeout (optional)

`number`

The timeout for async WebSocket requests. Defaults to `10_000`.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', {
  timeout: 60_000, // [!code focus]
})
```

---

---
url: /react/api/transports/webSocket.md
---

# webSocket

The `webSocket` Transport connects to a JSON-RPC API via a WebSocket. Wraps Viem's [`webSocket` Transport](https://viem.sh/docs/clients/transports/websocket).

## Import

```ts-vue
import { webSocket } from '{{packageName}}'
```

## Usage

```ts-vue
import { 
  createConfig, 
  webSocket // [!code hl]
} from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()],
  transports: {
    [mainnet.id]: webSocket('wss://foo-bar-baz.quiknode.pro/...'), // [!code hl]
    [sepolia.id]: webSocket('wss://foo-bar-sep.quicknode.pro/...'), // [!code hl]
  },
})
```

::: warning
If no URL is provided, then the transport will fall back to a public RPC URL on the chain. It is highly recommended to provide an authenticated RPC URL to prevent rate-limiting.
:::

## Parameters

### url

`string`

URL of the JSON-RPC API.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...')
```

### key (optional)

`string`

A key for the Transport. Defaults to `"webSocket"`.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', { 
  key: 'alchemy',  // [!code focus]
})
```

### name (optional)

`string`

A name for the Transport. Defaults to `"WebSocket JSON-RPC"`.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', { 
  name: 'Alchemy WebSocket Provider',  // [!code focus]
})
```

### retryCount (optional)

`number`

The max number of times to retry when a request fails. Defaults to `3`.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', {
  retryCount: 5, // [!code focus]
})
```

### retryDelay (optional)

`number`

The base delay (in ms) between retries. By default, the Transport will use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) (`~~(1 << count) * retryDelay`), which means the time between retries is not constant.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', {
  retryDelay: 100, // [!code focus]
})
```

### timeout (optional)

`number`

The timeout for async WebSocket requests. Defaults to `10_000`.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', {
  timeout: 60_000, // [!code focus]
})
```

---

---
url: /shared/transports/webSocket.md
---
# webSocket

The `webSocket` Transport connects to a JSON-RPC API via a WebSocket. Wraps Viem's [`webSocket` Transport](https://viem.sh/docs/clients/transports/websocket).

## Import

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/webSocket.md","from":257,"to":301}<fsm-vh3gqscxm4e>
import { webSocket } from '{{packageName}}'
```

## Usage

```ts-vue
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/webSocket.md","from":326,"to":745}<fsm-vh3gqscxm4e>
import { 
  createConfig, 
  webSocket // [!code hl]
} from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()],
  transports: {
    [mainnet.id]: webSocket('wss://foo-bar-baz.quiknode.pro/...'), // [!code hl]
    [sepolia.id]: webSocket('wss://foo-bar-sep.quicknode.pro/...'), // [!code hl]
  },
})
```

::: warning
If no URL is provided, then the transport will fall back to a public RPC URL on the chain. It is highly recommended to provide an authenticated RPC URL to prevent rate-limiting.
:::

## Parameters

### url

`string`

URL of the JSON-RPC API.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/webSocket.md","from":1011,"to":1077}<fsm-vh3gqscxm4e>
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...')
```

### key (optional)

`string`

A key for the Transport. Defaults to `"webSocket"`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/webSocket.md","from":1171,"to":1279}<fsm-vh3gqscxm4e>
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', { 
  key: 'alchemy',  // [!code focus]
})
```

### name (optional)

`string`

A name for the Transport. Defaults to `"WebSocket JSON-RPC"`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/webSocket.md","from":1384,"to":1512}<fsm-vh3gqscxm4e>
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', { 
  name: 'Alchemy WebSocket Provider',  // [!code focus]
})
```

### retryCount (optional)

`number`

The max number of times to retry when a request fails. Defaults to `3`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/webSocket.md","from":1633,"to":1738}<fsm-vh3gqscxm4e>
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', {
  retryCount: 5, // [!code focus]
})
```

### retryDelay (optional)

`number`

The base delay (in ms) between retries. By default, the Transport will use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) (`~~(1 << count) * retryDelay`), which means the time between retries is not constant.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/webSocket.md","from":2022,"to":2129}<fsm-vh3gqscxm4e>
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', {
  retryDelay: 100, // [!code focus]
})
```

### timeout (optional)

`number`

The timeout for async WebSocket requests. Defaults to `10_000`.

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/shared/transports/webSocket.md","from":2239,"to":2346}<fsm-vh3gqscxm4e>
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', {
  timeout: 60_000, // [!code focus]
})
```

---

---
url: /solid/api/transports/webSocket.md
---

# webSocket

The `webSocket` Transport connects to a JSON-RPC API via a WebSocket. Wraps Viem's [`webSocket` Transport](https://viem.sh/docs/clients/transports/websocket).

## Import

```ts-vue
import { webSocket } from '{{packageName}}'
```

## Usage

```ts-vue
import { 
  createConfig, 
  webSocket // [!code hl]
} from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()],
  transports: {
    [mainnet.id]: webSocket('wss://foo-bar-baz.quiknode.pro/...'), // [!code hl]
    [sepolia.id]: webSocket('wss://foo-bar-sep.quicknode.pro/...'), // [!code hl]
  },
})
```

::: warning
If no URL is provided, then the transport will fall back to a public RPC URL on the chain. It is highly recommended to provide an authenticated RPC URL to prevent rate-limiting.
:::

## Parameters

### url

`string`

URL of the JSON-RPC API.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...')
```

### key (optional)

`string`

A key for the Transport. Defaults to `"webSocket"`.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', { 
  key: 'alchemy',  // [!code focus]
})
```

### name (optional)

`string`

A name for the Transport. Defaults to `"WebSocket JSON-RPC"`.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', { 
  name: 'Alchemy WebSocket Provider',  // [!code focus]
})
```

### retryCount (optional)

`number`

The max number of times to retry when a request fails. Defaults to `3`.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', {
  retryCount: 5, // [!code focus]
})
```

### retryDelay (optional)

`number`

The base delay (in ms) between retries. By default, the Transport will use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) (`~~(1 << count) * retryDelay`), which means the time between retries is not constant.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', {
  retryDelay: 100, // [!code focus]
})
```

### timeout (optional)

`number`

The timeout for async WebSocket requests. Defaults to `10_000`.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', {
  timeout: 60_000, // [!code focus]
})
```

---

---
url: /vue/api/transports/webSocket.md
---

# webSocket

The `webSocket` Transport connects to a JSON-RPC API via a WebSocket. Wraps Viem's [`webSocket` Transport](https://viem.sh/docs/clients/transports/websocket).

## Import

```ts-vue
import { webSocket } from '{{packageName}}'
```

## Usage

```ts-vue
import { 
  createConfig, 
  webSocket // [!code hl]
} from '{{packageName}}'
import { mainnet, sepolia } from '{{packageName}}/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  connectors: [injected()],
  transports: {
    [mainnet.id]: webSocket('wss://foo-bar-baz.quiknode.pro/...'), // [!code hl]
    [sepolia.id]: webSocket('wss://foo-bar-sep.quicknode.pro/...'), // [!code hl]
  },
})
```

::: warning
If no URL is provided, then the transport will fall back to a public RPC URL on the chain. It is highly recommended to provide an authenticated RPC URL to prevent rate-limiting.
:::

## Parameters

### url

`string`

URL of the JSON-RPC API.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...')
```

### key (optional)

`string`

A key for the Transport. Defaults to `"webSocket"`.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', { 
  key: 'alchemy',  // [!code focus]
})
```

### name (optional)

`string`

A name for the Transport. Defaults to `"WebSocket JSON-RPC"`.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', { 
  name: 'Alchemy WebSocket Provider',  // [!code focus]
})
```

### retryCount (optional)

`number`

The max number of times to retry when a request fails. Defaults to `3`.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', {
  retryCount: 5, // [!code focus]
})
```

### retryDelay (optional)

`number`

The base delay (in ms) between retries. By default, the Transport will use [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) (`~~(1 << count) * retryDelay`), which means the time between retries is not constant.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', {
  retryDelay: 100, // [!code focus]
})
```

### timeout (optional)

`number`

The timeout for async WebSocket requests. Defaults to `10_000`.

```ts
const transport = webSocket('wss://foo-bar-baz.quiknode.pro/...', {
  timeout: 60_000, // [!code focus]
})
```

---

---
url: /react/why.md
---
# Why Wagmi

## The Problems

Building Ethereum applications is hard. Apps need to support connecting wallets, multiple chains, signing messages and data, sending transactions, listening for events and state changes, refreshing stale blockchain data, and much more. This is all on top of solving for app-specific use-cases and providing polished user experiences.

The ecosystem is also continuously evolving, meaning you need to adapt to new improvements or get left behind. App developers should not need to worry about connecting tens of different wallets, the intricacies of multi-chain support, typos accidentally sending an order of magnitude more ETH or calling a misspelled contract function, or accidentally spamming their RPC provider, costing thousands in compute units.

Wagmi solves all these problems and more — allowing app developers to focus on building high-quality and performant experiences for Ethereum — by focusing on **developer experience**, **performance**, **feature coverage**, and **stability.**

## Developer Experience

Wagmi delivers a great developer experience through modular and composable APIs, automatic type safety and inference, and comprehensive documentation.

It provides developers with intuitive building blocks to build their Ethereum apps. While Wagmi's APIs might seem more verbose at first, it makes Wagmi's modular building blocks extremely flexible. Easy to move around, change, and remove. It also allows developers to better understand Ethereum concepts as well as understand *what* and *why* certain properties are being passed through. Learning how to use Wagmi is a great way to learn how to interact with Ethereum in general.

Wagmi also provides [strongly typed APIs](/react/typescript), allowing consumers to get the best possible experience through [autocomplete](https://twitter.com/awkweb/status/1555678944770367493), [type inference](https://twitter.com/jakemoxey/status/1570244174502588417?s=20), as well as static validation. You often just need to provide an ABI and Wagmi can help you autocomplete your way to success, identify type errors before your users do, drill into blockchain errors [at compile and runtimes](/react/guides/error-handling) with surgical precision, and much more.

The API documentation is comprehensive and contains usage info for *every* module in Wagmi. The core team uses a [documentation](https://gist.github.com/zsup/9434452) and [test driven](https://en.wikipedia.org/wiki/Test-driven_development#:~:text=Test%2Ddriven%20development%20\(TDD\),software%20against%20all%20test%20cases.) development approach to building modules, which leads to predictable and stable APIs.

## Performance

Performance is critical for applications on all sizes. Slow page load and interactions can cause users to stop using applications. Wagmi uses and is built by the same team behind [Viem](https://viem.sh), the most performant production-ready Ethereum library.

End users should not be required to download a module of over 100kB in order to interact with Ethereum. Wagmi is optimized for tree-shaking and dead-code elimination, allowing apps to minimize bundle size for fast page load times.

Data layer performance is also critical. Slow, unnecessary, and manual data fetching can make apps unusable and cost thousands in RPC compute units. Wagmi supports caching, deduplication, persistence, and much more through [TanStack Query](/react/guides/tanstack-query).

## Feature Coverage

Wagmi supports the most popular and commonly-used Ethereum features out of the box with 40+ React Hooks for accounts, wallets, contracts, transactions, signing, ENS, and more. Wagmi also supports just about any wallet out there through official [connectors](/react/api/connectors), [EIP-6963 support](/react/api/createConfig#multiinjectedproviderdiscovery), and [extensible API](/dev/creating-connectors).

If you need lower-level control, you can always drop down to [Wagmi Core](/core/getting-started) or [Viem](https://viem.sh), which Wagmi uses internally to perform blockchain operations. Wagmi also manages multi-chain support automatically so developers can focus on their applications instead of adding custom code.

Finally, Wagmi has a [CLI](/cli/getting-started) to manage ABIs as well as a robust ecosystem of third-party libraries, like [ConnectKit](https://docs.family.co/connectkit), [Dynamic](https://www.dynamic.xyz), [Privy](https://privy.io), and many more, so you can get started quickly without needing to build everything from scratch.

## Stability

Stability is a fundamental principle for Wagmi. Many organizations, large and small, rely heavily on Wagmi and expect it to be entirely stable for their users and applications.

Wagmi's test suite runs against forked Ethereum nodes to make sure functions work across chains. The test suite also runs type tests against many different versions of peer dependencies, like TypeScript, to ensure compatibility with the latest releases of other popular software.

Wagmi follows semver so developers can upgrade between versions with confidence. Starting with Wagmi v2, new functionality will be opt-in with old functionality being deprecated alongside the new features. This means upgrading to the latest major versions will not require immediate changes.

Lastly, the core team works full-time on Wagmi and [related projects](https://github.com/wevm), and is constantly improving Wagmi and keeping it up-to-date with industry trends and changes.

---

---
url: /solid/why.md
---
# Why Wagmi

Please see the [React "Why Wagmi"](/react/why) page for more information on the rationale behind the Wagmi project. The same principles apply to `@wagmi/solid`.

## Why Solid?

[Solid](https://www.solidjs.com/) is a declarative JavaScript library for building user interfaces. It compiles templates to real DOM nodes and updates them with fine-grained reactions. Solid combines the best ideas from React, Vue, and Svelte while providing excellent performance and a small bundle size.

`@wagmi/solid` brings the same great developer experience from Wagmi to Solid applications, allowing you to build Ethereum applications with Solid's reactive primitives.

---

---
url: /vue/why.md
---
# Why Wagmi

## The Problems

Building Ethereum applications is hard. Apps need to support connecting wallets, multiple chains, signing messages and data, sending transactions, listening for events and state changes, refreshing stale blockchain data, and much more. This is all on top of solving for app-specific use-cases and providing polished user experiences.

The ecosystem is also continuously evolving, meaning you need to adapt to new improvements or get left behind. App developers should not need to worry about connecting tens of different wallets, the intricacies of multi-chain support, typos accidentally sending an order of magnitude more ETH or calling a misspelled contract function, or accidentally spamming their RPC provider, costing thousands in compute units.

Wagmi solves all these problems and more — allowing app developers to focus on building high-quality and performant experiences for Ethereum — by focusing on **developer experience**, **performance**, **feature coverage**, and **stability.**

## Developer Experience

Wagmi delivers a great developer experience through modular and composable APIs, automatic type safety and inference, and comprehensive documentation.

It provides developers with intuitive building blocks to build their Ethereum apps. While Wagmi's APIs might seem more verbose at first, it makes Wagmi's modular building blocks extremely flexible. Easy to move around, change, and remove. It also allows developers to better understand Ethereum concepts as well as understand *what* and *why* certain properties are being passed through. Learning how to use Wagmi is a great way to learn how to interact with Ethereum in general.

Wagmi also provides [strongly typed APIs](/vue/typescript), allowing consumers to get the best possible experience through [autocomplete](https://twitter.com/awkweb/status/1555678944770367493), [type inference](https://twitter.com/jakemoxey/status/1570244174502588417?s=20), as well as static validation. You often just need to provide an ABI and Wagmi can help you autocomplete your way to success, identify type errors before your users do, drill into blockchain errors [at compile and runtimes](/vue/guides/error-handling) with surgical precision, and much more.

The API documentation is comprehensive and contains usage info for *every* module in Wagmi. The core team uses a [documentation](https://gist.github.com/zsup/9434452) and [test driven](https://en.wikipedia.org/wiki/Test-driven_development#:~:text=Test%2Ddriven%20development%20\(TDD\),software%20against%20all%20test%20cases.) development approach to building modules, which leads to predictable and stable APIs.

## Performance

Performance is critical for applications on all sizes. Slow page load and interactions can cause users to stop using applications. Wagmi uses and is built by the same team behind [Viem](https://viem.sh), the most performant production-ready Ethereum library.

End users should not be required to download a module of over 100kB in order to interact with Ethereum. Wagmi is optimized for tree-shaking and dead-code elimination, allowing apps to minimize bundle size for fast page load times.

Data layer performance is also critical. Slow, unnecessary, and manual data fetching can make apps unusable and cost thousands in RPC compute units. Wagmi supports caching, deduplication, persistence, and much more through [TanStack Query](/vue/guides/tanstack-query).

## Feature Coverage

Wagmi supports the most popular and commonly-used Ethereum features out of the box with 40+ Vue Composables for accounts, wallets, contracts, transactions, signing, ENS, and more. Wagmi also supports just about any wallet out there through it's official [connectors](/vue/api/connectors), [EIP-6963 support](/vue/api/createConfig#multiinjectedproviderdiscovery), and [extensible API](/dev/creating-connectors).

If you need lower-level control, you can always drop down to [Wagmi Core](/core/getting-started) or [Viem](https://viem.sh), which Wagmi uses internally to perform blockchain operations. Wagmi also manages multi-chain support automatically so developers can focus on their applications instead of adding custom code.

Finally, Wagmi has a [CLI](/cli/getting-started) to manage ABIs as well as a robust ecosystem of third-party libraries, like [ConnectKit](https://docs.family.co/connectkit), [Dynamic](https://www.dynamic.xyz), [Privy](https://privy.io), and many more, so you can get started quickly without needing to build everything from scratch.

## Stability

Stability is a fundamental principle for Wagmi. Many organizations, large and small, rely heavily on Wagmi and expect it to be entirely stable for their users and applications.

Wagmi's test suite runs against forked Ethereum nodes to make sure functions work across chains. The test suite also runs type tests against many different versions of peer dependencies, like TypeScript, to ensure compatibility with the latest releases of other popular software.

Wagmi follows semver so developers can upgrade between versions with confidence. Starting with Wagmi v2, new functionality will be opt-in with old functionality being deprecated alongside the new features. This means upgrading to the latest major versions will not require immediate changes.

Lastly, the core team works full-time on Wagmi and [related projects](https://github.com/wevm), and is constantly improving Wagmi and keeping it up-to-date with industry trends and changes.

---

---
url: /cli/why.md
---
# Why Wagmi CLI

## The Problem

The most common way to interact with smart contracts is through [Application Binary Interfaces](https://docs.soliditylang.org/en/latest/abi-spec.html). ABIs describe smart contracts' public functionality (e.g. functions, events, errors) as well as how to encode and decode related data (e.g. arguments and results).

While ABIs are extremely powerful, there isn't a uniform way developers manage them in their apps. Developers do a bunch of different things, like:

* Publish packages on npm containing ABIs
* Write custom scripts to fetch ABIs from external sources
* Compile contracts into application project
* Copy and paste ABIs from local projects or block explorers

All these approaches take time that you could spend doing more important things, like interacting with your smart contracts!

## The Solution

The Wagmi CLI is an attempt to automate manual work so you can build faster. In short, the CLI manages ABIs and generates code. It takes ABIs as inputs and outputs ABIs and generated code. For example, the [Etherscan plugin](/cli/api/plugins/etherscan) allows you to fetch ABIs across multiple chains and deployments and immediately start importing them into your project.

Code generation is another big advantage of the CLI. Using the [React plugin](/cli/api/plugins/react), you can generate [Wagmi Hooks](/react/api/hooks) for ABIs. When you combine this with the CLI's different ABI sources, like Etherscan, Foundry/Hardhat, and more, you reduce a lot of boilerplate code.

::: code-group

```ts [Diff]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/why.md","from":1556,"to":2407}<fsm-vh3gqscxm4e>
import { useReadContract, useWriteContract } from 'wagmi' // [!code --]
import { froggyFriendsAbi, froggyFriendsAddress } from './generated' // [!code --]
import { useReadFroggyFriends, useWriteFroggyFriends } from './generated' // [!code ++]

function App() {
  const { data } = useReadContract({ // [!code --]
  const { data } = useReadFroggyFriends({ // [!code ++]
    abi: froggyFriendsAbi, // [!code --]
    address: froggyFriendsAddress, // [!code --]
    functionName: 'tokenURI',
    args: [123n],
  })

  const { write } = useWriteContract() // [!code --]
  const { write } = useWriteFroggyFriends() // [!code ++]
  const onClick = React.useCallback(() => {
    write({
      abi: froggyFriendsAbi, // [!code --]
      address: froggyFriendsAddress, // [!code --]
      functionName: 'mint',
      args: ['foo', 123n],
    })
  }, [write])
}
```

```ts [Before]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/why.md","from":2426,"to":2963}<fsm-vh3gqscxm4e>
import { useReadContract, useWriteContract } from 'wagmi'
import { froggyFriendsAbi, froggyFriendsAddress } from './generated'

function App() {
  const { data } = useReadContract({
    abi: froggyFriendsAbi,
    address: froggyFriendsAddress,
    functionName: 'tokenURI',
    args: [123n],
  })

  const { write } = useWriteContract()
  const onClick = React.useCallback(() => {
    write({
      abi: froggyFriendsAbi,
      address: froggyFriendsAddress,
      functionName: 'mint',
      args: ['foo', 123n],
    })
  }, [write])
}
```

```ts [After]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/cli/why.md","from":2981,"to":3347}<fsm-vh3gqscxm4e>
import { useReadFroggyFriends, useWriteFroggyFriends } from './generated'

function App() {
  const { data } = useReadFroggyFriends({
    functionName: 'tokenURI',
    args: [123n],
  })

  const { write } = useWriteFroggyFriends()
  const onClick = React.useCallback(() => {
    write({
      functionName: 'mint',
      args: ['foo', 123n],
    })
  }, [write])
}
```

:::

Finally, the Wagmi CLI supports popular smart contract development tools, [Foundry](/cli/api/plugins/foundry) and [Hardhat](/cli/api/plugins/hardhat). You can run the CLI in [watch mode](/cli/api/commands/generate#w-watch), make changes to your contracts, and the CLI will automatically pick up ABI changes and run plugins over those changes. A major boon to working a monorepo and shortening the feedback loop across your stack.

---

---
url: /core/why.md
---
# Why Wagmi Core

## The Problems

Building Ethereum applications is hard. Apps need to support connecting wallets, multiple chains, signing messages and data, sending transactions, listening for events and state changes, refreshing stale blockchain data, and much more. This is all on top of solving for app-specific use-cases and providing polished user experiences.

The ecosystem is also continuously evolving, meaning you need to adapt to new improvements or get left behind. App developers should not need to worry about connecting tens of different wallets, the intricacies of multi-chain support, typos accidentally sending an order of magnitude more ETH or calling a misspelled contract function, or accidentally spamming their RPC provider, costing thousands in compute units.

Wagmi Core solves all these problems and more — allowing app developers to focus on building high-quality and performant experiences for Ethereum — by focusing on **developer experience**, **performance**, **feature coverage**, and **stability.**

## Developer Experience

Wagmi Core delivers a great developer experience through modular and composable APIs, automatic type safety and inference, and comprehensive documentation.

It provides developers with intuitive building blocks to build their Ethereum apps. While Wagmi Core's APIs might seem more verbose at first, it makes Wagmi Core's modular building blocks extremely flexible. Easy to move around, change, and remove. It also allows developers to better understand Ethereum concepts as well as understand *what* and *why* certain properties are being passed through. Learning how to use Wagmi Core is a great way to learn how to interact with Ethereum in general.

Wagmi Core also provides [strongly typed APIs](/core/typescript), allowing consumers to get the best possible experience through [autocomplete](https://twitter.com/awkweb/status/1555678944770367493), [type inference](https://twitter.com/jakemoxey/status/1570244174502588417?s=20), as well as static validation. You often just need to provide an ABI and Wagmi Core can help you autocomplete your way to success, identify type errors before your users do, drill into blockchain errors [at compile and runtimes](/core/guides/error-handling) with surgical precision, and much more.

The API documentation is comprehensive and contains usage info for *every* module in Wagmi Core. The core team uses a [documentation](https://gist.github.com/zsup/9434452) and [test driven](https://en.wikipedia.org/wiki/Test-driven_development#:~:text=Test%2Ddriven%20development%20\(TDD\),software%20against%20all%20test%20cases.) development approach to building modules, which leads to predictable and stable APIs.

## Performance

Performance is critical for applications on all sizes. Slow page load and interactions can cause users to stop using applications. Wagmi Core uses and is built by the same team behind [Viem](https://viem.sh), the most performant production-ready Ethereum library.

End users should not be required to download a module of over 100kB in order to interact with Ethereum. Wagmi Core is optimized for tree-shaking and dead-code elimination, allowing apps to minimize bundle size for fast page load times.

Data layer performance is also critical. Slow, unnecessary, and manual data fetching can make apps unusable and cost thousands in RPC compute units. Wagmi Core supports caching, deduplication, persistence, and much more through [TanStack Query](/react/guides/tanstack-query) via the `'@wagmi/core/query'` entrypoint so you can [plug it into your framework](/core/guides/framework-adapters) of choice, like Vue, Svelte, and more.

## Feature Coverage

Wagmi Core supports the most popular and commonly-used Ethereum features out of the box with 40+ VanillaJS Actions for accounts, wallets, contracts, transactions, signing, ENS, and more. Wagmi Core also supports just about any wallet out there through its official [connectors](/core/api/connectors), [EIP-6963 support](/core/api/createConfig#multiinjectedproviderdiscovery), and [extensible API](/dev/creating-connectors).

If you need lower-level control, you can always drop down to [Viem](https://viem.sh), which Wagmi Core uses internally to perform blockchain operations. Wagmi Core also manages multi-chain support automatically so developers can focus on their applications instead of adding custom code.

Finally, Wagmi Core has a [CLI](/cli/getting-started) to manage ABIs as well as a robust ecosystem of third-party libraries, like [ConnectKit](https://docs.family.co/connectkit), [Dynamic](https://www.dynamic.xyz), [Privy](https://privy.io), and many more, so you can get started quickly without needing to build everything from scratch.

## Stability

Stability is a fundamental principle for Wagmi Core. Many organizations, large and small, rely heavily on Wagmi Core and expect it to be entirely stable for their users and applications.

Wagmi Core's test suite runs against forked Ethereum nodes to make sure functions work across chains. The test suite also runs type tests against many different versions of peer dependencies, like TypeScript, to ensure compatibility with the latest releases of other popular software.

Wagmi Core follows semver so developers can upgrade between versions with confidence. Starting with Wagmi Core v2, new functionality will be opt-in with old functionality being deprecated alongside the new features. This means upgrading to the latest major versions will not require immediate changes.

Lastly, the core team works full-time on Wagmi Core and [related projects](https://github.com/wevm), and is constantly improving Wagmi Core and keeping it up-to-date with industry trends and changes.

---

---
url: /react/guides/write-to-contract.md
---
# Write to Contract

The [`useWriteContract` Hook](/react/api/hooks/useWriteContract) allows you to mutate data on a smart contract, from a `payable` or `nonpayable` (write) function. These types of functions require gas to be executed, hence a transaction is broadcasted in order to change the state.

In the guide below, we will teach you how to implement a "Mint NFT" form that takes in a dynamic argument (token ID) using Wagmi. The example below builds on the [Connect Wallet guide](/react/guides/connect-wallet) and uses the [useWriteContract](/react/api/hooks/useWriteContract) & [useWaitForTransactionReceipt](/react/api/hooks/useWaitForTransactionReceipt) hooks.

If you have already completed the [Sending Transactions guide](/react/guides/send-transaction), this guide will look very similar! That's because writing to a contract internally broadcasts & sends a transaction.

## Example

Feel free to check out the example before moving on:

## Steps

### 1. Connect Wallet

Follow the [Connect Wallet guide](/react/guides/connect-wallet) guide to get this set up.

### 2. Create a new component

Create your `MintNFT` component that will contain the Mint NFT logic.

::: code-group

```tsx [mint-nft.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/write-to-contract.md","from":1389,"to":1592}<fsm-vh3gqscxm4e>
import * as React from 'react'
 
export function MintNFT() {
  return (
    <form>
      <input name="tokenId" placeholder="69420" required />
      <button type="submit">Mint</button>
    </form>
  )
}
```

:::

### 3. Add a form handler

Next, we will need to add a handler to the form that will send the transaction when the user hits "Mint". This will be a basic handler in this step.

::: code-group

```tsx [mint-nft.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/write-to-contract.md","from":1817,"to":2355}<fsm-vh3gqscxm4e>
import * as React from 'react'
 
export function MintNFT() {
  async function submit(e: React.FormEvent<HTMLFormElement>) { // [!code ++]
    e.preventDefault() // [!code ++]
    const formData = new FormData(e.target as HTMLFormElement) // [!code ++]
    const tokenId = formData.get('tokenId') as string // [!code ++]
  } // [!code ++]

  return (
    <form> // [!code --]
    <form onSubmit={submit}> // [!code ++]
      <input name="tokenId" placeholder="69420" required />
      <button type="submit">Mint</button>
    </form>
  )
}
```

:::

### 4. Hook up the `useWriteContract` Hook

Now that we have the form handler, we can hook up the [`useWriteContract` Hook](/react/api/hooks/useWriteContract) to send the transaction.

::: code-group

```tsx [mint-nft.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/write-to-contract.md","from":2588,"to":3501}<fsm-vh3gqscxm4e>
import * as React from 'react'
import { useWriteContract } from 'wagmi' // [!code ++]
import { abi } from './abi' // [!code ++]
 
export function MintNFT() {
  const { data: hash, writeContract } = useWriteContract() // [!code ++]

  async function submit(e: React.FormEvent<HTMLFormElement>) { 
    e.preventDefault() 
    const formData = new FormData(e.target as HTMLFormElement) 
    const tokenId = formData.get('tokenId') as string 
    writeContract({ // [!code ++]
      address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', // [!code ++]
      abi, // [!code ++]
      functionName: 'mint', // [!code ++]
      args: [BigInt(tokenId)], // [!code ++]
    }) // [!code ++]
  } 

  return (
    <form onSubmit={submit}>
      <input name="tokenId" placeholder="69420" required />
      <button type="submit">Mint</button>
      {hash && <div>Transaction Hash: {hash}</div>} // [!code ++]
    </form>
  )
}
```

```ts [abi.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/write-to-contract.md","from":3521,"to":3729}<fsm-vh3gqscxm4e>
export const abi = [
  {
    name: 'mint',
    type: 'function',
    stateMutability: 'nonpayable',
    inputs: [{ internalType: 'uint32', name: 'tokenId', type: 'uint32' }],
    outputs: [],
  },
] as const
```

:::

### 5. Add loading state (optional)

We can optionally add a loading state to the "Mint" button while we are waiting confirmation from the user's wallet.

::: code-group

```tsx [mint-nft.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/write-to-contract.md","from":3932,"to":4898}<fsm-vh3gqscxm4e>
import * as React from 'react'
import { useWriteContract } from 'wagmi'
import { abi } from './abi'
 
export function MintNFT() {
  const { 
    data: hash, 
    isPending, // [!code ++]
    writeContract 
  } = useWriteContract() 

  async function submit(e: React.FormEvent<HTMLFormElement>) { 
    e.preventDefault() 
    const formData = new FormData(e.target as HTMLFormElement) 
    const tokenId = formData.get('tokenId') as string 
    writeContract({
      address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
      abi,
      functionName: 'mint',
      args: [BigInt(tokenId)],
    })
  } 

  return (
    <form onSubmit={submit}>
      <input name="tokenId" placeholder="69420" required />
      <button 
        disabled={isPending} // [!code ++]
        type="submit"
      >
        Mint // [!code --]
        {isPending ? 'Confirming...' : 'Mint'} // [!code ++]
      </button>
      {hash && <div>Transaction Hash: {hash}</div>}
    </form>
  )
}
```

```ts [abi.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/write-to-contract.md","from":4918,"to":5126}<fsm-vh3gqscxm4e>
export const abi = [
  {
    name: 'mint',
    type: 'function',
    stateMutability: 'nonpayable',
    inputs: [{ internalType: 'uint32', name: 'tokenId', type: 'uint32' }],
    outputs: [],
  },
] as const
```

:::

### 6. Wait for transaction receipt (optional)

We can also display the transaction confirmation status to the user by using the [`useWaitForTransactionReceipt` Hook](/react/api/hooks/useWaitForTransactionReceipt).

::: code-group

```tsx [mint-nft.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/write-to-contract.md","from":5391,"to":6662}<fsm-vh3gqscxm4e>
import * as React from 'react'
import { 
  useWaitForTransactionReceipt, // [!code ++]
  useWriteContract 
} from 'wagmi'
import { abi } from './abi'
 
export function MintNFT() {
  const { 
    data: hash, 
    isPending, 
    writeContract 
  } = useWriteContract() 

  async function submit(e: React.FormEvent<HTMLFormElement>) { 
    e.preventDefault() 
    const formData = new FormData(e.target as HTMLFormElement) 
    const tokenId = formData.get('tokenId') as string 
    writeContract({
      address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
      abi,
      functionName: 'mint',
      args: [BigInt(tokenId)],
    })
  } 

  const { isLoading: isConfirming, isSuccess: isConfirmed } = // [!code ++]
    useWaitForTransactionReceipt({ // [!code ++]
      hash, // [!code ++]
    }) // [!code ++]

  return (
    <form onSubmit={submit}>
      <input name="tokenId" placeholder="69420" required />
      <button 
        disabled={isPending} 
        type="submit"
      >
        {isPending ? 'Confirming...' : 'Mint'} 
      </button>
      {hash && <div>Transaction Hash: {hash}</div>}
      {isConfirming && <div>Waiting for confirmation...</div>} // [!code ++]
      {isConfirmed && <div>Transaction confirmed.</div>} // [!code ++]
    </form>
  )
}
```

```ts [abi.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/write-to-contract.md","from":6682,"to":6890}<fsm-vh3gqscxm4e>
export const abi = [
  {
    name: 'mint',
    type: 'function',
    stateMutability: 'nonpayable',
    inputs: [{ internalType: 'uint32', name: 'tokenId', type: 'uint32' }],
    outputs: [],
  },
] as const
```

:::

### 7. Handle errors (optional)

If the user rejects the transaction, or the contract reverts, we can display an error message to the user.

::: code-group

```tsx [mint-nft.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/write-to-contract.md","from":7079,"to":8465}<fsm-vh3gqscxm4e>
import * as React from 'react'
import { 
  type BaseError, // [!code ++]
  useWaitForTransactionReceipt, 
  useWriteContract 
} from 'wagmi'
import { abi } from './abi'
 
export function MintNFT() {
  const { 
    data: hash,
    error, // [!code ++]  
    isPending, 
    writeContract 
  } = useWriteContract() 

  async function submit(e: React.FormEvent<HTMLFormElement>) { 
    e.preventDefault() 
    const formData = new FormData(e.target as HTMLFormElement) 
    const tokenId = formData.get('tokenId') as string 
    writeContract({
      address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
      abi,
      functionName: 'mint',
      args: [BigInt(tokenId)],
    })
  } 

  const { isLoading: isConfirming, isSuccess: isConfirmed } = 
    useWaitForTransactionReceipt({ 
      hash, 
    }) 

  return (
    <form onSubmit={submit}>
      <input name="tokenId" placeholder="69420" required />
      <button 
        disabled={isPending} 
        type="submit"
      >
        {isPending ? 'Confirming...' : 'Mint'} 
      </button>
      {hash && <div>Transaction Hash: {hash}</div>}
      {isConfirming && <div>Waiting for confirmation...</div>} 
      {isConfirmed && <div>Transaction confirmed.</div>} 
      {error && ( // [!code ++]
        <div>Error: {(error as BaseError).shortMessage || error.message}</div> // [!code ++]
      )} // [!code ++]
    </form>
  )
}
```

```ts [abi.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/write-to-contract.md","from":8485,"to":8693}<fsm-vh3gqscxm4e>
export const abi = [
  {
    name: 'mint',
    type: 'function',
    stateMutability: 'nonpayable',
    inputs: [{ internalType: 'uint32', name: 'tokenId', type: 'uint32' }],
    outputs: [],
  },
] as const
```

:::

### 8. Wire it up!

Finally, we can wire up our Mint NFT component to our application's entrypoint.

::: code-group

```tsx [app.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/write-to-contract.md","from":8837,"to":9278}<fsm-vh3gqscxm4e>
import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
import { WagmiProvider } from 'wagmi'
import { config } from './config'
import { MintNft } from './mint-nft' // [!code ++]

const queryClient = new QueryClient()

function App() {
  return (
    <WagmiProvider config={config}>
      <QueryClientProvider client={queryClient}> 
        <MintNft /> // [!code ++]
      </QueryClientProvider> 
    </WagmiProvider>
  )
}
```

```tsx [mint-nft.tsx]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/write-to-contract.md","from":9305,"to":10626}<fsm-vh3gqscxm4e>
import * as React from 'react'
import { 
  type BaseError, 
  useWaitForTransactionReceipt, 
  useWriteContract 
} from 'wagmi'
import { abi } from './abi'
 
export function MintNFT() {
  const { 
    data: hash,
    error,   
    isPending, 
    writeContract 
  } = useWriteContract() 

  async function submit(e: React.FormEvent<HTMLFormElement>) { 
    e.preventDefault() 
    const formData = new FormData(e.target as HTMLFormElement) 
    const tokenId = formData.get('tokenId') as string 
    writeContract({
      address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
      abi,
      functionName: 'mint',
      args: [BigInt(tokenId)],
    })
  } 

  const { isLoading: isConfirming, isSuccess: isConfirmed } = 
    useWaitForTransactionReceipt({ 
      hash, 
    }) 

  return (
    <form onSubmit={submit}>
      <input name="tokenId" placeholder="69420" required />
      <button 
        disabled={isPending} 
        type="submit"
      >
        {isPending ? 'Confirming...' : 'Mint'} 
      </button>
      {hash && <div>Transaction Hash: {hash}</div>}
      {isConfirming && <div>Waiting for confirmation...</div>} 
      {isConfirmed && <div>Transaction confirmed.</div>} 
      {error && ( 
        <div>Error: {(error as BaseError).shortMessage || error.message}</div> 
      )} 
    </form>
  )
}
```

```ts [abi.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/write-to-contract.md","from":10646,"to":10854}<fsm-vh3gqscxm4e>
export const abi = [
  {
    name: 'mint',
    type: 'function',
    stateMutability: 'nonpayable',
    inputs: [{ internalType: 'uint32', name: 'tokenId', type: 'uint32' }],
    outputs: [],
  },
] as const
```

```tsx [config.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/react/guides/write-to-contract.md","from":10878,"to":11336}<fsm-vh3gqscxm4e>
import { http, createConfig } from 'wagmi'
import { base, mainnet, optimism } from 'wagmi/chains'
import { injected, metaMask, safe, walletConnect } from 'wagmi/connectors'

const projectId = '<WALLETCONNECT_PROJECT_ID>'

export const config = createConfig({
  chains: [mainnet, base],
  connectors: [
    injected(),
    walletConnect({ projectId }),
    metaMask(),
    safe(),
  ],
  transports: {
    [mainnet.id]: http(),
    [base.id]: http(),
  },
})
```

:::

[See the Example.](#example)

---

---
url: /vue/guides/write-to-contract.md
---
# Write to Contract

The [`useWriteContract` Composable](/vue/api/composables/useWriteContract) allows you to mutate data on a smart contract, from a `payable` or `nonpayable` (write) function. These types of functions require gas to be executed, hence a transaction is broadcasted in order to change the state.

In the guide below, we will teach you how to implement a "Mint NFT" form that takes in a dynamic argument (token ID) using Wagmi. The example below builds on the [Connect Wallet guide](/vue/guides/connect-wallet) and uses the [useWriteContract](/vue/api/composables/useWriteContract) & [useWaitForTransactionReceipt](/vue/api/composables/useWaitForTransactionReceipt) composables.

If you have already completed the [Sending Transactions guide](/vue/guides/send-transaction), this guide will look very similar! That's because writing to a contract internally broadcasts & sends a transaction.

## Example

Feel free to check out the example before moving on:

## Steps

### 1. Connect Wallet

Follow the [Connect Wallet guide](/vue/guides/connect-wallet) guide to get this set up.

### 2. Create a new component

Create your `MintNft` component that will contain the Mint NFT logic.

::: code-group

```vue [MintNft.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/write-to-contract.md","from":1406,"to":1583}<fsm-vh3gqscxm4e>
<script setup lang="ts">
</script>
 
<template>
  <form>
    <input name="tokenId" placeholder="69420" required />
    <button type="submit">Mint</button>
  </form>
</template>
```

:::

### 3. Add a form handler

Next, we will need to add a handler to the form that will send the transaction when the user hits "Mint". This will be a basic handler in this step.

::: code-group

```vue [MintNft.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/write-to-contract.md","from":1807,"to":2247}<fsm-vh3gqscxm4e>
<script setup lang="ts">
function submit(event: Event) { // [!code ++]
  const formData = new FormData(e.target as HTMLFormElement) // [!code ++]
  const tokenId = formData.get('tokenId') as string // [!code ++]
} // [!code ++]
</script>

<template
  <form> // [!code --]
  <form @submit.prevent="submit"> // [!code ++]
    <input name="tokenId" placeholder="69420" required />
    <button type="submit">Mint</button>
  </form>
</template>
```

:::

### 4. Hook up the `useWriteContract` Composable

Now that we have the form handler, we can hook up the [`useWriteContract` Composable](/vue/api/composables/useWriteContract) to send the transaction.

::: code-group

```vue [MintNft.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/write-to-contract.md","from":2495,"to":3317}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useWriteContract } from 'wagmi' // [!code ++]
import { abi } from './abi' // [!code ++]

const { data: hash, writeContract } = useWriteContract() // [!code ++]

function submit(event: Event) { 
  const formData = new FormData(e.target as HTMLFormElement) 
  const tokenId = formData.get('tokenId') as string 
  writeContract({ // [!code ++]
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', // [!code ++]
    abi, // [!code ++]
    functionName: 'mint', // [!code ++]
    args: [BigInt(tokenId)], // [!code ++]
  }) // [!code ++]
} 
</script>

<template
  <form @submit.prevent="submit"> 
    <input name="tokenId" placeholder="69420" required />
    <button type="submit">Mint</button>
    <div v-if="hash">Transaction Hash: {{ hash }}</div> // [!code ++]
  </form>
</template>
```

```ts [abi.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/write-to-contract.md","from":3337,"to":3545}<fsm-vh3gqscxm4e>
export const abi = [
  {
    name: 'mint',
    type: 'function',
    stateMutability: 'nonpayable',
    inputs: [{ internalType: 'uint32', name: 'tokenId', type: 'uint32' }],
    outputs: [],
  },
] as const
```

:::

### 5. Add loading state (optional)

We can optionally add a loading state to the "Mint" button while we are waiting confirmation from the user's wallet.

::: code-group

```vue [MintNft.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/write-to-contract.md","from":3747,"to":4606}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useWriteContract } from 'wagmi'
import { abi } from './abi'

const { 
  data: hash, 
  isPending, // [!code ++]
  writeContract 
} = useWriteContract()

function submit(event: Event) { 
  const formData = new FormData(e.target as HTMLFormElement) 
  const tokenId = formData.get('tokenId') as string 
  writeContract({
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
    abi,
    functionName: 'mint',
    args: [BigInt(tokenId)],
  })
} 
</script>

<template
  <form @submit.prevent="submit"> 
    <input name="tokenId" placeholder="69420" required />
    <button :disabled="isPending" type="submit"> // [!code ++]
      <span v-if="isPending">Sending...</span> // [!code ++]
      <span v-else>Send</span> // [!code ++]
    </button>
    <div v-if="hash">Transaction Hash: {{ hash }}</div>
  </form>
</template>
```

```ts [abi.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/write-to-contract.md","from":4626,"to":4834}<fsm-vh3gqscxm4e>
export const abi = [
  {
    name: 'mint',
    type: 'function',
    stateMutability: 'nonpayable',
    inputs: [{ internalType: 'uint32', name: 'tokenId', type: 'uint32' }],
    outputs: [],
  },
] as const
```

:::

### 6. Wait for transaction receipt (optional)

We can also display the transaction confirmation status to the user by using the [`useWaitForTransactionReceipt` Composable](/vue/api/composables/useWaitForTransactionReceipt).

::: code-group

```vue [MintNft.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/write-to-contract.md","from":5108,"to":6274}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { 
  useWaitForTransactionReceipt, // [!code ++]
  useWriteContract 
} from 'wagmi'
import { abi } from './abi'

const { 
  data: hash, 
  isPending,
  writeContract 
} = useWriteContract()

function submit(event: Event) { 
  const formData = new FormData(e.target as HTMLFormElement) 
  const tokenId = formData.get('tokenId') as string 
  writeContract({
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
    abi,
    functionName: 'mint',
    args: [BigInt(tokenId)],
  })
} 

const { isLoading: isConfirming, isSuccess: isConfirmed } = // [!code ++]
  useWaitForTransactionReceipt({ // [!code ++]
    hash, // [!code ++]
  }) // [!code ++]
</script>

<template
  <form @submit.prevent="submit"> 
    <input name="tokenId" placeholder="69420" required />
    <button :disabled="isPending" type="submit">
      <span v-if="isPending">Sending...</span>
      <span v-else>Send</span>
    </button>
    <div v-if="hash">Transaction Hash: {{ hash }}</div>
    <div v-if="isConfirming">Waiting for confirmation...</div> // [!code ++]
    <div v-if="isConfirmed">Transaction Confirmed!</div> // [!code ++]
  </form>
</template>
```

```ts [abi.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/write-to-contract.md","from":6294,"to":6502}<fsm-vh3gqscxm4e>
export const abi = [
  {
    name: 'mint',
    type: 'function',
    stateMutability: 'nonpayable',
    inputs: [{ internalType: 'uint32', name: 'tokenId', type: 'uint32' }],
    outputs: [],
  },
] as const
```

:::

### 7. Handle errors (optional)

If the user rejects the transaction, or the user does not have enough funds to cover the transaction, we can display an error message to the user.

::: code-group

```vue [MintNft.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/write-to-contract.md","from":6730,"to":7967}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { 
  useWaitForTransactionReceipt,
  useWriteContract 
} from 'wagmi'
import { abi } from './abi'

const { 
  data: hash,
  error, // [!code ++] 
  isPending,
  writeContract 
} = useWriteContract()

function submit(event: Event) { 
  const formData = new FormData(e.target as HTMLFormElement) 
  const tokenId = formData.get('tokenId') as string 
  writeContract({
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
    abi,
    functionName: 'mint',
    args: [BigInt(tokenId)],
  })
} 

const { isLoading: isConfirming, isSuccess: isConfirmed } =
  useWaitForTransactionReceipt({
    hash,
  })
</script>

<template
  <form @submit.prevent="submit"> 
    <input name="tokenId" placeholder="69420" required />
    <button :disabled="isPending" type="submit">
      <span v-if="isPending">Sending...</span>
      <span v-else>Send</span>
    </button>
    <div v-if="hash">Transaction Hash: {{ hash }}</div>
    <div v-if="isConfirming">Waiting for confirmation...</div>
    <div v-if="isConfirmed">Transaction Confirmed!</div>
    <div v-if="error"> // [!code ++]
      Error: {{ (error as BaseError).shortMessage || error.message }} // [!code ++]
    </div> // [!code ++]
  </form>
</template>
```

```ts [abi.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/write-to-contract.md","from":7987,"to":8195}<fsm-vh3gqscxm4e>
export const abi = [
  {
    name: 'mint',
    type: 'function',
    stateMutability: 'nonpayable',
    inputs: [{ internalType: 'uint32', name: 'tokenId', type: 'uint32' }],
    outputs: [],
  },
] as const
```

:::

### 8. Wire it up!

Finally, we can wire up our Send Transaction component to our application's entrypoint.

:::code-group

```vue [App.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/write-to-contract.md","from":8345,"to":8720}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { useConnection } from '@wagmi/vue'
import Connection from './Connection.vue'
import Connect from './Connect.vue'
import MintNft from './MintNft.vue' // [!code ++]

const { isConnected } = useConnection()
</script>

<template>
  <Connection v-if="isConnected" />
  <Connect v-else />
  <MintNft v-if="isConnected" /> // [!code ++]
</template>
```

```vue [MintNft.vue]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/write-to-contract.md","from":8746,"to":9927}<fsm-vh3gqscxm4e>
<script setup lang="ts">
import { 
  useWaitForTransactionReceipt,
  useWriteContract 
} from 'wagmi'
import { abi } from './abi'

const { 
  data: hash,
  error, 
  isPending,
  writeContract 
} = useWriteContract()

function submit(event: Event) { 
  const formData = new FormData(e.target as HTMLFormElement) 
  const tokenId = formData.get('tokenId') as string 
  writeContract({
    address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
    abi,
    functionName: 'mint',
    args: [BigInt(tokenId)],
  })
} 

const { isLoading: isConfirming, isSuccess: isConfirmed } =
  useWaitForTransactionReceipt({
    hash,
  })
</script>

<template
  <form @submit.prevent="submit"> 
    <input name="tokenId" placeholder="69420" required />
    <button :disabled="isPending" type="submit">
      <span v-if="isPending">Sending...</span>
      <span v-else>Send</span>
    </button>
    <div v-if="hash">Transaction Hash: {{ hash }}</div>
    <div v-if="isConfirming">Waiting for confirmation...</div>
    <div v-if="isConfirmed">Transaction Confirmed!</div>
    <div v-if="error">
      Error: {{ (error as BaseError).shortMessage || error.message }}
    </div>
  </form>
</template>
```

```ts [abi.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/vue/guides/write-to-contract.md","from":9947,"to":10155}<fsm-vh3gqscxm4e>
export const abi = [
  {
    name: 'mint',
    type: 'function',
    stateMutability: 'nonpayable',
    inputs: [{ internalType: 'uint32', name: 'tokenId', type: 'uint32' }],
    outputs: [],
  },
] as const
```

:::

[See the Example.](#example)

---

---
url: /core/api/actions/writeContract.md
---
# writeContract

Action for executing a write function on a contract.

A "write" function on a Solidity contract modifies the state of the blockchain. These types of functions require gas to be executed, hence a transaction is broadcasted in order to change the state.

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":415,"to":459}<fsm-vh3gqscxm4e>
import { writeContract } from '@wagmi/core'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":506,"to":882}<fsm-vh3gqscxm4e>
import { writeContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await writeContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

::::tip Pairing with `simulateContract`

Pairing [`simulateContract`](/core/api/actions/simulateContract) with `writeContract` allows you to validate if the transaction will succeed ahead of time. If the simulate succeeds, `writeContract` can execute the transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":1269,"to":1721}<fsm-vh3gqscxm4e>
import { simulateContract, writeContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const { request } = await simulateContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
})
const hash = await writeContract(config, request)
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### Synchronous Usage

If you want to wait for the transaction to be included in a block before returning, you can use `writeContractSync`:

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":1985,"to":2370}<fsm-vh3gqscxm4e>
import { writeContractSync } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const receipt = await writeContractSync(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":2477,"to":2536}<fsm-vh3gqscxm4e>
import { type WriteContractParameters } from '@wagmi/core'
```

### abi

`Abi`

The contract's ABI. Check out the [TypeScript docs](/react/typescript#const-assert-abis-typed-data) for how to set up ABIs for maximum type inference and safety.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":2752,"to":3162}<fsm-vh3gqscxm4e>
import { writeContract } from '@wagmi/core'
import { abi } from './abi' // [!code focus]
import { config } from './config'

const result = await writeContract(config, {
  abi, // [!code focus]
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### accessList

`AccessList | undefined`

The access list.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":3340,"to":3853}<fsm-vh3gqscxm4e>
import { writeContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await writeContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  accessList: [{ // [!code focus]
    address: '0x1', // [!code focus]
    storageKeys: ['0x1'], // [!code focus]
  }], // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### account

`Address | Account | undefined`

Account to use when signing data. Throws if account is not found on [`connector`](#connector).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":4113,"to":4563}<fsm-vh3gqscxm4e>
import { writeContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await writeContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  account: '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### address

`Address`

The contract's address.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":4730,"to":5123}<fsm-vh3gqscxm4e>
import { writeContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await writeContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f', // [!code focus]
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### args

`readonly unknown[] | undefined`

* Arguments to pass when calling the contract.
* Inferred from [`abi`](#abi) and [`functionName`](#functionname).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":5401,"to":5861}<fsm-vh3gqscxm4e>
import { writeContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await writeContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [ // [!code focus]
    '0xd2135CfB216b74109775236E36d4b433F1DF507B', // [!code focus]
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', // [!code focus]
    123n, // [!code focus]
  ] // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`config['chains'][number]['id'] | undefined`

Chain ID to validate against before sending transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":6096,"to":6568}<fsm-vh3gqscxm4e>
import { writeContract } from '@wagmi/core'
import { mainnet } from 'wagmi/chains' // [!code focus]
import { abi } from './abi'
import { config } from './config'

const result = await writeContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  chainId: mainnet.id, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

[Connector](/core/api/connectors) to sign data with.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":6780,"to":7245}<fsm-vh3gqscxm4e>
import { getConnection, writeContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const { connector } = getConnection(config)
const result = await writeContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  connector, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### dataSuffix

`` `0x${string}` | undefined ``

Data to append to the end of the calldata. Useful for adding a ["domain" tag](https://opensea.notion.site/opensea/Seaport-Order-Attributions-ec2d69bf455041a5baa490941aad307f).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":7589,"to":8043}<fsm-vh3gqscxm4e>
import { writeContract } from '@wagmi/core'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

const result = await writeContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  dataSuffix: '0xdeadbeef', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### functionName

`string`

* Function to call on the contract.
* Inferred from [`abi`](#abi).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":8257,"to":8581}<fsm-vh3gqscxm4e>
import { writeContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await writeContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'approve', // [!code focus]
  args: ['0xA0Cf798816D4b9b9866b5330EEa46a18382f251e', 123n]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### gas

`bigint | undefined`

Gas provided for transaction execution.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":8772,"to":9222}<fsm-vh3gqscxm4e>
import { writeContract } from '@wagmi/core'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

const result = await writeContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  gas: parseGwei('20'), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### gasPrice

`bigint | undefined`

The price in wei to pay per gas. Only applies to [Legacy Transactions](https://viem.sh/docs/glossary/terms#legacy-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":9510,"to":9965}<fsm-vh3gqscxm4e>
import { writeContract } from '@wagmi/core'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

const result = await writeContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  gasPrice: parseGwei('20'), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxFeePerGas

`bigint | undefined`

Total fee per gas in wei, inclusive of [`maxPriorityFeePerGas`](#maxPriorityFeePerGas). Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":10311,"to":10770}<fsm-vh3gqscxm4e>
import { writeContract } from '@wagmi/core'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

const result = await writeContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  maxFeePerGas: parseGwei('20'), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### maxPriorityFeePerGas

`bigint | undefined`

Max priority fee per gas in wei. Only applies to [EIP-1559 Transactions](https://viem.sh/docs/glossary/terms#eip-1559-transaction).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":11069,"to":11568}<fsm-vh3gqscxm4e>
import { writeContract } from '@wagmi/core'
import { parseGwei } from 'viem'
import { abi } from './abi'
import { config } from './config'

const result = await writeContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  maxFeePerGas: parseGwei('20'),
  maxPriorityFeePerGas: parseGwei('2'), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

***

### nonce

`number`

Unique number identifying this transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":11757,"to":12164}<fsm-vh3gqscxm4e>
import { writeContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await writeContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  nonce: 123, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### type

`'legacy' | 'eip1559' | 'eip2930' | undefined`

Optional transaction request type to narrow parameters.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":12397,"to":12809}<fsm-vh3gqscxm4e>
import { writeContract } from '@wagmi/core'
import { abi } from './abi'
import { config } from './config'

const result = await writeContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  type: 'eip1559', // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### value

`bigint | undefined`

Value in wei sent with this transaction.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":13002,"to":13458}<fsm-vh3gqscxm4e>
import { writeContract } from '@wagmi/core'
import { parseEther } from 'viem'
import { abi } from './abi'
import { config } from './config'

const result = await writeContract(config, {
  abi,
  address: '0x6b175474e89094c44da98b954eedeac495271d0f',
  functionName: 'transferFrom',
  args: [
    '0xd2135CfB216b74109775236E36d4b433F1DF507B',
    '0xA0Cf798816D4b9b9866b5330EEa46a18382f251e',
    123n,
  ],
  value: parseEther('0.01'), // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":13566,"to":13625}<fsm-vh3gqscxm4e>
import { type WriteContractReturnType } from '@wagmi/core'
```

[`Hash`](https://viem.sh/docs/glossary/types#hash)

The transaction hash.

## Type Inference

With [`abi`](#abi) setup correctly, TypeScript will infer the correct types for [`functionName`](#functionname), [`args`](#args), and [`value`](#value). See the Wagmi [TypeScript docs](/core/typescript) for more information.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContract.md","from":13966,"to":14024}<fsm-vh3gqscxm4e>
import { type WriteContractErrorType } from '@wagmi/core'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Variables,
  type {{typeName}}Mutate,
  type {{typeName}}MutateAsync,
  {{actionName}}MutationOptions,
} from '{{packageName}}/query'
```

## Viem

* [`writeContract`](https://viem.sh/docs/contract/writeContract)

---

---
url: /core/api/actions/writeContracts.md
---
# writeContracts

Action that requests for the wallet to sign and broadcast a batch of write contract calls (transactions) to the network.

[Read more.](https://github.com/ethereum/EIPs/blob/815028dc634463e1716fc5ce44c019a6040f0bef/EIPS/eip-5792.md#wallet_sendcalls)

## Import

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContracts.md","from":431,"to":489}<fsm-vh3gqscxm4e>
import { writeContracts } from '@wagmi/core/experimental'
```

## Usage

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContracts.md","from":536,"to":1349}<fsm-vh3gqscxm4e>
import { parseAbi } from 'viem'
import { writeContracts } from '@wagmi/core/experimental'
import { config } from './config'

const abi = parseAbi([
  'function approve(address, uint256) returns (bool)',
  'function transferFrom(address, address, uint256) returns (bool)',
])

const id = await writeContracts(config, {
  contracts: [
    {
      address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
      abi,
      functionName: 'approve',
      args: [
        '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC', 
        100n
      ],
    },
    {
      address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
      abi,
      functionName: 'transferFrom',
      args: [
        '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
        '0x0000000000000000000000000000000000000000',
        100n
      ],
    },
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Parameters

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContracts.md","from":1420,"to":1493}<fsm-vh3gqscxm4e>
import { type WriteContractsParameters } from '@wagmi/core/experimental'
```

### account

`Account | Address | undefined`

Account to execute the calls.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContracts.md","from":1607,"to":2494}<fsm-vh3gqscxm4e>
import { parseAbi } from 'viem'
import { writeContracts } from '@wagmi/core/experimental'
import { config } from './config'

const abi = parseAbi([
  'function approve(address, uint256) returns (bool)',
  'function transferFrom(address, address, uint256) returns (bool)',
])

const id = await writeContracts(config, {
  account: '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC', // [!code focus]
  contracts: [
    {
      address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
      abi,
      functionName: 'approve',
      args: [
        '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC', 
        100n
      ],
    },
    {
      address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
      abi,
      functionName: 'transferFrom',
      args: [
        '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
        '0x0000000000000000000000000000000000000000',
        100n
      ],
    },
  ],
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### contracts

`{ to: Hex, data?: Hex, value?: bigint }[]`

Calls to execute.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContracts.md","from":2655,"to":3824}<fsm-vh3gqscxm4e>
import { parseAbi } from 'viem'
import { writeContracts } from '@wagmi/core/experimental'
import { config } from './config'

const abi = parseAbi([
  'function approve(address, uint256) returns (bool)',
  'function transferFrom(address, address, uint256) returns (bool)',
])

const id = await writeContracts(config, {
  contracts: [ // [!code focus]
    { // [!code focus]
      address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', // [!code focus]
      abi, // [!code focus]
      functionName: 'approve', // [!code focus]
      args: [ // [!code focus]
        '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC', // [!code focus]
        100n // [!code focus]
      ], // [!code focus]
    }, // [!code focus]
    { // [!code focus]
      address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2', // [!code focus]
      abi, // [!code focus]
      functionName: 'transferFrom', // [!code focus]
      args: [ // [!code focus]
        '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC', // [!code focus]
        '0x0000000000000000000000000000000000000000', // [!code focus]
        100n // [!code focus]
      ], // [!code focus]
    }, // [!code focus]
  ], // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### capabilities

`WalletCapabilities | undefined`

Capability metadata for the calls (e.g. specifying a paymaster).

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContracts.md","from":4024,"to":4999}<fsm-vh3gqscxm4e>
import { parseAbi } from 'viem'
import { writeContracts } from '@wagmi/core/experimental'
import { config } from './config'

const abi = parseAbi([
  'function approve(address, uint256) returns (bool)',
  'function transferFrom(address, address, uint256) returns (bool)',
])

const id = await writeContracts(config, {
  contracts: [
    {
      address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
      abi,
      functionName: 'approve',
      args: [
        '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC', 
        100n
      ],
    },
    {
      address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
      abi,
      functionName: 'transferFrom',
      args: [
        '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
        '0x0000000000000000000000000000000000000000',
        100n
      ],
    },
  ],
  capabilities: { // [!code focus]
    paymasterService: { // [!code focus]
      url: 'https://...' // [!code focus]
    } // [!code focus]
  } // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### chainId

`number | undefined`

The target chain ID to broadcast the calls.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContracts.md","from":5161,"to":6006}<fsm-vh3gqscxm4e>
import { parseAbi } from 'viem'
import { writeContracts } from '@wagmi/core/experimental'
import { config } from './config'

const abi = parseAbi([
  'function approve(address, uint256) returns (bool)',
  'function transferFrom(address, address, uint256) returns (bool)',
])

const id = await writeContracts(config, {
  contracts: [
    {
      address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
      abi,
      functionName: 'approve',
      args: [
        '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC', 
        100n
      ],
    },
    {
      address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
      abi,
      functionName: 'transferFrom',
      args: [
        '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
        '0x0000000000000000000000000000000000000000',
        100n
      ],
    },
  ],
  chainId: 10, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

### connector

`Connector | undefined`

Connector to get send the calls with.

::: code-group

```ts [index.ts]
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContracts.md","from":6167,"to":7125}<fsm-vh3gqscxm4e>
import { parseAbi } from 'viem'
import { getConnections } from '@wagmi/core'
import { writeContracts } from '@wagmi/core/experimental'
import { config } from './config'

const abi = parseAbi([
  'function approve(address, uint256) returns (bool)',
  'function transferFrom(address, address, uint256) returns (bool)',
])

const connections = getConnections(config)
const id = await writeContracts(config, {
  contracts: [
    {
      address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
      abi,
      functionName: 'approve',
      args: [
        '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC', 
        100n
      ],
    },
    {
      address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
      abi,
      functionName: 'transferFrom',
      args: [
        '0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC',
        '0x0000000000000000000000000000000000000000',
        100n
      ],
    },
  ],
  connector: connections[0]?.connector, // [!code focus]
})
```

```ts \[config.ts]
import { createConfig, http } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'

export const config = createConfig({
  chains: [mainnet, sepolia],
  transports: {
    [mainnet.id]: http(),
    [sepolia.id]: http(),
  },
})

```

## Return Type

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContracts.md","from":7197,"to":7270}<fsm-vh3gqscxm4e>
import { type WriteContractsReturnType } from '@wagmi/core/experimental'
```

`{ id: string; capabilities?: WalletCapabilities | undefined }`

Identifier of the call batch.

## Error

```ts
// <fsm-vh3gqscxm4e>{"path":"/vercel/path0/site/core/api/actions/writeContracts.md","from":7387,"to":7459}<fsm-vh3gqscxm4e>
import { type WriteContractsErrorType } from '@wagmi/core/experimental'
```

## TanStack Query

```ts-vue
import {
  type {{typeName}}Data,
  type {{typeName}}Options,
  type {{typeName}}QueryFnData,
  type {{typeName}}QueryKey,
  {{actionName}}QueryKey,
  {{actionName}}QueryOptions,
} from '{{packageName}}/query'
```

## Viem

* [`writeContracts`](https://viem.sh/experimental/eip5792/writeContracts)