Struct MultiEd25519PublicKey 

pub struct MultiEd25519PublicKey { /* private fields */ }

Available on crate feature ed25519 only.

A multi-Ed25519 public key.

This is a collection of Ed25519 public keys with a threshold value. M-of-N signatures are required where M = threshold and N = number of keys.

Example

use aptos_sdk::crypto::{Ed25519PrivateKey, MultiEd25519PublicKey};

let keys: Vec<_> = (0..3).map(|_| Ed25519PrivateKey::generate().public_key()).collect();
let multi_pk = MultiEd25519PublicKey::new(keys, 2).unwrap(); // 2-of-3

Implementations

impl MultiEd25519PublicKey

pub fn new( public_keys: Vec<Ed25519PublicKey>, threshold: u8, ) -> AptosResult<Self>

Creates a new multi-Ed25519 public key.

Arguments

• public_keys - The individual Ed25519 public keys
• threshold - The number of signatures required (M in M-of-N)

Errors

Returns an error if:

• No public keys are provided
• More than 32 public keys are provided
• Threshold is 0
• Threshold exceeds the number of keys

pub fn num_keys(&self) -> usize

Returns the number of public keys.

pub fn threshold(&self) -> u8

Returns the threshold (M in M-of-N).

pub fn public_keys(&self) -> &[Ed25519PublicKey]

Returns the individual public keys.

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

Serializes the public key to bytes.

Format: public_key_1 || public_key_2 || … || public_key_n || threshold

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

Creates a public key from bytes.

Errors

Returns AptosError::InvalidPublicKey if:

• The bytes are empty
• The bytes are too short (less than 33 bytes for one key + threshold)
• The key bytes length is not a multiple of 32 bytes
• Any individual public key fails to parse
• The threshold is invalid (0, exceeds number of keys, etc.)

pub fn to_address(&self) -> AccountAddress

Derives the account address for this multi-Ed25519 public key.

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

Derives the authentication key for this public key.

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

Verifies a multi-Ed25519 signature against a message.

Errors

This function will return an error if:

• The number of signatures is less than the threshold
• Any individual signature verification fails
• A signer index is out of bounds

Trait Implementations

impl Clone for MultiEd25519PublicKey

fn clone(&self) -> MultiEd25519PublicKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MultiEd25519PublicKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MultiEd25519PublicKey

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MultiEd25519PublicKey

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

Formats the value using the given formatter.

impl PartialEq for MultiEd25519PublicKey

fn eq(&self, other: &MultiEd25519PublicKey) -> 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 MultiEd25519PublicKey

const LENGTH: usize = 0

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 MultiEd25519PublicKey

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 MultiEd25519PublicKey

type Signature = MultiEd25519Signature

The signature type this verifier can check.

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

Verifies that the signature is valid for the given message.

impl Eq for MultiEd25519PublicKey

impl StructuralPartialEq for MultiEd25519PublicKey