Enum Identity

pub enum Identity {
    None,
    Public(PublicKey),
    Signer(Box<dyn Signer>),
}

All states that your identity can be in

Variants

None

No identity information

Public(PublicKey)

Public key only

Signer(Box<dyn Signer>)

Signer (locked or unlocked)

Implementations

impl Identity

pub fn from_public_key(pk: PublicKey) -> Self

New Identity from a public key

pub fn from_private_key( pk: PrivateKey, pass: &str, log_n: u8, ) -> Result<Self, Error>

New Identity from a private key

pub fn from_locked_parts(pk: PublicKey, epk: EncryptedPrivateKey) -> Self

New Identity from an encrypted private key and a public key

pub fn from_encrypted_private_key( epk: EncryptedPrivateKey, pass: &str, ) -> Result<Self, Error>

New Identity from an encrypted private key and its password

pub fn generate(password: &str, log_n: u8) -> Result<Self, Error>

Generate a new Identity

pub fn unlock(&mut self, password: &str) -> Result<(), Error>

Unlock

pub fn lock(&mut self)

Lock access to the private key

pub fn has_public_key(&self) -> bool

Has a public key

pub fn has_private_key(&self) -> bool

Has a private key

pub fn is_locked(&self) -> bool

Is the identity locked?

pub fn is_unlocked(&self) -> bool

Is the identity unlocked?

pub fn change_passphrase( &mut self, old: &str, new: &str, log_n: u8, ) -> Result<(), Error>

Change the passphrase used for locking access to the private key

pub fn public_key(&self) -> Option<PublicKey>

What is the public key?

pub fn encrypted_private_key(&self) -> Option<&EncryptedPrivateKey>

What is the signer’s encrypted private key?

pub fn sign_id(&self, id: Id) -> Result<Signature, Error>

Sign a 32-bit hash

pub fn sign(&self, message: &[u8]) -> Result<Signature, Error>

Sign a message (this hashes with SHA-256 first internally)

pub fn encrypt( &self, other: &PublicKey, plaintext: &str, algo: ContentEncryptionAlgorithm, ) -> Result<String, Error>

Encrypt

pub fn decrypt( &self, other: &PublicKey, ciphertext: &str, ) -> Result<String, Error>

Decrypt

pub fn nip44_conversation_key( &self, other: &PublicKey, ) -> Result<[u8; 32], Error>

Get NIP-44 conversation key

pub fn export_private_key_in_hex( &mut self, pass: &str, log_n: u8, ) -> Result<(String, bool), Error>

Export the private key in hex.

This returns a boolean indicating if the key security was downgraded. If it was, the caller should save the new self.encrypted_private_key()

We need the password and log_n parameters to possibly rebuild the EncryptedPrivateKey when downgrading key security

pub fn export_private_key_in_bech32( &mut self, pass: &str, log_n: u8, ) -> Result<(String, bool), Error>

Export the private key in bech32.

This returns a boolean indicating if the key security was downgraded. If it was, the caller should save the new self.encrypted_private_key()

We need the password and log_n parameters to possibly rebuild the EncryptedPrivateKey when downgrading key security

pub fn key_security(&self) -> Result<KeySecurity, Error>

Get the security level of the private key

pub fn upgrade(&mut self, pass: &str, log_n: u8) -> Result<(), Error>

Upgrade the encrypted private key to the latest format

pub fn create_metadata_event( &self, input: PreEvent, metadata: Metadata, ) -> Result<Event, Error>

Create an event that sets Metadata

pub fn create_zap_request_event( &self, recipient_pubkey: PublicKey, zapped_event: Option<Id>, millisatoshis: u64, relays: Vec<String>, content: String, ) -> Result<Event, Error>

Create a ZapRequest event These events are not published to nostr, they are sent to a lnurl.

pub fn decrypt_event_contents(&self, event: &Event) -> Result<String, Error>

Decrypt the contents of an event

pub fn unwrap_giftwrap(&self, event: &Event) -> Result<Rumor, Error>

If a gift wrap event, unwrap and return the inner Rumor

pub fn unwrap_giftwrap1(&self, event: &EventV1) -> Result<RumorV1, Error>

If a gift wrap event, unwrap and return the inner Rumor @deprecated for migrations only

pub fn unwrap_giftwrap2(&self, event: &EventV2) -> Result<RumorV2, Error>

If a gift wrap event, unwrap and return the inner Rumor @deprecated for migrations only

pub fn generate_delegation_signature( &self, delegated_pubkey: PublicKey, delegation_conditions: &DelegationConditions, ) -> Result<Signature, Error>

Generate delegation signature

pub fn giftwrap( &self, input: PreEvent, pubkey: PublicKey, ) -> Result<Event, Error>

Giftwrap an event

pub fn sign_event(&self, input: PreEvent) -> Result<Event, Error>

Sign an event

pub fn sign_event_with_pow( &self, input: PreEvent, zero_bits: u8, work_sender: Option<Sender<u8>>, ) -> Result<Event, Error>

Sign an event with Proof-of-Work

pub fn verify_delegation_signature( &self, delegated_pubkey: PublicKey, delegation_conditions: &DelegationConditions, signature: &Signature, ) -> Result<(), Error>

Verify delegation signature

Trait Implementations

impl Debug for Identity

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

Formats the value using the given formatter.

impl Default for Identity

fn default() -> Identity

Returns the “default value” for a type.

impl Send for Identity

impl Sync for Identity