useClients

Hook for accessing the underlying Aptos clients (aptos, indexer, signer) and the main client instance from the AptosJSCoreProvider. Allows specifying a different network.

Usage

Default Network


import { useClients } from "@aptos-labs/react";
 
export default function App() {
  const { aptos, indexer, signer, network, client } = useClients();
 
  return <>{/* ... */}</>;
}

Specific Network (Testnet)


import { useClients } from "@aptos-labs/react";
import { Network } from "@aptos-labs/ts-sdk";
 
export default function App() {
  const { aptos, indexer, signer, network, client } = useClients({
    network: { network: Network.TESTNET },
  });
 
  return <>{/* ... */}</>;
}

Parameters

Name	Type	Default
`network`	`NetworkInfo` The network to use for the request. If not set, the network of the `AptosJSProClient` instance will be used.

Return Type

Name	Type	Default
`client`	`AptosJSProClient`
`account`	`AccountInfo`
`aptos`	`Aptos`
`indexer`	`{ getAccountTokensTotal(variables: Exact<{ address: string; where: Current_Token_Ownerships_V2_Bool_Exp \| Current_Token_Ownerships_V2_Bool_Exp[]; }>, requestHeaders?: HeadersInit \| undefined, signal?: AbortSignal \| ... 1 more ... \| undefined): Promise<...>; ... 13 more ...; getNumberOfDelegators(variables?: Exact<.....`
`network`	`NetworkInfo`
`signer`	`SignerClient`