useWalletLogin

useWalletLogin is a React Hook that lets you authenticate with the Lens API.

const { login, error, isPending } = useWalletLogin();

Usage

Although the following example uses wagmi it can be adapted to any wallet integration that results in an ethers Signer.

import { useWalletLogin } from '@lens-protocol/react';
import { useAccount, useConnect, useDisconnect } from 'wagmi';
import { InjectedConnector } from 'wagmi/connectors/injected';

function LoginButton() {
  const { login, error: loginError, isPending: isLoginPending } = useWalletLogin();

  const { isConnected } = useAccount();
  const { disconnectAsync } = useDisconnect();

  const { connectAsync } = useConnect({
    connector: new InjectedConnector(),
  });

  const onLoginClick = async () => {
    if (isConnected) {
      await disconnectAsync();
    }

    const { connector } = await connectAsync();

    if (connector instanceof InjectedConnector) {
      const signer = await connector.getSigner();
      await login(signer);
    }
  };
 
  return (
    <div>
      {error && <p>{error}</p>}
      <button disabled={isPending} onClick={onLoginClick}>Log in</button>
    </div>
  );
}

📘

Looking for a full-fledged example?

Check the web-wagmi example in the Lens SDK monorepo. It's showcasing a full authnetication integration with some helper components to control which part of the UI should be just for logged in (or logged out) users.

Reference

useWalletLogin

Call useWalletLogin in the component responsible to log in your users.

function LoginButton() {
  const { login, error, isPending } = useWalletLogin();
  // ...

Parameters

useWalletLogin does not take any parameters.

Returns

Returns an object with:

  • login: a function you can use to programmatically log in your user with the Lens API.
  • isPending: a boolean notifying you when the operation is still in progress.
  • error: any error that might occur in normal operating conditions will be returned via this property. Default value null.

login function

The login function returned by the useWalletLogin lets you programmatically login the specified ethers Signer. If called multiple times it will re-trigger a new login flow. If called with a different signer it will implicitly log-out the old signer and log-in the new one.

login(signer)

Parameters

  • signer: Signer: an instance of ethers Signer