https://github.com/web3auth/single-factor-auth-android
Single-Factor-Auth-Android
https://github.com/web3auth/single-factor-auth-android
Last synced: about 1 year ago
JSON representation
Single-Factor-Auth-Android
- Host: GitHub
- URL: https://github.com/web3auth/single-factor-auth-android
- Owner: Web3Auth
- Created: 2023-05-08T10:23:11.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-04-07T05:05:05.000Z (about 1 year ago)
- Last Synced: 2025-04-28T12:03:13.234Z (about 1 year ago)
- Language: Kotlin
- Size: 980 KB
- Stars: 3
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Single-Factor-Auth-Android
[](https://jitpack.io/#com.github.web3auth/single-factor-auth-android)
> Web3Auth is where passwordless auth meets non-custodial key infrastructure for Web3 apps and wallets. By aggregating OAuth (Google, Twitter, Discord) logins, different wallets and innovative Multi Party Computation (MPC) - Web3Auth provides a seamless login experience to every user on your application.
Web3Auth Single Factor Auth is the SDK that gives you the ability to start with just one key (aka, Single Factor) with Web3Auth, giving you the flexibility of implementing your own UI and UX.
## 📖 Documentation
Checkout the official [Web3Auth Documentation](https://web3auth.io/docs/sdk/web/core/) to get started.
## Features
- Multi network support
- All API's return `CompletableFutures`
## Getting Started
Typically your application should depend on release versions of fetch-node-details, but you may also use snapshot dependencies for early access to features and fixes, refer to the Snapshot Dependencies section.
This project uses [jitpack](https://jitpack.io/docs/) for release management
Add the relevant dependency to your project:
```groovy
repositories {
maven { url "https://jitpack.io" }
}
dependencies {
implementation 'com.github.Web3auth:single-factor-auth-android:0.0.4'
}
```
### Permissions
Open your app's `AndroidManifest.xml` file and add the following permission:
```xml
```
## Requirements
- Android API version 24 or newer is required.
## 💥 Initialization & Usage
In your activity class, configure it like this:
```kotlin
class MainActivity : AppCompatActivity() {
// ...
private lateinit var singleFactorAuth: SingleFactorAuth
private lateinit var singleFactorAuthArgs: SingleFactorAuthArgs
private lateinit var loginParams: LoginParams
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
// Initialize singleFactorAuthArgs with TorusNetwork type
singleFactorAuthArgs = SingleFactorAuthArgs(TorusNetwork.TESTNET)
// Initialize singleFactorAuth by passing singleFactorAuthArgs params
singleFactorAuth = SingleFactorAuth(singleFactorAuthArgs)
// Initialize loginParams by passing verifier, verifiedId(email) and idToken
loginParams = LoginParams(TEST_VERIFIER, TORUS_TEST_EMAIL, idToken)
// Use the getKey function to get the privateKey and public address for the user
val torusKey: TorusKey = singleFactorAuth.getKey(loginParams, this.applicationContext).get()
print("Private Key: ${torusKey.privateKey}")
// Call initialize function to get TorusKey value without relogging in user if a user has an active session it will return the TorusKey
val sessionResponse: CompletableFuture = singleFactorAuth.initialize(this.applicationContext)
sessionResponse.whenComplete { torusKey, error ->
if (error == null) {
print("Private Key: ${torusKey.privateKey}")
print("Public Address: ${torusKey.publicAddress}")
}
}
// ...
}
//...
}
```
## 🩹 Examples
Checkout the examples for your preferred blockchain and platform in our [examples repository](https://github.com/Web3Auth/single-fact-auth-android/tree/master/app)
## 💬 Troubleshooting and Discussions
- Have a look at our [GitHub Discussions](https://github.com/Web3Auth/Web3Auth/discussions?discussions_q=sort%3Atop) to see if anyone has any questions or issues you might be having.
- Checkout our [Troubleshooting Documentation Page](https://web3auth.io/docs/troubleshooting) to know the common issues and solutions
- Join our [Discord](https://discord.gg/web3auth) to join our community and get private integration support or help with your integration.