tdex-analytics

module
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 8, 2022 License: MIT

README ยถ

๐Ÿ“Š tdex-analytics

Go Report Card PkgGoDev Release

TDEX Analytics provides historical data about balances and prices of Liquidity Providers registered in the tdex-registry.

It periodically polls Liquidity Provider's registry and fetches all available markets and their market price and balances and fills a time-series DB with data that are accessible through gRPC & JSON HTTP APIs.

API specifications can be found in here.

๐Ÿ–ฅ Local Development

Below is a list of commands you will probably find useful for development.

Requirements
  • Go (^1.17.*)
Build

Builds tdexad as static binary in the ./bin folder

$ make build
Build CLI

Builds tdexa as static binary in the ./bin folder

$ make build-cli
Run with docker-compose

Build docker image and runs the project with other dependencies with default configuration.

$ make dev
Test
$ make testall

๐Ÿ“„ Usage

  • Configure CLI:
./bin/tdexa config
  • List market's id's to be passed to prices/balances cmd's:
./bin/tdexa markets
  • List balances for last hour:
./bin/tdexa balances --predefined_period 1
  • List prices for last hour:
./bin/tdexa prices --predefined_period 1
Release

Precompiled binaries are published with each release.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Directories ยถ

Path Synopsis
api-spec
protobuf/gen/tdex/v1
Package tdexv1 is a reverse proxy.
Package tdexv1 is a reverse proxy.
protobuf/gen/tdexa/v1
Package tdexav1 is a reverse proxy.
Package tdexav1 is a reverse proxy.
cmd
internal
pkg
test

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL