circlesubi / slimemold-service

Trust network indexing and transfer steps finding API for Circles

slimemold-service

Trust network indexing and transfer steps finding API for Circles

Handbook | Releases | Contributing

Off-chain API service for Circles to find transitive transfer steps to send tokens within the trust graph.

Features

• Indexes and stores Circles trust network
• Calculate transitive transfer steps to send tokens

Requirements

• NodeJS environment (v14)

Development

# Install dependencies
npm install

# Copy .env file for local development
cp .env.example .env

# Check code formatting
npm run lint

# Start local server and watch changes
npm run watch

# Run tests via `jest`
npm run test
npm run test:watch

Deployment

# Clean `./dist` folder from previous builds
npm run clean

# Build project files and copy them to `./dist` folder
npm run build

# Start node process
npm run start

License

GNU Affero General Public License v3.0 AGPL-3.0

slimemold-service's Issues

Define TypeScript types for API request and response bodies

• Create definition
• Test definitions

Document Architecture Implementation

Review and update https://nubo.bitspossessed.org/f/47280 with implementation of the new transitive transfer API

CI: Build and upload Docker image to registry

Cereate CI to push docker image to Digital Ocean registry

Docker image

Create a docker image for the API to make it usable by myxo and other projects interacting with circles

Review the API proxy concept

• review the concept of API Proxy
• review how an API can collect the number of request and comunicate this to the backend service

Implement basic HTTP Server

• Support basic middlewares as compression, cors, etc.
• Logging
• Error responses to clients

Include metrics and logs useful for the user and developer

Enable metrics such as:

• Time to return steps
• Numbers of steps vs hops
• Max flow depending of the # hops

Set up database

Set up linting

Set up TypeScript pipeline

Review how the edges are calculated

Review how the edges are calculated from the balances and trust_limits.

Review slimemold service to fit scope for pathfinder2 integration

• check what is missing to do the integratin
• what needs to be updated
• what needs to be deleted

Review how transfer edges are represented in the database

This will be important for the pathfinder service, as it will query the database directly.

Current implementation: https://github.com/CirclesUBI/circles-api/blob/main/src/models/edges.js

Worker design

• What is a worker task? Is it handling edge updates, a whole event or even a block?
• Where and how does the worker report errors?

Implement findTransferSteps function calling the pathfinder2 service

Enable this endpoint to use any of the parameters from the definition of the pathfinder2 https://hackmd.io/Gg04t7gjQKeDW2Q6Jchp0Q

• Create test cases
• Test with production data

CI: Set up automated tests

Set up basic NodeJS project

User request validation in HTTP API

via https://joi.dev/api/?v=17.4.0

Write a README.md

Also changelog and codeowners

Set up test pipeline

Decide which database to use

Define public HTTP API

What we have had so far: https://github.com/CirclesUBI/circles-api/blob/main/API.md#find-transitive-transfer-steps

What we need

• Find transitive transfer steps

Nice to have

• Get trust connections of a node