Skip to content

Latest commit

 

History

History
100 lines (76 loc) · 3.09 KB

README.md

File metadata and controls

100 lines (76 loc) · 3.09 KB
Raw

rarime-points-svc

Description

Core service of Rarimo Points System

Install

git clone github.com/rarimo/rarime-points-svc
cd rarime-points-svc
go build main.go
export KV_VIPER_FILE=./config.yaml
./main migrate up
./main run service

API documentation

Online docs are available.

All endpoints from docs MUST be publicly accessible.

Private endpoints

Private endpoints are not documented and MUST only be accessible within the internal network. They do not require authorization in order to simplify back-end interactions with Points service. Package connector provides functionality to interact with these endpoints.

The path for internal endpoints is /integrations/rarime-points-svc/v1/private/*.

Add referrals

Private endpoint to set usage count for genesis referral code or create a new System user with genesis referral code. System user is unable to claim events or withdraw, it has is_disabled attribute set to true, so the client app should not allow it interactions with the system, although it is technically possible to do other actions.

Path: /integrations/rarime-points-svc/v1/private/referrals Body:

{
    "nullifier": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "count": 2,
}

Response:

{
  "referral": "kPRQYQUcWzW",
  "usage_left": 2
}

Parameters:

  • nullifier - nullifier to create or edit referrals for
  • count - number of referral usage

Local build

We do use openapi:json standard for API. We use swagger for documenting our API.

To open online documentation, go to swagger editor here is how you can start it

  cd docs
  npm install
  npm run start

To build documentation use npm run build command, that will create open-api documentation in web_deploy folder.

To generate resources for Go models run ./generate.sh script in root folder. use ./generate.sh --help to see all available options.

Note: if you are using Gitlab for building project docs/spec/paths folder must not be empty, otherwise only Build and Publish job will be passed.

Running from Source

  • Run dependencies, based on config example
  • Set up environment value with config file path KV_VIPER_FILE=./config.yaml
  • Provide valid config file
  • Launch the service with migrate up command to create database schema
  • Launch the service with run service command

Database

For services, we do use PostgresSQL database. You can install it locally or use docker image.

Testing

In order to run the tests, you need to be in the project directory, have docker and docker compose installed. To start, you need to run the run_tests.sh script.

The script works as follows:

  1. If there is already an image rarime-points-svc:test - deletes it.
  2. Builds a new rarime-points-svc:test image (some logic mocked)
  3. Starts docker compose with test service and database.
  4. Runs tests
  5. Deletes created containers and everything related to them