drand-client/love.drand/DrandClient

DrandClient

class DrandClient(api: DrandApi, cache: Cache<String, ChainInfo> = SimpleCache(), verifier: BeaconVerificationService = BeaconVerificationService()) : Closeable

Client for interacting with the drand distributed randomness network.

This client provides verified access to drand beacons with automatic cryptographic verification of all received randomness.

Example usage:

// Create client
val client = DrandClient()

// Get latest verified randomness
val beacon = client.getVerifiedLatestBeacon().getOrThrow()
println("Randomness: ${beacon.randomness}")

// Get specific round
val round1000 = client.getVerifiedBeacon(1000).getOrThrow()

// Clean up
client.close()

Or use with Kotlin's use:

DrandClient().use { client ->
    val beacon = client.getVerifiedLatestBeacon().getOrThrow()
    // ...
}

Parameters

api

The underlying API implementation for network transport (default: HTTP)

cache

Thread-safe cache for storing chain information to reduce network calls

verifier

Service for cryptographic verification of beacons

Constructors

DrandClient

constructor(baseUrl: String = "https://api.drand.sh", httpConfig: HttpConfig = HttpConfig(), enableCache: Boolean = true)

Creates a client using HTTP transport with the specified base URL.

constructor(api: DrandApi, cache: Cache<String, ChainInfo> = SimpleCache(), verifier: BeaconVerificationService = BeaconVerificationService())

Properties

beacons

val beacons: DrandApi.BeaconOperations

Direct access to beacon operations (access by beacon ID).

chains

val chains: DrandApi.ChainOperations

Direct access to chain operations (access by chain hash).

Functions

open override fun close()

getChainInfo

suspend fun getChainInfo(beaconId: String): Result<ChainInfo>

Fetches chain configuration information, with automatic caching.

getVerifiedBeacon

suspend fun getVerifiedBeacon(beaconId: String, round: Long): Result<RandomnessBeacon>

Fetches and verifies a specific round of randomness from a drand network.

getVerifiedLatestBeacon

suspend fun getVerifiedLatestBeacon(beaconId: String): Result<RandomnessBeacon>

Fetches and verifies the latest round of randomness from a drand network.