Struct XmtpInstallationCredential 

pub struct XmtpInstallationCredential(/* private fields */);

The credential for an XMTP Installation an XMTP Installation often refers to one specific device, and is an ed25519 key

Implementations

impl XmtpInstallationCredential

pub fn new() -> Self

Create a new XmtpInstallationCredential with rand_chacha::ChaCha20Rng

pub fn verifying_key(&self) -> VerifyingKey

Get a reference to the public [ed25519_dalek::VerifyingKey] Can be used to verify signatures

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

View the public [ed25519_dalek::VerifyingKey] as constant-sized bytes

pub fn public_slice(&self) -> &[u8]

View the public [ed25519_dalek::VerifyingKey] as a slice

pub fn with_context<'k, 'v>( &'k self, context: &'v [u8], ) -> Result<Context<'k, 'v, SigningKey>, SignatureError>

pub fn from_bytes(bytes: &[u8; 32]) -> Result<Self, SignatureError>

Alias for [ed25519_dalek::SigningKey::from_bytes]

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

private key for this credential

Trait Implementations

impl Clone for XmtpInstallationCredential

fn clone(&self) -> XmtpInstallationCredential

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XmtpInstallationCredential

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

Formats the value using the given formatter.

impl Default for XmtpInstallationCredential

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for XmtpInstallationCredential

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Deserialize for XmtpInstallationCredential

fn tls_deserialize<R: Read>(bytes: &mut R) -> Result<Self, Error>

where Self: Sized,

This function deserializes the bytes from the provided a std::io::Read and returns the populated struct.

fn tls_deserialize_exact(bytes: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

This function deserializes the provided bytes and returns the populated struct. All bytes must be consumed.

impl<'a> From<&'a SigningKey> for XmtpInstallationCredential

fn from(signing_key: &'a SigningKey) -> Self

Converts to this type from the input type.

impl<'a> From<&'a XmtpInstallationCredential> for SignatureKeyPair

fn from(key: &'a XmtpInstallationCredential) -> SignatureKeyPair

Converts to this type from the input type.

impl From<SigningKey> for XmtpInstallationCredential

fn from(signing_key: SigningKey) -> Self

Converts to this type from the input type.

impl From<XmtpInstallationCredential> for SignatureKeyPair

fn from(key: XmtpInstallationCredential) -> SignatureKeyPair

Converts to this type from the input type.

impl From<XmtpInstallationCredential> for SignaturePublicKey

fn from(value: XmtpInstallationCredential) -> Self

Converts to this type from the input type.

impl Serialize for XmtpInstallationCredential

fn tls_serialize<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Serialize self and write it to the writer. The function returns the number of bytes written to writer.

fn tls_serialize_detached(&self) -> Result<Vec<u8>, Error>

Serialize self and return it as a byte vector.

impl Serialize for XmtpInstallationCredential

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Signer for &XmtpInstallationCredential

fn sign(&self, payload: &[u8]) -> Result<Vec<u8>, SignerError>

Sign the provided payload.

fn signature_scheme(&self) -> SignatureScheme

The SignatureScheme of this signer.

impl Signer for XmtpInstallationCredential

The signer here must maintain compatibility with SignatureKeyPair

fn sign(&self, payload: &[u8]) -> Result<Vec<u8>, SignerError>

Sign the provided payload.

fn signature_scheme(&self) -> SignatureScheme

The SignatureScheme of this signer.

impl Size for XmtpInstallationCredential

fn tls_serialized_len(&self) -> usize