Skip to main content

MultiKeyPublicKey

Struct MultiKeyPublicKey 

Source
pub struct MultiKeyPublicKey { /* private fields */ }
Expand description

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§

Source§

impl MultiKeyPublicKey

Source

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
Source

pub fn num_keys(&self) -> usize

Returns the number of public keys.

Source

pub fn threshold(&self) -> u8

Returns the threshold.

Source

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

Returns the individual public keys.

Source

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

Returns the key at the given index.

Source

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

Serializes to bytes for authentication key derivation.

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

Source

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
Source

pub fn to_address(&self) -> AccountAddress

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

Source

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

Derives the authentication key for this public key.

Source

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§

Source§

impl Clone for MultiKeyPublicKey

Source§

fn clone(&self) -> MultiKeyPublicKey

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MultiKeyPublicKey

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for MultiKeyPublicKey

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for MultiKeyPublicKey

Source§

impl PartialEq for MultiKeyPublicKey

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for MultiKeyPublicKey

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
§

impl<T> ToStringFallible for T
where T: Display,

§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more