Enum PublicKey

#[non_exhaustive]
pub enum PublicKey {
    System,
    Ed25519(VerifyingKey),
    Secp256k1(VerifyingKey),
}

A public asymmetric key.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

System

System public key.

Ed25519(VerifyingKey)

Ed25519 public key.

Secp256k1(VerifyingKey)

secp256k1 public key.

Implementations

impl PublicKey

pub const SYSTEM_LENGTH: usize = 0usize

The length in bytes of a system public key.

pub const ED25519_LENGTH: usize = 32usize

The length in bytes of an Ed25519 public key.

pub const SECP256K1_LENGTH: usize = 33usize

The length in bytes of a secp256k1 public key.

pub fn to_account_hash(&self) -> AccountHash

Creates an AccountHash from a given PublicKey instance.

pub fn to_hex_string(&self) -> String

Hexadecimal representation of the key.

pub fn is_system(&self) -> bool

Returns true if this public key is of the System variant.

pub fn to_file<P: AsRef<Path>>(&self, file: P) -> Result<(), ErrorExt>

Available on crate feature std-fs-io only.

Attempts to write the key bytes to the configured file path.

pub fn from_file<P: AsRef<Path>>(file: P) -> Result<Self, ErrorExt>

Available on crate feature std-fs-io only.

Attempts to read the key bytes from configured file path.

pub fn to_der(&self) -> Result<Vec<u8>, ErrorExt>

Available on crate feature std only.

DER encodes a key.

pub fn from_der<T: AsRef<[u8]>>(input: T) -> Result<Self, ErrorExt>

Available on crate feature std only.

Decodes a key from a DER-encoded slice.

pub fn to_pem(&self) -> Result<String, ErrorExt>

Available on crate feature std only.

PEM encodes a key.

pub fn from_pem<T: AsRef<[u8]>>(input: T) -> Result<Self, ErrorExt>

Available on crate feature std only.

Decodes a key from a PEM-encoded slice.

pub fn random(rng: &mut TestRng) -> Self

Available on crate feature testing only.

Returns a random PublicKey.

pub fn random_ed25519(rng: &mut TestRng) -> Self

Available on crate feature testing only.

Returns a random Ed25519 variant of PublicKey.

pub fn random_secp256k1(rng: &mut TestRng) -> Self

Available on crate feature testing only.

Returns a random secp256k1 variant of PublicKey.

Trait Implementations

impl AsymmetricType<'_> for PublicKey

fn system() -> Self

Constructs a new system variant.

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

Constructs a new ed25519 variant from a byte slice.

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

Constructs a new secp256k1 variant from a byte slice.

fn to_hex(&'a self) -> String

Converts self to hex, where the first byte represents the algorithm tag.

fn from_hex<A: AsRef<[u8]>>(input: A) -> Result<Self, Error>

Tries to decode Self from its hex-representation. The hex format should be as produced by AsymmetricType::to_hex().

impl CLTyped for PublicKey

fn cl_type() -> CLType

The CLType of Self.

impl Clone for PublicKey

fn clone(&self) -> PublicKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DataSize for PublicKey

const IS_DYNAMIC: bool = true

If true, the type has a heap size that can vary at runtime, depending on the actual value.

const STATIC_HEAP_SIZE: usize = 0usize

The amount of space a value of the type always occupies. If IS_DYNAMIC is false, this is the total amount of heap memory occupied by the value. Otherwise this is a lower bound.

fn estimate_heap_size(&self) -> usize

Estimates the size of heap memory taken up by this value.

impl Debug for PublicKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PublicKey

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

Deserialize this value from the given Serde deserializer.

impl Display for PublicKey

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

Formats the value using the given formatter.

impl Distribution<PublicKey> for Standard

Available on crate feature testing only.

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> PublicKey

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl From<&PublicKey> for AccountHash

fn from(public_key: &PublicKey) -> Self

Converts to this type from the input type.

impl From<&PublicKey> for DelegatorKind

fn from(value: &PublicKey) -> Self

Converts to this type from the input type.

impl From<&PublicKey> for PackageHash

fn from(public_key: &PublicKey) -> Self

Converts to this type from the input type.

impl From<&PublicKey> for Vec<u8>

fn from(public_key: &PublicKey) -> Self

Converts to this type from the input type.

impl From<&SecretKey> for PublicKey

fn from(secret_key: &SecretKey) -> PublicKey

Converts to this type from the input type.

impl From<PublicKey> for BidAddr

fn from(public_key: PublicKey) -> Self

Converts to this type from the input type.

impl From<PublicKey> for DelegatorKind

fn from(value: PublicKey) -> Self

Converts to this type from the input type.

impl From<PublicKey> for InitiatorAddr

fn from(public_key: PublicKey) -> Self

Converts to this type from the input type.

impl From<PublicKey> for TransferTarget

fn from(public_key: PublicKey) -> Self

Converts to this type from the input type.

impl From<PublicKey> for Vec<u8>

fn from(public_key: PublicKey) -> Self

Converts to this type from the input type.

impl FromBytes for PublicKey

fn from_bytes(bytes: &[u8]) -> Result<(Self, &[u8]), Error>

Deserializes the slice into Self.

fn from_vec(bytes: Vec<u8>) -> Result<(Self, Vec<u8>), Error>

Deserializes the Vec<u8> into Self.

impl Hash for PublicKey

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for PublicKey

Available on crate feature json-schema only.

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl Ord for PublicKey

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PublicKey

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

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for PublicKey

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

Serialize this value into the given Serde serializer.

impl Tagged<u8> for PublicKey

fn tag(&self) -> u8

Returns the tag of a given object

impl ToBytes for PublicKey

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

Serializes &self to a Vec<u8>.

fn serialized_length(&self) -> usize

Returns the length of the Vec<u8> which would be returned from a successful call to to_bytes() or into_bytes(). The data is not actually serialized, so this call is relatively cheap.

fn write_bytes(&self, writer: &mut Vec<u8>) -> Result<(), Error>

Writes &self into a mutable writer.

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

where Self: Sized,

Consumes self and serializes to a Vec<u8>.

impl Eq for PublicKey

impl StructuralPartialEq for PublicKey