walletkit-android

Getting Started

Import library

Check the releases on this page for the latest_version

Gradle

implementation group: 'com.usewalletkit.sdk', name: 'sdk', version: '<latest_version>'

Gradle DLS

implementation("com.usewalletkit.sdk:sdk:<latest_version>")

Maven

<dependency>
    <groupId>com.usewalletkit.sdk</groupId>
    <artifactId>sdk</artifactId>
    <version>latest_version</version>
</dependency>

Initialize the login client and login

WalletKit supports different auth providers:

• WalletKit (native)
• Firebase
• Supabase

The first step is to initialize the login client and use it to login with the preferred method the client provides. E.g.: with WalletKit you can login by email + code or anonymously, with Firebase you can login via third-parties, with Supabase via email and password. All the clients provide session persistency cross-sessions out of the box.

• WalletKit

val loginClient = WalletKitLoginClient(
    projectId = "my_project_id",
    baseUrl = "https://testnet.usewalletkit.com", // or mainnet
    context = context,
)
val response = loginClient.loginAnonymously()
if (response.isSuccessful) {
    // do something
} else {
    // handle error
}

• Firebase

val auth: FirebaseAuth = Firebase.auth
auth.signInWithEmailAndPassword(email, password)
    .addOnCompleteListener(Dispatchers.IO.asExecutor()) { task ->
        if (task.isSuccessful) {
            // do something
        } else {
            // handle error
        }
    }

Refer to the official Firebase documentation.

• Supabase

val loginClient = createSupabaseClient(
    supabaseUrl = projectUrl,
    supabaseKey = apiKey
) {
    install(GoTrue)
}.gotrue

loginClient.loginWith(Email) {
    this.email = email
    this.password = password
}

if (loginClient.currentSessionOrNull() != null) {
    // do something
} else {
    // handle error
}

Refer to the official Supabase documentation.

Initialize WalletKitClient

Once logged in you can create a WalletKitClient. Technically, it can be created before a successful login, as far as you make sure no api call are performed before a successful login. The client will take the login client created in the previous step.

• WalletKit auth

val walletKitClient = WalletKitClient(
    loginClient = loginClient,
)

NOTE: we are not passing projectId or baseUrl wich is derived from the loginClient.

• Firebase auth

private val walletKitClient = WalletKitClient(
    firebaseAuth = auth,
    projectId = "my_project_id",
    baseUrl = "https://testnet.usewalletkit.com", // or mainnet
)

• Supabase auth

private val walletKitClient = WalletKitClient(
    loginClient = loginClient,
    projectId = "my_project_id",
    baseUrl = "https://testnet.usewalletkit.com", // or mainnet
)

Use WalletKitClient for API requests

At this point WalletKitClient can be used for API requests independently from the login client used. Given that the session persistency is provided under the hood, the login client should not be used anymore, unless the long living session is expired.

val response = walletKitClient.getService(WalletsApi::class.java)
    .walletsList()
if (response.isSuccessful && response.body() != null) {
    val wallets = response.body()
    // show wallets or store them in the DB

} else {
    // handle error

}

All the services and endpoints can be found in the SDK package com.usewalletkit.sdk.generated.apis.

Running the sample app

You can run the sample app to test the wallet kit login. On the initial screen you can choose the login method between WalletKit, Firebase and Supabase.

NOTE: in order to use Firebase you will need to override the mock config under app/google-services.json with the one from your project.

The app is for showcase only and it supports two api calls: fetch wallets and create wallet. Good places to learn how to interact with the API are the ViewModels: WalletKitViewModel FirebaseViewModel and SupabaseViewModel.

Contributing

Guidelines

To contribute and extend the SDK, PR against main branch should be submitted. The PR should pass the lint check and all the tests. The PR require an approval from the core team to be merged.

OpenApi Generator

Api classes and models are auto-generated with openapi-generator. To update the schema, run ./gradlew openApiGenerate. This will update the files under src/main/kotlin/com/usewalletkit/sdk/openapi/. The openapi spec url is defined in sdk/gradle.properties and can be changed there. To run the generator with a temporary url without changing the property, it is possible to run ./gradlew openApiGenerate -PopenApiSpecUrl=<your_url>.

Releases

The SDK is released to the Maven Central repository by the github action triggered on release (source .github/workflows/release.yml). So, Maven versioning in in sync with github versioning. The version format is X.X.X (E.g.: 0.0.1).