​
Overview

Capsule supports various OAuth methods to authenticate users across different platforms. Currently supported platforms include Google, Facebook, Discord, Twitter, and Apple.

Capsule automatically links wallets with a common email identifier to avoid creating duplicate wallets if users choose different methods in different sessions. Because of this, users must have an email associated with their login account of choice. Without an email linked to the account, authentication will fail and the user will see a prompt to either add email to their social account or try a different method.

​
Integrating Social Logins

​
Capsule Modal

Social Logins can be easily integrated via the CapsuleModal Component by passing the desired options as an array to the oAuthMethods property as follows:

import { CapsuleModal, OAuthMethod } from '@usecapsule/web-sdk';

const capsule = new Capsule(Environment.BETA, YOUR_API_KEY);

<CapsuleModal
  capsule={capsule}
  appName="YourAppName"
  oAuthMethods={[
    OAuthMethod.GOOGLE,
    OAuthMethod.FACEBOOK,
    OAuthMethod.APPLE,
    OAuthMethod.TWITTER,
    OAuthMethod.DISCORD,
    OAuthMethod.FARCASTER,
  ]}
/>;

​
Custom UI Entrypoint

For developers preferring manual control over launching an authentication process or leveraging a custom implementation, the following can be used to obtain OAuth URLs:

// Import the required modules from the Capsule Wallet SDK.
import { OAuthMethod } from '@usecapsule/web-sdk';

// Select your desired platform
const oAuthMethod = OAuthMethod.TWITTER; // Example for Twitter authentication

// Obtain the OAuth URL using the getOAuthURL method.
const oAuthURL = await capsule.getOAuthURL(oAuthMethod);

// Direct the user to the obtained oAuthURL for authentication
window.open(oAuthURL); // can choose via redirect, popup, etc.

// Wait for the user to be authenticated via the OAuth method through Capsule.
const { email, userExists } = await capsule.waitForOAuth();

Beta Testing Email In the BETA Environment, you can use any email ending in @test.usecapsule.com (like dev@test.usecapsule.com). Any OTP code will work for verification with these test emails. These credentials are for beta testing only. You can delete test users anytime in the beta developer console to free up user slots.

​
Farcaster OAuth Login

Farcaster Login works similarly to other social logins, with one key difference: there is no email associated with the account. Instead, we use the Farcaster username as the identifier for this user. This is important to keep in mind, as the functions used in the SDK will be different. Here’s an example of implementing Farcaster login:

import { OAuthMethod } from '@usecapsule/web-sdk';

const oAuthMethod = OAuthMethod.FARCASTER;
const oAuthURL = await capsule.getFarcasterConnectURL(); // Display this url in a QR Code

// Wait for the user to be authenticated via the OAuth method through Capsule.
const { username, userExists } = await capsule.waitForFarcasterStatus();

if (userExists) {
  const webAuthUrlForLogin = await capsule.initiateUserLogin(username, false, 'farcaster');
} else {
  const webAuthURLForCreate = await capsule.getSetUpBiometricsURL(false, 'farcaster');
}

Was this page helpful?

UI & ThemingPhone Number Logins