watchReadContracts

Action for subscribing to readContracts changes.

import { watchReadContracts } from '@wagmi/core'

Usage

By default, the callback will be invoked on chain change.

To listen for block changes, you can use the listenToBlock config.

import { readContracts, watchReadContracts } from '@wagmi/core'
 
const config = {
  contracts: [
    {
      address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
      abi: wagmigotchiABI,
      functionName: 'getBoredom',
    },
    {
      address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
      abi: mlootABI,
      functionName: 'getWaist',
      args: [69],
    },
  ],
}
 
let data = await readContracts(config)
const unwatch = watchReadContracts(config, (data_) => (data = data_))

Return Value

unwatch is a function that can be called to unsubscribe from the readContracts change event.

Configuration

contracts

address

Contract address.

import { watchReadContracts } from '@wagmi/core'
 
watchReadContracts(
  {
    contracts: [
      {
        address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        abi: wagmigotchiABI,
        functionName: 'getAlive',
      },
      {
        address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        abi: wagmigotchiABI,
        functionName: 'getBoredom',
      },
    ],
  },
  (data) => console.log(data),
)

abi

Contract ABI.

By defining inline or adding a const assertion to abi, TypeScript will infer the correct types for functionName, args, and action result. See the wagmi TypeScript docs for more information.

import { watchReadContracts } from '@wagmi/core'
 
const data = await watchReadContracts(
  {
    contracts: [
      {
        address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        abi: wagmigotchiABI,
        functionName: 'getAlive',
      },
      {
        address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        abi: wagmigotchiABI,
        functionName: 'getBoredom',
      },
    ],
  },
  (data) => console.log(data),
)

functionName

Name of function to call.

import { watchReadContracts } from '@wagmi/core'
 
const data = await watchReadContracts(
  {
    contracts: [
      {
        address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        abi: wagmigotchiABI,
        functionName: 'getAlive',
      },
      {
        address: '0xecb504d39723b0be0e3a9aa33d646642d1051ee1',
        abi: wagmigotchiABI,
        functionName: 'getBoredom',
      },
    ],
  },
  (data) => console.log(data),
)

args

Arguments to pass to function call.

import { watchReadContracts } from '@wagmi/core'
 
const data = await watchReadContracts(
  {
    contracts: [
      {
        address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
        abi: mlootABI,
        functionName: 'getChest',
        args: [69],
      },
      {
        address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
        abi: mlootABI,
        functionName: 'getWaist',
        args: [69],
      },
    ],
  },
  (data) => console.log(data),
)

chainId (optional)

Force a specific chain id for the request. The wagmi Client's publicClient must be set up as a chain-aware function for this to work correctly.

import { watchReadContracts } from '@wagmi/core'
 
const data = await watchReadContracts(
  {
    contracts: [
      {
        ...wagmigotchiContract,
        functionName: 'getAlive',
        chainId: 1,
      },
      {
        ...wagmigotchiContract,
        functionName: 'getBoredom',
        chainId: 1,
      },
    ],
  },
  (data) => console.log(data),
)

allowFailure (optional)

If a contract read fails while fetching, it will fail silently and not throw an error.

import { watchReadContracts } from '@wagmi/core'
 
const data = await watchReadContracts(
  {
    contracts: [
      {
        ...wagmigotchiContract,
        functionName: 'getAlive',
      },
      {
        ...wagmigotchiContract,
        functionName: 'getBoredom',
      },
    ],
    allowFailure: false,
  },
  (data) => console.log(data),
)

listenToBlock (optional)

Listen for block changes & invoke readContracts.

import { watchReadContracts } from '@wagmi/core'
 
const data = await watchReadContracts(
  {
    contracts: [
      {
        address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
        abi: mlootABI,
        functionName: 'getChest',
        args: [69],
      },
      {
        address: '0x1dfe7ca09e99d10835bf73044a23b73fc20623df',
        abi: mlootABI,
        functionName: 'getWaist',
        args: [69],
      },
    ],
    listenToBlock: true,
  },
  (data) => console.log(data),
)

blockNumber (optional)

The block number to perform the read against.

import { watchReadContracts } from '@wagmi/core'
 
const data = await watchReadContracts(
  {
    contracts: [
      {
        ...wagmigotchiContract,
        functionName: 'getAlive',
      },
      {
        ...wagmigotchiContract,
        functionName: 'getBoredom',
      },
    ],
    blockNumber: 15121123n,
  },
  (data) => console.log(data),
)

blockTag (optional)

The block tag to perform the read against. Accepts: 'latest' | 'earliest' | 'pending' | 'safe' | 'finalized'

import { watchReadContracts } from '@wagmi/core'
 
const data = await watchReadContracts(
  {
    contracts: [
      {
        ...wagmigotchiContract,
        functionName: 'getAlive',
      },
      {
        ...wagmigotchiContract,
        functionName: 'getBoredom',
      },
    ],
    blockNumber: 'safe',
  },
  (data) => console.log(data),
)

watchReadContract writeContract