Skip to content

Using Arcana Dashboard

Are you ready to setup user onboarding and blockchain signing experience for your application users?

The first step is to register your application on the Arcana Developer Dashboard, the go-to console for application developers.

You can customize Arcana Auth SDK settings and enable application users to utilize Arcana Testnet or Mainnet. Once you have completed the registration and configuration process, you need to install the Auth SDK and integrate it with your application.

This guide will walk you through the various configuration options available on the dashboard to tailor your Auth SDK usage. For instruction on how to install Auth SDK and integrate your application, refer to the Quick Start Guide.

Note

After configuration, each newly created application is assigned a unique App Address. This is required to integrate the Auth SDK with your application.

Prerequisites

  • Developers must use the Arcana Developer Dashboard to configure the Auth SDK usage settings before integrating their application.

  • Log in to the Arcana Developer Dashboard using one of the social provider accounts listed below. Or use the password-free sign in option.

    • Google
    • GitHub
    • Twitch
    • Discord

Using Arcana Developer Dashboard

Login

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

Welcome screen

Tip

The Arcana Network protocol aggregates multiple social account login identities of Web3 developers under a single user account, allowing them to access their dashboard application settings using any of their social logins.

Register Application

Login to the dashboard, use the Create New App wizard and provide the following inputs to register your application with the Arcana Network.

create new app wizard icon

  • App Name: The name of your registered application

Register dApp

Click Create to register your application with the Arcana Testnet (default network).

Tip

After registration, you can change the application entry name by using the pen icon. Click Enter in the editable text field to save the new application entry name.

After a successful registration, you will see the application dashboard screen for 'Testnet' configuration profile (default).

New app dashboard

Application dashboard screen displays per application usage statistics. Use the LHS navigation and choose Configure to view and edit configuration settings. Refer to the next section for details.

Every registered application shows up as a card on the Arcana dashboard Manage Apps screen next to the Create New App wizard. You can view the list of all registered applications for a developer account in the form of cards.

New app card

Configure Application

Click Configure in the LHS navigation of the Application dashboard screen. It has the following sections:

  • Branding
  • Social Auth
  • Arcana Wallet

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

config details

Click on the tabs below to learn more about various configuration settings for branding, social authentication and Arcana wallet.

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

Branding Settings:

  • Upload Logo: Upload light and dark theme branding/logo images and customize the wallet UI that shows up in the context of your application for any authenticated user. You can customize the logo mark that shows in a minimized wallet. You can also customize the horizontal logo that shows up in the top left of the Arcana wallet UI right before the registered application name.
  • Wallet Theme: Choose an appropriate wallet theme for your application. Dark theme is the default.

    Branding

Use the social authentication section to manage user onboarding experience by setting up requisite social login providers. Only the providers that are configured for an application will be enabled in the Auth SDK as options for users to onboard the application.

Example

For example, if you wish to enable Google and Discord login options for your application, make sure you provide the requisite inputs required for these providers in the settings below. You can leave other provider entries as blank.

By default, password-free login is always enabled in the Auth SDK.

Social Auth Settings:

  • Redirect URI: URL auto-generated by Arcana to complete OAuth verification. It needs to be added in the redirect URI for all the social authentication providers that are configured for the dApp.
  • Social Auth: Select dApp user onboarding experience and provide social authentication provider specific configuration details.

    Social OAuth

Use the Arcana wallet section to specify Arcana wallet additional security settings. (Optional)

Arcana Wallet Settings:

  • Wallet: Website Domain - Set our website domain here. It is used for security reasons by the server, to restrict Arcana wallet from loading anywhere else other than the domain you specify. Arcana uses frame-ancestor CSP for restricted domains.

    Social OAuth

Use the shared keyspace section to use default App-specific or Global Keys feature. Global keys allows an application user to have the same wallet address across different applications in the Arcana Network ecosystem. Learn more about App-specific and global keys and use the Arcana Developer Dashboard User Guide to configure shared keyspace.

Keyspace

  • App-Specific: Highly secure but an authenticated user will be assigned unique, different wallet address for every apps in the Arcana Network ecosystem.

  • Global Keys: Less secure but better user experience as an authenticated user will be assigned a unique address that remains the same whether user logs into any application in the Arcana Network ecosystem.

Mainnet Keyspace options

Note

Make sure you save the configuration settings before leaving the dashboard page in your browser.

Arcana Wallet

Arcana Auth SDK allows developers to manage the dApp user experience for signing blockchain transactions with the Arcana wallet.After installing the Auth SDK, during integration with the dApp, create a new AuthProvider instance and specify appropriate wallet visibility mode through the alwaysVisible parameter. See the Arcana wallet configuration guide for details.

Note

The "App Address" assigned to your application can be found on the top right of the dashboard. App Address

Manage Configurations

Every application that is registered using the Arcana Developer Dashboard is represented by a single card displayed in the 'Manage Apps' dashboard screen, next to the 'Create New App' wizard. Click on application card to view the application dashboard. By default, the application dashboard shows application usage details for Testnet configuration profile and some links to the Arcana Auth documentation.

To view configuration details for an application, use the LHS navigation menu and click Configure to view/edit the application configuration settings as described in an earlier section of this guide.

Each application can only be associated with two configuration profiles, 'Testnet' and 'Mainnet. Both these configurations are maintained separately and each is associated with a unique App Address.

New App config card

Testnet

All newly registered applications are enabled for using the Arcana 'Testnet'. The default configuration profile created for every registered application is meant for 'Testnet' usage. Developers can view or edit the default configuration settings by clicking 'Testnet' on the application card displayed in the 'Manage Apps' dashboard. This will bring up the application dashboard screen with various navigation options in the LHS pane.

After validation on the 'Testnet', the application can be configured to use the Arcana 'Mainnet'. To do this, developers must create a corresponding 'Mainnet' configuration profile.

Mainnet

By default, all newly registered applications are enabled to use Arcana 'Testnet' and associated with the 'Testnet' configuration. To switch an application from using 'Testnet' to 'Mainnet', developers must first create a 'Mainnet' profile using the developer dashboard.

A newly registered application does not have any 'Mainnet' profile associated with it. The application card displayed in the 'Manage Apps' screen will show the 'Mainnet' configuration as disabled. To create a 'Mainnet' configuration profile, the developer must use the application dashboard screen displaying the Testnet profile and select the Social Auth settings. In the social authentication settings screen, refer to the dropdown on the top right next to 'Testnet'. Use this dropdown to select and switch to 'Mainnet'.

Testnet Mainnet Selection

When 'Mainnet' is selected from the dropdown, if there already exists a 'Mainnet' profile then the configuration settings for social authentication for Mainnet are displayed. Otherwise a new 'Mainnet' profile creation wizard gets activated and displays a pop up screen asking the developer to choose one of the options to create the 'Mainnet' configuration. You can either copy the exact 'Testnet' configuration or create a new blank configuration for 'Mainnet' settings.

Switch to Mainnet Profile

After the selection is made and the developer confirms, the 'Mainnet' profile is created and automatically registered with the Arcana Network. 'Mainnet' configuration requires an additional setting which is not there for 'Testnet' configuration profile. This additional setting is keyspace and it is used to allow Web3 application users to share the same wallet address across multiple applications that are deployed on the Arcana 'Mainnet'. Refer to the next section for more details.

Mainnet App Address

The newly creat4ed 'Mainnet' configuration profile is associated with a brand new unique App Address. Developers must specify this new app address while integrating the application with the Auth SDK and deploy it on Arcana 'Mainnet'.

Configure Mainnet Keyspace

To deploy an application on the Arcana Mainnet, developers need to create a 'Mainnet' profile and configure the keyspace option. You can choose to copy the 'Testnet' profile as 'Mainnet' configuration or create a new one. In both cases, you need to specify an additional keyspace option. Keyspace is only available for Mainnet. There are two keyspace options: App-specific and Global Keys.

You can either use the default, highly secure App-specific keyspace option or Global keyspace depending upon the desired level of security and user experience required for the application.

Mainnet Keyspace options

Use global keyspace if you want to allow the Web3 users experience where same wallet address is assigned to the user across different Arcana application logins. It is less secure than the default App-specific keyspace option whereby a user will see different wallet address across different application.

Select Global Keyspace and click Verify. This will bring up a verification form. Fill out the verification form, click Submit.

Global Keyspace Verify

You can check the status of Global Keyspace verification by using the Keyspace screen. After submitting the form, you will see the status as In Review.

Mainnet Global keyspace in review

The status will change to Approved once verification is complete. You can integrate your application with the Auth SDK but do not deploy it until the verification is complete. Otherwise users that log in before verification is complete may see different wallet addresses after the process is complete.

Mainnet Global keyspace approved

Now your application is configured to use the Arcana Mainnet. You can further edit configuration settings for Mainnet by using the LHS navigation pane and selecting Configure.

Mainnet Profile entry

Switch Profiles

There are multiple ways to switch an application from using Testnet to Mainnet.

  • To switch to 'Mainnet', use the application dashboard screen, select Configuration >> Social Auth in the LHS navigation pane. Refer to the dropdown next to 'Testnet' on the top RHS of the screen and choose 'Mainnet'. If there is a preexisting 'Mainnet profile, the app is automatically switched to it and you can see the social authentication settings and assigned App Address for the 'Mainnet' profile. Otherwise, the profile wizard gets activated and assists the developer in creating a 'Mainnet' configuration profile for the application. Once the profile is created, a new App Address is automatically assigned and the configuration switches to 'Mainnet'.

    Select Testnet or Mainnet

  • Alternatively, if a 'Mainnet' configuration profile is already created for an application, you can also switch between Testnet/Mainnet configuration profiles by using the 'Manage Apps' dashboard screen. Simply select the application card and click on 'Testnet' or 'Mainnet'. This will bring up the application dashboard screen displaying the application dashboard for the selected configuration profile.

    Switch to Testnet

Caution

Depending upon whether the 'Testnet' App Address value or the 'Mainnet' App Address value is used to integrate an application with the Auth SDK, the corresponding Arcana Network is used by the application users. "Testnet" usage is not billed but if an application chooses 'Mainnet', it will be billed in the forthcoming releases.

Switch Applications

Developers can switch from one application configuration profile screen to another application by using the 'Manage Apps' screen and clicking on the requisite application card.

Alternatively, you can use the LHS navigation pane in the configuration screen and click on the dropdown next to the application name in the top left. The dropdown displays a list of all the applications registered by the developer and a link to navigate to the Manage Apps dashboard screen. Select a different application from the drop down list and you will be switched to a different application dashboard screen.

Switch Application

Monitor Usage

Developers can monitor their registered application usage statistics via the Arcana Developer Dashboard. The Manage Apps screen displays the account level usage metrics. Application specific usage details are available in the application dashboard screen.

Account Usage Metrics

The Manage Apps screen displays Monthly Active Users (MAU) for the developer account. This is an aggregate score across all the applications that are registered for a dev account and configured to use the Arcana 'Mainnet'. Any application using the 'Testnet' are not billed and not included in this overall account usage statistic.

Dashboard metrics

Caution

The billing data is only applicable for Mainnet usage and will be made available in the forthcoming releases.

Usage per Application

Arcana Network maintains per application usage statistics separately for both the 'Testnet' and 'Mainnet' configuration profiles.

In the Manage Apps dashboard screen, all registered applications are listed as cards. Each application card displays the 'Total Users' statistic. This refers to the total monthly active application users that are utilizing the Arcana Testnet/Mainnet. To view per application usage details, you need to select 'Testnet' or 'Mainnet' profile and look at the Application dashboard screen that displays the following user statistics:

  • Number of logged in users

Use the 'Daily' and 'Monthly' tabs to see the respective usage statistics.

You can use the dropdown in the top right of the application dashboard screen to select Testnet/Mainnet usage details.

Application Usage Stats

Delete Application

To de-register an application the developers must delete the entry using the dashboard. Go to the 'Manage Apps' dashboard page that lists all the registered applications.

Manage Apps Dashboard

Select the application you wish to de-register and choose Delete.

Delete App

Dashboard FAQ

New users can get help with Auth SDK configuration and dashboard usage by consulting the Arcana Dashboard FAQ or contacting ๐Ÿ“จ support@arcana.network.


Last update: January 30, 2023 by shaloo