Struct Keypair

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

Available on crate feature full only.

A vanilla Ed25519 key pair

Implementations

impl Keypair

pub const SECRET_KEY_LENGTH: usize = 32usize

Can be used for generating a Keypair without a dependency on rand types

pub fn generate<R>(csprng: &mut R) -> Keypair

where R: CryptoRng + RngCore,

Constructs a new, random Keypair using a caller-provided RNG

pub fn new() -> Keypair

Constructs a new, random Keypair using OsRng

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

Recovers a Keypair from a byte array

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

Returns this Keypair as a byte array

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

Recovers a Keypair from a base58-encoded string

pub fn to_base58_string(&self) -> String

Returns this Keypair as a base58-encoded string

pub fn secret(&self) -> &SecretKey

Gets this Keypair’s SecretKey

pub fn insecure_clone(&self) -> Keypair

Allows Keypair cloning

Note that the Clone trait is intentionally unimplemented because making a second copy of sensitive secret keys in memory is usually a bad idea.

Only use this in tests or when strictly required. Consider using std::sync::Arc<Keypair> instead.

Trait Implementations

impl Debug for Keypair

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

Formats the value using the given formatter.

impl EncodableKey for Keypair

fn read<R>(reader: &mut R) -> Result<Keypair, Box<dyn Error>>

where R: Read,

fn write<W>(&self, writer: &mut W) -> Result<String, Box<dyn Error>>

where W: Write,

fn read_from_file<F>(path: F) -> Result<Self, Box<dyn Error>>

where F: AsRef<Path>,

fn write_to_file<F>(&self, outfile: F) -> Result<String, Box<dyn Error>>

where F: AsRef<Path>,

impl EncodableKeypair for Keypair

fn encodable_pubkey(&self) -> <Keypair as EncodableKeypair>::Pubkey

Returns the associated pubkey. Use this function specifically for settings that involve reading or writing pubkeys. For other settings, use Signer::pubkey() instead.

type Pubkey = Pubkey

impl From<Keypair> for Keypair

fn from(value: Keypair) -> Keypair

Converts to this type from the input type.

impl<T> PartialEq<T> for Keypair

where T: Signer,

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

fn from_seed(seed: &[u8]) -> Result<Keypair, Box<dyn Error>>

fn from_seed_and_derivation_path( seed: &[u8], derivation_path: Option<DerivationPath>, ) -> Result<Keypair, Box<dyn Error>>

fn from_seed_phrase_and_passphrase( seed_phrase: &str, passphrase: &str, ) -> Result<Keypair, Box<dyn Error>>

impl Signer for Keypair

fn pubkey(&self) -> Pubkey

Infallibly gets the implementor’s public key. Returns the all-zeros Pubkey if the implementor has none.

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

Fallibly gets the implementor’s public key

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

Infallibly produces an Ed25519 signature over the provided message bytes. Returns the all-zeros Signature if signing is not possible.

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

Fallibly produces an Ed25519 signature over the provided message bytes.

fn is_interactive(&self) -> bool

Whether the implementation requires user interaction to sign