Laravel Nostr

概览

revolution/laravel-nostr 是一个让你能在 Laravel 中使用 Nostr 协议的包。它提供密钥生成与转换、事件获取与发布、pool（多 relay）支持、NIP-05 profile、NIP-17 Private Direct Messages，以及与 Laravel Notifications 的集成。

由于 Nostr 规范仍在演进中，该包也在持续开发。通知功能已经可以实际投入使用。

驱动

该包提供两个驱动。

驱动	说明
`native`	仅使用 PHP 的实现。使用 nostr-php。目前该驱动已经足够使用。
`node`	依赖外部 WebAPI（Node.js）的实现。

native 驱动的独特之处在于其 WebSocketHttpMixin 实现。它通过 Laravel 的 HTTP 客户端连接到 WebSocket，收发数据后立即断开。无需持续运行 WebSocket 服务器，任何 Laravel 用户都可以使用。

native 驱动不支持 NIP-04。

配置默认驱动

在 config/nostr.php 或 .env 中配置。

// config/nostr.php

'driver' => env('NOSTR_DRIVER', 'node'),

NOSTR_DRIVER=native

如果未指定驱动，将使用默认驱动。

use Revolution\Nostr\Facades\Nostr;

Nostr::event()->list();

也可以显式指定驱动。

use Revolution\Nostr\Facades\Nostr;

Nostr::driver('node')->event()->list();
Nostr::node()->event()->list();

Nostr::driver('native')->event()->list();
Nostr::native()->event()->list();

安装

安装包

composer require revolution/laravel-nostr

发布配置文件

php artisan vendor:publish --tag=nostr-config

密钥管理

生成密钥

use Revolution\Nostr\Facades\Nostr;
use Illuminate\Http\Client\Response;

/** @var Response $response */
$response = Nostr::key()->generate();
$keys = $response->json();
// [
//     'sk'   => 'sk...',
//     'nsec' => 'nsec...',
//     'pk'   => 'pk...',
//     'npub' => 'npub...',
// ]

转换密钥

从 nsec 转换。

use Revolution\Nostr\Facades\Nostr;

$response = Nostr::key()->fromNsec(nsec: 'nsec');
$keys = $response->json();
// ['sk' => '...', 'nsec' => '...', 'pk' => '...', 'npub' => '...']

从 Secret Key 转换。

$response = Nostr::key()->fromSecretKey(sk: 'sk');

从 npub 转换（仅公钥）。

$response = Nostr::key()->fromNpub(npub: 'npub');
$keys = $response->json();
// ['pk' => '...', 'npub' => '...']

从 Public Key 转换。

$response = Nostr::key()->fromPublicKey(pk: 'pk');

获取事件

获取多个事件

use Illuminate\Http\Client\Response;
use Revolution\Nostr\Facades\Nostr;
use Revolution\Nostr\Filter;
use Revolution\Nostr\Kind;

$filter = Filter::make(
    authors: ['my pk'],
    kinds: [Kind::Text],
    limit: 10,
);

/** @var Response $response */
$response = Nostr::event()->list(filter: $filter);
$events = $response->json('events');
// [
//     ['id' => '...1', 'kind' => 1, 'content' => '...'],
//     ['id' => '...2', 'kind' => 1, 'content' => '...'],
// ]

获取单个事件

use Revolution\Nostr\Facades\Nostr;
use Revolution\Nostr\Filter;
use Revolution\Nostr\Kind;

$filter = Filter::make(
    authors: ['my pk'],
    kinds: [Kind::Metadata],
);

$response = Nostr::event()->get(filter: $filter);
$event = $response->json('event');
// ['id' => '...', 'kind' => 0, 'content' => '{name: ""}']

发布事件

发布到单个 relay

use Revolution\Nostr\Facades\Nostr;
use Revolution\Nostr\Event;
use Revolution\Nostr\Kind;

$event = Event::make(
    kind: Kind::Text,
    content: 'hello',
    created_at: now()->timestamp,
    tags: [],
);

$sk = 'my sk';

$response = Nostr::event()->publish(event: $event, sk: $sk);

if ($response->successful()) {
    $event = $response->json('event');
}

发布到多个 relay（pool）

use Revolution\Nostr\Facades\Nostr;
use Revolution\Nostr\Event;
use Revolution\Nostr\Kind;

$event = Event::make(
    kind: Kind::Text,
    content: 'test',
    created_at: now()->timestamp,
    tags: [],
);

$responses = Nostr::pool()->publish(event: $event, sk: 'my sk');
// $responses 为 array<string, Response>
// ['wss://relay1' => $response, 'wss://relay2' => $response]

foreach ($responses as $relay => $response) {
    if ($response->failed()) {
        dump($relay . ' : ' . $response->body());
    }
}

Relay 服务器配置

使用的 relay 服务器

当仅使用 Nostr::event() 时，会使用 config/nostr.php 中的第一个 relay。当使用 Nostr::pool() 时，配置中的所有 relay 都会作为目标。

在运行时更换 relay

use Revolution\Nostr\Facades\Nostr;

$response = Nostr::event()->withRelay('wss://')->...;

use Revolution\Nostr\Facades\Nostr;

$response = Nostr::pool()->withRelays(['wss://', 'wss://'])->...;

NIP-05 profile

use Revolution\Nostr\Facades\Nostr;

$profile = Nostr::nip05()->profile('user@localhost');
// [
//     'user'   => 'user@localhost',
//     'pubkey' => 'pk',
//     'relays' => [],
// ]

NIP-17 Private Direct Messages

NIP-17 仅在 native 驱动中受支持。

发送私信

use Revolution\Nostr\Facades\Nostr;

$response = Nostr::driver('native')
    ->nip17()
    ->sendDirectMessage(
        sk: 'sender-secret-key',
        pk: 'receiver-public-key',
        message: 'Hello, this is a private message!'
    );

解密私信

use Revolution\Nostr\Facades\Nostr;

$response = Nostr::driver('native')
    ->nip17()
    ->decryptDirectMessage(
        giftWrap: $receivedGiftWrap,
        sk: 'receiver-secret-key'
    );

$decryptedMessage = $response->json();

Laravel Notifications

使用 NostrChannel，你可以从 Laravel Notifications 向 Nostr 发送消息。

Notification 类

use Illuminate\Notifications\Notification;
use Revolution\Nostr\Notifications\NostrChannel;
use Revolution\Nostr\Notifications\NostrMessage;
use Revolution\Nostr\Tags\HashTag;

class TestNotification extends Notification
{
    public function via(object $notifiable): array
    {
        return [
            'mail',
            NostrChannel::class,
        ];
    }

    public function toNostr(object $notifiable): NostrMessage
    {
        return new NostrMessage(
            // content 中的 #laravel 用于显示，tags 中的 HashTag 用于协议层面的分类
            content: 'hello #laravel',
            tags: [
                HashTag::make(t: 'laravel'),
            ],
        );
    }
}

按需通知

use Illuminate\Support\Facades\Notification;
use Revolution\Nostr\Notifications\NostrRoute;

Notification::route('nostr', NostrRoute::to(sk: 'sk'))
    ->notify(new TestNotification());

与 User 模型集成

use Illuminate\Notifications\Notifiable;
use Revolution\Nostr\Notifications\NostrRoute;

class User
{
    use Notifiable;

    public function routeNotificationForNostr($notification): NostrRoute
    {
        return NostrRoute::to(sk: $this->sk, relays: ['wss://']);
    }
}

$user->notify(new TestNotification());

通知中使用的 relay 服务器

默认情况下会使用 config/nostr.php 中配置的所有 relay。也可以通过 NostrRoute 在运行时指定 relay。

use Revolution\Nostr\Notifications\NostrRoute;

return NostrRoute::to(sk: 'sk', relays: ['wss://', 'wss://']);

更多最新信息请参见 GitHub 仓库。

GitHub Copilot

SDK

AI SDK

VOICEVOX

启动套件

Feed 与 RSS

中间件

概览

驱动

配置默认驱动

安装

密钥管理

生成密钥

转换密钥

获取事件

获取多个事件

获取单个事件

发布事件

发布到单个 relay

发布到多个 relay（pool）

Relay 服务器配置

使用的 relay 服务器

在运行时更换 relay

NIP-05 profile

NIP-17 Private Direct Messages

发送私信

解密私信

Laravel Notifications

Notification 类

按需通知

与 User 模型集成

通知中使用的 relay 服务器

​概览

​驱动

​配置默认驱动

​安装

​密钥管理

​生成密钥

​转换密钥

​获取事件

​获取多个事件

​获取单个事件

​发布事件

​发布到单个 relay

​发布到多个 relay（pool）

​Relay 服务器配置

​使用的 relay 服务器

​在运行时更换 relay

​NIP-05 profile

​NIP-17 Private Direct Messages

​发送私信

​解密私信

​Laravel Notifications

​Notification 类

​按需通知

​与 User 模型集成

​通知中使用的 relay 服务器

概览

驱动

配置默认驱动

安装

密钥管理

生成密钥

转换密钥

获取事件

获取多个事件

获取单个事件

发布事件

发布到单个 relay

发布到多个 relay（pool）

Relay 服务器配置

使用的 relay 服务器

在运行时更换 relay

NIP-05 profile

NIP-17 Private Direct Messages

发送私信

解密私信

Laravel Notifications

Notification 类

按需通知

与 User 模型集成

通知中使用的 relay 服务器