faucet.useFund

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

Usage

example.ts

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...']

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:

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

data

See Wagmi Action faucet.fund Return Type

mutate/mutateAsync

See Wagmi Action faucet.fund Parameters

Parameters

config

Config | undefined

Config to use instead of retrieving from the nearest WagmiProvider.

mutation

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

Action

• faucet.fund