Auth SDK Reference Guide - v1.0.10

Arcana Network Auth SDK


Arcana Auth SDK

Arcana Auth

Use Arcana Auth SDK to onboard Web3 app users via social login and allow authenticated users to instantly access the built-in, embedded Arcana wallet and sign blockchain transactions from within the app context.

Use the built-in gasless feature in the Auth SDK to enable gasless transactions in the Arcana wallet.

Auth SDK enables the standard Ethereum provider that can be used by the application for Web3 operations. Users are not required to install any wallet extension or manage keys or share them explicitly for enabling any blockchain transaction.

Auth Providers

  • Social Login

    • Discord
    • GitHub
    • Google
    • Steam
    • Twitter
    • Twitch
  • Custom IAM

    • Cognito
    • Firebase
  • Passwordless authentication

Auth SDK usage is easily customizable. Developers can choose to use the built-in plug and play login UI to onboard users or use a custom UI. Also, instead of the built-in Arcana wallet UI, developers can integrate with the SDK and use a custom wallet UI.

đŸ’Ē Key Features

🔒   Onboard users via social, passwordless login

🗝ī¸   Allow authenticated users to sign blockchain transactions

🔒   Non-custodial, embedded Web3 Arcana wallet that can be branded and configured

⛓ī¸   Web3 wallet operations: sign blockchain transactions, deploy and interact with smart contracts, manage native and custom tokens, view and manage NFTs, send and receive tokens

⚙ī¸   Gaslesss transactions

🏗ī¸ 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

Configure Auth SDK usage through the Arcana Dashboard, obtain a unique app identifier (client Id). Then install the SDK, use the client Id to integrate the app with the Arcana Auth SDK. Learn more....

📚 Documentation

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

💡 Support

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

🤝 Contributing

We welcome all contributions to the Arcana Auth SDK from the community. See contributing guide for details.

ℹī¸ License

Arcana Auth SDK is distributed under the MIT License.

For details see Arcana License.

Generated using TypeDoc