Struct Ed25519PublicKey 

pub struct Ed25519PublicKey { /* private fields */ }

Available on crate feature ed25519 only.

An Ed25519 public key.

Example

use aptos_sdk::crypto::{Ed25519PrivateKey, Ed25519PublicKey, Signer, Verifier};

let private_key = Ed25519PrivateKey::generate();
let public_key = private_key.public_key();

let message = b"hello";
let signature = private_key.sign(message);

assert!(public_key.verify(message, &signature).is_ok());

Implementations

impl Ed25519PublicKey

pub fn from_bytes(bytes: &[u8]) -> AptosResult<Self>

Creates a public key from raw bytes.

Errors

Returns AptosError::InvalidPublicKey if:

• The byte slice length is not exactly 32 bytes
• The bytes do not represent a valid Ed25519 public key

pub fn from_hex(hex_str: &str) -> AptosResult<Self>

Creates a public key from a hex string.

Errors

Returns AptosError::Hex if the hex string is invalid. Returns AptosError::InvalidPublicKey if the decoded bytes are not exactly 32 bytes or do not represent a valid Ed25519 public key.

pub fn from_aip80(s: &str) -> AptosResult<Self>

Creates a public key from AIP-80 format string.

AIP-80 format: ed25519-pub-0x{hex_bytes}

Errors

Returns an error if the format is invalid or the key bytes are invalid.

pub fn to_bytes(&self) -> [u8; 32]

Returns the public key as bytes.

pub fn to_hex(&self) -> String

Returns the public key as a hex string.

pub fn to_aip80(&self) -> String

Returns the public key in AIP-80 format.

AIP-80 format: ed25519-pub-0x{hex_bytes}

pub fn verify( &self, message: &[u8], signature: &Ed25519Signature, ) -> AptosResult<()>

Verifies a signature against a message.

Errors

Returns AptosError::SignatureVerificationFailed if the signature is invalid or does not match the message.

pub fn to_address(&self) -> AccountAddress

Derives the account address for this public key.

Uses the Ed25519 single-key scheme (scheme byte 0).

pub fn to_authentication_key(&self) -> [u8; 32]

Derives the authentication key for this public key.

Trait Implementations

impl Clone for Ed25519PublicKey

fn clone(&self) -> Ed25519PublicKey

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Ed25519PublicKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Ed25519PublicKey

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Ed25519PublicKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Ed25519PublicKey

fn eq(&self, other: &Ed25519PublicKey) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PublicKey for Ed25519PublicKey

const LENGTH: usize = ED25519_PUBLIC_KEY_LENGTH

The length of the public key in bytes.

fn from_bytes(bytes: &[u8]) -> AptosResult<Self>

Creates a public key from bytes.

fn to_bytes(&self) -> Vec<u8>

Returns the public key as bytes.

fn to_hex(&self) -> String

Returns the public key as a hex string with 0x prefix.

impl Serialize for Ed25519PublicKey

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Verifier for Ed25519PublicKey

type Signature = Ed25519Signature

The signature type this verifier can check.

fn verify( &self, message: &[u8], signature: &Ed25519Signature, ) -> AptosResult<()>

Verifies that the signature is valid for the given message.

impl Copy for Ed25519PublicKey

impl Eq for Ed25519PublicKey

impl StructuralPartialEq for Ed25519PublicKey