Class PrivateKey

Namespace

Aptos

Assembly

Aptos.dll

public abstract class PrivateKey : Serializable, IDisposable

Inheritance

object

Serializable

PrivateKey

Implements

IDisposable

Derived

Ed25519PrivateKey

Secp256k1PrivateKey

Inherited Members

Serializable.Serialize(Serializer)

Serializable.BcsToBytes()

Serializable.BcsToHex()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

PrivateKey(PrivateKeyVariant)

protected PrivateKey(PrivateKeyVariant type)

Parameters

type PrivateKeyVariant

Fields

AIP80_PREFIXES

The AIP-80 compliant prefixes for each private key type

public static readonly Dictionary<PrivateKeyVariant, string> AIP80_PREFIXES

Field Value

Dictionary<PrivateKeyVariant, string>

Remarks

Read about AIP-80: https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-80.md

Type

public PrivateKeyVariant Type

Field Value

PrivateKeyVariant

Properties

IsDisposed

Whether this key has been disposed and its bytes zeroed out. Use ThrowIfDisposed() to enforce in concrete subclasses before reading the underlying material.

protected bool IsDisposed { get; }

Property Value

bool

Methods

Dispose()

Zeros out the in-memory copy of the private key material. After Dispose() is called, subsequent calls that read the key (e.g. Sign(byte[]) or ToByteArray()) will throw ObjectDisposedException.

Notes:

• Managed memory may have been copied by the runtime garbage collector before Dispose() is called. This API offers best-effort zeroization of the SDK's own reference; it cannot guarantee that no stale copy lives elsewhere in the heap.
• Calling Dispose() more than once is safe and a no-op.

public void Dispose()

DisposeCore()

Implemented by subclasses to perform the actual byte scrubbing.

protected abstract void DisposeCore()

FormatPrivateKey(byte[], PrivateKeyVariant)

Format a HexInput to an AIP-80 compliant string.

public static string FormatPrivateKey(byte[] privateKey, PrivateKeyVariant type)

Parameters

privateKey byte[]

The HexString or byte array format of the private key.

type PrivateKeyVariant

The private key type

Returns

string

AIP-80 compliant string.

Remarks

Read about AIP-80: https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-80.md

FormatPrivateKey(string, PrivateKeyVariant)

Format a HexInput to an AIP-80 compliant string.

public static string FormatPrivateKey(string privateKey, PrivateKeyVariant type)

Parameters

privateKey string

The HexString or byte array format of the private key.

type PrivateKeyVariant

The private key type

Returns

string

AIP-80 compliant string.

Remarks

Read about AIP-80: https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-80.md

ParseHexInput(byte[], PrivateKeyVariant)

Parse a HexInput that may be a HexString, byte array, or a AIP-80 compliant string to a Hex instance.

public static Hex ParseHexInput(byte[] value, PrivateKeyVariant type)

Parameters

value byte[]

A HexString, byte array, or AIP-80 compliant string.

type PrivateKeyVariant

The private key type

Returns

Hex

A Hex instance.

ParseHexInput(string, PrivateKeyVariant, bool?)

Parse a HexInput that may be a HexString, byte array, or a AIP-80 compliant string to a Hex instance.

public static Hex ParseHexInput(string value, PrivateKeyVariant type, bool? strict = null)

Parameters

value string

A HexString, byte array, or AIP-80 compliant string.

type PrivateKeyVariant

The private key type

strict bool?

If true, the value MUST be compliant with AIP-80. If false, the value MAY be compliant with AIP-80 and ignore warnings.

Returns

Hex

A Hex instance.

PublicKey()

public abstract PublicKey PublicKey()

Returns

PublicKey

Sign(byte[])

public abstract PublicKeySignature Sign(byte[] message)

Parameters

message byte[]

Returns

PublicKeySignature

Sign(string)

public virtual PublicKeySignature Sign(string message)

Parameters

message string

Returns

PublicKeySignature

ThrowIfDisposed()

Throws ObjectDisposedException if this key has been disposed. Concrete subclasses should call this before reading their key material.

protected void ThrowIfDisposed()

ToAIP80String()

public virtual string ToAIP80String()

Returns

string

ToByteArray()

public abstract byte[] ToByteArray()

Returns

byte[]

ToHexString()

public virtual string ToHexString()

Returns

string

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.