https://github.com/snowcait/restr

Nostr REST API proxy
https://github.com/snowcait/restr

nostr

Last synced: 2 months 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 (8 months ago)
• Default Branch: main
• Last Pushed: 2024-09-16T02:15:01.000Z (4 months ago)
• Last Synced: 2024-09-16T05:39:56.279Z (4 months ago)
• Topics: nostr
• Language: TypeScript
• Homepage:
• Size: 55.7 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Restr

Nostr REST API proxy on Cloudflare Workers.

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

```

npm install

npm run dev

```

## Test

```

cd test/

docker compose up --build -d --wait

npm test

docker compose down --volumes

```

## Deploy

```

npm run deploy

```