Create Your First Wallet with Social Logins

Learn how to initialize and create a user-controlled wallet using the social logins. To create a wallet with email authentication, see Create Your First Wallet with Email.

This quickstart utilizes Circle's sample application in combination with API requests that can be sent using cURL requests or Circle's API references. cURL requests are provided inline while API references call the API endpoints. For more information on how to use API references to make calls, see Testing API References.

You can create both Smart Contract Accounts (SCA) and Externally Owned Accounts (EOA) wallets. To learn more, see the Account Type guide.

Before you begin:

1. Create or sign in to your Circle Developer Console account.
2. Generate an API Key.
3. Complete the Authentication Methods configurations before you set up the sample app.

This guide walks you through steps on how to create a wallet and perform transactions or signatures, and provides sample code. You can use Circle's sample app on web or set it up locally.

1. Obtain an App ID. Either:

• From the Circle Developer Console, navigate to Wallets > User Controlled > Configurator and copy App ID.
• Send a GET request to the /config/entity endpoint and copy the appId from the response body.

2. Add the App ID to the sample app.

Obtain IDs from the following providers:

• Google has a dedicated Client ID for Web, iOS, and Android platforms. See the Google doc: Get your Google API client ID.
• Facebook has an App ID. See the Facebook doc: Facebook App Development.
• Apple has a Bundle ID for iOS, and a Service ID for Web and Android platforms. See the Apple doc: Register an App ID.

Add the IDs to the Circle Developer Console:

1. From the sidebar, navigate to Wallets > User Controlled > Configurator.
2. Select Authentication Methods > Social Logins.
3. From Social Logins, enter the IDs required for your app:
   • Google: Client ID for Android, iOS, or Web.
   • Apple: Bundle ID for iOS or Service ID for Android Web.
   • Facebook: App ID.

You must ensure the ID settings for your app and the Circle Developer Console always match. If you only edit or delete IDs set on the identity provider side:

• If your user is logged out, they will not be able to log back in even if their user token is active.
• If your user is logged in, they will remain logged in if their user token is active. When their user token expires in over 14 days, they will be logged out and will not be able to log back in.

For more, see Authentication Methods.

Once you have configured the social provider IDs, you must set up redirectedURI, which corresponds to the loginConfigs within the Web SDK.

• For Google or Facebook, you must set the relevant URL domain or else redirects will be blocked by the provider.
• For Apple, Firebase is used for URL redirection. Firebase configuration must be properly set to carry out the Apple login flow. For setup instructions, see the Firebase doc: Authenticate Using Apple.

1. Once the SDK setup is done, include your API key and deviceId in a POST request to the /users/social/token endpoint.

import { initiateUserControlledWalletsClient } from '@circle-fin/user-controlled-wallets'

const circleUserSdk = initiateUserControlledWalletsClient({
  apiKey: '<your-api-key>',
})

const response = await circleUserSdk.createDeviceTokenForSocialLogin({
  deviceId: 'your device id',
})

2. Copy deviceToken and deviceEncryptionKey from the response and enter them into the sample app.

   Response Body

   Text

   {
     deviceToken: string
     deviceEncryptionKey: string
     otpToken?: string // For email authentication method only
   }
   

   CopyCopied!
   

3. On the sample app, select Login with Google or Login with Facebook. This takes you through the social login flow and corresponds to the SDK method performLogin.

   
   

   If calling performLogin doesn't return a response, check the following:

   • The identity provider credentials in the SDK and DevConsole are correct.
   • Confirm that the steps of the SDK initialization are complete, including calling getDeviceId.

   Consider wrapping the initialization process in a context hook instead of the useEffect hook so you can correctly capture the SDK response. Put the context provider in the root component of the web application:

import { createContext, ReactNode, useCallback, useContext, useEffect, useMemo, useState } from 'react'
import { W3SSdk } from '@circle-fin/w3s-pw-web-sdk'
import { EmailLoginResult, Error, SocialLoginResult } from '@circle-fin/w3s-pw-web-sdk/dist/src/types'

let webSdk: W3SSdk

const Sdk = createContext<{ sdk: W3SSdk | undefined }>({
  sdk: undefined,
})

const getConfig = () => ({
  appSettings: { appId: process.env.NEXT_PUBLIC_CIRCLE_APP_ID || '' },
  loginConfigs: {
    deviceToken: localStorage.getItem('deviceToken') || '',
    deviceEncryptionKey: localStorage.getItem('deviceEncryptionKey') || '',
    otpToken: localStorage.getItem('otpToken') || '',
    facebook: {
      appId: process.env.NEXT_PUBLIC_FACEBOOK_AUTH_CLIENT_ID || '',
      redirectUri: window.location.origin,
    },
    google: {
      clientId: process.env.NEXT_PUBLIC_GOOGLE_AUTH_CLIENT_ID || '',
      redirectUri: window.location.origin,
    },
  },
})

const initializeSdk = (
  onLoginComplete: (error: Error | undefined, result: SocialLoginResult | EmailLoginResult | undefined) => void
) => {
  return new W3SSdk(getConfig(), onLoginComplete)
}

export const useSdk = () => useContext(Sdk)

interface SdkProviderProps {
  children: ReactNode
}

export const SdkProvider = ({ children }: SdkProviderProps): JSX.Element => {
  const [sdk, setSdk] = useState<W3SSdk | undefined>(webSdk)

  const onLoginComplete = useCallback(
    (error: Error | undefined, result: SocialLoginResult | EmailLoginResult | undefined) => {
      if (error) {
        console.log(error)
      } else {
        console.log(result)
      }
    },
    []
  )

  useEffect(() => {
    const sdk = initializeSdk(onLoginComplete)

    if (sdk) {
      webSdk = sdk
      setSdk(webSdk)
    }
  }, [onLoginComplete])

  const contextValues = useMemo(() => ({ sdk }), [sdk])
  return <Sdk.Provider value={contextValues}>{children}</Sdk.Provider>
}

4. After a successful login, you are redirected back to the main page of this sample app. The "Execute Challenge" section is now visible.

   

5. Select Execute Challenge.

   Both encryptionKey and userToken are pre-populated since these parameters are required for the next step, which is to initialize the user.

   

1. Include userToken copied from the previous step in a POST request to the /user/initialize endpoint.
2. Copy challengeId from the response and enter it into the sample app.

To create an SCA wallet, provide a Testnet blockchain such as ETH-SEPOLIA, MATIC-AMOY, and AVAX-FUJI.

The following code samples show how to create an SCA wallet on Amoy and the response.

const response = await circleUserSdk.createUserPinWithWallets({
  userToken: '<USER_TOKEN>',
  accountType: 'SCA',
  blockchains: ['MATIC-AMOY'],
})

{
  "data": {
    "challengeId": "0d1b5f41-1381-50af-983b-f54691415158"
  }
}

The following code samples show how to create an EOA wallet on Solana and the response.

const response = await circleUserSdk.createUserPinWithWallets({
  userToken: '<USER_TOKEN>',
  accountType: 'EOA',
  blockchains: ['SOL-DEVNET'],
})

{
  "data": {
    "challengeId": "0d1b5f41-1381-50af-983b-f54691415158"
  }
}

1. Paste the Challenge ID copied from the previous step into the sample app, and select Execute.
2. An “Execute Successful” message is displayed on the sample app. A web3 wallet is created for you users!

Once you have created a wallet in the sample app, you can check the user and wallet status.

To check the user's account status:

• Include userToken in a GET request to the /user endpoint to retrieve the status of the user’s account.

const response = await circleUserSdk.getUserStatus({
  userToken: '<USER_TOKEN>',
})

{
  "data": {
    "id": "2f1dcb5e-312a-4b15-8240-abeffc0e3463",
    "status": "ENABLED",
    "createDate": "2023-07-26T15:27:32Z",
    "pinStatus": "ENABLED",
    "pinDetails": {
      "failedAttempts": 0
    },
    "securityQuestionStatus": "ENABLED",
    "securityQuestionDetails": {
      "failedAttempts": 0
    }
  }
}

To check the status of the user’s new wallet.

• Include userToken in a GET request to the /wallets endpoint to retrieve the user’s new wallet.

const response = await circleUserSdk.listWallets({
  userToken: '<USER_TOKEN>',
})

{
  "data": {
    "wallets": [
      {
        "id": "01899cf2-d415-7052-a207-f9862157e546",
        "state": "LIVE",
        "walletSetId": "01899cf2-d407-7f89-b4d9-84d63573f138",
        "custodyType": "ENDUSER",
        "userId": "2f1dcb5e-312a-4b15-8240-abeffc0e3463",
        "address": "0x075e62c80e55d024cfd8fd4e3d1184834461db57",
        "addressIndex": 0,
        "blockchain": "MATIC-AMOY",
        "accountType": "SCA",
        "updateDate": "2023-07-28T14:41:47Z",
        "createDate": "2023-07-28T14:41:47Z"
      }
    ]
  }
}

{
  "data": {
    "wallets": [
      {
        "id": "8a79c80b-4d4f-4032-971a-8bb9f9b0254f",
        "state": "LIVE",
        "walletSetId": "c43221d3-9db1-4cbf-8b18-e1dcae16b55d",
        "custodyType": "ENDUSER",
        "userId": "d8c8f832-5d4f-4123-9a7f-60120c2da5f0",
        "address": "8UFfxP3zzSeqdkZ5iLTmUGzpHPRGnydZ1Vnq5GkzKTep",
        "addressIndex": 0,
        "blockchain": "SOL-DEVNET",
        "accountType": "EOA",
        "updateDate": "2023-07-28T14:43:48Z",
        "createDate": "2023-07-28T14:43:48Z"
      }
    ]
  }
}

You can also view the User ID, Auth Method, and Wallet status on the Circle Developer Console:

1. From the Wallets section on the sidebar, select User Controlled > Users.
2. Select your user from the row. The wallet address is displayed.