amm.useLiquidityBalance

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

Usage

example.ts

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

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 for more info hook return types.

data

See Wagmi Action amm.getLiquidityBalance Return Type

Parameters

See Wagmi Action amm.getLiquidityBalance Parameters

query

See the TanStack Query query docs for more info hook parameters.

Action

• amm.getLiquidityBalance