Laravel Nostr

Overzicht

revolution/laravel-nostr is een pakket om het Nostr-protocol vanuit Laravel te gebruiken. Het biedt het genereren en converteren van keys, het ophalen en publiceren van events, pool-ondersteuning (meerdere relays), NIP-05-profielen, NIP-17 Private Direct Messages en integratie met Laravel Notifications.

Omdat de Nostr-specificatie nog volop in ontwikkeling is, wordt ook dit pakket continu doorontwikkeld. De notificatiefunctionaliteit is al goed bruikbaar in de praktijk.

Drivers

Dit pakket heeft twee drivers.

Driver	Beschrijving
`native`	Implementatie die volledig in PHP werkt. Gebruikt nostr-php. Tegenwoordig volstaat deze driver.
`node`	Implementatie die afhankelijk is van een externe WebAPI (Node.js).

Het unieke aan de native-driver is de implementatie van WebSocketHttpMixin. Deze maakt via de HTTP-client van Laravel verbinding met een WebSocket en verbreekt de verbinding direct na het versturen en ontvangen van data. Je hoeft geen WebSocket-server draaiende te houden; het ontwerp is zo dat elke Laravel-gebruiker het kan gebruiken.

De native-driver ondersteunt NIP-04 niet.

Standaarddriver instellen

Stel dit in via config/nostr.php of .env.

// config/nostr.php

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

NOSTR_DRIVER=native

Als je geen driver opgeeft, wordt de standaarddriver gebruikt.

use Revolution\Nostr\Facades\Nostr;

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

Je kunt de driver ook expliciet opgeven.

use Revolution\Nostr\Facades\Nostr;

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

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

Installatie

Pakket installeren

composer require revolution/laravel-nostr

Configuratiebestand publiceren

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

Keybeheer

Keys genereren

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...',
// ]

Keys converteren

Converteren vanuit een nsec.

use Revolution\Nostr\Facades\Nostr;

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

Converteren vanuit een secret key.

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

Converteren vanuit een npub (alleen publieke sleutel).

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

Converteren vanuit een public key.

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

Events ophalen

Meerdere events ophalen

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' => '...'],
// ]

Eén event ophalen

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: ""}']

Events publiceren

Publiceren naar één 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');
}

Publiceren naar meerdere relays (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 is array<string, Response>
// ['wss://relay1' => $response, 'wss://relay2' => $response]

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

Relayservers configureren

Welke relayservers worden gebruikt

Als je alleen Nostr::event() gebruikt, wordt de eerste relay uit config/nostr.php gebruikt. Bij Nostr::pool() worden alle relays uit de configuratie gebruikt.

Relays wijzigen tijdens runtime

use Revolution\Nostr\Facades\Nostr;

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

use Revolution\Nostr\Facades\Nostr;

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

NIP-05-profielen

use Revolution\Nostr\Facades\Nostr;

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

NIP-17 Private Direct Messages

NIP-17 wordt alleen ondersteund door de native-driver.

Een privébericht versturen

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!'
    );

Een privébericht ontsleutelen

use Revolution\Nostr\Facades\Nostr;

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

$decryptedMessage = $response->json();

Laravel Notifications

Met NostrChannel kun je vanuit Laravel Notifications berichten versturen naar Nostr.

De Notification-klasse

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(
            // #laravel in content is voor weergave; de HashTag in tags is voor classificatie op protocolniveau
            content: 'hello #laravel',
            tags: [
                HashTag::make(t: 'laravel'),
            ],
        );
    }
}

On-demand notificaties

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

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

Integratie met het User-model

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());

Relayservers voor notificaties

Standaard worden alle relays uit config/nostr.php gebruikt. Door relays op te geven via NostrRoute kun je dit tijdens runtime wijzigen.

use Revolution\Nostr\Notifications\NostrRoute;

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

Zie de GitHub-repository voor de meest recente informatie.

GitHub Copilot

SDK

AI SDK

VOICEVOX

Starter kits

Feeds en RSS

Middleware

Overzicht

Drivers

Standaarddriver instellen

Installatie

Keybeheer

Keys genereren

Keys converteren

Events ophalen

Meerdere events ophalen

Eén event ophalen

Events publiceren

Publiceren naar één relay

Publiceren naar meerdere relays (pool)

Relayservers configureren

Welke relayservers worden gebruikt

Relays wijzigen tijdens runtime

NIP-05-profielen

NIP-17 Private Direct Messages

Een privébericht versturen

Een privébericht ontsleutelen

Laravel Notifications

De Notification-klasse

On-demand notificaties

Integratie met het User-model

Relayservers voor notificaties

​Overzicht

​Drivers

​Standaarddriver instellen

​Installatie

​Keybeheer

​Keys genereren

​Keys converteren

​Events ophalen

​Meerdere events ophalen

​Eén event ophalen

​Events publiceren

​Publiceren naar één relay

​Publiceren naar meerdere relays (pool)

​Relayservers configureren

​Welke relayservers worden gebruikt

​Relays wijzigen tijdens runtime

​NIP-05-profielen

​NIP-17 Private Direct Messages

​Een privébericht versturen

​Een privébericht ontsleutelen

​Laravel Notifications

​De Notification-klasse

​On-demand notificaties

​Integratie met het User-model

​Relayservers voor notificaties

Overzicht

Drivers

Standaarddriver instellen

Installatie

Keybeheer

Keys genereren

Keys converteren

Events ophalen

Meerdere events ophalen

Eén event ophalen

Events publiceren

Publiceren naar één relay

Publiceren naar meerdere relays (pool)

Relayservers configureren

Welke relayservers worden gebruikt

Relays wijzigen tijdens runtime

NIP-05-profielen

NIP-17 Private Direct Messages

Een privébericht versturen

Een privébericht ontsleutelen

Laravel Notifications

De Notification-klasse

On-demand notificaties

Integratie met het User-model

Relayservers voor notificaties