midnight-sdk/com.midnight.kuira.sdk

Package-level declarations

Types

interface DustCloudBackup : DustCloudBackupSource

Full cross-device dust backup — adds the upload side to DustCloudBackupSource. One implementation serves both views: DustSyncManager consumes only fetch, MidnightWallet also drives upload.

DustCloudBackupSource

fun interface DustCloudBackupSource

Optional cross-device source of a dust checkpoint (e.g. Google Drive). The concrete implementation lives in sdk:wallet-runtime (it needs Drive + the backup crypto); core:indexer and this module stay transport-agnostic.

DustSyncManager

class DustSyncManager(dustRepository: DustRepository, nodeRpcClient: NodeRpcClient, walletAddress: String, dustSeed: ByteArray, cloudBackupSource: DustCloudBackupSource? = null)

Dust state manager — keeps a single in-memory DustLocalState for the session.

ExperimentalKuiraApi

@RequiresOptIn(level = RequiresOptIn.Level.WARNING, message = "This API is experimental and may change in future releases. Opt in with @OptIn(ExperimentalKuiraApi::class) to acknowledge.")

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.TYPEALIAS])

annotation class ExperimentalKuiraApi

Marks an API as experimental — subject to breaking changes between releases without going through the standard deprecation cycle declared in STABILITY.md.

InsufficientDustException

class InsufficientDustException(message: String) : IllegalStateException

Thrown when a balance can't proceed because the wallet has no spendable dust — specifically, every dust UTXO in the synced state is one the wallet already spent but whose spend the indexer's event stream hasn't reflected yet (so it's correctly excluded to avoid node error 115).

MidnightSdk

class MidnightSdk

Top-level entry point for the Midnight Android SDK.

MidnightWallet

class MidnightWallet : TransactionBalancer

Embedded wallet that handles transaction balancing and submission on-device.

RestoredDustCheckpoint

data class RestoredDustCheckpoint(val stateBytes: ByteArray, val lastEventId: Long)

A restored dust checkpoint: enough to seed DustSyncManager so the next sync is a fast delta instead of a genesis replay.

WalletBalance

data class WalletBalance(val unshieldedNight: BigInteger, val shieldedNight: BigInteger, val dust: BigInteger, val dustRegistered: Boolean)

Snapshot of a wallet's full balance state across both pools.