nostr 0.45.0-alpha.1

Rust implementation of the Nostr protocol.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

// Copyright (c) 2022-2023 Yuki Kishimoto
// Copyright (c) 2023-2025 Rust Nostr Developers
// Distributed under the MIT software license

use alloc::string::String;
use core::any::Any;
use core::fmt::Debug;

use crate::key::PublicKey;
use crate::util::BoxedFuture;

// TODO: add a trait/method for encrypting using a specific version?
/// Synchronous NIP-44
pub trait Nip44: Any + Debug + Send + Sync {
    /// NIP-44 error
    type Error: core::error::Error;

    /// Encrypts synchronously using NIP-44.
    ///
    /// The NIP-44 version is chosen by the implementation.
    fn nip44_encrypt(&self, public_key: &PublicKey, content: &str) -> Result<String, Self::Error>;

    /// Decrypts synchronously a NIP-44 payload.
    fn nip44_decrypt(&self, public_key: &PublicKey, payload: &str) -> Result<String, Self::Error>;
}

/// Asynchronous NIP-44
pub trait AsyncNip44: Any + Debug + Send + Sync {
    /// NIP-44 error
    type Error: core::error::Error;

    /// Encrypts asynchronously using NIP-44.
    ///
    /// The NIP-44 version is chosen by the implementation.
    fn nip44_encrypt_async<'a>(
        &'a self,
        public_key: &'a PublicKey,
        content: &'a str,
    ) -> BoxedFuture<'a, Result<String, Self::Error>>;

    /// Decrypts asynchronously a NIP-44 payload.
    fn nip44_decrypt_async<'a>(
        &'a self,
        public_key: &'a PublicKey,
        payload: &'a str,
    ) -> BoxedFuture<'a, Result<String, Self::Error>>;
}