Using Arcana Dashboard
Are you ready to set up 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 instructions on how to install Auth SDK and integrate your application, refer to the Quick Start Guide.
After configuration, each newly created application is assigned a unique Client ID. This is required to integrate the Auth SDK with your application.
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 passwordless sign in option.
Using Arcana Developer Dashboard
Go to https://dashboard.arcana.network and select a login option on the welcome screen.
The Arcana Network protocol aggregates multiple social account login identities of Web3 developers under a single user account. This enables developers to log into the dashboard using any of the supported social providers and access the same developer account in the Arcana Network.
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 displayed as cards.
To register an app, log in to the dashboard, and click Create New App wizard.
You will see a pop-up UI for registering apps. 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.
The name of a registered app entry can be edited by using the pen icon. Click Enter in the editable text field to save app name changes.
After successful registration, the application dashboard screen is displayed. It shows the per-application usage statistics. Click Configure in the LHS menu to view and edit configuration settings. By default, every newly registered app is associated with the 'Testnet' configuration profile.
Click Configure in the LHS navigation of the Application dashboard screen. It has the following sections:
- Social Auth
- Arcana Wallet
- Keyspace (Available only after the 'Mainnet' profile is created)
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.
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 logo and uses the dark theme.
- 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. The 'dark' theme is the default.
Use the social authentication section to manage the user onboarding experience by setting up requisite social 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.
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 blank.
By default, passwordless login is always enabled in the Auth SDK.
You can enable multiple social providers for an app via the Arcana Developer Dashboard. See configuring social providers and enable user onboarding.
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 by configuring social providers.
Use the Arcana wallet section to specify Arcana wallet's additional security settings. (Optional)
Arcana Wallet Settings:
Available only for 'Mainnet' Configuration Profile
This tab is visible only if a developer chooses to create a 'Mainnet' configuration profile for the app.
Developers can choose to use App-Specific Keys (default) at the start and change to Global Keys later. However, transitioning between the two will mean that your user's wallet address will change.
Use the Keyspace section to select the App-specific (default) or Global Keys feature. Global keys allow app users 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 keyspace.
App-Specific: Highly secure but an authenticated user will be assigned a unique, different wallet address for every app 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 the user logs into any application in the Arcana Network ecosystem.
Make sure you save the configuration settings before leaving the dashboard page in your browser.
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 app, create a new
AuthProvider instance and specify appropriate wallet visibility mode through the
alwaysVisible parameter. See the Arcana wallet configuration guide for details.
The Client ID assigned to your application can be found on the top right of the dashboard.
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 the application card to view the application dashboard. By default, the application dashboard shows application usage details for the '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 Client ID.
By default, all newly registered applications are enabled for using the Arcana 'Testnet'. 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.
To use Arcana Mainnet, the developers must first create a 'Mainnet' configuration profile using the developer dashboard.
A newly registered application does not have any 'Mainnet' profile associated with it, it has to be explicitly created by the developer. The application card displayed in the 'Manage Apps' screen will show the 'Mainnet' configuration as disabled for all newly registered apps. To create a 'Mainnet' configuration profile, the developer must use the application dashboard screen displaying the Testnet profile, use the LHS navigation pane 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 the 'Mainnet' configuration.
When 'Mainnet' is selected from the dropdown, 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.
After the selection is made and the developer confirms, the 'Mainnet' profile is created and automatically registered with the Arcana Network.
Mainnet Client ID
The newly created 'Mainnet' configuration profile is associated with a brand new unique Client ID. Developers must specify this new Client ID while integrating the application with the Auth SDK and deploying it on Arcana 'Mainnet'.
Copying Testnet Profile
If the developer chooses to create the 'Mainnet' profile by copying the 'Testnet' profile, there is an additional setup required to enable the configured social providers. Once the 'Mainnet' profile is created, visit the dashboard and copy the
Redirect URI' displayed for the 'Mainnet' profile. You need to update thisRedirect URI` value using the respective social provider's developer console, similar to the one added that you added earlier in the case of the 'Testnet' profile.
Example: Copying Google Profile
If Google is enabled in your app's 'Testnet' profile, then during the configuration of the social provider with the Google Developer console, the Testnet redirect URI was added. Copy the 'Mainnet' profile redirect URI value from the Arcana dashboard and update them in the Google Console OAuth settings.
Make sure that you add the 'Mainnet' redirect URI value for the other social providers that are enabled in the 'Testnet' profile. This is required for enabling your app to use the Arcana Mainnet.
The figure below shows how the 'redirect URI' is updated in a scenario where Google and Twitch were configured for the 'Testnet' configuration profile and that profile was copied to create a 'Mainnet' profile.
'Mainnet' configuration requires an additional setting which is not available for the 'Testnet' configuration profile. This additional setting, Keyspace, is used to allow Web3 application users to share the same wallet address across multiple applications that are deployed on the 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. Setting up keyspace is mandatory irrespective of whether the developer chooses to copy the 'Testnet' profile as the 'Mainnet' configuration or creates a new one.
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.
Use global keyspace if you want to enable the kind of Web3 user experience whereby the 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 addresses across the different applications.
Select Global Keyspace and click Verify. This will bring up a verification form. Fill out the verification form, and click Submit.
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.
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.
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.
There are multiple ways to switch an application from using Testnet to Mainnet.
To switch from Testnet to the Mainnet profile, use the application dashboard screen, and 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. You can view the social authentication settings and the assigned Client ID for the 'Mainnet' profile. If there is no 'Mainnet' profile associated with the app, then on selecting 'Mainnet' from the dropdown, the app wizard gets activated and assists in creating a 'Mainnet' configuration profile for the application. Once the profile is created, a new Client ID is automatically assigned and the configuration switches to 'Mainnet'.
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.
Depending upon whether the 'Testnet' Client ID value or the 'Mainnet' Client ID value is used to integrate an application with the Auth SDK, the deployment of the app happens on the respective Arcana Network. "Testnet" usage is not billed but if an application chooses 'Mainnet' while integrating with the Auth SDK, it will be billed in the forthcoming releases.
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.
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 on 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.
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 usage 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.
To de-register an application the developers must delete the entry using the dashboard. Go to the 'Manage Apps' dashboard page which lists all the registered applications.
Select the application you wish to de-register and choose Delete.
New users can get help with Auth SDK configuration and dashboard usage by consulting the Arcana Dashboard FAQ or contacting 📨 email@example.com.