Rust去中心化社交协议库nostr-sdk的使用，支持Nostr协议的客户端开发与事件交互

Nostr SDK

这是一个用Rust编写的高层Nostr客户端库。如果你正在编写一个典型的Nostr客户端或机器人，这个库很可能就是你需要的。

快速开始

use std::net::{Ipv4Addr, SocketAddr, SocketAddrV4};

use nostr_sdk::prelude::*;

#[tokio::main]
async fn main() -> Result<()> {
    // 生成新的随机密钥
    let keys = Keys::generate();

    // 或者使用已有的密钥(从hex或bech32格式)
    let keys = Keys::parse("hex-or-bech32-secret-key")?;

    // 显示bech32格式的公钥
    let bech32_pubkey: String = keys.public_key().to_bech32()?;
    println!("Bech32 PubKey: {}", bech32_pubkey);

    // 配置客户端使用代理连接.onion中继
    let addr = SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::LOCALHOST, 9050));
    let connection: Connection = Connection::new()
        .proxy(addr) // 使用`.embedded_tor()`替代以启用嵌入式tor客户端(需要`tor`特性)
        .target(ConnectionTarget::Onion);
    let opts = ClientOptions::new().connection(connection);

    // 创建带有自定义选项的新客户端
    let client = Client::builder().signer(keys.clone()).opts(opts).build();

    // 添加中继
    client.add_relay("wss://relay.damus.io").await?;
    client.add_relay("ws://jgqaglhautb4k6e6i2g34jakxiemqp6z4wynlirltuukgkft2xuglmqd.onion").await?;
    
    // 添加只读中继
    client.add_read_relay("wss://relay.nostr.info").await?;

    // 连接到中继
    client.connect().await;

    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("pay@yukikishimoto.com")
        .custom_field("custom_field", "my value");

    // 更新元数据
    client.set_metadata(&metadata).await?;

    // 发布一条文本笔记
    let builder = EventBuilder::text_note("My first text note from rust-nostr!");
    client.send_event_builder(builder).await?;

    // 创建一条POW文本笔记
    let builder = EventBuilder::text_note("POW text note from nostr-sdk").pow(20);
    client.send_event_builder(builder).await?; // 发送到所有中继
    // client.send_event_builder_to(["wss://relay.damus.io"], builder).await?; // 发送到特定中继

    Ok(())
}

WASM支持

这个库支持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。

特性标志

以下是可用的特性标志:

状态

这个库处于ALPHA状态，已实现的功能通常可以工作，但API可能会有重大变更。

许可证

这个项目采用MIT软件许可证。

完整示例代码

基于上述内容，这里是一个更完整的Nostr客户端开发示例:

use nostr_sdk::prelude::*;
use std::time::Duration;

#[tokio::main]
async fn main() -> Result<()> {
    // 1. 密钥管理
    let keys = Keys::generate(); // 生成新密钥
    println!("公钥: {}", keys.public_key().to_bech32()?);
    
    // 2. 客户端配置
    let opts = ClientOptions::new()
        .send_timeout(Some(Duration::from_secs(10))) // 设置超时
        .wait_for_send(true); // 等待发送确认
    
    let client = Client::builder()
        .signer(keys.clone())
        .opts(opts)
        .build();
    
    // 3. 连接中继
    client.add_relay("wss://relay.damus.io").await?;
    client.add_relay("wss://nostr-relay.wlvs.space").await?;
    client.connect().await;
    
    // 4. 发布元数据
    let metadata = Metadata::new()
        .name("rust-nostr-example")
        .display_name("Rust Nostr示例")
        .about("使用nostr-sdk的示例客户端");
    client.set_metadata(&metadata).await?;
    
    // 5. 发布文本笔记
    let event_id = client
        .publish_text_note("Hello from Rust Nostr SDK!", &[])
        .await?;
    println!("发布的事件ID: {}", event_id);
    
    // 6. 订阅和接收事件
    let subscription = Filter::new()
        .author(keys.public_key())
        .limit(10);
    
    client.subscribe(vec![subscription]).await;
    
    let mut notifications = client.notifications();
    while let Ok(notification) = notifications.recv().await {
        if let RelayPoolNotification::Event(_url, event) = notification {
            println!("收到新事件: {:?}", event);
        }
    }
    
    Ok(())
}

这个示例展示了:

1. 密钥生成和管理
2. 客户端配置
3. 中继连接
4. 元数据发布
5. 文本笔记发布
6. 事件订阅和接收

你可以根据需要扩展这个基本框架，添加更多Nostr协议功能。