https://github.com/KiPSOFT/nostr-deno

Nostr protocol client library for deno runtime.
https://github.com/KiPSOFT/nostr-deno

client deno library nodejs nostr typescript

Last synced: 26 days ago
JSON representation

Nostr protocol client library for deno runtime.

• Host: GitHub
• URL: https://github.com/KiPSOFT/nostr-deno
• Owner: KiPSOFT
• License: mit
• Created: 2022-12-24T11:28:35.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-02-05T02:57:21.000Z (over 1 year ago)
• Last Synced: 2024-05-02T03:05:51.110Z (about 2 months ago)
• Topics: client, deno, library, nodejs, nostr, typescript
• Language: TypeScript
• Homepage:
• Size: 876 KB
• Stars: 24
• Watchers: 2
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-nostr - nostr-deno - deno.svg?style=social) - a client library for Deno javascript runtime. (Libraries / Client reviews and/or comparisons)
• Self-Hosting-Guide - nostr-deno - a client library for Deno javascript runtime. (Install from Source / Nostr)

README

        
## Nostr Deno Client Library

Nostr protocol client library for deno runtime.

Nostr - https://github.com/nostr-protocol/nostr

Deno - https://deno.land/

### Features

---

 - [x] Multiple relay support

 - [x] Profile information

 - [x] Global feed

 - [x] User's posts

 - [x] Follows

 - [x] Followers

 - [x] Reply post.

 - [x] Debug mode.

 - [x] Promise-based simple and easy to use.

 - [x] Encrypted send and receive direc messages.

 - [x] npub and nsec prefix key support.

 - [x] Async iterable filters.

### Usage

---

```javascript

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

---

 - [ ] NIP-05 DNS-based internet identifier checking.

 - [ ] Add user for follow.

 - [ ] Public chat (channels).

 - [ ] Hashtag list. NIP-12

 - [ ] Filter posts with hashtag.

 - [ ] CI for deno build.