Skip to content

Latest commit

 

History

History
 
 

cache-service

README.md

redstone-cache-service

This is a NestJS web app, which serves as a gateway to the data in the RedStone ecosystem.

Deploy

Click the button below to deploy the app to the DigitalOcean App Platform.

  • Here you can find a small tutorial on how to do it.
  • If you are not logged in, you will be prompted to log in with your DigitalOcean account.
  • The deployment may take up to 20 minutes and will be performed for the main branch.
  • If you need to have the deployment performed for your custom branch, you need to modify .do/deploy.template.yaml file and the link in the button below by replacing main with the name of your branch.

Prerequisites

You need to have the MongoDB setup performed as a cluster or as an external service. Check here to see how to set up the MongoDB cluster on the DigitalOcean platform.

Deploy to DigitalOcean

or

Use the following link to deploy redstone-cache-service on AWS lightsail in 2 minutes.

Endpoints

  • data-packages (main)
    • [MAYBE] the first 2 endpoints will be replaced with graphql
    • GET /data-packages/latest (query params: signerAddress, limit, dataServiceId)
    • GET /data-packages (query params: toTimestamp, signerAddress, limit, dataServiceId)
    • POST /data-packages (body = a single package)
    • POST /data-packages/bulk (body = array of data packages)
  • other (helpful endpoints)
    • GET /oracle-registry-state
    • GET /symbols-metadata

Background jobs

  • oracle-registry-state-updater (run each 2 minutes)

  • streamr-listener (will listen on all data packages in the redstone-ecosystem and save it in DB) (will be disabled in nodes with direct posting)

  • db-cleaner (will be launched every 1 hour, will remove too old data, e.g. data older than 7 days)

  • Key differences

    • Now we will force each node operator to create a stream in the streamr network
    • Each node will broadcast data packages to the streamr network and additionally will broadcast them to 2 cache services hosted by RedStone (for faster data access)
    • Cache layer nodes will by default listen on streamr and cache data in DB
    • Thanks to streamr cache layers nodes will won't need to push data every 3 seconds, they can do it in the same way as before, in each iteration
    • RedStone community and partners will be able to launch cache services
    • We will use additional hosted uptime-kuma to notify developers in case of problems
      • There are 2 ways to handle this
          1. Use push monitor type with upside-down mode (push errors to the uptime-kuma service with helpful messages)
          1. Use HTTP keyword fetching, and add to cache-services some additonal /status endpoint