v2.0.0-rc.1 release candidate

The API is frozen and later candidates carry fixes only, except the receipt-free and Safe create surface of /fhe-airdrop, which is @beta. Published on the next dist-tag; latest stays on 1.6.0 until 2.0.0.

Setup · deployuseMutation Curated

useRegister

First-time setup for a deployer — singleton creates the two ERC-1167 subwallets.

Import

@tokenops/sdk/fhe-disperse/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Setup · deploy

Description

Deploy the caller's dedicated wallet pair via register(token) and parse the resulting UserRegistered event to return both subwallet addresses.

Can only be called once per user — subsequent calls revert with UserAlreadyRegistered. Use useIsRegistered to gate this in your UI.

Throws `DisperseSubwalletNotFoundError` if the receipt has no UserRegistered event from the singleton — typically means the tx reverted silently or you're reading the wrong singleton address.

After success, invalidate every disperse query for this user:

const queryClient = useQueryClient();
const register = useRegister();
register.mutate({ token }, {
  onSuccess: () => {
    queryClient.invalidateQueries({ queryKey: ["tokenops-sdk", "fhe-disperse"] });
  },
});

Signature

@tokenops/sdk/fhe-disperse/react

function useRegister(options?: DisperseHookOptions): UseMutationResult<RegisterResult | PendingRegisterResult, Error, UseRegisterArgs>;

Parameters

Shape of the object you pass to .mutate(args).

Property	Type	Description
tokenrequired	Address	ERC-7984 token to approve the new subwallets for.
account	Account \| Address	Override signer account. Falls back to `walletClient.account`.
waitForReceipt	boolean \| undefined	See `ReceiptMode`. With `false` the mutation resolves to a {

Run it

Connect your wallet and click Register 2.0 subwallets — this dispatches a real Sepolia transaction through the same runner the stories use.

Interactive · live Sepolia tx

ERC-7984 token to register

Loading editor…

Edit any input above, then press ⌘↵ to run.

Console0 lines

No output yet. Run the snippet to see logs stream in.

Example

@tokenops/sdk/fhe-disperse/react · @example

tsx

const register = useRegister();
register.mutate({ token });
// register.data → { hash, wallets: [wallet0, wallet1] }; with waitForReceipt: false,
// { hash, wallets: undefined, pending: true }

Pulled directly from the hook's TSDoc block — the same snippet your IDE shows on hover.

Errors

This mutation can reject with SDK-level, product-level, or generic-fallback errors. Product classes carry the offending value as fields — render them inline instead of a generic "transaction failed." See Disperse 2.0 › Errors for the per-class recovery table.

Invalidation recipe

After this mutation succeeds, invalidate the queries it affects so consumer UI re-fetches fresh state. The SDK never auto-invalidates — that's a consumer decision (different apps cache different shapes).

patterns/invalidation.ts

import { useQueryClient } from "@tanstack/react-query";

const queryClient = useQueryClient();
const register = useRegister(/* options */);

register.mutate(args, {
  onSuccess() {
    // Coarse invalidation: refresh every cached read on this product surface.
    queryClient.invalidateQueries({
      queryKey: ["tokenops-sdk", "fhe-disperse"],
    });
  },
});