Skip to content

Quick Start

In this guide, you will learn how you can quickly integrate your application with the Arcana Auth SDK to:

Release Details

Refer to the Release Notes and see details about what's changed in the latest version.

You can also watch GitHub releases to receive notifications when a new release for Arcana Auth SDK is published.

Overview

To integrate an application with the Auth SDK, developers must:

  1. Use the Arcana Developer Dashboard to register their application and obtain a unique App Address.
  2. Configure user onboarding settings for the application using the dashboard. Application users will only see the onboarding options that are configured by the developer.
  3. Install and integrate the application with the Auth SDK.

To enable the embedded Arcana wallet in an application, the application developers need to integrate with the Auth SDK and use the AuthProvider interface. The AuthProvider is a standard Ethereum Web3 provider that allows the application users to sign blockchain transactions after they have been authenticated. For more information on AuthProvider, see Auth SDK Usage Guide and Auth SDK Reference Guide.

Arcana Auth Usage Overview Arcana Auth Usage Overview

Register & Configure

First register and configure your application using the Arcana dashboard. As part of registration, a unique value, App Address, is assigned to each application. This is required for integrating the application with the Auth SDK.

Developers must choose one or more options to onboard users and configure social login. This ensures that only the configured onboarding options are enabled in the Auth SDK.

Enable multiple login options

Web3 application developers can configure one or more authentication mechanisms using the dashboard and allow users to pick one of the available options to log in.

User Onboarding options

If the application is registered but not configured for any social login providers, by default, passwordless login is the only option that is enabled for the application users.

Install Auth SDK

npm

npm install --save @arcana/auth

yarn

yarn add @arcana/auth

CDN

<script src="https://cdn.jsdelivr.net/npm/@arcana/auth"></script>
<script src="https://unpkg.com/@arcana/auth"></script>

Integrate Application

Follow these instructions to integrate your application with the Arcana Auth SDK.

AuthProvider

Once you have installed and integrated your application, you can use the standard Ethereum Web3 Provider, AuthProvider in your application and call SDK functions for onboarding users and signing blockchain transactions. See how to enable and use Arcana wallet for more details.

Onboard Users

After installing and integrating with the Auth SDK, application developers can add code to onboard users. Two options are available depending on how much customization is needed for your use case.

  1. Use plug-and-play feature to quickly enable the default pop-up user login interface. Developers are not required to build any user login UI. Application users can choose one of the authentication mechanisms configured by developers when the plug and play default UI offered by the Auth SDK shows up in the context of the application.

  2. Build custom UI for your application and call Auth SDK functions for enabling social authentication and the passwordless option for the application users.

Sign Blockchain Transactions

Use the AuthProvider in your application and call standard JSON RPC Web3 wallet functions programmatically. Manage user experience for signing blockchain transactions with wallet visibility settings. Enable authenticated users to sign blockchain transactions, send and receive tokens, NFTs and more using the Arcana Web3 wallet.

Examples

Here are some examples of Auth SDK usage:

  1. Check out how to integrate your application with Auth SDK and enable Web2-like familiar user onboarding via Google, passwordless login.

  2. Manage Web3 user experience for signing blockchain transactions with the Arcana wallet:

    • Enable authenticated users to sign blockchain transactions by setting the Arcana wallet visibility parameter while instantiating the AuthProvider.
    • Use pre-configured, supported blockchains or add other EVM-compatible networks programmatically as per your application requirements.
    • Enable application users to check account balances, send or receive ERC-20, ERC-721 and ERC-1155 tokens, deploy smart contracts, interact with smart contracts, switch networks, manage NFT collections, and more.

Developer & User Guides

For more details on how users interact with the Arcana wallet, see Arcana wallet User Guide.

Developers can refer to the Auth SDK Usage Guide and the Auth SDK Reference Guide for SDK usage details.

See also


Last update: January 23, 2023 by shaloo