psf-bch-api 1.1.0

package/examples/02-read-posts.js

@@ -0,0 +1,44 @@
+/*
+  Example script for reading posts (kind 1 events) from a relay.
+  Refactored to use REST API instead of WebSocket.
+
+  Run the server with `npm start` in the main directory, before running this example.
+*/
+
+const API_URL = process.env.API_URL || 'http://localhost:5942'
+
+// JB55's public key
+const jb55 = '32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245'
+
+// Create subscription ID
+const subId = 'read-posts-' + Date.now()
+
+// Create filters - read posts from JB55
+const filters = {
+  limit: 2,
+  kinds: [1],
+  authors: [jb55]
+}
+
+try {
+  // Query events using GET /req/:subId
+  const filtersJson = encodeURIComponent(JSON.stringify([filters]))
+  const url = `${API_URL}/req/${subId}?filters=${filtersJson}`
+
+  console.log(`Querying events from ${API_URL}`)
+  console.log('Filters:', JSON.stringify(filters, null, 2))
+
+  const response = await fetch(url)
+  const events = await response.json()
+
+  console.log(`\nReceived ${events.length} events:`)
+  events.forEach((ev, index) => {
+    console.log(`\nEvent ${index + 1}:`)
+    console.log('  ID:', ev.id)
+    console.log('  Author:', ev.pubkey)
+    console.log('  Created:', new Date(ev.created_at * 1000).toISOString())
+    console.log('  Content:', ev.content)
+  })
+} catch (err) {
+  console.error('Error reading posts:', err)
+}

package/examples/03-write-post.js

@@ -0,0 +1,55 @@
+/*
+  Example script for writing a post to a relay.
+  Refactored to use REST API instead of WebSocket.
+
+  Run the server with `npm start` in the main directory, before running this example.
+*/
+
+import { finalizeEvent, getPublicKey } from 'nostr-tools/pure'
+import { hexToBytes } from '@noble/hashes/utils.js'
+
+const API_URL = process.env.API_URL || 'http://localhost:5942'
+
+// Alice is our user making the post.
+const alicePrivKeyHex = '3292a48aa331aeccce003d50d70fbd79617ba91860abbd2c78fa4a8301e36bc0'
+const alicePrivKeyBin = hexToBytes(alicePrivKeyHex)
+const alicePubKey = getPublicKey(alicePrivKeyBin)
+console.log(`Alice Public Key: ${alicePubKey}`)
+
+const now = new Date()
+
+// Generate a post.
+const eventTemplate = {
+  kind: 1,
+  created_at: Math.floor(Date.now() / 1000),
+  tags: [],
+  content: `This is a test message posted at ${now.toLocaleString()}`
+}
+console.log(`eventTemplate: ${JSON.stringify(eventTemplate, null, 2)}`)
+
+// Sign the post
+const signedEvent = finalizeEvent(eventTemplate, alicePrivKeyBin)
+console.log('signedEvent:', JSON.stringify(signedEvent, null, 2))
+
+// Publish to REST API
+try {
+  const response = await fetch(`${API_URL}/event`, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    body: JSON.stringify(signedEvent)
+  })
+
+  const result = await response.json()
+  console.log('result:', result)
+
+  if (result.accepted) {
+    console.log('Post published successfully!')
+    console.log('Event ID:', result.eventId)
+  } else {
+    console.error('Failed to publish:', result.message)
+  }
+} catch (err) {
+  console.error('Error publishing post:', err)
+}

package/examples/04-read-alice-posts.js

@@ -0,0 +1,49 @@
+/*
+  Example script for reading posts from user Alice.
+  Refactored to use REST API instead of WebSocket.
+
+  Run the server with `npm start` in the main directory, before running this example.
+*/
+
+import { getPublicKey } from 'nostr-tools/pure'
+import { hexToBytes } from '@noble/hashes/utils.js'
+
+const API_URL = process.env.API_URL || 'http://localhost:5942'
+
+// Alice is our user.
+const alicePrivKeyHex = '3292a48aa331aeccce003d50d70fbd79617ba91860abbd2c78fa4a8301e36bc0'
+const alicePrivKeyBin = hexToBytes(alicePrivKeyHex)
+const alicePubKey = getPublicKey(alicePrivKeyBin)
+console.log(`Alice Public Key: ${alicePubKey}`)
+
+// Create subscription ID
+const subId = 'read-alice-posts-' + Date.now()
+
+// Create filters - read posts from Alice
+const filters = {
+  limit: 2,
+  kinds: [1],
+  authors: [alicePubKey]
+}
+
+try {
+  // Query events using GET /req/:subId
+  const filtersJson = encodeURIComponent(JSON.stringify([filters]))
+  const url = `${API_URL}/req/${subId}?filters=${filtersJson}`
+
+  console.log(`Querying events from ${API_URL}`)
+  console.log('Filters:', JSON.stringify(filters, null, 2))
+
+  const response = await fetch(url)
+  const events = await response.json()
+
+  console.log(`\nReceived ${events.length} events from Alice:`)
+  events.forEach((ev, index) => {
+    console.log(`\nEvent ${index + 1}:`)
+    console.log('  ID:', ev.id)
+    console.log('  Created:', new Date(ev.created_at * 1000).toISOString())
+    console.log('  Content:', ev.content)
+  })
+} catch (err) {
+  console.error('Error reading Alice posts:', err)
+}

package/examples/05-get-follow-list.js

@@ -0,0 +1,53 @@
+/*
+  Example script for getting a follow list (kind 3 events).
+  Refactored to use REST API instead of WebSocket.
+
+  Run the server with `npm start` in the main directory, before running this example.
+*/
+
+import { getPublicKey } from 'nostr-tools/pure'
+import { hexToBytes } from '@noble/hashes/utils.js'
+
+const API_URL = process.env.API_URL || 'http://localhost:5942'
+
+// Alice is our user to get the follow list.
+const alicePrivKeyHex = '3292a48aa331aeccce003d50d70fbd79617ba91860abbd2c78fa4a8301e36bc0'
+const alicePrivKeyBin = hexToBytes(alicePrivKeyHex)
+const alicePubKey = getPublicKey(alicePrivKeyBin)
+console.log(`Alice Public Key: ${alicePubKey}`)
+
+// Create subscription ID
+const subId = 'get-follow-list-' + Date.now()
+
+// Create filters - get follow list (kind 3) from Alice
+const filters = {
+  limit: 5,
+  kinds: [3],
+  authors: [alicePubKey]
+}
+
+try {
+  // Query events using GET /req/:subId
+  const filtersJson = encodeURIComponent(JSON.stringify([filters]))
+  const url = `${API_URL}/req/${subId}?filters=${filtersJson}`
+
+  console.log(`Querying follow list from ${API_URL}`)
+  console.log('Filters:', JSON.stringify(filters, null, 2))
+
+  const response = await fetch(url)
+  const events = await response.json()
+
+  if (events.length > 0) {
+    // Get the most recent follow list (kind 3 events are replaceable)
+    const followListEvent = events[0]
+    const aliceFollowList = followListEvent.tags.filter(tag => tag[0] === 'p')
+    console.log(`\nAlice Follow list (${aliceFollowList.length} followed users):`)
+    aliceFollowList.forEach((tag, index) => {
+      console.log(`  ${index + 1}. ${tag[1]}${tag[3] ? ` (${tag[3]})` : ''}`)
+    })
+  } else {
+    console.log('\nNo follow list found for Alice')
+  }
+} catch (err) {
+  console.error('Error getting follow list:', err)
+}

package/examples/06-update-follow-list.js

@@ -0,0 +1,63 @@
+/*
+  Example to update the follow list with a new list of people to follow.
+  Refactored to use REST API instead of WebSocket.
+
+  Run the server with `npm start` in the main directory, before running this example.
+*/
+
+import { finalizeEvent, getPublicKey } from 'nostr-tools/pure'
+import { hexToBytes } from '@noble/hashes/utils.js'
+
+const API_URL = process.env.API_URL || 'http://localhost:5942'
+
+// Alice wants to update her follow list
+const alicePrivKeyHex = '3292a48aa331aeccce003d50d70fbd79617ba91860abbd2c78fa4a8301e36bc0'
+const alicePrivKeyBin = hexToBytes(alicePrivKeyHex)
+const alicePubKey = getPublicKey(alicePrivKeyBin)
+console.log(`Alice Public Key: ${alicePubKey}`)
+
+// Bob is the person to be added to the new follow list
+const bobPrivKeyHex = 'd2e71a977bc3900d6b0f787421e3d1a666cd12ca625482b0d9eeffd23489c99f'
+const bobPrivKeyBin = hexToBytes(bobPrivKeyHex)
+const bobPubKey = getPublicKey(bobPrivKeyBin)
+console.log(`Bob Public Key: ${bobPubKey}`)
+
+const psf = 'wss://nostr-relay.psfoundation.info'
+
+const followList = [
+  ['p', bobPubKey, psf, 'bob']
+]
+
+// Generate a follow list event (kind 3)
+const eventTemplate = {
+  kind: 3,
+  created_at: Math.floor(Date.now() / 1000),
+  tags: followList,
+  content: ''
+}
+console.log(`eventTemplate: ${JSON.stringify(eventTemplate, null, 2)}`)
+
+// Sign the event
+const signedEvent = finalizeEvent(eventTemplate, alicePrivKeyBin)
+
+// Publish to REST API
+try {
+  const response = await fetch(`${API_URL}/event`, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    body: JSON.stringify(signedEvent)
+  })
+
+  const result = await response.json()
+  console.log('Publish result:', result)
+
+  if (result.accepted) {
+    console.log('Follow list updated successfully!')
+  } else {
+    console.error('Failed to update follow list:', result.message)
+  }
+} catch (err) {
+  console.error('Error updating follow list:', err)
+}

package/examples/07-liking-event.js

@@ -0,0 +1,59 @@
+/*
+  Example script for adding a reaction (like) to an event.
+  Refactored to use REST API instead of WebSocket.
+  https://github.com/nostr-protocol/nips/blob/master/25.md
+
+  Run the server with `npm start` in the main directory, before running this example.
+*/
+
+import { hexToBytes } from '@noble/hashes/utils.js'
+import { finalizeEvent, getPublicKey } from 'nostr-tools/pure'
+
+const API_URL = process.env.API_URL || 'http://localhost:5942'
+
+const bobPrivKeyHex = 'd2e71a977bc3900d6b0f787421e3d1a666cd12ca625482b0d9eeffd23489c99f'
+const bobPrivKeyBin = hexToBytes(bobPrivKeyHex)
+const bobPubKey = getPublicKey(bobPrivKeyBin)
+
+const psf = 'wss://nostr-relay.psfoundation.info'
+
+const evIdToLike = 'd09b4c5da59be3cd2768aa53fa78b77bf4859084c94f3bf26d401f004a9c8167'
+const evIdAuthorPubKey = '2c7e76c0f8dc1dca9d0197c7d19be580a8d074ccada6a2f6ebe056ae41092e92'
+
+// Generate like event (kind 7)
+const likeEventTemplate = {
+  kind: 7,
+  created_at: Math.floor(Date.now() / 1000),
+  pubkey: bobPubKey,
+  tags: [
+    ['e', evIdToLike, psf], // "e" tag includes event id, relay reference
+    ['p', evIdAuthorPubKey, psf] // "p" tag includes author pubkey, relay reference
+  ],
+  content: '+'
+}
+
+// Sign the event
+const signedEvent = finalizeEvent(likeEventTemplate, bobPrivKeyBin)
+console.log('signedEvent:', JSON.stringify(signedEvent, null, 2))
+
+// Publish to REST API
+try {
+  const response = await fetch(`${API_URL}/event`, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    body: JSON.stringify(signedEvent)
+  })
+
+  const result = await response.json()
+  console.log('result:', result)
+
+  if (result.accepted) {
+    console.log('Like published successfully!')
+  } else {
+    console.error('Failed to publish like:', result.message)
+  }
+} catch (err) {
+  console.error('Error publishing like:', err)
+}

package/examples/README.md

@@ -0,0 +1,90 @@
+# REST2NOSTR Examples
+
+This directory contains examples refactored from the `nostr-sandbox/` directory to use the REST API instead of WebSocket connections.
+
+## Prerequisites
+
+1. Install dependencies:
+```bash
+npm install nostr-tools @noble/hashes
+```
+
+2. Start the REST2NOSTR proxy server:
+```bash
+npm start
+```
+
+3. Set the API_URL environment variable if the server is not running on localhost:3000:
+```bash
+export API_URL=http://localhost:3000
+```
+
+## Examples
+
+### 01-create-account.js
+Creates a new Nostr account keypair and publishes profile metadata (kind 0 event).
+
+```bash
+node examples/01-create-account.js
+```
+
+### 02-read-posts.js
+Reads posts (kind 1 events) from a specific author using GET /req/:subId.
+
+```bash
+node examples/02-read-posts.js
+```
+
+### 03-write-post.js
+Publishes a text post (kind 1 event) using POST /event.
+
+```bash
+node examples/03-write-post.js
+```
+
+### 04-read-alice-posts.js
+Reads posts from Alice's account using GET /req/:subId with author filter.
+
+```bash
+node examples/04-read-alice-posts.js
+```
+
+### 14-get-follow-list.js
+Retrieves a user's follow list (kind 3 event) using GET /req/:subId.
+
+```bash
+node examples/05-get-follow-list.js
+```
+
+### 15-update-follow-list.js
+Updates a user's follow list (kind 3 event) using POST /event.
+
+```bash
+node examples/06-update-follow-list.js
+```
+
+### 17-liking-event.js
+Adds a reaction/like to an event (kind 7 event) using POST /event.
+
+```bash
+node examples/07-liking-event.js
+```
+
+## API Endpoints Used
+
+- **POST /event**: Publish events to the relay
+- **GET /req/:subId**: Stateless query for events (returns immediately)
+
+## Differences from WebSocket Examples
+
+1. **No WebSocket connections**: All communication is via HTTP REST API
+2. **Stateless queries**: GET /req/:subId returns events immediately rather than streaming
+3. **Event publishing**: POST /event returns immediately with acceptance status
+4. **No subscription management**: For stateless queries, subscriptions are automatically closed after EOSE
+
+## Notes
+
+- These examples use the same private keys as the original sandbox examples for consistency
+- The REST API handles WebSocket connections to relays internally
+- For real-time streaming, use POST /req/:subId which supports Server-Sent Events (SSE)
+

package/index.js

@@ -0,0 +1,11 @@
+/*
+  Main entry point for REST2NOSTR Proxy API
+*/
+
+import Server from './bin/server.js'
+
+const server = new Server()
+server.startServer().catch(err => {
+  console.error('Failed to start server:', err)
+  process.exit(1)
+})

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "psf-bch-api",
+  "version": "1.1.0",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "start": "node bin/server.js",
+    "docs": "./node_modules/.bin/apidoc -i src/ -o docs",
+    "lint": "standard --env mocha --fix",
+    "test": "npm run lint && TEST=unit c8 mocha 'test/unit/**/*.js' --exit",
+    "test:integration": "mocha --timeout 25000 'test/integration/**/*.js' --exit",
+    "coverage": "c8 --reporter=html mocha 'test/unit/**/*.js' --exit"
+  },
+  "author": "Chris Troutner <chris.troutner@gmail.com>",
+  "license": "MIT",
+  "description": "REST API proxy to Bitcoin Cash infrastructure",
+  "dependencies": {
+    "axios": "1.7.7",
+    "cors": "2.8.5",
+    "dotenv": "16.3.1",
+    "express": "5.1.0",
+    "winston": "3.11.0",
+    "winston-daily-rotate-file": "4.7.1"
+  },
+  "devDependencies": {
+    "apidoc": "1.2.0",
+    "c8": "10.1.3",
+    "chai": "6.2.0",
+    "mocha": "11.7.4",
+    "sinon": "21.0.0",
+    "standard": "17.1.2"
+  },
+  "apidoc": {
+    "title": "psf-bch-api",
+    "url": "http://localhost:3070"
+  }
+}

package/production/docker/Dockerfile

@@ -0,0 +1,85 @@
+# Create a Dockerized API server
+#
+
+#IMAGE BUILD COMMANDS
+# ct-base-ubuntu = ubuntu 18.04 + nodejs v10 LTS
+#FROM christroutner/ct-base-ubuntu
+FROM ubuntu:22.04
+MAINTAINER Chris Troutner <chris.troutner@gmail.com>
+
+#Update the OS and install any OS packages needed.
+RUN apt-get update
+RUN apt-get install -y sudo git curl nano gnupg wget zip unzip python3
+
+#Install Node and NPM
+RUN curl -sL https://deb.nodesource.com/setup_20.x -o nodesource_setup.sh
+RUN bash nodesource_setup.sh
+RUN apt-get install -y nodejs build-essential
+
+#Create the user 'safeuser' and add them to the sudo group.
+RUN useradd -ms /bin/bash safeuser
+RUN adduser safeuser sudo
+
+#Set password to 'password' change value below if you want a different password
+RUN echo safeuser:password | chpasswd
+
+#Set the working directory to be the home directory
+WORKDIR /home/safeuser
+
+#Setup NPM for non-root global install
+RUN mkdir /home/safeuser/.npm-global
+RUN chown -R safeuser .npm-global
+RUN echo "export PATH=~/.npm-global/bin:$PATH" >> /home/safeuser/.profile
+RUN runuser -l safeuser -c "npm config set prefix '~/.npm-global'"
+
+# Update to the latest version of npm.
+#RUN npm install -g npm@8.3.0
+
+# npm mirror to prevent direct dependency on npm.
+#RUN npm set registry http://94.130.170.209:4873/
+
+# Switch to user account.
+#USER safeuser
+# Prep 'sudo' commands.
+#RUN echo 'abcd8765' | sudo -S pwd
+
+#RUN npm install -g node-gyp
+
+# Clone the rest.bitcoin.com repository
+WORKDIR /home/safeuser
+RUN git clone https://github.com/christroutner/REST2NOSTR
+
+# Switch to the desired branch. `master` is usually stable,
+# and `stage` has the most up-to-date changes.
+WORKDIR /home/safeuser/REST2NOSTR
+
+# For development: switch to unstable branch
+#RUN git checkout pin-ipfs
+
+# Install dependencies
+RUN npm install
+
+# Generate the API docs
+RUN npm run docs
+
+#VOLUME /home/safeuser/keys
+
+# Make leveldb folders
+#RUN mkdir leveldb
+#WORKDIR /home/safeuser/psf-slp-indexer/leveldb
+#RUN mkdir current
+#RUN mkdir zips
+#RUN mkdir backup
+#WORKDIR /home/safeuser/psf-slp-indexer/leveldb/zips
+#COPY restore-auto.sh restore-auto.sh
+#WORKDIR /home/safeuser/psf-slp-indexer
+
+# Expose the port the API will be served on.
+#EXPOSE 5011
+
+# Start the application.
+#COPY start-production.sh start-production.sh
+VOLUME start-rest2nostr.sh
+CMD ["./start-rest2nostr.sh"]
+
+#CMD ["npm", "start"]

package/production/docker/cleanup-images.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+# Remove all untagged docker images.
+docker rmi $(docker images | grep "^<none>" | awk '{print $3}')
+

package/production/docker/docker-compose.yml

@@ -0,0 +1,19 @@
+# Start the service with the command 'docker-compose up -d'
+
+services:
+    rest2nostr:
+      build: .
+      container_name: rest2nostr
+      logging:
+        driver: 'json-file'
+        options:
+          max-size: '10m'
+          max-file: '10'
+      #mem_limit: 500mb
+      #links:
+      #  - mongo-slp-indexer
+      ports:
+        - '5942:5942' # <host port>:<container port>
+      volumes:
+        - ./start-rest2nostr.sh:/home/safeuser/REST2NOSTR/start-rest2nostr.sh
+      restart: always

package/production/docker/start-rest2nostr.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+npm start