An open API service indexing awesome lists of open source software.

https://github.com/dcspark/token-registry-service

Cardano token registry service
https://github.com/dcspark/token-registry-service

Last synced: about 1 year ago
JSON representation

Cardano token registry service

Awesome Lists containing this project

README

          

# Cardano- Token Registry Service

[![Node.js CI](https://github.com/dcSpark/token-registry-service/actions/workflows/node.js.yml/badge.svg?branch=main)](https://github.com/dcSpark/token-registry-service/actions/workflows/node.js.yml)

## Background

## Purpose of this project

The purpose of this micro service is to cache the token information from sources as [CF token registry](https://github.com/cardano-foundation/cardano-token-registry), [CNFT](https://github.com/Cardano-NFTs/policyIDs) that can be queried by the cardano-backend service.

# Requirements

## Building

Development build (with hot reloading):

```bash
# install the right version of Node
nvm use
nvm install

# install dependencies
npm install

# run the server
npm run dev:watch
```

Production build:

```
npm run build
```

_Never put production credentials into repository!_

## Containers

This will build to a container with the docker file. The container is using the PM2 runtime. You will need to pass ENV variables to the container to register with PM2 logging.

## Tests

1. On one terminal, run `npm run dev:watch`
2. On a second terminal, run `npm run test`

## API

Post - `/v1/getTokenInfo`
- Input: `{ policyIdAssetMap: Record }`
- Output: `Record>`

Post - `/v1/getFingerprintInfo`
- Input: `{ fingerprintIdAssets: string[] }`
- Output: `Record`