This repository contains the source code for middleware that will provide time-series data related to Cooler Loans.
This repository deploys two API endpoints:
-
generate- Generates daily snapshots for Cooler Loans.
- Each snapshot is based on the previous day's snapshot (where applicable), in combination with the loan events (e.g. repayment) from that day.
- Loan events are processed in the order that they occur.
- A Google Cloud Function (with a periodic trigger) determines the previous date for which the snapshot was generated, and generates from that day onwards.
- The snapshots are stored in Google Cloud Storage and exposed through a BigQuery database.
- Generates daily snapshots for Cooler Loans.
-
get- Fetches the daily snapshots for the given
startDateandbeforeDate
- Fetches the daily snapshots for the given
- Run
yarnto install the dependencies of the whole project
yarn test
Pulumi is used to deploy the infrastructure.
To deploy:
- Build the project:
yarn run build cd packages/infrastructurepulumi up --stack <STACK_NAME>
If the daily snapshots need to be rebuilt (e.g. change in the subgraph or the snapshot structure), simply delete the directories in the Google Cloud Storage bucket that corresponds to the environment.
REST API clients can utilise the apps/get/openapi/openapi.yml file to generate typings. The schema, contained in apps/get/openapi/snapshot.yaml is regenerated with the yarn run build command.