PrivateKey - OpenDive/AptosKit GitHub Wiki

PrivateKey

The ED25519 Private Key

public struct PrivateKey: Equatable, KeyProtocol, CustomStringConvertible

CustomStringConvertible, Equatable, KeyProtocol

public init(key: Data)

The length of the key in bytes

public static let LENGTH: Int = 32

The key itself

public let key: Data

public var description: String

Converts the private key to a hexadecimal string.

public func hex() -> String

A string representation of the private key in hexadecimal format, with a "0x" prefix.

Creates a PrivateKey instance from a hex string.

public static func fromHex(_ value: String) -> PrivateKey

A PrivateKey instance representing the private key.

Calculates the corresponding public key for this private key instance using the Ed25519 algorithm.

public func publicKey() throws -> PublicKey

An error if the calculation of the public key fails, or if the public key cannot be used to create a PublicKey instance.

A PublicKey instance representing the public key associated with this private key.

Generates a new random private key using the Ed25519 algorithm.

public static func random() throws -> PrivateKey

An error if the generation of the key pair fails or if the generated private key cannot be used to create a PrivateKey instance.

A new PrivateKey instance with a randomly generated private key.

Signs a message using this private key and the Ed25519 algorithm.

public func sign(data: Data) throws -> Signature

An error if the signing operation fails or if the resulting signature cannot be used to create a Signature instance.

A Signature instance representing the signature for the message.

public static func deserialize(from deserializer: Deserializer) throws -> PrivateKey

public func serialize(_ serializer: Serializer) throws

public static func == (lhs: PrivateKey, rhs: PrivateKey) -> Bool