@arcana/auth

Arcana Network Auth SDK

What is Auth SDK?

You can integrate your application with Arcana Network Auth SDK to securely sign blockchain transactions and easily onboard application users. Auth SDK can be used to enable one or more authentication mechanisms. After authentication, each user is internally assigned a unique key that is secure, private and never exposed. Application users don't need to manage keys or share them explicitly for enabling any blockchain transaction. At the same time, application users get complete flexibility to choose the way they onboard a dApp using familiar Web2 signup/login mechanisms configured by the application developer.

Auth SDK enables secure Ethereum provider for dApps. If the dApp requires to provide blockchain enabled secure and private file storage and access functionality, Auth SDK seamlessly works with Arcana Storage SDK to enable file based transaction signing and approval by the user.

If your application use case requires you to have a secure, private file store for user data while managing your own keys, or using your own wallet, or a third party wallet, then you can directly integrate your application with Storage SDK. Otherwise, it is recommended that you use Arcana Auth SDK and Storage SDK together for a seamless experience.

Following authentication mechanisms are supported:

• Social OAuth

  • Discord
  • GitHub
  • Google
  • Reddit
  • Twitter
  • Twitch

• Passwordless authentication

:warning: Caution: Arcana Network SDKs and apps (Beta Release), not recommended for production usage.

💪 Key Features

🗝️   Enables secure Ethereum provider access to dApps

🔒   Onboard dApp users via social, passwordless login

👛   Encrypt/Decrypt data using Ethereum Provider interface

⛓️   Sign blockchain transactions using Ethereum Provider interface

⚙️   Configure transaction signing user experience (no UI, popup UI) as per dApp use case

🏗️ 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 AppId 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.

Refer to the demo dApp and How To Integrate with Auth SDK guide for details.

💡 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.