Struct Keypair

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

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) -> Self

where R: CryptoRng + RngCore,

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

pub fn new() -> Self

Constructs a new, random Keypair using OsRng

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

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) -> Self

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) -> Self

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

Formats the value using the given formatter.

impl EncodableKey for Keypair

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

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

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

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

impl EncodableKeypair for Keypair

fn encodable_pubkey(&self) -> Self::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 JsValue

fn from(value: Keypair) -> Self

Converts to this type from the input type.

impl FromWasmAbi for Keypair

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for Keypair

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for Keypair

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<Keypair>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Keypair

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Keypair

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

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

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<Keypair>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for Keypair

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<Keypair>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl SeedDerivable for Keypair

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

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

fn from_seed_phrase_and_passphrase( seed_phrase: &str, passphrase: &str, ) -> Result<Self, 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

impl TryFromJsValue for Keypair

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl VectorFromWasmAbi for Keypair

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[Keypair]>

impl VectorIntoJsValue for Keypair

fn vector_into_jsvalue(vector: Box<[Keypair]>) -> JsValue

impl VectorIntoWasmAbi for Keypair

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[Keypair]>) -> Self::Abi

impl WasmDescribe for Keypair

fn describe()

impl WasmDescribeVector for Keypair

fn describe_vector()