https://github.com/CodyTseng/nostr-relay-nestjs
A high-performance nostr relay, using PostgreSQL. (Thanks to https://opensats.org/ for their generous donation!)
https://github.com/CodyTseng/nostr-relay-nestjs
meilisearch nestjs nostr postgresql relay typescript wot
Last synced: 4 months ago
JSON representation
A high-performance nostr relay, using PostgreSQL. (Thanks to https://opensats.org/ for their generous donation!)
- Host: GitHub
- URL: https://github.com/CodyTseng/nostr-relay-nestjs
- Owner: CodyTseng
- License: mit
- Created: 2023-03-19T16:22:55.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-18T09:22:38.000Z (about 1 year ago)
- Last Synced: 2024-09-18T15:39:53.695Z (about 1 year ago)
- Topics: meilisearch, nestjs, nostr, postgresql, relay, typescript, wot
- Language: TypeScript
- Homepage:
- Size: 2.18 MB
- Stars: 42
- Watchers: 3
- Forks: 6
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- Self-Hosting-Guide - nostr-relay-nestjs - A Nostr relay implemented using the NestJS framework (Install from Source / Nostr)
- awesome-nostr - nostr-relay-nestjs - relay-nestjs.svg?style=social) - A Nostr relay with a clear architecture and high test coverage (PostgreSQL, MeiliSearch, NestJS) (Relays / Implementations)
README
# Nostr Relay NestJS
[](https://coveralls.io/github/CodyTseng/nostr-relay-nestjs?branch=master)
[](https://app.fossa.com/projects/git%2Bgithub.com%2FCodyTseng%2Fnostr-relay-nestjs?ref=badge_shield)
Powered by [nostr-relay](https://github.com/CodyTseng/nostr-relay) & [NestJS](https://nestjs.com/).
A high-performance nostr relay, using PostgreSQL.
If you'd like to help me test the reliability of this relay implementation, you can add wss://nostr-relay.app to your relay list (it's free) 💜⚡️
> **Note:** Please use the released version of this code. The latest version may contain changes to migration scripts and other elements that are not finalized.
[](https://railway.app/template/ooFSnW?referralCode=WYIfFr)
## Features
🟢 Full implemented 🟡 Partially implemented 🔴 Not implemented
| Feature | Status | Note |
| ------------------------------------------------------------------------------------------------------------------------ | :----: | ---------------------------------------- |
| [NIP-01: Basic protocol flow description](https://github.com/nostr-protocol/nips/blob/master/01.md) | 🟢 | |
| [NIP-02: Follow List](https://github.com/nostr-protocol/nips/blob/master/02.md) | 🟢 | |
| [NIP-04: Encrypted Direct Message](https://github.com/nostr-protocol/nips/blob/master/04.md) | 🟢 | |
| [NIP-05: Mapping Nostr keys to DNS-based internet identifiers](https://github.com/nostr-protocol/nips/blob/master/05.md) | 🟢 | |
| [NIP-09: Event Deletion](https://github.com/nostr-protocol/nips/blob/master/09.md) | 🔴 | No real deletion in a distributed system |
| [NIP-11: Relay Information Document](https://github.com/nostr-protocol/nips/blob/master/11.md) | 🟢 | |
| [NIP-13: Proof of Work](https://github.com/nostr-protocol/nips/blob/master/13.md) | 🟢 | |
| [NIP-22: Event created_at Limits](https://github.com/nostr-protocol/nips/blob/master/22.md) | 🟢 | |
| [NIP-26: Delegated Event Signing](https://github.com/nostr-protocol/nips/blob/master/26.md) | 🟢 | |
| [NIP-28: Public Chat](https://github.com/nostr-protocol/nips/blob/master/28.md) | 🟢 | |
| [NIP-40: Expiration Timestamp](https://github.com/nostr-protocol/nips/blob/master/40.md) | 🟢 | |
| [NIP-42: Authentication of clients to relays](https://github.com/nostr-protocol/nips/blob/master/42.md) | 🟢 | |
| [NIP-45: Counting results](https://github.com/nostr-protocol/nips/blob/master/45.md) | 🔴 | |
| [NIP-50: Keywords filter](https://github.com/nostr-protocol/nips/blob/master/50.md) | 🟢 | |
## Extra Features
### WoT (Web of Trust)
If you want to enable the WoT feature, you need to set the following environment variables:
- `WOT_TRUST_ANCHOR_PUBKEY`: The public key of the trust anchor. Trust anchor is the root of the trust net.
- `WOT_TRUST_DEPTH`: The depth of the trust net. If the trust depth is 1, the trust net will include the trust anchor and the trust anchor's following users. If the trust depth is 2, the trust net will include the trust anchor, the trust anchor's following users, and the trust anchor's following users' following users. Now the maximum trust depth is 2.
- `WOT_FETCH_FOLLOW_LIST_FROM`: Comma-separated list of relay URLs to fetch follow list from (e.g., WOT_FETCH_FOLLOW_LIST_FROM=wss://nostr-relay.app,wss://relay.damus.io). This environment variable is optional. The relay will always fetch the follow list from the local database first.
### RESTful API
You can see the API documentation at `/api` endpoint. [Example](https://nostr-relay.app/api)
### TOP verb
TOP verb accepts a subscription id and filters as specified in [NIP 01](https://github.com/nostr-protocol/nips/blob/master/01.md) for the verb REQ.
```json
["TOP",,...]
```
And return the top N event IDs with the highest score (Scoring is determined by relay).
```json
["TOP",,]
```
Example:
```json
["TOP","test",{"search":"nostr bitcoin","kinds":[30023],"limit":10}]
["TOP","test",["2359f4bdfe0bd2353aa7702dc1af23279197694823b8b4916b904a9940334192","622a875c9f9a4696eb4050fa5b0bba3a9b0531ec4a27398245af7369e6d40da8","d8989c65d26511b2e3ea42b0ebfcaf0ea885cb958419df4ddb334cb72556f950","ffcb0c9e0ace0b5d3928f30395bc9832763f8b583f2b1beb696f7c199f9f94d2","287147867bd00299553fa91e110d40206eea19a9142a4283832ee67e1407e6f2","ffaea8bc3b08db32af97f1ff595e68eee8a2f7b0a4a66dc2eff330f450855f6c","cddbc6cd4a0589d4a593e99a3a94426c85c6867b47d7eb751ce419c27f079b76","f2291ac6d206e898965b9e4ba6bbe5bb10118e6a74bd9f9f13597813979a254b","a101a2a44938dbb0a611bc00bd7ed4cb44d682fea4c14618bd1148567cd6fcc3","21990a723b491b6c594438a2ecf5d5e4898212635f59e82f1c736d994a86e907"]]
```
## Quick Start
### Dockerfile
Build image
```bash
./scripts/build.sh
```
Create `.env` file based on [example.env](./example.env) file
```.env
DATABASE_URL=postgresql://username:password@host:port/database
```
Run container
```bash
./scripts/run.sh
```
### Local Development
First of all, you need to have a PostgreSQL database running.
Clone the repository and install dependencies
```bash
git clone https://github.com/CodyTseng/nostr-relay-nestjs.git
cd nostr-relay-nestjs
npm install
```
Create `.env` file based on [example.env](./example.env) file
```.env
DATABASE_URL=postgresql://username:password@host:port/database
```
Execute migration scripts
```bash
npm run migration:run
```
Start the server
```bash
npm run start
```
### Running as a systemd service
It is best practice to not run services as root where possible. If you want to ignore that, remove the User and Group lines from the service file. Otherwise, start with creating a locked down user to run the service as
```bash
useradd --shell /bin/false nestjs
usermod -L nestjs
chown -R nestjs:nestjs /opt/nostr-relay-nestjs
chmod g+s /opt/nostr-relay-nestjs
```
The last two lines assume you cloned the project to /opt/nostr-relay-nestjs, update them as needed.
To create the service file, copy and paste the below to /etc/systemd/system/nostr-relay-nestjs.service
```
[Unit]
Description=Nostr Relay Nestjs Service
After=network.target
[Service]
User=nestjs
Group=nestjs
ExecStart=/usr/bin/npm run start
WorkingDirectory=/opt/nostr-relay-nestjs
Restart=always
MemoryMax=2G
[Install]
WantedBy=multi-user.target
```
Run `sudo systemctl daemon-reload`
Start, stop or check status with `systemctl start|stop|status nostr-relay-nestjs`
## Metrics
You can view some simple relay metrics on `/metrics` endpoint.
## TODO
- [x] Unit test
- [x] RESTful API
- [ ] Metrics, Monitoring and Alerting
- [ ] Support multi nodes
- [ ] Support for Bitcoin Lightning Network payments
## Architecture
## Donate
If you like this project, you can buy me a coffee :) ⚡️ codytseng@getalby.com ⚡️
## License
This project is MIT licensed.
[](https://app.fossa.com/projects/git%2Bgithub.com%2FCodyTseng%2Fnostr-relay-nestjs?ref=badge_large)