Repository files navigation

nostr nodejs library

const{RelayPool}=require('nostr')constjb55="32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245"constdamus="wss://relay.damus.io"constscsi="wss://nostr-pub.wellorder.net"constrelays=[damus,scsi]constpool=RelayPool(relays)pool.on('open',relay=>{relay.subscribe("subid",{limit:2,kinds:[1],authors:[jb55]})});pool.on('eose',relay=>{relay.close()});pool.on('event',(relay,sub_id,ev)=>{console.log(ev)});

Connect to a pool of relays. You should use this instead ofRelay directly.

options:{reconnect: true|false}, defaults to{reconnect: true}

const relays = [`wss://relay1.com`, `wss://relay2.com`]const pool = RelayPool(relays, {reconnect: false})

Connect to a relay

options:{reconnect: true|false}, defaults to{reconnect: true}

const relay = Relay(`wss://relay.damus.io`, {reconnect: false})

Calculate an id from an event

Create a signature for an id

Verify an event

Returns: true if valid signature, false otherwise

Decrypt a direct message

Returns: decrypted content

Encrypt a direct message

Returns: encrypted content

Get a public key from a privkey

Create a delegation. This givespublisherPubkey permission to create eventson theprivkeys behalf subject toconditions

privkey: authorizer private key

publisherKey: delegate/publisher pubkey

conditions:& separated set of event creation permissions that the delegateis required to adhere to when creating events

eg:created_at>1669303873&created_at<1674574279&kind=1,7

Returns:

{pubkey,publisherPubkey,conditions,token}

Wheretoken is the delegation token, which is a signature from the authorizerof the delegationnostr:delegation:publisher_key:.

Create a delegated event from adelegation. This is an event posted on behalfofdelegation.pubkey subject todelegation.conditions.

delegation: a delegation in the form returned bycreateDelegation

publisherPrivkey: the private key of the delegate, the entity posting on behalf ofdelegation.pubkey

event: The event to post as a delegate. The eventpubkey will be overriddenby thepublisherPubkey. The delegation tag will be upserted into the taglist.

Sign a delegation string in the formnostr:delegation:....

Returns: a signature string called the delegation token.