Nostr

描述

Rust 实现的 Nostr 协议。

你可能还感兴趣

• nostr-sdk 如果你想要编写典型的 Nostr 客户端或机器人
• nostr-database: Nostr 应用程序的数据库
• nostr-relay-pool: Nostr 中继池
• nostr-signer: Nostr 应用的签名者
• nostr-zapper: Nostr 应用的 Zapper 抽象
• nwc: NWC 客户端和 zapper 后端用于 Nostr 应用程序

入门

use nostr::prelude::*;

fn main() -> Result<()> {
    // Generate new random keys
    let my_keys = Keys::generate();

    // Or use your already existing (from hex or bech32)
    let my_keys = Keys::parse("hex-or-bech32-secret-key")?;

    // Show bech32 public key
    let bech32_pubkey: String = my_keys.public_key().to_bech32()?;
    println!("Bech32 PubKey: {}", bech32_pubkey);

    let metadata = Metadata::new()
        .name("username")
        .display_name("My Username")
        .about("Description")
        .picture(Url::parse("https://example.com/avatar.png")?)
        .banner(Url::parse("https://example.com/banner.png")?)
        .nip05("username@example.com")
        .lud16("yuki@getalby.com")
        .custom_field("custom_field", "my value");

    let event: Event = EventBuilder::metadata(&metadata).to_event(&my_keys)?;

    // New text note
    let event: Event = EventBuilder::text_note("Hello from rust-nostr", []).to_event(&my_keys)?;

    // New POW text note
    let event: Event = EventBuilder::text_note("My first POW text note from rust-nostr", []).to_pow_event(&my_keys, 20)?;

    // Convert client nessage to JSON
    let json = ClientMessage::event(event).as_json();
    println!("{json}");

    Ok(())
}

更多示例可以在 examples/ 目录中找到。

WASM

这个 crate 支持 wasm32 目标。

在 macOS 上您需要安装 llvm

brew install llvm
LLVM_PATH=$(brew --prefix llvm)
AR="${LLVM_PATH}/bin/llvm-ar" CC="${LLVM_PATH}/bin/clang" cargo build --target wasm32-unknown-unknown

注意：当前 nip03 功能不支持 WASM。

嵌入式

这个 crate 支持 no_std 环境。

检查 embedded/ 目录中的示例。

包功能标志

以下包功能标志可用

支持的 NIPs

状态

这个库处于 alpha 状态，已实现的功能通常可以工作，但 API 将会以破坏性的方式改变。

捐赠

rust-nostr 是免费和开源的。这意味着我们通过销售它不赚取任何收入。相反，我们依赖您的财务支持。如果您积极使用任何 rust-nostr 库/软件/服务，那么请捐赠。

许可证

本项目采用 MIT 软件许可协议分发 - 有关详细信息，请参阅LICENSE 文件