React Hooks

The React Hooks package provides hooks for accessing user state, connecting to and disconnecting from wallets.

Installation

pnpm add @aurum-sdk/core @aurum-sdk/hooks

npm install @aurum-sdk/core @aurum-sdk/hooks

yarn add @aurum-sdk/core @aurum-sdk/hooks

bun add @aurum-sdk/core @aurum-sdk/hooks

Provider Setup

Wrap your application root in AurumProvider with an initialized Aurum instance:

import { Aurum } from '@aurum-sdk/core';
import { AurumProvider } from '@aurum-sdk/hooks';

const aurum = new Aurum({
  brand: { appName: 'Your App Name' },
  wallets: {
    embedded: { projectId: 'cdp-project-id' },
    walletConnect: { projectId: 'reown-project-id' },
  },
});

function App() {
  return (
    <AurumProvider aurum={aurum}>
      <YourApp />
    </AurumProvider>
  );
}

See Core SDK Configuration for all available Aurum options.

Available Hooks

`useAurum()`

Access the raw Aurum SDK instance for advanced use cases.

const { aurum, isReady } = useAurum();

Show Return values

Aurum

The Aurum SDK instance passed to AurumProvider.

boolean

true once the SDK has finished initializing and restored any persisted connection.

`useAccount()`

Access connected user information. Updates automatically when the connection state changes.

const {
  publicAddress,
  walletName,
  walletId,
  email,
  isConnected,
  isInitializing,
} = useAccount();

Show Return values

string | undefined

The connected wallet address

WalletName | undefined

Display name of the connected wallet

WalletId | undefined

Identifier of the connected wallet

string | undefined

User’s email (only present for email wallets)

boolean

true if a wallet is currently connected

boolean

true while the SDK is checking for / restoring a persisted connection

`useConnect()`

Connect to a wallet via the modal or directly by wallet ID.

const {
  connect,
  emailAuthStart,
  emailAuthVerify,
  getWalletConnectSession,
  isPending,
  error,
} = useConnect();

// Open wallet selection modal
await connect();

// Or connect directly to a specific wallet (skips modal)
import { WalletId } from '@aurum-sdk/types';

await connect(WalletId.MetaMask);

Show Return values

(walletId?: WalletId) => Promise<`0x${string}`>

Opens the modal or connects directly if walletId is provided. Returns the connected address.

(email: string) => Promise<{ flowId: string }>

Starts the headless email OTP flow. Returns a flowId for emailAuthVerify.

(flowId: string, otp: string) => Promise<{ address: string, email: string, isNewUser: boolean }>

Verifies the OTP and completes the email connection.

() => Promise<{ uri: string, waitForConnection: () => Promise<`0x${string}`> }>

Initiates a headless WalletConnect session for rendering your own QR code.

boolean

true while a connection attempt is in progress (covers all four methods above).

Error | null

The error if the last connection attempt failed.

WalletId.Email cannot be used with connect(walletId) — use emailAuthStart / emailAuthVerify instead. See the Headless API for full examples.

Do not use useConnect() with <ConnectWidget>. Instead use useAccount() to react to connection state changes when using the widget.

`useDisconnect()`

Disconnect the current wallet.

const { disconnect } = useDisconnect();

await disconnect();

`useChain()`

Access current chain information and switch networks.

import { sepolia } from 'viem/chains';

const { chainId, switchChain, error } = useChain();

await switchChain(sepolia.id, sepolia);

Show Return values

number | null

The current chain ID as a decimal number, or null if no wallet is connected.

(chainId: number | string, chain?: Chain) => Promise<void>

Switches to the specified chain. Pass the chain definition to prompt the user to add it if it’s not yet configured.

Error | null

The error if the user rejected the request.

Core SDK

Framework-agnostic API

Headless Mode

Build custom connection UIs

API reference

UI Modes

Integrations

Installation

Provider Setup

Available Hooks

`useAurum()`

`useAccount()`

`useConnect()`

`useDisconnect()`

`useChain()`

Core SDK

Headless Mode

​Installation

​Provider Setup

​Available Hooks

​useAurum()

​useAccount()

​useConnect()

​useDisconnect()

​useChain()

Core SDK

Headless Mode

Installation

Provider Setup

Available Hooks

`useAurum()`

`useAccount()`

`useConnect()`

`useDisconnect()`

`useChain()`