Home

Awesome

Nostr Deno Client Library

Nostr protocol client library for deno runtime.

Nostr - https://github.com/nostr-protocol/nostr Deno - https://deno.land/

Features

Usage

import { Nostr, Relay } from 'https://deno.land/x/nostr_deno_client/mod.ts';

const nostr = new Nostr();

nostr.privateKey = '';  // A private key is optional. Only used for sending posts.

nostr.relayList.push({
    name: 'Nostrprotocol',
    url: 'wss://relay.nostrprotocol.net'
});

nostr.relayList.push({
    name: 'Wellorder',
    url: 'wss://nostr-pub.wellorder.net'
});

nostr.on('relayConnected', (relay: Relay) => console.log('Relay connected.', relay.name));
nostr.on('relayError', (err: Error) => console.log('Relay error;', err));
nostr.on('relayNotice', (notice: string[]) => console.log('Notice', notice));

nostr.debugMode = true;

await nostr.connect();

await nostr.sendTextPost('Hello nostr deno client library.');

const posts = await nostr.getPosts();
console.log('Posts', posts);

const post = posts[posts.length - 1];
await nostr.sendReplyPost('Test reply.', post);

const profile = await nostr.getMyProfile();
console.log('Profile', profile);

const feeds = await nostr.globalFeed({
    limit: 10
});
console.log('Feeds', feeds);

//method 1: for await
console.log('iterable return');
for await (const note of nostr.filter(filter) ) {
    console.log(note);
}

//method 2: collect
console.log('promise return');
const allNotes = await nostr.filter(filter).collect();
console.log(allNotes);

//method 3: callback
console.log('callback return');
await nostr.filter(filter).each(note => {
    console.log(note);
});

await nostr.disconnect();
console.log('Finish');

Supported NIPs

NIP-01, NIP-02, NIP-04 NIP-05, NIP-08, NIP-10, NIP-19 NIP-20

Roadmap