Struct MultiKeyPublicKey 

pub struct MultiKeyPublicKey { /* private fields */ }

A multi-key public key supporting mixed signature schemes.

This allows M-of-N threshold signing where each key can be a different type.

Implementations

impl MultiKeyPublicKey

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

Creates a new multi-key public key.

Arguments

• public_keys - The individual public keys (can be mixed types)
• threshold - The number of signatures required (M in M-of-N)

Errors

Returns AptosError::InvalidPublicKey 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.

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

Returns the individual public keys.

pub fn get(&self, index: usize) -> Option<&AnyPublicKey>

Returns the key at the given index.

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

Serializes to bytes for authentication key derivation.

Format: num_keys || pk1_bcs || pk2_bcs || … || threshold

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

Creates from bytes.

Errors

Returns AptosError::InvalidPublicKey if:

• The bytes are empty
• The number of keys is invalid (0 or > 32)
• The bytes are too short for the expected structure
• Any public key variant byte is invalid
• Any public key length or data is invalid
• The threshold is invalid

pub fn to_address(&self) -> AccountAddress

Derives the account address for this multi-key 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: &MultiKeySignature, ) -> AptosResult<()>

Verifies a multi-key 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 MultiKeyPublicKey

fn clone(&self) -> MultiKeyPublicKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MultiKeyPublicKey

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

Formats the value using the given formatter.

impl Display for MultiKeyPublicKey

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

Formats the value using the given formatter.

impl PartialEq for MultiKeyPublicKey

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

impl StructuralPartialEq for MultiKeyPublicKey