Skip to content

Integrate Near App

Estimated time to read: 4 minutes

In this guide, you will learn how to integrate a vanilla HTML/CSS/JS app with the Arcana Auth SDK and perform transactions through the Arcana wallet on Near blockchain.

Prerequisites

  • Log in to the Arcana Developer Dashboard: https://dashboard.arcana.network

  • Use the Arcana Developer Dashboard to register the app before configuring and integrating with the Arcana Auth SDK.

  • Click on the Social Auth tab in the Arcana Developer Dashboard. Configure and select one or more supported authentication providers for onboarding the app users.

    Configure Authentication Providers

    You may be required to configure additional provider details for different authentication providers. In the case of Google, the developer must use Google Developer Console to set up the app and generate a Google assigned client ID for Google OAuth. This Google ClientID will be configured in the Arcana Developer Dashboard Social Auth settings before integrating the app.

    For details, see how to configure authentication providers.

  • Save the Client ID assigned to the app displayed in the Arcana Developer Dashboard. It is required while integrating the app with the Arcana Auth SDK and creating the AuthProvider.

  • Make sure you configure the required Near chains through the dashboard. See how to set up Near blockchain transactions through the Arcana wallet in apps that are integrated with the Arcana Auth SDK.

Non-EVM Chains

When registering an app through Arcana Developer Dashboard, the choice of chain type (EVM, Solana, MultiversX, Near) is final. App developers can't change it later. They can switch the default chain within the same type. For example, a Solana app on Testnet can switch to Solana Mainnet or Solana Dev but not to MultiversX or an EVM chain.

Steps

Integrating a vanilla HTML/CSS/JS app with the Arcana Auth SDK to enable Near blockchain transactions through the Arcana wallet is simple!

Follow these two steps:

Step 1: Install auth package

npm install --save @arcana/auth
yarn add @arcana/auth
<script src="https://cdn.jsdelivr.net/npm/@arcana/auth"></script>
<script src="https://unpkg.com/@arcana/auth"></script>

Step 2: Initialize the Arcana Auth SDK

Import auth and create a 'new' AuthProvider. During instantiation of the AuthProvider, specify the unique Client ID value assigned to the app after registering through the Arcana Developer Dashboard earlier. Also, specify the Arcana wallet visibility mode via the alwaysVisible parameter to manage the wallet user experience.

import { AuthProvider } from '@arcana/auth'
const auth = new AuthProvider(
  "xar_test_445007f942xxxxxxxxxxxxxxxxxx484cAfd2", // App client ID
  { 
    position: 'left',         // default: right
    theme: 'light',           // default: dark
    alwaysVisible: false,     // default: true, wallet always visible
    setWindowProvider: true,  // default: false, window.ethereum not set
    connectOptions: {
      compact: true           // default: false, regular plug-and-play login UI
    },
    chainConfig: {
      chainId: '137',                    // defaults to Ethereum
      rpcUrl: 'https://polygon-rpc.com', // defaults to 'https://rpc.ankr.com/eth'
    },
})

Initialize the newly instantiated AuthProvider.

try {
  await auth.init()
} catch (e) {
  // Handle exception case
}

Initialize First!

The app must wait until the init call is complete before invoking any of the other Arcana Auth SDK functions such as onboarding users by triggering user login, obtaining the standard Ethereum provider, adding/switching networks in the wallet, etc.

After initializing the AuthProvider, you can call any of its exported functions. See Arcana Auth SDK Reference Guide for details.

try {
  await auth.init()
} catch (e) {
  // Handle exception case
}

That is all!

The vanilla HTML/CSS/JS app is now successfully integrated with the Arcana Auth SDK for enabling Near blockchain transactions through the Arcana wallet, after the user is onboarded in the app.

Refer to the Auth Examples for Near integration examples.

What's Next?

After integrating an app with the Arcana Auth SDK, developers need to add code to onboard users and enable Web3 wallet operations for authenticated users to sign transactions on the Near blockchain.

See also


Last update: June 12, 2024 by shaloo