Skip to content

useNonceForAddress

Returns the nonce associated with the given address in the given block

By default this hook fetches the latest block, but you can change it with the blockIdentifier argument.

Usage

import { useNonceForAddress, useAccount } from "@starknet-react/core";
import { type Address } from "@starknet-react/chains";
 
const { account } = useAccount();
 
const { data, isLoading, isError, error } = useNonceForAddress({
  address: account?.address as Address,
});

Data

  • Type: Nonce

The Nonce type from starknet.

Arguments

address

  • Type: Address

Contract address.

blockIdentifier

  • Type: BlockNumber | undefined

Perform the query against the provided block, e.g. BlockTag.LATEST.

enabled

  • Type: boolean | undefined

If false, don't perform the query.

refetchInterval

  • Type: number | false | ((query: Query) => number | false | undefined)

If set to a number, the query is refetched at the provided interval (in milliseconds).

If set to a function, the callback will be used to determine the refetch interval.

Returns

data

  • Type: Data | undefined

The resolved data.

error

  • Type: Error | null

Any error thrown by the query.

reset

  • Type: () => void

Reset the query status.

status

  • Type: "error" | "pending" | "success"

The mutation status.

  • pending: the query is being executed.
  • success: the query executed without an error.
  • error: the query threw an error.

isError

  • Type: boolean

Derived from status.

isPending

  • Type: boolean

Derived from status.

isSuccess

  • Type: boolean

Derived from status.

fetchStatus

  • Type: "fetching" | "paused" | "idle"

  • fetching: the query is fetching.

  • paused: the query is paused.

  • idle: the query is not fetching.

isFetching

  • Type: boolean

Derived from fetchStatus.

isPaused

  • Type: boolean

Derived from fetchStatus.

isIdle

  • Type: boolean

Derived from fetchStatus.