Struct JsMPublicKey

pub struct JsMPublicKey { /* private fields */ }

Multicipher public key

A public key (also called shared key or pk in some literature) is that part of an asymmetric keypair which can be used to verify the authenticity of the sender of a message or to encrypt a message that can only be decrypted by a single recipient. In both cases this other party owns the {@link PrivateKey} part of the keypair and never shares it with anyone else.

Implementations

impl JsMPublicKey

pub fn new(pub_key_str: &str) -> Result<JsMPublicKey, JsValue>

Parses a string into a {@link PublicKey}.

pub fn from_secp(pk: &JsSecpPublicKey) -> JsMPublicKey

Converts a {@link SecpPublicKey} into a multicipher {@link PublicKey}.

pub fn prefix() -> String

All multicipher public keys start with this prefix

pub fn key_id(&self) -> JsMKeyId

Calculates the key id (also called fingerprint or address in some literature) of the public key.

pub fn validate_id(&self, key_id: &JsMKeyId) -> bool

Validates if key_id belongs to this public key

We do not yet have multiple versions of key ids for the same multicipher public key, so for now this comparison is trivial. But when we introduce newer versions, we need to take the version of the key_id argument into account and calculate that possibly older version from self.

pub fn validate_ecdsa(&self, data: &[u8], signature: &JsMSignature) -> bool

This method can be used to verify if a given signature for a message was made using the private key that belongs to this public key.

@see PrivateKey.sign

pub fn stringify(&self) -> String

Converts a {@link PublicKey} into a string.

Trait Implementations

impl Clone for JsMPublicKey

fn clone(&self) -> JsMPublicKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsMPublicKey

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

Formats the value using the given formatter.

impl From<JsMPublicKey> for JsValue

fn from(value: JsMPublicKey) -> JsValue

Converts to this type from the input type.

impl From<MPublicKey> for JsMPublicKey

fn from(inner: MPublicKey) -> JsMPublicKey

Converts to this type from the input type.

impl FromWasmAbi for JsMPublicKey

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> JsMPublicKey

Recover a Self from Self::Abi.

impl IntoWasmAbi for JsMPublicKey

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for JsMPublicKey

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<JsMPublicKey>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <JsMPublicKey as LongRefFromWasmAbi>::Abi, ) -> <JsMPublicKey as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for JsMPublicKey

fn is_none(abi: &<JsMPublicKey as FromWasmAbi>::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for JsMPublicKey

fn none() -> <JsMPublicKey as IntoWasmAbi>::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for JsMPublicKey

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<JsMPublicKey>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi( js: <JsMPublicKey as RefFromWasmAbi>::Abi, ) -> <JsMPublicKey as RefFromWasmAbi>::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for JsMPublicKey

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<JsMPublicKey>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi( js: <JsMPublicKey as RefMutFromWasmAbi>::Abi, ) -> <JsMPublicKey as RefMutFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for JsMPublicKey

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value( value: JsValue, ) -> Result<JsMPublicKey, <JsMPublicKey as TryFromJsValue>::Error>

Performs the conversion.

impl VectorFromWasmAbi for JsMPublicKey

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi( js: <JsMPublicKey as VectorFromWasmAbi>::Abi, ) -> Box<[JsMPublicKey]>

impl VectorIntoWasmAbi for JsMPublicKey

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi( vector: Box<[JsMPublicKey]>, ) -> <JsMPublicKey as VectorIntoWasmAbi>::Abi

impl Wraps<MPublicKey> for JsMPublicKey

fn inner(&self) -> &MPublicKey

Converts a reference to a WASM type to a reference to the underlying Rust type.