1.5.0

kotlin-sdk/com.sodot.kotlin_sdk

Package-level declarations

Types

class BIP340(hostUrl: String = SODOT_RELAY_URL) : Scheme

BIP340 scheme implementation providing functionality for the FROST MPC protocol.

BIP340PublicKey

typealias BIP340PublicKey = ByteArray

A 32 byte BIP340 public key, generated by the BIP340.keygen function.

BIP340SecretShare

typealias BIP340SecretShare = String

The per-party private key material that is used for threshold signing.

BIP340Signature

typealias BIP340Signature = ByteArray

A 64 byte BIP340 Signature, generated by the BIP340.sign function.

typealias BIP340Tweak = ByteArray

A 32 byte tweak as defined in BIP-341

class Ecdsa(hostUrl: String = SODOT_RELAY_URL) : Scheme

ECDSA scheme implementation providing functionality for the DKLs19 MPC protocol.

class EcdsaPublicKey

Represents an ECDSA public key.

EcdsaSecretShare

typealias EcdsaSecretShare = String

The per-party private key material that is used for threshold signing.

class EcdsaSignature

Represents an ECDSA signature.

class Ed25519(hostUrl: String = SODOT_RELAY_URL) : Scheme

Ed25519 scheme implementation providing functionality for the FROST MPC protocol.

Ed25519PublicKey

typealias Ed25519PublicKey = ByteArray

A 32 byte Ed25519 Public Key, generated by the Ed25519.keygen() function.

Ed25519SecretShare

typealias Ed25519SecretShare = String

The per-party private key material that is used for threshold signing.

Ed25519Signature

typealias Ed25519Signature = ByteArray

A 64 byte Ed25519 Signature, generated by the Ed25519.sign() function.

ExportableEd25519

class ExportableEd25519(hostUrl: String = SODOT_RELAY_URL) : Scheme

ExportableEd25519 scheme implementation providing functionality for a variant of the FROST MPC protocol.

ExportableEd25519SecretShare

typealias ExportableEd25519SecretShare = String

The per-party private key material that is used for threshold signing.

typealias KeygenID = String

KeygenID is a base58 string representing the ID of the party in the key generation protocol.

KeygenPrivateKey

typealias KeygenPrivateKey = ByteArray

KeygenPrivateKey is 32 bytes representing the private key of the corresponding KeygenID.

class MessageHash(bytes: ByteArray)

Represents a cryptographic hash of a message.

typealias PrivateKey = ByteArray

PrivateKey is a 32 bytes representing some private key.

typealias RoomUUID = String

RoomUUID is a hex string representing a room, which is created for each MPC operation (e.g. Signing, Keygen, Refresh, etc.) and acts as a session identifier to synchronize all involved parties.

abstract class Scheme(hostUrl: String)

Base class for all cryptographic scheme implementations in the Sodot SDK.

class SodotException(message: String, val code: Int = -1, cause: Throwable? = null) : Exception

Exception thrown by the Sodot SDK when an error occurs during cryptographic operations.

class Sr25519(hostUrl: String = SODOT_RELAY_URL) : Scheme

Sr25519 scheme implementation providing functionality for the FROST MPC protocol.

typealias Sr25519KeyPair = ByteArray

A 64 byte sr25519 private keypair

Sr25519PublicKey

typealias Sr25519PublicKey = ByteArray

A 32 byte Sr25519 public key, generated by the Sr25519.keygen() function.

Sr25519SecretShare

typealias Sr25519SecretShare = String

The per-party private key material that is used for threshold signing.

Sr25519Signature

typealias Sr25519Signature = ByteArray