Skip to main content

Keys

Struct Keys 

Source
pub struct Keys { /* private fields */ }
Expand description

secp256k1 BIP-340 keypair.

Construct from a SecretKey (Keys::from_secret_key) or generate a fresh pair (Keys::generate). The public key is computed eagerly so signing has O(1) overhead.

§Example

use nula_core::Keys;

let keys = Keys::generate().unwrap();
let pk_hex = keys.public_key().to_hex();
assert_eq!(pk_hex.len(), 64);

Implementations§

Source§

impl Keys

Source

pub fn from_secret_key(secret_key: SecretKey) -> Self

Construct a Keys from a SecretKey.

Source

pub fn generate() -> Result<Self, SecretKeyError>

Generate a fresh Keys pair using the operating system’s entropy.

§Errors

Returns SecretKeyError::Rng if the OS RNG fails.

Source

pub fn parse<S>(input: S) -> Result<Self, SecretKeyError>
where S: AsRef<str>,

Parse Keys from a 64-char lowercase hex secret key.

§Errors

See SecretKeyError.

Source

pub const fn secret_key(&self) -> &SecretKey

Borrow the secret key.

Source

pub const fn public_key(&self) -> &PublicKey

Borrow the public key.

Source

pub const fn as_inner(&self) -> &Keypair

Borrow the inner secp256k1::Keypair.

Use this only at the boundary with the cryptography backend.

Source

pub fn sign_schnorr(&self, message: &[u8; 32]) -> Signature

Sign an arbitrary message digest with BIP-340 Schnorr.

Callers are responsible for hashing application data — for Nostr events, the digest is the SHA-256 of the canonical serialization described in NIP-01.

Trait Implementations§

Source§

impl Clone for Keys

Source§

fn clone(&self) -> Keys

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Keys

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for Keys

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl Eq for Keys

Source§

impl From<SecretKey> for Keys

Source§

fn from(secret_key: SecretKey) -> Self

Converts to this type from the input type.
Source§

impl NostrSigner for Keys

Source§

fn get_public_key(&self) -> SignerFuture<'_, Result<PublicKey, SignerError>>

Return the signer’s public key. Read more
Source§

fn sign_event( &self, unsigned: UnsignedEvent, ) -> SignerFuture<'_, Result<Event, SignerError>>

Sign an UnsignedEvent and return the resulting Event. Read more
Source§

fn nip04_encrypt<'a>( &'a self, peer: &'a PublicKey, plaintext: &'a str, ) -> SignerFuture<'a, Result<String, SignerError>>

NIP-04 (legacy) encrypt to peer. Read more
Source§

fn nip04_decrypt<'a>( &'a self, peer: &'a PublicKey, ciphertext: &'a str, ) -> SignerFuture<'a, Result<String, SignerError>>

NIP-04 (legacy) decrypt from peer. Read more
Source§

fn nip44_encrypt<'a>( &'a self, peer: &'a PublicKey, plaintext: &'a str, ) -> SignerFuture<'a, Result<String, SignerError>>

NIP-44 v2 encrypt to peer. Read more
Source§

fn nip44_decrypt<'a>( &'a self, peer: &'a PublicKey, payload: &'a str, ) -> SignerFuture<'a, Result<String, SignerError>>

NIP-44 v2 decrypt from peer. Read more
Source§

impl PartialEq for Keys

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

Auto Trait Implementations§

§

impl Freeze for Keys

§

impl RefUnwindSafe for Keys

§

impl Send for Keys

§

impl Sync for Keys

§

impl Unpin for Keys

§

impl UnsafeUnpin for Keys

§

impl UnwindSafe for Keys

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more