This interface defines the PrivateKey interface, which represents a private key in the SUI blockchain. The private key is used to sign transactions and messages.

PublicKey

interface PublicKey

Secp256k1PrivateKey

class Secp256k1PrivateKey(privateKey: ByteArray) : PrivateKey

This class represents an Secp256k1 private key.

Secp256k1PublicKey

class Secp256k1PublicKey(val data: ByteArray) : PublicKey

Secp256r1PrivateKey

class Secp256r1PrivateKey(privateKey: ByteArray) : PrivateKey

Secp256r1PublicKey

class Secp256r1PublicKey(val data: ByteArray) : PublicKey

SignatureScheme

enum SignatureScheme : Enum<SignatureScheme>

Functions

derivePrivateKeyFromMnemonic

actual fun derivePrivateKeyFromMnemonic(mnemonic: List<String>, scheme: SignatureScheme, path: String): ByteArray

actual fun derivePrivateKeyFromMnemonic(mnemonic: List<String>, scheme: <Error class: unknown class>, path: String): ByteArray

expect fun derivePrivateKeyFromMnemonic(mnemonic: List<String>, scheme: SignatureScheme = SignatureScheme.ED25519, path: String = "m/44'/784'/0/0/0"): ByteArray

actual fun derivePrivateKeyFromMnemonic(mnemonic: List<String>, scheme: SignatureScheme, path: String): ByteArray

derivePublicKey

actual fun derivePublicKey(privateKey: PrivateKey, schema: SignatureScheme): PublicKey

actual fun derivePublicKey(privateKey: <Error class: unknown class>, schema: <Error class: unknown class>): <Error class: unknown class>

expect fun derivePublicKey(privateKey: PrivateKey, schema: SignatureScheme): PublicKey

actual fun derivePublicKey(privateKey: PrivateKey, schema: SignatureScheme): PublicKey

findCommonPublicKey

fun findCommonPublicKey(arr1: List<PasskeyPublicKey>, arr2: List<PasskeyPublicKey>): PasskeyPublicKey

Finds the unique public key that exists in both arrays, throws error if the common pubkey does not equal to one.

generateKeyPair

fun generateKeyPair(seed: ByteArray, scheme: SignatureScheme): KeyPair

generateMnemonic

actual fun generateMnemonic(): String

expect fun generateMnemonic(): String

actual fun generateMnemonic(): String

generateSeed

actual fun generateSeed(mnemonic: List<String>): ByteArray

expect fun generateSeed(mnemonic: List<String>): ByteArray

actual fun generateSeed(mnemonic: List<String>): ByteArray

hash

actual fun hash(hash: Hash, data: ByteArray): ByteArray

actual fun hash(hash: <Error class: unknown class>, data: ByteArray): ByteArray

expect fun hash(hash: Hash, data: ByteArray): ByteArray

actual fun hash(hash: Hash, data: ByteArray): ByteArray

importFromMnemonic

actual fun importFromMnemonic(mnemonic: String): KeyPair

actual fun importFromMnemonic(mnemonic: List<String>): KeyPair

actual fun importFromMnemonic(mnemonic: String): KeyPair

actual fun importFromMnemonic(mnemonic: List<String>): KeyPair

expect fun importFromMnemonic(mnemonic: String): KeyPair

expect fun importFromMnemonic(mnemonic: List<String>): KeyPair

actual fun importFromMnemonic(mnemonic: String): KeyPair

actual fun importFromMnemonic(mnemonic: List<String>): KeyPair

normalizeSignature

fun normalizeSignature(derSignature: ByteArray): ByteArray

Parses a DER-encoded signature, normalizes its 'S' value to prevent malleability, and returns it in a compact 64-byte (r || s) format.

sign

actual fun sign(message: ByteArray, privateKey: PrivateKey): Result<ByteArray, E>

actual fun sign(message: ByteArray, privateKey: <Error class: unknown class>): ByteArray

expect fun sign(message: ByteArray, privateKey: PrivateKey): Result<ByteArray, E>

actual fun sign(message: ByteArray, privateKey: PrivateKey): Result<ByteArray, E>

verifySignature

actual fun verifySignature(publicKey: PublicKey, message: ByteArray, signature: ByteArray): Result<Boolean, E>

actual fun verifySignature(publicKey: <Error class: unknown class>, message: ByteArray, signature: ByteArray): Boolean

expect fun verifySignature(publicKey: PublicKey, message: ByteArray, signature: ByteArray): Result<Boolean, E>

actual fun verifySignature(publicKey: PublicKey, message: ByteArray, signature: ByteArray): Result<Boolean, E>