Implemented by optional authentication modules whose public keys are encoded inside Aptos' AnyPublicKey enum. The payload returned by toAnyPublicKeyBcs excludes the enum variant.

AnySignature

class AnySignature(val signature: Signature) : Signature

Instance of signature that uses the SingleKey authentication scheme. This signature can only be generated by a SingleKeySigner, since it uses the same authentication scheme.

AnySignatureCompatible

interface AnySignatureCompatible

Implemented by optional authentication modules whose signatures are encoded inside Aptos' AnySignature enum. The payload returned by toAnySignatureBcs excludes the enum variant.

AptosDerivationPath

sealed class AptosDerivationPath

An Aptos BIP-44 derivation path.

Ed25519PrivateKey

class Ed25519PrivateKey(data: ByteArray) : PrivateKey

Represents the private key of an Ed25519 key pair.

Ed25519PublicKey

@Serializable

class Ed25519PublicKey(val data: ByteArray) : AccountPublicKey

Represents the public key of an Ed25519 key pair.

Ed25519Signature

@Serializable

class Ed25519Signature(hexInput: ByteArray) : Signature

A signature of a message signed using an Ed25519 private key

KeyPair

data class KeyPair(val privateKey: ByteArray, val publicKey: ByteArray)

Represents a pair of signing keys: a public key and a private key.

MnemonicPhrase

class MnemonicPhrase

A validated BIP-39 phrase whose textual form is redacted by default.

MnemonicWordCount

enum MnemonicWordCount : Enum<MnemonicWordCount>

Supported BIP-39 mnemonic sizes.

MultiEd25519PublicKey

class MultiEd25519PublicKey(publicKeys: List<Ed25519PublicKey>, val threshold: UByte) : AccountPublicKey

A legacy Aptos K-of-N Ed25519 public key.

MultiEd25519Signature

class MultiEd25519Signature(signatures: List<Ed25519Signature>, bitmap: ByteArray) : Signature

Ed25519 signatures and their canonical 32-bit Aptos signer bitmap.

PrivateKey

interface PrivateKey

An interface of a private key. It is associated to a signature scheme and provides signing capabilities.

PrivateKeyType

enum PrivateKeyType : Enum<PrivateKeyType>

The private-key algorithms with an AIP-80 textual representation.

PublicKey

abstract class PublicKey

An abstract representation of a public key.

Secp256k1PrivateKey

class Secp256k1PrivateKey(key: ByteArray) : PrivateKey

A Secp256k1 ecdsa private key

Secp256k1PublicKey

class Secp256k1PublicKey(val hexInput: HexInput) : PublicKey

Represents the Secp256k1 ecdsa public key

Secp256k1Signature

class Secp256k1Signature(hexInput: HexInput) : Signature

Secp256r1PrivateKey

class Secp256r1PrivateKey(key: ByteArray) : PrivateKey

A NIST P-256 private key using Aptos' SHA3-256 signing convention.

Secp256r1PublicKey

class Secp256r1PublicKey(key: ByteArray) : PublicKey

A NIST P-256 (Secp256r1) public key in canonical uncompressed SEC1 form.

Secp256r1Signature

class Secp256r1Signature(signature: ByteArray) : Signature

A canonical 64-byte (r, s) P-256 signature.

Signature

abstract class Signature

An abstract representation of a crypto signature, associated to a specific signature scheme e.g. Ed25519 or Secp256k1

SimulationSignatureProvider

interface SimulationSignatureProvider

Implemented by optional public-key families that need a scheme-specific placeholder signature for fullnode simulation.

WebAuthnSignature

class WebAuthnSignature(signature: ByteArray, authenticatorData: ByteArray, clientDataJson: ByteArray) : Signature

A WebAuthn assertion in the exact Aptos BCS layout.

WebAuthnVerificationOptions

data class WebAuthnVerificationOptions(val expectedOrigin: String? = null, val requireUserPresence: Boolean = true, val requireUserVerification: Boolean = false)

Validation policy for locally verifying a WebAuthn transaction signature.