Options
All
  • Public
  • Public/Protected
  • All
Menu

Auth SDK Reference Guide - v1.0.3

Arcana Network Auth SDK


Arcana Auth SDK

What is Auth SDK?

Integrate your application with Arcana Network Auth SDK to easily onboard application users and allow authenticated users to sign blockchain transactions. Configure one or more social login and passwordless authentication options for application users. Application users don't need to manage keys or share them explicitly for enabling any blockchain transaction.

Auth SDK enables the standard Ethereum provider that can be used by the application for Web3 operations.

The following authentication mechanisms are supported:

  • Social Login

    • Discord
    • GitHub
    • Google
    • Twitter
    • Twitch
  • Passwordless authentication

Application developers can choose to use plug and play feature of the Auth SDK that provides a default UI for user login. Alternatively, they can build their own UI and simply call the Auth SDK functions for social login and passwordless authentication.

đŸ’Ē Key Features

🗝ī¸   Plug and play user authentication

🔒   Onboard dApp users via social, passwordless login

🗝ī¸   Secure Ethereum provider access for Web3 operations

🔒   Embedded Web3 Arcana wallet that can be branded and configured as per the application needs

⛓ī¸   Sign blockchain transactions, deploy and interact with smart contracts, manage native and custom tokens, view and manage NFTs, send and receive tokens

⚙ī¸   Configure blockchain transaction signing user experience using wallet visibility modes

🏗ī¸ Installation

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>

📋 Prerequisites

Before you can start using the Arcana Auth SDK, you need to register your dApp using Arcana Developer Dashboard.

A unique App Address will be assigned to your dApp and you need the same to initialize the Arcana Auth SDK.

📚 Documentation

Check out Arcana Network documentation for Auth SDK Quick Start Guide, Usage Guide and API Reference Guide.

💡 Support

For any support or integration-related queries, contact Arcana support team.

🤝 Contributing

We welcome all contributions to the Arcana Auth SDK from the community. Read our contributing guide to learn about the SDK development process, how to propose bug fixes and improvements, and the code of conduct that we expect the participants to adhere to. Refer to the build and test section of this readme for details on how to test and validate your changes to the Auth SDK code before submitting your contributions.

ℹī¸ License

Arcana Auth SDK is distributed under the MIT License.

For details see Arcana License.

Generated using TypeDoc, the 3/9/2023 at 10:47:20 AM