EdgeAgentSDK/org.hyperledger.identus.walletsdk.apollo.utils/Secp256k1PrivateKey

Secp256k1PrivateKey

class Secp256k1PrivateKey(nativeValue: ByteArray) : PrivateKey, SignableKey, StorableKey, ExportableKey, DerivableKey(source)

The Secp256k1PrivateKey class represents a private key that uses the secp256k1 elliptic curve. It extends the PrivateKey class and implements the SignableKey, StorableKey, ExportableKey, and DerivableKey interfaces.

Parameters

nativeValue

The raw byte array value of the private key.

Constructors

Secp256k1PrivateKey

constructor(nativeValue: ByteArray)

Creates a Secp256k1PrivateKey object with the specified nativeValue.

Properties

keySpecification

open override val keySpecification: MutableMap<String, String>

A mutable map that contains additional key specifications.

raw

open override val raw: ByteArray

The raw byte array value of the private key.

restorationIdentifier

open override val restorationIdentifier: String

This variable represents the restoration identifier for a key. It is a unique identifier used for restoring the key from storage.

size

open override val size: Int

The size of the private key in bytes.

storableData

open override val storableData: ByteArray

Represents the storable data of a key.

type

open override val type: KeyTypes

The type of the key, which is set to KeyTypes.EC.

Functions

canVerify

fun canVerify(): Boolean

Evaluates if this key implements VerifiableKey

derive

open override fun derive(derivationPath: DerivationPath): PrivateKey

Derives a private key using the given derivation path.

equals

open operator override fun equals(other: Any?): Boolean

Checks if the current Key object is equal to the provided object. Two Key objects are considered equal if the following conditions are met:

getCurve

fun getCurve(): String

Returns the value of the key curve for this private key

getCurveInstance

fun getCurveInstance(): Curve?

Returns an instance of the key curve for this private key

getEncoded

fun getEncoded(): ByteArray

Returns the encoded raw value into base 64 url

getIndex

fun getIndex(): String

Returns the index for this private key

getJwk

open override fun getJwk(): JWK

Retrieves the JWK (JSON Web Key) representation of the private key.

getPem

open override fun getPem(): String

Returns the PEM (Privacy-Enhanced Mail) representation of the private key. The key is encoded in base64 and wrapped with "BEGIN" and "END" markers.

getProperty

fun getProperty(name: String): String

Searches the value based on the input key, if it exists

getValue

fun getValue(): ByteArray

Returns the value of this private key

hashCode

open override fun hashCode(): Int

Computes the hash code of the Key object. The hash code is calculated based on the properties of the keySpecification map and the raw byte array. Two Key objects with the same keySpecification map and the raw byte array are guaranteed to have the same hash code.

isCurve