PHP Helper library for Nostr. More info about Nostr: https://github.com/nostr-protocol/nostr
To use in your project
$ composer require swentel/nostr-php
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($event, $private_key);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($event, $private_key);
$eventMessage = new EventMessage($event);
$message_string = $eventMessage->generate();Publish 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($event);
$websocket = 'wss://nostr-websocket.tld';
$relay = new Relay($websocket, $eventMessage);
$result = $relay->send();use swentel\nostr\Key\Key;
$key = new Key();
$private_key = $key->generatePrivateKey();
$public_key = $key->getPublicKey($private_key);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);The library ships with a simple client to post a text note to a Nostr relay.
Usage:
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.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent