Class Ed25519PublicKey

constructor

• new Ed25519PublicKey(hexInput: HexInput): Ed25519PublicKey

  Creates an instance of the Ed25519Signature class from a hex input. This constructor validates the length of the signature to ensure it meets the required specifications.

  Parameters

  • hexInput: HexInput

    The hex input representing the Ed25519 signature.

  Returns Ed25519PublicKey

  Throws

  Error if the signature length is not equal to Ed25519Signature.LENGTH.

Static ReadonlyLENGTH

authKey

• authKey(): AuthenticationKey

  Generates an authentication key from the public key using the Ed25519 scheme. This function is essential for creating a secure authentication key that can be used for further cryptographic operations.

  Returns AuthenticationKey

  The generated authentication key.

serialize

• serialize(serializer: Serializer): void

  Serializes the data into a byte array using the provided serializer. This allows for the conversion of data into a format suitable for transmission or storage.

  Parameters

  • serializer: Serializer

    The serializer instance used to perform the serialization.

  Returns void

toUint8Array

• toUint8Array(): Uint8Array

  Convert the internal data representation to a Uint8Array.

  Returns Uint8Array

  Uint8Array representation of the data.

verifyBytes

• verifyBytes(args: { message: Uint8Array; signature: Signature }): boolean

  Verifies a signature against the exact bytes of message. This is the unambiguous form — the input is interpreted as raw bytes regardless of what they encode. Pair with Ed25519PrivateKey.signBytes.

  Performs an Ed25519 malleability check (rejects non-canonical S values) before delegating to the underlying curve verifier.

  Parameters

  • args: { message: Uint8Array; signature: Signature }

    The arguments for verification.

    • message: Uint8Array

      The exact bytes that were signed.

    • signature: Signature

      The signature to verify.

  Returns boolean

verifySignature

• verifySignature(args: VerifySignatureArgs): boolean

  Verifies a signed message using a public key.

  Parameters

  • args: VerifySignatureArgs

    The arguments for verification.

    Represents the arguments required to verify a digital signature.

    • message: HexInput

    • signature: Signature

  Returns boolean

  Deprecated

  The polymorphic message: HexInput input is ambiguous — a bare even-length string of hex characters (e.g., "cafe") is interpreted as the 2 bytes [0xCA, 0xFE], not as 4 UTF-8 text bytes. Use verifyBytes for Uint8Array input or verifyText for string input; both are unambiguous. See convertSigningMessage for the full legacy rule.

verifySignatureAsync

• verifySignatureAsync(args: VerifySignatureAsyncArgs): Promise<boolean>

  Note: Ed25519Signatures can be verified syncronously.

  Verifies the provided signature against the given message. This function helps ensure the integrity and authenticity of the message by confirming that the signature is valid.

  Parameters

  • args: VerifySignatureAsyncArgs

    The arguments for signature verification.

  Returns Promise<boolean>

  A boolean indicating whether the signature is valid for the given message.

verifyText

• verifyText(args: { message: string; signature: Signature }): boolean

  Verifies a signature against the UTF-8 encoding of message. The input is always treated as text — there is no hex/text heuristic. Pair with Ed25519PrivateKey.signText.

  Parameters

  • args: { message: string; signature: Signature }

    The arguments for verification.

    • message: string

      The text that was signed.

    • signature: Signature

      The signature to verify.

  Returns boolean

Staticdeserialize

• deserialize(deserializer: Deserializer): Ed25519PublicKey

  Deserialize bytes into an Ed25519Signature object. This function is used to convert serialized byte data into a usable Ed25519Signature instance.

  Parameters

  • deserializer: Deserializer

    The deserializer instance used to read the byte data.

  Returns Ed25519PublicKey

StaticisInstance

• isInstance(publicKey: PublicKey): publicKey is Ed25519PublicKey

  Determines if the provided public key is a valid Ed25519 public key. This function checks for the presence of the "key" property and verifies that its data length matches the expected length for Ed25519 public keys.

  Parameters

  • publicKey: PublicKey

    The public key to validate.

  Returns publicKey is Ed25519PublicKey

  A boolean indicating whether the public key is a valid Ed25519 public key.

StaticisPublicKey

• isPublicKey(publicKey: AccountPublicKey): publicKey is Ed25519PublicKey

  Determine if the provided public key is an instance of Ed25519PublicKey.

  Parameters

  • publicKey: AccountPublicKey

    The public key to check.

  Returns publicKey is Ed25519PublicKey

  True if the public key is an instance of Ed25519PublicKey, otherwise false.

  Deprecated

  use instanceof Ed25519PublicKey instead.