Slashtags Exchange Feeds Daemon

A simple HTTP RPC deamon to enable publishing Slashtags Exchange Feeds. Can be used either as a Library or as a Daemon

Import as Library

Install as a dependency

npm i @synonymdev/feeds-daemon 

Import to your code and instantiate providing corresponding parameters and start the server

const { Feeds } = require('@synonymdev/feeds-daemon')
const feeds = new Feeds({
    db: {
        name: 'feeds-db',
        path: "./data"
    },
    slashtags: "./",
    feed_schema: "<feed schema json file>"
})

await feeds.start()

You can now call various functions

let feed = await feeds.getFeed({ feed_id: "123123" })

Run as Daemon

1. Setup config Go to ./schema/config.json Update config items.

2. Update your feeds slashfeed.json file This schema file allows feed consumers to parse the feed.

git clone
npm install
mkdir ./db
node start.js

Enable detailed logs specifying env variable*

DEBUG=stfeed:*

*Run with PM2

*pm2 start

Test & Development

There are tests for all methods located in ./test dir. You can run them by npm run test There examples in ./examples folder. They require running daemon. Run npm run start to start daemon and in separate terminal run npm run example:account to start generating account feed. See examples readme for more details

RPC API

A Postman collection has been provided.

Create Feed

Create a feed request

/// Request Body
curl --location --request POST 'http://localhost:8787/v0.1/rpc' \
--header 'Content-Type: application/json' \
--data-raw '{
    "method":"createFeed",
    "params":{
        "feed_id":"satoshi123"
    }
}'

Response

{
    "jsonrpc": "2.0",
    "id": "925b10c27f4ad350ab3ef7e027605fd83388c999a890cfdd8e6061656b5a5513",
    "result": {
        "slashdrive": {
            "key": "<string>",
            "encryption_key": "<string>"
        }
    }
}

Update Feed

Update feed request

curl --location --request POST 'http://localhost:8787/v0.1/rpc' \
--header 'Content-Type: application/json' \
--data-raw '{
    "method":"updateFeedBalance",
    "params": {
        "feed_id":"satoshi123",
        "fields": [
          {
            "name": "Bitcoin",
            "value": 1.442
          }
        ]
    }
}'

Response

{
    "jsonrpc": "2.0",
    "id": "4fefad839fa440cc2a85d8178d1d895fa1044460080b8fe1a26b4942aa86c07f",
    "result": true
}

Get Feed

curl --location --request POST 'http://localhost:8787/v0.1/rpc' \
--header 'Content-Type: application/json' \
--data-raw '{
    "method":"getFeed",
    "params":{ "feed_id" : "satoshi123" }
}'

Response

{
    "jsonrpc": "2.0",
    "id": "c6ccd88f842330ab60153b5fb512101d2ab76824189eee5690f9070ebe18cb87",
    "result": {
        "feed_key": "<string>",
        "encrypt_key": "<string>"
    }
}

Delete Feed

curl --location --request POST 'http://localhost:8787/v0.1/rpc' \
--header 'Content-Type: application/json' \
--data-raw '{
    "method":"deleteFeed",
    "params":{ "feed_id" : "satoshi123" }
}'

Response

{
    "jsonrpc": "2.0",
    "id": "c6ccd88f842330ab60153b5fb512101d2ab76824189eee5690f9070ebe18cb87",
    "result": {
        "deleted": "true"
    }
}