getBlockNumber
Action for fetching the number of the most recent block seen.
Import
ts
import { getBlockNumber } from '@wagmi/core'import { getBlockNumber } from '@wagmi/core'Usage
ts
import { getBlockNumber } from '@wagmi/core'
import { config } from './config'
const blockNumber = await getBlockNumber(config)import { getBlockNumber } from '@wagmi/core'
import { config } from './config'
const blockNumber = await getBlockNumber(config)ts
import { http, createConfig } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'
export const config = createConfig({
chains: [mainnet, sepolia],
transports: {
[mainnet.id]: http(),
[sepolia.id]: http(),
},
})import { http, createConfig } 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
import { type GetBlockNumberParameters } from '@wagmi/core'import { type GetBlockNumberParameters } from '@wagmi/core'cacheTime
number | undefined
Time in milliseconds that cached block number will remain in memory.
ts
import { getBlockNumber } from '@wagmi/core'
import { config } from './config'
const blockNumber = await getBlockNumber(config, {
cacheTime: 4_000,
})import { getBlockNumber } from '@wagmi/core'
import { config } from './config'
const blockNumber = await getBlockNumber(config, {
cacheTime: 4_000,
})ts
import { http, createConfig } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'
export const config = createConfig({
chains: [mainnet, sepolia],
transports: {
[mainnet.id]: http(),
[sepolia.id]: http(),
},
})import { http, createConfig } 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.
ts
import { getBlockNumber } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'
const blockNumber = await getBlockNumber(config, {
chainId: mainnet.id,
})import { getBlockNumber } from '@wagmi/core'
import { mainnet } from '@wagmi/core/chains'
import { config } from './config'
const blockNumber = await getBlockNumber(config, {
chainId: mainnet.id,
})ts
import { http, createConfig } from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'
export const config = createConfig({
chains: [mainnet, sepolia],
transports: {
[mainnet.id]: http(),
[sepolia.id]: http(),
},
})import { http, createConfig } 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
import { type GetBlockNumberReturnType } from '@wagmi/core'import { type GetBlockNumberReturnType } from '@wagmi/core'bigint
Most recent block number seen.
Error
ts
import { type GetBlockNumberErrorType } from '@wagmi/core'import { type GetBlockNumberErrorType } from '@wagmi/core'TanStack Query
ts
import {
type GetBlockNumberData,
type GetBlockNumberOptions,
type GetBlockNumberQueryFnData,
type GetBlockNumberQueryKey,
getBlockNumberQueryKey,
getBlockNumberQueryOptions,
} from '@wagmi/core/query'import {
type GetBlockNumberData,
type GetBlockNumberOptions,
type GetBlockNumberQueryFnData,
type GetBlockNumberQueryKey,
getBlockNumberQueryKey,
getBlockNumberQueryOptions,
} from '@wagmi/core/query'