Struct Signature

pub struct Signature(pub Signature);

The Signature object is a wrapper around a raw bytes signature, typically returned by :meth:~solders.keypair.Keypair.sign_message or other similar methods.

Args: signature_bytes (bytes): The raw signature bytes.

Tuple Fields

0: Signature

Implementations

impl Signature

pub const LENGTH: usize = 64usize

pub fn new(signature_bytes: [u8; 64]) -> Self

pub fn new_unique() -> Self

Create a random siganture.

Returns: Signature: The random signature.

pub fn new_default() -> Self

Create a new default signature object.

Returns: Signature: The default signature.

Example: >>> from solders.signature import Signature >>> Signature.default() Signature( 1111111111111111111111111111111111111111111111111111111111111111, )

pub fn new_from_str(s: &str) -> PyResult<Self>

Retrieve a signature from a base58-encoded string.

Args: s (str): base58-encoded signature.

Returns: Signature: The decoded signature.

Example: >>> from solders.signature import Signature >>> from solders.keypair import Keypair >>> sig = Keypair().sign_message(bytes([0])) >>> assert Signature.from_string(str(sig)) == sig

pub fn verify(&self, pubkey: Pubkey, message_bytes: &[u8]) -> bool

Check if the signature is a valid signature created by the given pubkey on the given message.

Args: pubkey: The pubkey that is supposed to have signed the message. message (bytes): The message in bytes.

Returns: bool: True if verfiication is successful.

Example: >>> from solders.keypair import Keypair >>> from solders.signature import Signature >>> kp = Keypair() >>> msg = b“macaroni“ >>> sig = kp.sign_message(msg) >>> sig.verify(kp.pubkey(), msg) True

pub fn to_bytes_array(&self) -> [u8; 64]

Returns this signature as a byte array.

Returns: list[int]: the signature as a list of 64 u8 ints.

Example: >>> from solders.signature import Signature >>> assert Signature.default().to_bytes_array() == [0] * 64

pub fn from_bytes(raw_bytes: [u8; 64]) -> PyResult<Self>

Construct from bytes. Equivalent to Signature.__init__ but included for the sake of consistency.

Args: raw_bytes (bytes): the signature bytes.

Returns: Signature: a Signature object.

pub fn __hash__(&self) -> u64

pub fn __richcmp__(&self, other: &Self, op: CompareOp) -> bool

pub fn __bytes__<'a>(&self, py: Python<'a>) -> &'a PyBytes

pub fn __str__(&self) -> String

pub fn __repr__(&self) -> String

pub fn __reduce__(&self) -> PyResult<(PyObject, PyObject)>

pub fn to_json(&self) -> String

Convert to a JSON string.

pub fn from_json(raw: &str) -> PyResult<Self>

Build from a JSON string.

Trait Implementations

impl AsRef<[u8]> for Signature

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Signature> for Signature

fn as_ref(&self) -> &SignatureOriginal

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Signature

fn clone(&self) -> Signature

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommonMethods<'_> for Signature

fn py_to_json(&self) -> String

fn py_from_json(raw: &'a str) -> Result<Self, PyErr>

impl CommonMethodsCore for Signature

fn pybytes<'b>(&self, py: Python<'b>) -> &'b PyBytes

fn pystr(&self) -> String

fn pyrepr(&self) -> String

fn py_from_bytes(raw: &[u8]) -> Result<Self, PyErr>

fn pyreduce(&self) -> Result<(Py<PyAny>, Py<PyAny>), PyErr>

impl Debug for Signature

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

Formats the value using the given formatter.

impl Default for Signature

fn default() -> Signature

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Signature

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Signature

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

Formats the value using the given formatter.

impl From<Signature> for Signature

fn from(original: SignatureOriginal) -> Signature

Converts to this type from the input type.

impl From<Signature> for Signature

fn from(original: Signature) -> Self

Converts to this type from the input type.

impl FromStr for Signature

type Err = ParseSignatureError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Signature

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 IntoPy<Py<PyAny>> for Signature

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl Ord for Signature

fn cmp(&self, other: &Signature) -> 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 Signature

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

fn partial_cmp(&self, other: &Signature) -> 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 PyBytesGeneral for Signature

fn pybytes_general<'a>(&self, py: Python<'a>) -> &'a PyBytes

impl PyBytesSlice for Signature

fn pybytes_slice<'a>(&self, py: Python<'a>) -> &'a PyBytes

impl PyClass for Signature

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Signature

const IS_BASETYPE: bool = true

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Signature>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<Signature> for PyClassImplCollector<Signature>

fn new_text_signature(self) -> Option<&'static str>

impl PyFromBytesGeneral for Signature

fn py_from_bytes_general(raw: &[u8]) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a Signature

type Holder = Option<PyRef<'py, Signature>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut Signature

type Holder = Option<PyRefMut<'py, Signature>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl PyHash for Signature

fn pyhash(&self) -> u64

impl PyMethods<Signature> for PyClassImplCollector<Signature>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Signature

const NAME: &'static str = "Signature"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

type AsRefTarget = PyCell<Signature>

Utility type to make Py::as_ref work.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> &PyType

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.

impl RichcmpFull for Signature

fn richcmp(&self, other: &Self, op: CompareOp) -> bool

impl Serialize for Signature

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Signature

impl Eq for Signature

impl StructuralPartialEq for Signature