swentel/nostr-php

Nostr helper library for PHP

1.2.3 2024-03-08 21:15 UTC

Requires

• php: ^8.1
• ext-gmp: *
• ext-xml: *
• bitwasp/bech32: ^0.0.1
• phrity/websocket: ^2.1
• simplito/elliptic-php: ^1.0
• uma/phpecc: ^0.1.3

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.51
• phpunit/phpunit: ^10.5

GPL-2.0-or-later

• Sebastian Hagens
• Kristof De Jaeger

README

This is a PHP Helper library for Nostr. More info about Nostr: https://github.com/nostr-protocol/nostr.

If you need any help, please join this Telegram group: https://t.me/nostr_php

Installation

To use in your project with Composer:

$ composer require swentel/nostr-php

Install dependencies if you would like to test / code some things out for yourself with the code example snippets below.

$ composer install

Create an event

This will create an event object with a short text message (kind 1).

use swentel\nostr\Event\Event;

$note = new Event();
$note->setKind(1);
$note->setContent('Hello world!');
$note->setTags([
  ['e', $relayUrl],
  ['p', $public_key, $relayUrl],
  ['r', $relayUrl],
]);
// or use addTag()
$note->addTag(['p', $public_key, $relayUrl]);

Signing an event

Generates the id and signature for an event. The 'pubkey', 'id' and 'sig' properties are added to the event object.

use swentel\nostr\Event\Event;
use swentel\nostr\Sign\Sign;

$note = new Event();
$note->setContent('Hello world!');
$note->setKind(1);

$signer = new Sign();
$signer->signEvent($note, $private_key);

Generating a message

Generate an event message : ["EVENT", <event JSON as created above with id and sig>]

use swentel\nostr\Sign\Sign;
use swentel\nostr\Message\EventMessage;

$signer = new Sign();
$signer->signEvent($note, $private_key);

$eventMessage = new EventMessage($note);
$message_string = $eventMessage->generate();

Interacting with a relay

Publish an event with a note that has been prepared for sending to a relay.

use swentel\nostr\Event\Event;
use swentel\nostr\Message\EventMessage;
use swentel\nostr\Relay\Relay;

$note = new Event();
$note->setContent('Hello world');
$note->setKind(1);

$signer = new Sign();
$signer->signEvent($note, $private_key);

$eventMessage = new EventMessage($note);

$relayUrl = 'wss://nostr-websocket.tld';
$relay = new Relay($relayUrl, $eventMessage);
$result = $relay->send();

Generating a private key and a public key

use swentel\nostr\Key\Key;

$key = new Key();

$private_key = $key->generatePrivateKey();
$public_key  = $key->getPublicKey($private_key);

Converting keys

Convert bech32 encoded keys (npub, nsec) to hex.

use swentel\nostr\Key\Key;

$public_key = 'npub10elfcs4fr0l0r8af98jlmgdh9c8tcxjvz9qkw038js35mp4dma8qzvjptg';
$key = new Key();
$hex = $key->convertToHex($public_key);

Convert hex keys to bech32 (npub, nsec).

use swentel\nostr\Key\Key;

$public_key = '7e7e9c42a91bfef19fa929e5fda1b72e0ebc1a4c1141673e2794234d86addf4e';
$private_key = '67dea2ed018072d675f5415ecfaed7d2597555e202d85b3d65ea4e58d2d92ffa';
$key = new Key();
$bech32_public = $key->convertPublicKeyToBech32($public_key);
$bech32_private = $key->convertPrivateKeyToBech32($private_key);

Run tests

All tests can be found in tests.

$ php vendor/bin/phpunit

nostr-php script (cli client)

The library ships with a simple CLI client (bin/nostr-php) to post a short text note to a Nostr relay.

Usage:
$ bin/nostr-php --content "Hello world!" --key /home/path/to/nostr-private.key --relay wss://nostr.pleb.network

Note: the key arguments expects a file with your private key! Do not paste your private key on command line.

Roadmap

• Keypair generation and validation
  • Convert from hex to bech32-encoded keys
• Event signing with Schnorr signatures (secp256k1)
• Event validation (issue #17)
• Support NIP-01 basic protocol flow description
  • Publish events
  • Request events (pr #48)
• Improve handling relay responses
• Support NIP-19 bech32-encoded identifiers
• Support NIP-42 authentication of clients to relays
• Support NIP-45 event counts
• Support NIP-50 search capability
• Support multi-threading for handling requests simultaneously

Maintainers

• @sebastix npub1qe3e5wrvnsgpggtkytxteaqfprz0rgxr8c3l34kk3a9t7e2l3acslezefe
• @swentel (original author, inactive) npub1z8n2zt0vzkefhrhpf60face4wwq2nx87sz7wlgcvuk4adddkkycqknzjk5