https://github.com/snowcait/restr
Nostr REST API proxy
https://github.com/snowcait/restr
nostr
Last synced: 1 day ago
JSON representation
Nostr REST API proxy
- Host: GitHub
- URL: https://github.com/snowcait/restr
- Owner: SnowCait
- License: mit
- Created: 2024-05-08T10:42:44.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-01T02:38:25.000Z (5 months ago)
- Last Synced: 2025-04-15T01:44:07.833Z (3 months ago)
- Topics: nostr
- Language: TypeScript
- Homepage:
- Size: 304 KB
- Stars: 13
- Watchers: 1
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Restr
Nostr REST API proxy.
Client implementation is simplified by having proxy server handle communication
with relays.\
It also reduces the amount of communication on client.
## Usage
### GET `/{nevent}`
`{nevent}` is [NIP-19](https://github.com/nostr-protocol/nips/blob/master/19.md)
and requires **id** and **relays**.
### GET `/{naddr}`
`{naddr}` is [NIP-19](https://github.com/nostr-protocol/nips/blob/master/19.md)
and requires **kind**, **pubkey**, **identifier** and **relays**.
### GET `/{nprofile}`
`{nprofile}` is
[NIP-19](https://github.com/nostr-protocol/nips/blob/master/19.md) and requires
**pubkey** and **relays**.
This is an alias of naddr with kind 0 and empty identifier.
### POST `/{nevent}`
`{nevent}` is [NIP-19](https://github.com/nostr-protocol/nips/blob/master/19.md)
and requires **relays**.
Request body is event JSON.
### POST `/req`
Fetch events.\
POST method is used because filters can be long.
Request body contains relays and filters.
```json
{
"relays": ["wss://example.com/"],
"filters": [{ "limit": 10 }]
}
```
### POST `/req/stream`
This is
[Server-Sent Events](https://developer.mozilla.org/docs/Web/API/Server-sent_events)
with POST method.\
POST method is used because filters can be long.\
Use a library which can handle POST method
([sse.js](https://www.npmjs.com/package/sse.js),
[launchdarkly-eventsource](https://www.npmjs.com/package/launchdarkly-eventsource),
[eventsource-client](https://www.npmjs.com/package/eventsource-client),
[@microsoft/fetch-event-source](https://www.npmjs.com/package/@microsoft/fetch-event-source),
etc.) instead of
[EventSource](https://developer.mozilla.org/docs/Web/API/EventSource).
Request body contains relays and filters.
```json
{
"relays": ["wss://example.com/"],
"filters": [{ "limit": 10 }]
}
```
## Development
```shell
npm install
npm run dev
```
## Test
```shell
cd test/
docker compose up --build -d --wait
npm test
docker compose down --volumes
```
## Deploy
### Cloudflare Workers
#### With Git integration
See [Document](https://developers.cloudflare.com/workers/ci-cd/builds/).
#### With Wrangler
```shell
npm run deploy
```
### Deno Deploy
#### With GitHub integration
See [Document](https://docs.deno.com/deploy/manual/how-to-deploy/).
#### With deployctl
See [Document](https://docs.deno.com/deploy/manual/deployctl/).
An example workflow of GitHub Actions is
[here](.github/workflows/deno-deploy.yml.example).
### Render
[](https://render.com/deploy)
### Docker
#### With Docker Compose
```shell
docker compose up
```
The origin is `http://localhost:8000`.