Skip to content

arcana-network/auth-verify

Repository files navigation



Twitter URL

Arcana Auth Verify

Arcana Auth Verify

The Arcana Auth Verify is a Vue-based UI that is part of the Arcana Auth product. Auth Verify works in tandem with the Arcana Auth SDK on the client side. The auth-verify repo implements a wrapper that is used for the user authentication redirect page handling.

When a user logs in to a Web3 app that is integrated with the Arcana Auth SDK through passwordless or social logins, a user verification UI is displayed once the authentication provider successfully processes the user login and redirects to auth-verify link. Auth Verify then passes on the verified user's parameters to the Arcana Wallet UI frame and securely fetches the key shares from the Arcana ADKG subsystem. These key shares are assembled within the Web3 app and Arcana Wallet UI context to generate the user's key for signing blockchain transactions.

In addition, Auth Verify also implements the MFA feature and assists in restoring the user's identity share across devices for enhanced wallet security.

🏗️ Auth Verify Developer Guide

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

  1. Disable the built-in TypeScript Extension
    1. Run Extensions: Show Built-in Extensions from VSCode's command palette
    2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
  2. Reload the VSCode window by running Developer: Reload Window from the command palette.

Customize configuration

See Vite Configuration Reference.

Installation

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Lint with ESLint

npm run lint

📋 Usage Prerequisites

The Arcana Auth Verify functionality cannot be used as a standalone app. It works in tandem with the Arcana Auth SDK and Arcana Wallet UI. Web3 app developers must register the app with Arcana Network, configure onboarding options using the Arcana Developer Dashboard and then install the Auth SDK and integrate the app to onboard users, leverage the Auth Verify functionality and then allow authenticated users to use the embedded Arcana Wallet UI to sign blockchain transactions.

📚 Documentation

See Arcana Network documentation and refer to the Auth SDK Quick Start Guide, Usage Guide and API Reference Guide to integrate a Web3 app with the Arcana Auth product.

The Arcana Wallet User Guide shows various Web3 wallet operations supported by the Arcana Wallet.

💡 Support

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

🤝 Contributing

We welcome all contributions to the Arcana Auth product and Auth Verify 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 Verify code before submitting your contributions.

ℹ️ License

Arcana Auth Verify is distributed under the MIT License.

For details see Arcana License.