Quickstart

​

Install Using Swift Package Manager in Xcode

1. Open your project in Xcode.
2. Go to File > Add Packages....
3. Enter the repository URL: https://github.com/gandalf-network/connect-ios-sdk.git.
4. Choose the version rule (e.g., “Up to Next Major”) and click Add Package.
5. Select the GandalfConnect package for your target.

​

Or Update Package.swift

// swift-tools-version: 5.9
import PackageDescription

let package = Package(
    name: "YourProjectName",
    dependencies: [
        .package(url: "https://github.com/gandalf-network/connect-ios-sdk.git", .upToNextMajor(from: "1.0.0"))
    ],
    targets: [
        .target(
            name: "YourTargetName",
            dependencies: ["GandalfConnect"]
        )
    ]
)

Then, run swift package update to fetch the dependency.

​

Usage

​

Import the package

import GandalfConnect

​

Initialization

Create an instance of ConnectInput with the necessary details:

let services: InputData = [
    "uber": .service(Service(traits: ["rating"], activities: ["trip"]))
]

let input = ConnectInput(
    publicKey: "yourPublicKey",
    redirectURL: "https://example.com",
    services: services
)

Initialize the Connect class:

let connect = Connect(input: input)

​

Generating URL

To generate a URL, call the generateURL method:

do {
    let generatedURL = try await connect.generateURL()
    print("Generated URL: \(generatedURL)")
} catch {
    print("Error generating URL: \(error)")
}

Read more on Github.

​

Install

npm i @gandalf-network/connect

​

Usage

​

Import the package

// Typescript && ESModules
import Connect from '@gandalf-network/connect'
import { Platform } from "@gandalf-network/connect/components";

// CommonJS
const Connect = require("@gandalf-network/connect");
const { Platform } = require("@gandalf-network/connect/components");

​

Connect

// Initialize Connect
const connect = new Connect({
    publicKey: "YOUR_PUBLIC_KEY",
    redirectURL: "YOUR_REDIRECT_URL",
    // The platform defaults to IOS but could be ANDROID or UNIVERSAL
    platform: Platform.ANDROID,
    services:
    {
        uber: {
            traits: ["rating"],
            activities: ["trip"],
        },
        gandalf: {
            traits: ["email"]
        }
    }
})

try {
// Generate the Connect URL
    const connectUrl = await connect.generateURL()

    // Use the URL as needed
    console.log('Generated Connect URL:', connectUrl)

    // If you want to display a QR Code instead:
    const qrCodeDataUrl = await connect.generateQRCode()
} catch (error) {
    // handle error
}

Display the QR code using the qrCodeDataUrl

<img src={{qrCodeDataUrl}} alt="Connect QR Code"/>

Read more on Github.

​

Install with Gradle

To integrate GandalfConnect into your project, add it to your build.gradle.kts or build.gradle file:

​

build.gradle.kts

repositories {
    maven("https://jitpack.io")
}

dependencies {
    implementation("com.github.gandalf-network:connect-kotlin-sdk:1.0.0")
}

​

build.gradle

repositories {
    mavenCentral()
    maven {
        url 'https://jitpack.io'
    }
}

dependencies {
    implementation 'com.github.gandalf-network:connect-kotlin-sdk:1.0.0'
}

​

Install with Maven

To integrate GandalfConnect into your project, add it to your pom.xml file:

​

build.gradle.kts

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>com.github.gandalf-network</groupId>
        <artifactId>connect-kotlin-sdk</artifactId>
        <version>1.0.0</version>
    </dependency>
</dependencies>

​

Usage

​

Importing the Library

In your Kotlin file where you want to use GandalfConnect, import the library:

// The Connect class
import com.gandalf.connect.Connect

// Useful Types
import com.gandalf.connect.types.ConnectInput
import com.gandalf.connect.types.InputData
import com.gandalf.connect.types.Service

​

Connect

Create an instance of ConnectInput with the necessary details:

val publicKey = ""
val redirectURL = "https://example.com"
val services: InputData = mutableMapOf(
    "uber" to Service(traits = listOf("rating"), activities = listOf("trip"))
)

val connectInput = ConnectInput(publicKey, redirectURL, services)

Initialize the Connect class:

val connect = Connect(connectInput)

To generate a URL, call the generateURL method:

runBlocking {
    try {
        val generatedURL = connect.generateURL()
        println("Generated URL: $generatedURL")
    } catch (e: Exception) {
        println("Error: ${e.message}")
    }
}

Read more on Github.