Skip to content

Register & Configure App

In this tutorial, you will learn how to register and configure a Web3 app before integrating it with the Arcana Auth SDK.

Client ID

Each registered app is assigned a unique identifier, Client ID, required to integrate an app with the Arcana Auth SDK.

Prerequisites

  • To use the Arcana Developer Dashboard, developers must have an account with one of the supported social providers. Or they can use the passwordless sign-in option.

    • Google
    • Discord
    • Twitter
    • GitHub

Step 1: Developer Dashboard Login

Go to https://dashboard.arcana.network and select a login option on the welcome screen.

Welcome screen

Tip

The Arcana Auth protocol aggregates multiple login identities across social providers under a single identifiable Arcana account. This enables developers to log into the Arcana Developer Dashboard through any of the supported social providers and access the same Arcana developer account.

Step 2: Register Application

All the apps registered against the developer's account show up as cards in the Manage Apps screen of the Arcana Developer Dashboard.

New app card

Click on the Create New App wizard, the first card on the Manage Apps screen, to register a new app. create new app wizard icon

Click the wizard and specify the name of the app to be registered in the App Name field. When you click Create, the app is registered for using the Arcana Testnet by default.

Register dApp

Tip

To edit the name of a registered app entry, use the pen icon. Click Enter in the editable text field to save the changes.

After successfully registering an app, the app dashboard screen is displayed automatically. It shows the Arcana Testnet usage statistics for the app. By default, every newly registered app is associated with the 'Testnet' configuration profile. Use Configure in the LHS menu to view and edit configuration settings.

New app dashboard

Step 3: Configure Application

Click Configure in the LHS navigation of the app configuration screen in the Arcana Developer Dashboard to bring up app configuration settings:

  • Branding
  • Social Auth
  • Chain Management
  • Arcana Wallet
  • Keyspace (Available only after the 'Mainnet' profile is created)

Use the defaults or provide inputs for various settings as per your application use case. These settings control Arcana Auth SDK usage, user onboarding, and blockchain transaction signing experience.

config details

Click on the tabs below to see the various configuration settings in each category.

Use branding settings to manage the look and feel of the embedded Arcana wallet that shows up in an application context. By default, the Arcana wallet displays The default branding logo logo and uses the dark theme.

  • Upload Logo: Upload light and dark theme branding/logo images that are displayed in the Arcana wallet UI.
  • Wallet Theme: You can change the default 'dark' theme.
    Branding

Use the social authentication settings to manage the user onboarding experience. Only the social providers that are configured for an application will be made available in the Arcana Auth SDK as user onboarding options. Developers can enable multiple providers for an app and allow users to choose anyone to onboard the app. For details on how to configure authentication providers, see configuring social providers.

Enable Google, Discord for Onboarding Users

To enable Google and Discord login options for an app, configure these social providers in the Arcana Developer Dashboard. You can leave other social provider entries blank.

By default, passwordless login is always enabled in the Arcana Auth SDK.

  • Redirect URI: Displays the URL auto-generated for each registered app by Arcana. This is required to complete OAuth verification via the selected authentication providers.
  • Social Auth: Select and configure authentication providers for onboarding app users.
    Social OAuth

Use the chain management section to specify the subset of chains from the list of supported blockchains that are configured for the Arcana wallet out of the box. This specified subset will be displayed in the Arcana wallet UI when a user logs into an app that is integrated with the Arcana Auth SDK. Developers can also specify which chain will be the default and show up in the wallet 'Network' dropdown list on the top.

Chain Management Settings

Add Chains: Click Add Chains to add a new blockchain to the Arcana wallet. Make sure it is one of the supported blockchains for the Arcana Auth product.

Set Default Chain

For details, see how to manage chains.

Use the Arcana wallet section to specify additional, optional security settings.

  • Wallet: Website Domain - Set the website domain used by the server, to secure and restrict Arcana wallet from loading anywhere else other than the specified domain. Arcana uses the frame-ancestor CSP for restricted domains.
    Social OAuth

Use the Keyspace section to select the App-specific (default) or Global Keys feature. Global keys are less secure but allow app users to have the same wallet address across different applications in the Arcana ecosystem. Learn more about App-specific and global keys and how to use the Arcana Developer DashboardUser Guide to configure keyspace.

Mainnet Keyspace options

Available only for 'Mainnet' Configuration Profile

The 'Keyspace' tab is visible only if a developer chooses to create a 'Mainnet' configuration profile for the app.

It is possible to use App-Specific Keys (default) at the start and change the keyspace type later to Global Keys. However, transitioning between the two will cause the user's wallet address to change.

Make sure you save the configuration settings before leaving the Arcana Developer Dashboard page in your browser.

You can reconfigure Web3 app settings for Arcana Auth SDK usage anytime later by using the Arcana Developer Dashboard.

That is all! ๐ŸŽ‰

You have successfully registered and configured your application.

What's next?

See how to configure Arcana Auth SDK usage for details on setting up authentication providers.

After registering and configuring the application, developers must install the Arcana Auth SDK and integrate the app before enabling user onboarding and allowing the authenticated users to sign blockchain transactions.

Save Client ID

A unique Client ID is assigned to every registered app. It is displayed on the top right of the dashboard screen. Copy and use it to integrate the app with the Arcana Auth SDK.

App unique identifier

See Also


Last update: April 25, 2023 by shaloo