Struct Keypair

pub struct Keypair(pub Keypair);

A vanilla Ed25519 key pair.

Calling Keypair() creates a new, random Keypair.

Example: >>> from solders.keypair import Keypair >>> assert Keypair() != Keypair()

Tuple Fields

0: Keypair

Implementations

impl Keypair

pub fn new() -> Self

Constructs a new, random Keypair using OsRng

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

Recovers a Keypair from bytes.

Args: raw_bytes (bytes): a 64-byte keypair.

Returns: Keypair: a keypair object.

Example: >>> from solders.keypair import Keypair >>> kp = Keypair() >>> assert kp == Keypair.from_bytes(bytes(kp))

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

Returns this Keypair as a byte array.

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

Example: >>> from solders.keypair import Keypair >>> raw_bytes = b’\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x8a\x88\xe3\xddt\t\xf1\x95\xfdR\xdb-<\xba]r\xcag\t\xbf\x1d\x94\x12\x1b\xf3t\x88\x01\xb4\x0fo\’ >>> assert Keypair.from_bytes(raw_bytes).to_bytes_array() == list(raw_bytes)

pub fn from_base58_string(s: &str) -> Self

Recovers a Keypair from a base58-encoded string.

Args: s (str): The base58-encoded string.

Returns: Keypair: a keypair oject.

Example: >>> from solders.keypair import Keypair >>> raw_bytes = b’\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x8a\x88\xe3\xddt\t\xf1\x95\xfdR\xdb-<\xba]r\xcag\t\xbf\x1d\x94\x12\x1b\xf3t\x88\x01\xb4\x0fo\’ >>> base58_str = “2AXDGYSE4f2sz7tvMMzyHvUfcoJmxudvdhBcmiUSo6iuCXagjUCKEQF21awZnUGxmwD4m9vGXuC3qieHXJQHAcT” >>> kp = Keypair.from_base58_string(base58_str) >>> assert kp == Keypair.from_bytes(raw_bytes) >>> assert str(kp) == base58_str

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

Gets this Keypair’s secret key.

Returns: bytes: The secret key in 32 bytes.

Example: >>> from solders.keypair import Keypair >>> kp = Keypair() >>> assert kp.secret() == bytes(kp)[:32]

pub fn py_pubkey(&self) -> Pubkey

Get this keypair’s :class:~solders.pubkey.Pubkey.

Returns: Pubkey: the pubkey of this keypair.

Example: >>> from solders.keypair import Keypair >>> from solders.pubkey import Pubkey >>> seed_bytes = bytes([0] * 32) >>> pubkey_bytes = b“;j’\xbc\xce\xb6\xa4-b\xa3\xa8\xd0*o\rse2\x15w\x1d\xe2C\xa6:\xc0H\xa1\x8bY\xda)“ >>> kp = Keypair.from_bytes(seed_bytes + pubkey_bytes) >>> assert kp.pubkey() == Pubkey(pubkey_bytes)

pub fn py_sign_message(&self, message: &[u8]) -> Signature

Sign a mesage with this keypair, producing an Ed25519 signature over the provided message bytes.

Args: message (bytes): The message to sign.

Returns: Signature: The Ed25519 signature.

Example: >>> from solders.keypair import Keypair >>> seed = bytes([1] * 32) >>> keypair = Keypair.from_seed(seed) >>> msg = b“hello“ >>> sig = keypair.sign_message(msg) >>> bytes(sig).hex() ‘e1430c6ebd0d53573b5c803452174f8991ef5955e0906a09e8fdc7310459e9c82a402526748c3431fe7f0e5faafbf7e703234789734063ee42be17af16438d08’

pub fn from_seed(seed: [u8; 32]) -> PyResult<Self>

Generate a keypair from a 32-byte seed.

Args: seed (bytes): 32-byte seed. Returns: Keypair: The generated keypair.

Example: >>> from solders.keypair import Keypair >>> from solders.pubkey import Pubkey >>> seed_bytes = bytes([0] * 32) >>> from_seed = Keypair.from_seed(seed_bytes) >>> from_bytes = Keypair.from_bytes(seed_bytes + bytes(from_seed.pubkey())) >>> assert from_seed == from_bytes

pub fn from_seed_and_derivation_path( seed: [u8; 64], dpath: &str, ) -> PyResult<Self>

Generate a keypair from a 32-byte seed and derivation path..

Args: seed (bytes): 32-byte seed. dpath (str): derivation path. Returns: Keypair: The generated keypair.

Example: >>> from solders.keypair import Keypair >>> from solders.pubkey import Pubkey >>> seed_bytes = bytes([0] * 64) >>> account_index = 0 >>> derivation_path = f“m/44’/501’/0’/{account_index}’“ >>> from_seed = Keypair.from_seed_and_derivation_path(seed_bytes, derivation_path)

pub fn from_seed_phrase_and_passphrase( seed_phrase: &str, passphrase: &str, ) -> PyResult<Self>

Generate a keypair from a seed phrase and passphrase.

Args: seed_phrase (string): Secret seed phrase. passphrase (string): Passphrase.

Example: >>> from pybip39 import Mnemonic, Seed >>> from solders.keypair import Keypair >>> mnemonic = Mnemonic() >>> passphrase = “42” >>> seed = Seed(mnemonic, passphrase) >>> expected_keypair = Keypair.from_seed(bytes(seed)[:32]) >>> keypair = Keypair.from_seed_phrase_and_passphrase(mnemonic.phrase, passphrase) >>> assert keypair.pubkey() == expected_keypair.pubkey()

pub fn py_is_interactive(&self) -> bool

Whether the impelmentation requires user interaction to sign.

Returns: bool: Always False for this class.

pub fn __hash__(&self) -> u64

pub fn __richcmp__(&self, other: Signer, op: CompareOp) -> PyResult<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<Keypair> for Keypair

fn as_ref(&self) -> &KeypairOriginal

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

impl Clone for Keypair

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommonMethods<'_> for Keypair

fn py_to_json(&self) -> String

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

impl CommonMethodsCore for Keypair

fn pystr(&self) -> String

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

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 Keypair

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

Formats the value using the given formatter.

impl Default for Keypair

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Keypair

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Keypair

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

Formats the value using the given formatter.

impl From<Keypair> for Keypair

fn from(original: KeypairOriginal) -> Keypair

Converts to this type from the input type.

impl From<Keypair> for Keypair

fn from(original: Keypair) -> Self

Converts to this type from the input type.

impl Hash for Keypair

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 Keypair

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

Performs the conversion.

impl PartialEq for Keypair

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

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

impl PyClass for Keypair

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Keypair

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<Keypair>

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<Keypair> for PyClassImplCollector<Keypair>

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

impl PyFromBytesGeneral for Keypair

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

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

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

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

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

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

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

impl PyHash for Keypair

fn pyhash(&self) -> u64

impl PyMethods<Keypair> for PyClassImplCollector<Keypair>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for Keypair

const NAME: &'static str = "Keypair"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

type AsRefTarget = PyCell<Keypair>

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 RichcmpSigner for Keypair

fn richcmp( &self, other: impl SignerTraitWrapper, op: CompareOp, ) -> Result<bool, PyErr>

impl Serialize for Keypair

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SignerTraitWrapper for Keypair

fn pubkey(&self) -> Pubkey

fn try_pubkey(&self) -> Result<Pubkey, SignerError>

fn sign_message(&self, message: &[u8]) -> Signature

fn try_sign_message(&self, message: &[u8]) -> Result<Signature, SignerError>

fn is_interactive(&self) -> bool

impl ToSignerOriginal for Keypair

fn to_inner(&self) -> Box<dyn SignerTrait>

impl StructuralPartialEq for Keypair