Enum SimpleSignature 

pub enum SimpleSignature {
    Ed25519 {
        signature: Ed25519Signature,
        public_key: Ed25519PublicKey,
    },
    Secp256k1 {
        signature: Secp256k1Signature,
        public_key: Secp256k1PublicKey,
    },
    Secp256r1 {
        signature: Secp256r1Signature,
        public_key: Secp256r1PublicKey,
    },
}

A basic signature

This enumeration defines the set of simple or basic signature schemes supported by IOTA. Most signature schemes supported by IOTA end up comprising of a at least one simple signature scheme.

BCS

The BCS serialized form for this type is defined by the following ABNF:

simple-signature-bcs = bytes ; where the contents of the bytes are defined by <simple-signature>
simple-signature = (ed25519-flag ed25519-signature ed25519-public-key) /
                   (secp256k1-flag secp256k1-signature secp256k1-public-key) /
                   (secp256r1-flag secp256r1-signature secp256r1-public-key)

Note: Due to historical reasons, signatures are serialized slightly different from the majority of the types in IOTA. In particular if a signature is ever embedded in another structure it generally is serialized as bytes meaning it has a length prefix that defines the length of the completely serialized signature.

Variants

Ed25519

Fields

signature: Ed25519Signature

public_key: Ed25519PublicKey

Secp256k1

Fields

signature: Secp256k1Signature

public_key: Secp256k1PublicKey

Secp256r1

Fields

signature: Secp256r1Signature

public_key: Secp256r1PublicKey

Implementations

impl SimpleSignature

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

Available on crate feature serde only.

pub fn from_serialized_bytes( bytes: impl AsRef<[u8]>, ) -> Result<Self, SignatureFromBytesError>

Available on crate feature serde only.

impl SimpleSignature

pub fn is_ed25519(&self) -> bool

pub fn is_secp256k1(&self) -> bool

pub fn is_secp256r1(&self) -> bool

pub fn as_ed25519_sig_opt(&self) -> Option<&Ed25519Signature>

pub fn as_ed25519_sig(&self) -> &Ed25519Signature

pub fn as_ed25519_pub_key_opt(&self) -> Option<&Ed25519PublicKey>

pub fn as_ed25519_pub_key(&self) -> &Ed25519PublicKey

pub fn into_ed25519_opt(self) -> Option<(Ed25519Signature, Ed25519PublicKey)>

pub fn into_ed25519(self) -> (Ed25519Signature, Ed25519PublicKey)

pub fn as_secp256k1_sig_opt(&self) -> Option<&Secp256k1Signature>

pub fn as_secp256k1_sig(&self) -> &Secp256k1Signature

pub fn as_secp256k1_pub_key_opt(&self) -> Option<&Secp256k1PublicKey>

pub fn as_secp256k1_pub_key(&self) -> &Secp256k1PublicKey

pub fn into_secp256k1_opt( self, ) -> Option<(Secp256k1Signature, Secp256k1PublicKey)>

pub fn into_secp256k1(self) -> (Secp256k1Signature, Secp256k1PublicKey)

pub fn as_secp256r1_sig_opt(&self) -> Option<&Secp256r1Signature>

pub fn as_secp256r1_sig(&self) -> &Secp256r1Signature

pub fn as_secp256r1_pub_key_opt(&self) -> Option<&Secp256r1PublicKey>

pub fn as_secp256r1_pub_key(&self) -> &Secp256r1PublicKey

pub fn into_secp256r1_opt( self, ) -> Option<(Secp256r1Signature, Secp256r1PublicKey)>

pub fn into_secp256r1(self) -> (Secp256r1Signature, Secp256r1PublicKey)

pub fn scheme(&self) -> SignatureScheme

Return the flag for this signature scheme

Trait Implementations

impl Arbitrary for SimpleSignature

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<SimpleSignature>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(args: <Self as Arbitrary>::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for SimpleSignature

fn clone(&self) -> SimpleSignature

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SimpleSignature

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SimpleSignature

Available on crate feature serde only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for SimpleSignature

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 SimpleSignature

fn schema_name() -> String

The name of the generated JSON Schema.

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

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

fn json_schema(generator: &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.

impl PartialEq for SimpleSignature

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

Available on crate feature serde only.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SimpleSignature

impl StructuralPartialEq for SimpleSignature