useSiwx()

useSiwx(): UseSiwxReturn

React hook that runs the CAIP-122 sign-in flow and keeps its state in useSiwxSessionStore.

signIn sets the store to building, resolves the nonce and builds the message with buildMessage from @tuwaio/siwx-core, sets signing and asks signer for the signature, then sets verifying and passes { message, signature } to verifier. On success it sets authenticated with the returned session (which is saved to localStorage) and calls onSuccess; on failure it sets error and calls onError. The hook performs no network requests itself; your getNonce and verifier do.

Side effect: after the first mount, restores the session saved by a previous page load (see useSiwxSessionStore).

Returns

UseSiwxReturn

The signIn and signOut actions.

Example


const { signIn, signOut } = useSiwx();
 
const handleLogin = () =>
  signIn({
    signer: createEvmSiwxSigner(walletClient),
    getNonce: async () => (await (await fetch('/api/siwx/nonce')).json()).nonce,
    verifier: async (payload) => {
      const res = await fetch('/api/siwx/verify', { method: 'POST', body: JSON.stringify(payload) });
      return res.ok ? res.json() : null;
    },
    fields: {
      domain: window.location.host,
      address: `eip155:1:${address}`,
      uri: window.location.origin,
      chainId: 'eip155:1',
      statement: 'Sign in to TUWA.',
    },
  });